{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PaymentResponse",
"title": "PaymentResponse",
"properties": {
"action": {
"x-addedInVersion": "49",
"description": "Action to be taken for completing the payment.",
"oneOf": [
{
"$ref": "#/components/schemas/CheckoutAwaitAction"
},
{
"$ref": "#/components/schemas/CheckoutDelegatedAuthenticationAction"
},
{
"$ref": "#/components/schemas/CheckoutNativeRedirectAction"
},
{
"$ref": "#/components/schemas/CheckoutQrCodeAction"
},
{
"$ref": "#/components/schemas/CheckoutRedirectAction"
},
{
"$ref": "#/components/schemas/CheckoutSDKAction"
},
{
"$ref": "#/components/schemas/CheckoutThreeDS2Action"
},
{
"$ref": "#/components/schemas/CheckoutVoucherAction"
}
]
},
"additionalData": {
"additionalProperties": {
"type": "string"
},
"x-anyOf": [
{
"$ref": "#/components/schemas/ResponseAdditionalData3DSecure"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataBillingAddress"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataCard"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataCommon"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataDomesticError"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataInstallments"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataSepa"
}
],
"description": "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.",
"type": "object"
},
"amount": {
"x-addedInVersion": "52",
"description": "Authorised amount in the transaction.",
"$ref": "#/components/schemas/Amount"
},
"donationToken": {
"x-addedInVersion": "66",
"description": "Donation Token containing payment details for Adyen Giving.",
"type": "string"
},
"fraudResult": {
"description": "The fraud result properties of the payment.",
"$ref": "#/components/schemas/FraudResult"
},
"merchantReference": {
"x-addedInVersion": "49",
"description": "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.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.",
"type": "string"
},
"order": {
"description": "Contains updated information regarding the order in case order information was provided in the request.",
"$ref": "#/components/schemas/CheckoutOrderResponse"
},
"paymentMethod": {
"x-addedInVersion": "69",
"description": "Details about the payment method used in the transaction. \nOnly returned if `resultCode` is **Authorised**.",
"$ref": "#/components/schemas/ResponsePaymentMethod"
},
"pspReference": {
"description": "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.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.",
"type": "string"
},
"refusalReason": {
"description": "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.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type": "string"
},
"refusalReasonCode": {
"x-addedInVersion": "37",
"description": "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type": "string"
},
"resultCode": {
"description": "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **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.\n* **Cancelled** Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **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.\n* **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.\n* **Received** Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.",
"enum": [
"AuthenticationFinished",
"AuthenticationNotRequired",
"Authorised",
"Cancelled",
"ChallengeShopper",
"Error",
"IdentifyShopper",
"PartiallyAuthorised",
"Pending",
"PresentToShopper",
"Received",
"RedirectShopper",
"Refused",
"Success"
],
"type": "string"
},
"threeDS2ResponseData": {
"x-addedInVersion": "67",
"description": "Response of the 3D Secure 2 authentication.",
"$ref": "#/components/schemas/ThreeDS2ResponseData"
},
"threeDS2Result": {
"x-addedInVersion": "41",
"description": "Result of the 3D Secure 2 authentication.",
"$ref": "#/components/schemas/ThreeDS2Result"
},
"threeDSPaymentData": {
"x-addedInVersion": "67",
"description": "When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.",
"type": "string"
}
},
"type": "object"
}