PaymentResult class abstract

PaymentResult

Properties:

  • 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.
  • authCode - 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.
  • dccAmount - Includes the currency of the conversion and the value of the transaction. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, contact Support.
  • dccSignature - Cryptographic signature used to verify dccQuote. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, contact Support.
  • fraudResult - The fraud result properties of the payment.
  • issuerUrl - The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL.
  • md - The payment session.
  • paRequest - 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.
  • pspReference - Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
  • 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.
  • 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.
Annotations
  • @BuiltValue.new()

Constructors

PaymentResult([void updates(PaymentResultBuilder b)])
factory

Properties

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
authCode → String?
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.
no setter
dccAmount → Amount?
Includes the currency of the conversion and the value of the transaction. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, contact Support.
no setter
dccSignature → String?
Cryptographic signature used to verify dccQuote. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, contact Support.
no setter
fraudResult → FraudResult?
The fraud result properties of the payment.
no setter
hashCode → int
The hash code for this object.
no setterinherited
issuerUrl → String?
The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL.
no setter
md → String?
The payment session.
no setter
paRequest → String?
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.
no setter
pspReference → String?
Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
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
resultCode → PaymentResultResultCodeEnum?
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

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(PaymentResultBuilder)) → PaymentResult
Rebuilds the instance.
inherited
toBuilder() → PaymentResultBuilder
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<PaymentResult>
no setter