{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-donation-payment-response-schema.json", "title": "DonationPaymentResponse", "x-generated": "2026-10-12", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/adyen-donations-api-openapi.yml#/components/schemas/DonationPaymentResponse", "properties": { "amount": { "description": "Authorised amount in the transaction.", "$ref": "#/$defs/Amount" }, "donationAccount": { "description": "The Adyen account name of your charity. We will provide you with this account name once your chosen charity has been [onboarded](https://docs.adyen.com/online-payments/donations#onboarding).", "type": "string" }, "id": { "description": "Your unique resource identifier.", "type": "string" }, "merchantAccount": { "description": "The merchant account identifier, with which you want to process the transaction.", "type": "string" }, "payment": { "description": "Action to be taken for completing the payment.", "$ref": "#/$defs/PaymentResponse" }, "reference": { "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. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.", "type": "string" }, "status": { "description": "The status of the donation transaction.\n\nPossible values:\n* **completed**\n* **pending**\n* **refused**", "enum": [ "completed", "pending", "refused" ], "type": "string" } }, "type": "object", "$defs": { "Amount": { "properties": { "currency": { "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", "maxLength": 3, "minLength": 3, "type": "string" }, "value": { "description": "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).", "format": "int64", "type": "integer" } }, "required": [ "value", "currency" ], "type": "object" }, "CheckoutAwaitAction": { "additionalProperties": false, "properties": { "paymentData": { "description": "Encoded payment data.", "type": "string" }, "paymentMethodType": { "description": "Specifies the payment method.", "type": "string" }, "type": { "description": "**await**", "enum": [ "await" ], "type": "string" }, "url": { "description": "Specifies the URL to redirect to.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "CheckoutDelegatedAuthenticationAction": { "additionalProperties": false, "properties": { "authorisationToken": { "description": "A token needed to authorise a payment.", "type": "string" }, "paymentData": { "description": "Encoded payment data.", "type": "string" }, "paymentMethodType": { "description": "Specifies the payment method.", "type": "string" }, "token": { "description": "A token to pass to the delegatedAuthentication component.", "type": "string" }, "type": { "description": "**delegatedAuthentication**", "enum": [ "delegatedAuthentication" ], "type": "string" }, "url": { "description": "Specifies the URL to redirect to.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "CheckoutNativeRedirectAction": { "additionalProperties": false, "properties": { "data": { "additionalProperties": { "type": "string" }, "description": "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", "type": "object" }, "method": { "description": "Specifies the HTTP method, for example GET or POST.", "type": "string" }, "nativeRedirectData": { "description": "Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.", "type": "string" }, "paymentMethodType": { "description": "Specifies the payment method.", "type": "string" }, "type": { "description": "**nativeRedirect**", "enum": [ "nativeRedirect" ], "type": "string" }, "url": { "description": "Specifies the URL to redirect to.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "CheckoutOrderResponse": { "properties": { "amount": { "description": "The initial amount of the order.", "$ref": "#/$defs/Amount" }, "expiresAt": { "description": "The expiry date for the order.", "type": "string" }, "orderData": { "description": "The encrypted order data.", "type": "string" }, "pspReference": { "description": "The `pspReference` that belongs to the order.", "type": "string" }, "reference": { "description": "The merchant reference for the order.", "type": "string" }, "remainingAmount": { "description": "The updated remaining amount.", "$ref": "#/$defs/Amount" } }, "required": [ "pspReference" ], "type": "object" }, "CheckoutQrCodeAction": { "additionalProperties": false, "properties": { "expiresAt": { "description": "Expiry time of the QR code.", "type": "string" }, "paymentData": { "description": "Encoded payment data.", "type": "string" }, "paymentMethodType": { "description": "Specifies the payment method.", "type": "string" }, "qrCodeData": { "description": "The contents of the QR code as a UTF8 string.", "type": "string" }, "type": { "description": "**qrCode**", "enum": [ "qrCode" ], "type": "string" }, "url": { "description": "Specifies the URL to redirect to.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "CheckoutRedirectAction": { "additionalProperties": false, "properties": { "data": { "additionalProperties": { "type": "string" }, "description": "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.", "type": "object" }, "method": { "description": "Specifies the HTTP method, for example GET or POST.", "type": "string" }, "paymentMethodType": { "description": "Specifies the payment method.", "type": "string" }, "type": { "description": "**redirect**", "enum": [ "redirect" ], "type": "string" }, "url": { "description": "Specifies the URL to redirect to.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "CheckoutSDKAction": { "additionalProperties": false, "properties": { "paymentData": { "description": "Encoded payment data.", "type": "string" }, "paymentMethodType": { "description": "Specifies the payment method.", "type": "string" }, "sdkData": { "additionalProperties": { "type": "string" }, "description": "The data to pass to the SDK.", "type": "object" }, "type": { "description": "The type of the action.", "enum": [ "sdk", "wechatpaySDK" ], "type": "string" }, "url": { "description": "Specifies the URL to redirect to.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "CheckoutThreeDS2Action": { "additionalProperties": false, "properties": { "authorisationToken": { "description": "A token needed to authorise a payment.", "type": "string" }, "paymentData": { "description": "Encoded payment data.", "type": "string" }, "paymentMethodType": { "description": "Specifies the payment method.", "type": "string" }, "subtype": { "description": "A subtype of the token.", "type": "string" }, "token": { "description": "A token to pass to the 3DS2 Component to get the fingerprint.", "type": "string" }, "type": { "description": "**threeDS2**", "enum": [ "threeDS2" ], "type": "string" }, "url": { "description": "Specifies the URL to redirect to.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "CheckoutVoucherAction": { "additionalProperties": false, "properties": { "alternativeReference": { "description": "The voucher alternative reference code.", "type": "string" }, "collectionInstitutionNumber": { "description": "A collection institution number (store number) for Econtext Pay-Easy ATM.", "type": "string" }, "downloadUrl": { "description": "The URL to download the voucher.", "type": "string" }, "entity": { "description": "An entity number of Multibanco.", "type": "string" }, "expiresAt": { "description": "The date time of the voucher expiry.", "type": "string" }, "initialAmount": { "description": "The initial amount.", "$ref": "#/$defs/Amount" }, "instructionsUrl": { "description": "The URL to the detailed instructions to make payment using the voucher.", "type": "string" }, "issuer": { "description": "The issuer of the voucher.", "type": "string" }, "maskedTelephoneNumber": { "description": "The shopper telephone number (partially masked).", "type": "string" }, "merchantName": { "description": "The merchant name.", "type": "string" }, "merchantReference": { "description": "The merchant reference.", "type": "string" }, "passCreationToken": { "x-addedInVersion": "68", "description": "A base64 encoded signature of all properties", "type": "string" }, "paymentData": { "description": "Encoded payment data.", "type": "string" }, "paymentMethodType": { "description": "Specifies the payment method.", "type": "string" }, "reference": { "description": "The voucher reference code.", "type": "string" }, "shopperEmail": { "description": "The shopper email.", "type": "string" }, "shopperName": { "description": "The shopper name.", "type": "string" }, "surcharge": { "description": "The surcharge amount.", "$ref": "#/$defs/Amount" }, "totalAmount": { "description": "The total amount (initial plus surcharge amount).", "$ref": "#/$defs/Amount" }, "type": { "description": "**voucher**", "enum": [ "voucher" ], "type": "string" }, "url": { "description": "Specifies the URL to redirect to.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "FraudCheckResult": { "properties": { "accountScore": { "description": "The fraud score generated by the risk check.", "format": "int32", "type": "integer" }, "checkId": { "description": "The ID of the risk check.", "format": "int32", "type": "integer" }, "name": { "description": "The name of the risk check.", "type": "string" } }, "required": [ "checkId", "name", "accountScore" ], "type": "object" }, "FraudResult": { "properties": { "accountScore": { "description": "The total fraud score generated by the risk checks.", "format": "int32", "type": "integer" }, "results": { "description": "The result of the individual risk checks.", "items": { "$ref": "#/$defs/FraudCheckResult" }, "type": "array" } }, "required": [ "accountScore" ], "type": "object" }, "PaymentResponse": { "properties": { "action": { "x-addedInVersion": "49", "description": "Action to be taken for completing the payment.", "oneOf": [ { "$ref": "#/$defs/CheckoutAwaitAction" }, { "$ref": "#/$defs/CheckoutDelegatedAuthenticationAction" }, { "$ref": "#/$defs/CheckoutNativeRedirectAction" }, { "$ref": "#/$defs/CheckoutQrCodeAction" }, { "$ref": "#/$defs/CheckoutRedirectAction" }, { "$ref": "#/$defs/CheckoutSDKAction" }, { "$ref": "#/$defs/CheckoutThreeDS2Action" }, { "$ref": "#/$defs/CheckoutVoucherAction" } ] }, "additionalData": { "additionalProperties": { "type": "string" }, "x-anyOf": [ { "$ref": "#/$defs/ResponseAdditionalData3DSecure" }, { "$ref": "#/$defs/ResponseAdditionalDataBillingAddress" }, { "$ref": "#/$defs/ResponseAdditionalDataCard" }, { "$ref": "#/$defs/ResponseAdditionalDataCommon" }, { "$ref": "#/$defs/ResponseAdditionalDataDomesticError" }, { "$ref": "#/$defs/ResponseAdditionalDataInstallments" }, { "$ref": "#/$defs/ResponseAdditionalDataNetworkTokens" }, { "$ref": "#/$defs/ResponseAdditionalDataOpi" }, { "$ref": "#/$defs/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": "#/$defs/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": "#/$defs/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": "#/$defs/CheckoutOrderResponse" }, "paymentMethod": { "x-addedInVersion": "69", "description": "Details about the payment method used in the transaction. \nOnly returned if `resultCode` is **Authorised**.", "$ref": "#/$defs/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": "#/$defs/ThreeDS2ResponseData" }, "threeDS2Result": { "x-addedInVersion": "41", "description": "Result of the 3D Secure 2 authentication.", "$ref": "#/$defs/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" }, "ResponseAdditionalData3DSecure": { "properties": { "cardHolderInfo": { "description": "Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. ", "type": "string" }, "cavv": { "description": "The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session, as a Base64-encoded 20-byte array.", "type": "string" }, "cavvAlgorithm": { "description": "The CAVV algorithm used.", "type": "string" }, "scaExemptionRequested": { "description": "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", "type": "string" }, "threeds2.cardEnrolled": { "description": "Indicates whether a card is enrolled for 3D Secure 2.", "type": "boolean" } }, "type": "object" }, "ResponseAdditionalDataBillingAddress": { "properties": { "billingAddress.city": { "description": "The billing address city passed in the payment request.", "type": "string" }, "billingAddress.country": { "description": "The billing address country passed in the payment request.\n\nExample: NL", "type": "string" }, "billingAddress.houseNumberOrName": { "description": "The billing address house number or name passed in the payment request.", "type": "string" }, "billingAddress.postalCode": { "description": "The billing address postal code passed in the payment request.\n\nExample: 1011 DJ", "type": "string" }, "billingAddress.stateOrProvince": { "description": "The billing address state or province passed in the payment request.\n\nExample: NH", "type": "string" }, "billingAddress.street": { "description": "The billing address street passed in the payment request.", "type": "string" } }, "type": "object" }, "ResponseAdditionalDataCard": { "properties": { "cardBin": { "description": "The first six digits of the card number.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with a six-digit BIN.\n\nExample: 521234", "type": "string" }, "cardHolderName": { "description": "The cardholder name passed in the payment request.", "type": "string" }, "cardIssuingBank": { "description": "The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available.", "type": "string" }, "cardIssuingCountry": { "description": "The country where the card was issued.\n\nExample: US", "type": "string" }, "cardIssuingCurrency": { "description": "The currency in which the card is issued, if this information is available. Provided as the currency code or currency number from the ISO-4217 standard. \n\nExample: USD", "type": "string" }, "cardPaymentMethod": { "description": "The card payment method used for the transaction.\n\nExample: amex", "type": "string" }, "cardSummary": { "description": "The last four digits of a card number.\n\n> Returned only in case of a card payment.", "type": "string" }, "issuerBin": { "description": "The first eight digits of the card number. Only returned if the card number is 16 digits or more.\n\nThis is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.\n\nExample: 52123423", "type": "string" } }, "type": "object" }, "ResponseAdditionalDataCommon": { "properties": { "acquirerAccountCode": { "description": "The name of the Adyen acquirer account.\n\nExample: PayPalSandbox_TestAcquirer\n\n> Only relevant for PayPal transactions.", "type": "string" }, "acquirerCode": { "description": "The name of the acquirer processing the payment request.\n\nExample: TestPmmAcquirer", "type": "string" }, "acquirerReference": { "description": "The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement.\n\nExample: 7C9N3FNBKT9", "type": "string" }, "alias": { "description": "The Adyen alias of the card.\n\nExample: H167852639363479", "type": "string" }, "aliasType": { "description": "The type of the card alias.\n\nExample: Default", "type": "string" }, "authCode": { "description": "Authorisation code:\n* When the payment is authorised successfully, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty.\n\nExample: 58747", "type": "string" }, "authorisationMid": { "description": "Merchant ID known by the acquirer.", "type": "string" }, "authorisedAmountCurrency": { "description": "The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).", "type": "string" }, "authorisedAmountValue": { "description": "Value of the amount authorised.\n\nThis amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).", "type": "string" }, "avsResult": { "description": "The AVS result code of the payment, which provides information about the outcome of the AVS check.\n\nFor possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).", "type": "string" }, "avsResultRaw": { "description": "Raw AVS result received from the acquirer, where available.\n\nExample: D", "type": "string" }, "bic": { "description": "BIC of a bank account.\n\nExample: TESTNL01\n\n> Only relevant for SEPA Direct Debit transactions.", "type": "string" }, "coBrandedWith": { "description": "Includes the co-branded card information.", "type": "string" }, "cvcResult": { "description": "The result of CVC verification.", "type": "string" }, "cvcResultRaw": { "description": "The raw result of CVC verification.", "type": "string" }, "dsTransID": { "description": "Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.", "type": "string" }, "eci": { "description": "The Electronic Commerce Indicator returned from the schemes for the 3DS payment session.\n\nExample: 02", "type": "string" }, "expiryDate": { "description": "The expiry date on the card.\n\nExample: 6/2016\n\n> Returned only in case of a card payment.", "type": "string" }, "extraCostsCurrency": { "description": "The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request.\n\nExample: EUR", "type": "string" }, "extraCostsValue": { "description": "The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.", "type": "string" }, "fraudCheck-[itemNr]-[FraudCheckname]": { "description": "The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.", "type": "string" }, "fraudManualReview": { "description": "Indicates if the payment is sent to manual review.", "type": "string" }, "fraudResultType": { "description": "The fraud result properties of the payment.", "enum": [ "GREEN", "FRAUD" ], "type": "string" }, "fundingSource": { "description": "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.", "type": "string" }, "fundsAvailability": { "description": "Indicates availability of funds.\n\nVisa:\n* \"I\" (fast funds are supported)\n* \"N\" (otherwise)\n\nMastercard:\n* \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list)\n* \"N\" (otherwise)\n\n> Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\".", "type": "string" }, "inferredRefusalReason": { "description": "Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\".\n\nPossible values:\n\n* 3D Secure Mandated\n* Closed Account\n* ContAuth Not Supported\n* CVC Mandated\n* Ecommerce Not Allowed\n* Crossborder Not Supported\n* Card Updated\n\n* Low Authrate Bin\n* Non-reloadable prepaid card", "type": "string" }, "isCardCommercial": { "description": "Indicates if the card is used for business purposes only.", "type": "string" }, "issuerCountry": { "description": "The issuing country of the card based on the BIN list that Adyen maintains.\n\nExample: JP", "type": "string" }, "liabilityShift": { "description": "A Boolean value indicating whether a liability shift was offered for this payment.", "type": "string" }, "mcBankNetReferenceNumber": { "description": "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.", "type": "string" }, "merchantAdviceCode": { "description": "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", "type": "string" }, "merchantReference": { "description": "The reference provided for the transaction.", "type": "string" }, "networkTxReference": { "description": "Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.\n\nThis contains either the Mastercard Trace ID or the Visa Transaction ID.", "type": "string" }, "ownerName": { "description": "The owner name of a bank account.\n\nOnly relevant for SEPA Direct Debit transactions.", "type": "string" }, "paymentAccountReference": { "description": "The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters.", "type": "string" }, "paymentMethod": { "description": "The payment method used in the transaction.", "type": "string" }, "paymentMethodVariant": { "description": "The Adyen sub-variant of the payment method used for the payment request.\n\nFor more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).\n\nExample: mcpro", "type": "string" }, "payoutEligible": { "description": "Indicates whether a payout is eligible or not for this card.\n\nVisa:\n* \"Y\"\n* \"N\"\n\nMastercard:\n* \"Y\" (domestic and cross-border)\n\n* \"D\" (only domestic)\n* \"N\" (no MoneySend)\n* \"U\" (unknown)", "type": "string" }, "realtimeAccountUpdaterStatus": { "description": "The response code from the Real Time Account Updater service.\n\nPossible return values are:\n* CardChanged\n* CardExpiryChanged\n* CloseAccount\n\n* ContactCardAccountHolder", "type": "string" }, "receiptFreeText": { "description": "Message to be displayed on the terminal.", "type": "string" }, "recurring.contractTypes": { "x-addedInVersion": "40", "description": "The recurring contract types applicable to the transaction.", "type": "string" }, "recurring.firstPspReference": { "description": "The `pspReference`, of the first recurring payment that created the recurring detail.\n\nThis functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.", "type": "string" }, "recurring.recurringDetailReference": { "description": "The reference that uniquely identifies the recurring transaction.", "type": "string" }, "recurring.shopperReference": { "x-addedInVersion": "40", "description": "The provided reference of the shopper for a recurring transaction.", "type": "string" }, "recurringProcessingModel": { "x-addedInVersion": "40", "description": "The processing model used for the recurring transaction.", "enum": [ "CardOnFile", "Subscription", "UnscheduledCardOnFile" ], "type": "string" }, "referred": { "description": "If the payment is referred, this field is set to true.\n\nThis field is unavailable if the payment is referred and is usually not returned with ecommerce transactions.\n\nExample: true", "type": "string" }, "refusalReasonRaw": { "description": "Raw refusal reason received from the acquirer, where available.\n\nExample: AUTHORISED", "type": "string" }, "requestAmount": { "description": "The amount of the payment request.", "type": "string" }, "requestCurrencyCode": { "description": "The currency of the payment request.", "type": "string" }, "shopperInteraction": { "description": "The shopper interaction type of the payment request.\n\nExample: Ecommerce", "type": "string" }, "shopperReference": { "description": "The shopperReference passed in the payment request.\n\nExample: AdyenTestShopperXX", "type": "string" }, "terminalId": { "description": "The terminal ID used in a point-of-sale payment.\n\nExample: 06022622", "type": "string" }, "threeDAuthenticated": { "description": "A Boolean value indicating whether 3DS authentication was completed on this payment.\n\nExample: true", "type": "string" }, "threeDAuthenticatedResponse": { "description": "The raw 3DS authentication result from the card issuer.\n\nExample: N", "type": "string" }, "threeDOffered": { "description": "A Boolean value indicating whether 3DS was offered for this payment.\n\nExample: true", "type": "string" }, "threeDOfferedResponse": { "description": "The raw enrollment result from the 3DS directory services of the card schemes.\n\nExample: Y", "type": "string" }, "threeDSVersion": { "description": "The 3D Secure 2 version.", "type": "string" }, "visaTransactionId": { "description": "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.", "type": "string" }, "xid": { "description": "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=", "type": "string" } }, "type": "object" }, "ResponseAdditionalDataDomesticError": { "properties": { "domesticRefusalReasonRaw": { "description": "The reason the transaction was declined, given by the local issuer. \nCurrently available for merchants in Japan.", "type": "string" }, "domesticShopperAdvice": { "description": "The action the shopper should take, in a local language. \nCurrently available in Japanese, for merchants in Japan.", "type": "string" } }, "type": "object" }, "ResponseAdditionalDataInstallments": { "properties": { "installmentPaymentData.installmentType": { "description": "Type of installment. The value of `installmentType` should be **IssuerFinanced**.", "type": "string" }, "installmentPaymentData.option[itemNr].annualPercentageRate": { "description": "Annual interest rate.", "type": "string" }, "installmentPaymentData.option[itemNr].firstInstallmentAmount": { "description": "First Installment Amount in minor units.", "type": "string" }, "installmentPaymentData.option[itemNr].installmentFee": { "description": "Installment fee amount in minor units.", "type": "string" }, "installmentPaymentData.option[itemNr].interestRate": { "description": "Interest rate for the installment period.", "type": "string" }, "installmentPaymentData.option[itemNr].maximumNumberOfInstallments": { "description": "Maximum number of installments possible for this payment.", "type": "string" }, "installmentPaymentData.option[itemNr].minimumNumberOfInstallments": { "description": "Minimum number of installments possible for this payment.", "type": "string" }, "installmentPaymentData.option[itemNr].numberOfInstallments": { "description": "Total number of installments possible for this payment.", "type": "string" }, "installmentPaymentData.option[itemNr].subsequentInstallmentAmount": { "description": "Subsequent Installment Amount in minor units.", "type": "string" }, "installmentPaymentData.option[itemNr].totalAmountDue": { "description": "Total amount in minor units.", "type": "string" }, "installmentPaymentData.paymentOptions": { "description": "Possible values:\n* PayInInstallmentsOnly\n* PayInFullOnly\n* PayInFullOrInstallments", "type": "string" }, "installments.value": { "description": "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.", "type": "string" } }, "type": "object" }, "ResponseAdditionalDataNetworkTokens": { "properties": { "networkToken.available": { "description": "Indicates whether a network token is available for the specified card.", "type": "string" }, "networkToken.bin": { "description": "The Bank Identification Number of a tokenized card, which is the first six digits of a card number.", "type": "string" }, "networkToken.tokenSummary": { "description": "The last four digits of a network token.", "type": "string" } }, "type": "object" }, "ResponseAdditionalDataOpi": { "properties": { "opi.transToken": { "description": "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", "type": "string" } }, "type": "object" }, "ResponseAdditionalDataSepa": { "properties": { "sepadirectdebit.dateOfSignature": { "description": "The transaction signature date.\n\nFormat: yyyy-MM-dd", "type": "string" }, "sepadirectdebit.mandateId": { "description": "Its value corresponds to the pspReference value of the transaction.", "type": "string" }, "sepadirectdebit.sequenceType": { "description": "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF", "type": "string" } }, "type": "object" }, "ResponsePaymentMethod": { "properties": { "brand": { "description": "The card brand that the shopper used to pay. Only returned if `paymentMethod.type` is **scheme**.", "type": "string" }, "type": { "description": "The `paymentMethod.type` value used in the request.", "type": "string" } }, "title": "paymentResponse", "type": "object" }, "ThreeDS2ResponseData": { "properties": { "acsChallengeMandated": { "type": "string" }, "acsOperatorID": { "type": "string" }, "acsReferenceNumber": { "type": "string" }, "acsSignedContent": { "type": "string" }, "acsTransID": { "type": "string" }, "acsURL": { "type": "string" }, "authenticationType": { "type": "string" }, "cardHolderInfo": { "type": "string" }, "cavvAlgorithm": { "type": "string" }, "challengeIndicator": { "type": "string" }, "dsReferenceNumber": { "type": "string" }, "dsTransID": { "type": "string" }, "exemptionIndicator": { "type": "string" }, "messageVersion": { "type": "string" }, "riskScore": { "type": "string" }, "sdkEphemPubKey": { "type": "string" }, "threeDSServerTransID": { "type": "string" }, "transStatus": { "type": "string" }, "transStatusReason": { "type": "string" } }, "type": "object" }, "ThreeDS2Result": { "properties": { "authenticationValue": { "description": "The `authenticationValue` value as defined in the 3D Secure 2 specification.", "type": "string" }, "cavvAlgorithm": { "x-addedInVersion": "50", "description": "The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.", "type": "string" }, "challengeCancel": { "x-addedInVersion": "67", "description": "Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).", "enum": [ "01", "02", "03", "04", "05", "06", "07" ], "type": "string" }, "dsTransID": { "description": "The `dsTransID` value as defined in the 3D Secure 2 specification.", "type": "string" }, "eci": { "description": "The `eci` value as defined in the 3D Secure 2 specification.", "type": "string" }, "exemptionIndicator": { "x-addedInVersion": "67", "description": "Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied.\nAllowed values:\n* `lowValue`\n* `secureCorporate`\n* `trustedBeneficiary`\n* `transactionRiskAnalysis`\n", "enum": [ "lowValue", "secureCorporate", "trustedBeneficiary", "transactionRiskAnalysis" ], "type": "string" }, "messageVersion": { "x-addedInVersion": "49", "description": "The `messageVersion` value as defined in the 3D Secure 2 specification.", "type": "string" }, "riskScore": { "x-addedInVersion": "67", "description": "Risk score calculated by Cartes Bancaires Directory Server (DS).", "type": "string" }, "threeDSRequestorChallengeInd": { "x-addedInVersion": "68", "description": "Indicates whether a challenge is requested for this transaction. Possible values:\n* **01** No preference\n* **02** No challenge requested\n* **03** Challenge requested (3DS Requestor preference)\n* **04** Challenge requested (Mandate)\n* **05** No challenge (transactional risk analysis is already performed)\n* **06** Data Only", "enum": [ "01", "02", "03", "04", "05", "06" ], "type": "string" }, "threeDSServerTransID": { "description": "The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.", "type": "string" }, "timestamp": { "description": "The `timestamp` value of the 3D Secure 2 authentication.", "type": "string" }, "transStatus": { "description": "The `transStatus` value as defined in the 3D Secure 2 specification.", "type": "string" }, "transStatusReason": { "description": "Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).", "type": "string" }, "whiteListStatus": { "x-addedInVersion": "49", "description": "The `whiteListStatus` value as defined in the 3D Secure 2 specification.", "type": "string" } }, "type": "object" } } }