Package com.adyen.model.payout
Class PayoutResponse
- java.lang.Object
-
- com.adyen.model.payout.PayoutResponse
-
public class PayoutResponse extends Object
PayoutResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPayoutResponse.ResultCodeEnumThe result of the payment.
-
Constructor Summary
Constructors Constructor Description PayoutResponse()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PayoutResponseadditionalData(Map<String,String> additionalData)PayoutResponseauthCode(String authCode)PayoutResponsedccAmount(Amount dccAmount)PayoutResponsedccSignature(String dccSignature)booleanequals(Object o)PayoutResponsefraudResult(FraudResult fraudResult)Map<String,String>getAdditionalData()This field contains additional data, which may be required to return in a particular payment response.StringgetAuthCode()Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment.AmountgetDccAmount()Get dccAmountStringgetDccSignature()Cryptographic signature used to verify `dccQuote`.FraudResultgetFraudResult()Get fraudResultStringgetIssuerUrl()The URL to direct the shopper to.StringgetMd()The payment session.StringgetPaRequest()The 3D request data for the issuer.StringgetPspReference()Adyen's 16-character string reference associated with the transaction/request.StringgetRefusalReason()If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error.PayoutResponse.ResultCodeEnumgetResultCode()The result of the payment.inthashCode()PayoutResponseissuerUrl(String issuerUrl)PayoutResponsemd(String md)PayoutResponsepaRequest(String paRequest)PayoutResponsepspReference(String pspReference)PayoutResponserefusalReason(String refusalReason)PayoutResponseresultCode(PayoutResponse.ResultCodeEnum resultCode)voidsetAdditionalData(Map<String,String> additionalData)voidsetAuthCode(String authCode)voidsetDccAmount(Amount dccAmount)voidsetDccSignature(String dccSignature)voidsetFraudResult(FraudResult fraudResult)voidsetIssuerUrl(String issuerUrl)voidsetMd(String md)voidsetPaRequest(String paRequest)voidsetPspReference(String pspReference)voidsetRefusalReason(String refusalReason)voidsetResultCode(PayoutResponse.ResultCodeEnum resultCode)StringtoString()
-
-
-
Method Detail
-
additionalData
public PayoutResponse additionalData(Map<String,String> additionalData)
-
getAdditionalData
public Map<String,String> getAdditionalData()
This field contains additional data, which may be required to return in a particular payment response. To choose data fields to be returned, go to **Customer Area** > **Account** > **API URLs**.- Returns:
- additionalData
-
authCode
public PayoutResponse authCode(String authCode)
-
getAuthCode
public String getAuthCode()
Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty.- Returns:
- authCode
-
setAuthCode
public void setAuthCode(String authCode)
-
dccAmount
public PayoutResponse dccAmount(Amount dccAmount)
-
getDccAmount
public Amount getDccAmount()
Get dccAmount- Returns:
- dccAmount
-
setDccAmount
public void setDccAmount(Amount dccAmount)
-
dccSignature
public PayoutResponse dccSignature(String dccSignature)
-
getDccSignature
public String getDccSignature()
Cryptographic signature used to verify `dccQuote`. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).- Returns:
- dccSignature
-
setDccSignature
public void setDccSignature(String dccSignature)
-
fraudResult
public PayoutResponse fraudResult(FraudResult fraudResult)
-
getFraudResult
public FraudResult getFraudResult()
Get fraudResult- Returns:
- fraudResult
-
setFraudResult
public void setFraudResult(FraudResult fraudResult)
-
issuerUrl
public PayoutResponse issuerUrl(String issuerUrl)
-
getIssuerUrl
public String getIssuerUrl()
The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL.- Returns:
- issuerUrl
-
setIssuerUrl
public void setIssuerUrl(String issuerUrl)
-
md
public PayoutResponse md(String md)
-
getMd
public String getMd()
The payment session.- Returns:
- md
-
setMd
public void setMd(String md)
-
paRequest
public PayoutResponse paRequest(String paRequest)
-
getPaRequest
public String getPaRequest()
The 3D request data for the issuer. If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/risk-management/3d-secure).- Returns:
- paRequest
-
setPaRequest
public void setPaRequest(String paRequest)
-
pspReference
public PayoutResponse pspReference(String pspReference)
-
getPspReference
public String getPspReference()
Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > `pspReference` is returned only for non-redirect payment methods.- Returns:
- pspReference
-
setPspReference
public void setPspReference(String pspReference)
-
refusalReason
public PayoutResponse refusalReason(String refusalReason)
-
getRefusalReason
public String getRefusalReason()
If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.- Returns:
- refusalReason
-
setRefusalReason
public void setRefusalReason(String refusalReason)
-
resultCode
public PayoutResponse resultCode(PayoutResponse.ResultCodeEnum resultCode)
-
getResultCode
public PayoutResponse.ResultCodeEnum getResultCode()
The result of the payment. Possible values: * **Authorised** – Indicates the payment authorisation was successfully completed. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. For more information on handling a pending payment, refer to [Payments with pending status](https://docs.adyen.com/development-resources/payments-with-pending-status). * **Error** – Indicates an error occurred during processing of the payment. The reason is given in the `refusalReason` field. This is a final state.- Returns:
- resultCode
-
setResultCode
public void setResultCode(PayoutResponse.ResultCodeEnum resultCode)
-
-