Package com.adyen.model.checkout
Class PaymentResultResponse
- java.lang.Object
-
- com.adyen.model.checkout.PaymentResultResponse
-
public class PaymentResultResponse extends Object
PaymentResultResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPaymentResultResponse.ResultCodeEnumThe result of the payment.
-
Constructor Summary
Constructors Constructor Description PaymentResultResponse()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PaymentResultResponseadditionalData(Map<String,String> additionalData)PaymentResultResponseauthResponse(String authResponse)booleanequals(Object o)Map<String,String>getAdditionalData()This field contains additional data, which may be required to return in a particular payment response.StringgetAuthResponse()The authorisation code representing the authentication result.FraudResultgetFraudResult()Get fraudResultStringgetMerchantReference()A unique value that you provided in the initial `/paymentSession` request as a `reference` field.StringgetPaymentMethod()The payment method used in the transaction.StringgetPspReference()Adyen's 16-digit unique reference associated with the transaction/the 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.StringgetRefusalReasonCode()PaymentResultResponse.ResultCodeEnumgetResultCode()The result of the payment.ServiceErrorgetServiceError()Get serviceErrorStringgetShopperLocale()The shopperLocale value provided in the payment request.inthashCode()PaymentResultResponsemerchantReference(String merchantReference)PaymentResultResponsepaymentMethod(String paymentMethod)PaymentResultResponsepspReference(String pspReference)PaymentResultResponseputAdditionalDataItem(String key, String additionalDataItem)PaymentResultResponserefusalReason(String refusalReason)PaymentResultResponseresultCode(PaymentResultResponse.ResultCodeEnum resultCode)PaymentResultResponseserviceError(ServiceError serviceError)voidsetAdditionalData(Map<String,String> additionalData)voidsetAuthResponse(String authResponse)voidsetFraudResult(FraudResult fraudResult)voidsetMerchantReference(String merchantReference)voidsetPaymentMethod(String paymentMethod)voidsetPspReference(String pspReference)voidsetRefusalReason(String refusalReason)voidsetRefusalReasonCode(String refusalReasonCode)voidsetResultCode(PaymentResultResponse.ResultCodeEnum resultCode)voidsetServiceError(ServiceError serviceError)voidsetShopperLocale(String shopperLocale)PaymentResultResponseshopperLocale(String shopperLocale)StringtoString()
-
-
-
Method Detail
-
getRefusalReasonCode
public String getRefusalReasonCode()
-
setRefusalReasonCode
public void setRefusalReasonCode(String refusalReasonCode)
-
additionalData
public PaymentResultResponse additionalData(Map<String,String> additionalData)
-
putAdditionalDataItem
public PaymentResultResponse putAdditionalDataItem(String key, String additionalDataItem)
-
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** > **Settings** > **API and Response**.- Returns:
- additionalData
-
authResponse
public PaymentResultResponse authResponse(String authResponse)
-
getAuthResponse
public String getAuthResponse()
The authorisation code representing the authentication result. Possible values: * Received * Authorised * Error * Refused * Cancelled * Unknown- Returns:
- authResponse
-
setAuthResponse
public void setAuthResponse(String authResponse)
-
getFraudResult
public FraudResult getFraudResult()
Get fraudResult- Returns:
- fraudResult
-
setFraudResult
public void setFraudResult(FraudResult fraudResult)
-
merchantReference
public PaymentResultResponse merchantReference(String merchantReference)
-
getMerchantReference
public String getMerchantReference()
A unique value that you provided in the initial `/paymentSession` request as a `reference` field.- Returns:
- merchantReference
-
setMerchantReference
public void setMerchantReference(String merchantReference)
-
paymentMethod
public PaymentResultResponse paymentMethod(String paymentMethod)
-
getPaymentMethod
public String getPaymentMethod()
The payment method used in the transaction.- Returns:
- paymentMethod
-
setPaymentMethod
public void setPaymentMethod(String paymentMethod)
-
pspReference
public PaymentResultResponse pspReference(String pspReference)
-
getPspReference
public String getPspReference()
Adyen's 16-digit unique reference associated with the transaction/the 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 PaymentResultResponse 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 PaymentResultResponse resultCode(PaymentResultResponse.ResultCodeEnum resultCode)
-
getResultCode
public PaymentResultResponse.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. For more information on handling a redirect, refer to [Handling a redirect](https://docs.adyen.com/developers/checkout/api-integration/payments#handlingaredirect). * **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/developers/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(PaymentResultResponse.ResultCodeEnum resultCode)
-
serviceError
public PaymentResultResponse serviceError(ServiceError serviceError)
-
getServiceError
public ServiceError getServiceError()
Get serviceError- Returns:
- serviceError
-
setServiceError
public void setServiceError(ServiceError serviceError)
-
shopperLocale
public PaymentResultResponse shopperLocale(String shopperLocale)
-
getShopperLocale
public String getShopperLocale()
The shopperLocale value provided in the payment request.- Returns:
- shopperLocale
-
setShopperLocale
public void setShopperLocale(String shopperLocale)
-
-