PaymentResponse class abstract

PaymentResponse

Properties:

  • action
  • additionalData - Contains additional information about the payment. Some data fields are included only if you select them first: Go to Customer Area > Developers > Additional data.
  • amount - Authorised amount in the transaction.
  • donationToken - Donation Token containing payment details for Adyen Giving.
  • fraudResult - The fraud result properties of the payment.
  • merchantReference - The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.
  • order - Contains updated information regarding the order in case order information was provided in the request.
  • paymentMethod - Details about the payment method used in the transaction. Only returned if resultCode is Authorised.
  • paymentValidations - The object that contains the validation outcomes. Only returned if resultCode is Authorised and if you have requested a payment validation in the request.
  • pspReference - 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. > For payment methods that require a redirect or additional action, you will get this value in the /payments/details response.
  • refusalReason - 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. For more information, see Refusal reasons.
  • refusalReasonCode - Code that specifies the refusal reason. For more information, see Authorisation refusal reasons.
  • resultCode - The result of the payment. For more information, see Result codes. Possible values: * AuthenticationFinished – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * AuthenticationNotRequired – The transaction does not require 3D Secure authentication. Returned for standalone authentication-only integrations. * Authorised – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * Cancelled – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * ChallengeShopper – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * Error – There was an error when the payment was being processed. The reason is given in the refusalReason field. This is a final state. * IdentifyShopper – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * PartiallyAuthorised – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * 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. * PresentToShopper – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * Received – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * RedirectShopper – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * Refused – Indicates the payment was refused. The reason is given in the refusalReason field. This is a final state.
  • threeDS2ResponseData - Response of the 3D Secure 2 authentication.
  • threeDS2Result - Result of the 3D Secure 2 authentication.
  • threeDSPaymentData - When non-empty, contains a value that you must submit to the /payments/details endpoint as paymentData.
Annotations
  • @BuiltValue.new()

Constructors

PaymentResponse([void updates(PaymentResponseBuilder b)])
factory

Properties

action → PaymentResponseAction?
no setter
additionalData → BuiltMap<String, String>?
Contains additional information about the payment. Some data fields are included only if you select them first: Go to Customer Area > Developers > Additional data.
no setter
amount → Amount?
Authorised amount in the transaction.
no setter
donationToken → String?
Donation Token containing payment details for Adyen Giving.
no setter
fraudResult → FraudResult?
The fraud result properties of the payment.
no setter
hashCode → int
The hash code for this object.
no setterinherited
merchantReference → String?
The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.
no setter
order → CheckoutOrderResponse?
Contains updated information regarding the order in case order information was provided in the request.
no setter
paymentMethod → ResponsePaymentMethod?
Details about the payment method used in the transaction. Only returned if resultCode is Authorised.
no setter
paymentValidations → PaymentValidationsResponse?
The object that contains the validation outcomes. Only returned if resultCode is Authorised and if you have requested a payment validation in the request.
no setter
pspReference → String?
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. > For payment methods that require a redirect or additional action, you will get this value in the /payments/details response.
no setter
refusalReason → String?
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. For more information, see Refusal reasons.
no setter
refusalReasonCode → String?
Code that specifies the refusal reason. For more information, see Authorisation refusal reasons.
no setter
resultCode → PaymentResponseResultCodeEnum?
The result of the payment. For more information, see Result codes. Possible values: * AuthenticationFinished – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * AuthenticationNotRequired – The transaction does not require 3D Secure authentication. Returned for standalone authentication-only integrations. * Authorised – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * Cancelled – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * ChallengeShopper – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * Error – There was an error when the payment was being processed. The reason is given in the refusalReason field. This is a final state. * IdentifyShopper – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * PartiallyAuthorised – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * 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. * PresentToShopper – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * Received – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * RedirectShopper – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * Refused – Indicates the payment was refused. The reason is given in the refusalReason field. This is a final state.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
threeDS2ResponseData → ThreeDS2ResponseData?
Response of the 3D Secure 2 authentication.
no setter
threeDS2Result → ThreeDS2Result?
Result of the 3D Secure 2 authentication.
no setter
threeDSPaymentData → String?
When non-empty, contains a value that you must submit to the /payments/details endpoint as paymentData.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(PaymentResponseBuilder)) → PaymentResponse
Rebuilds the instance.
inherited
toBuilder() → PaymentResponseBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<PaymentResponse>
no setter