Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 5.36 KB

PaymentResponse.md

File metadata and controls

31 lines (24 loc) · 5.36 KB

PaymentResponse

Properties

Name Type Description Notes
action PaymentResponseAction [optional]
additionalData kotlin.collections.Map<kotlin.String, kotlin.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. [optional]
amount Amount [optional]
donationToken kotlin.String Donation Token containing payment details for Adyen Giving. [optional]
fraudResult FraudResult [optional]
merchantReference kotlin.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 (&quot;-&quot;). Maximum length: 80 characters. [optional]
order CheckoutOrderResponse [optional]
paymentMethod ResponsePaymentMethod [optional]
pspReference kotlin.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. [optional]
refusalReason kotlin.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. [optional]
refusalReasonCode kotlin.String Code that specifies the refusal reason. For more information, see Authorisation refusal reasons. [optional]
resultCode inline 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. [optional]
threeDS2ResponseData ThreeDS2ResponseData [optional]
threeDS2Result ThreeDS2Result [optional]
threeDSPaymentData kotlin.String When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. [optional]

Enum: resultCode

Name Value
resultCode AuthenticationFinished, AuthenticationNotRequired, Authorised, Cancelled, ChallengeShopper, Error, IdentifyShopper, PartiallyAuthorised, Pending, PresentToShopper, Received, RedirectShopper, Refused, Success