diff --git a/yaml/AccountService-v3.yaml b/yaml/AccountService-v3.yaml index cf4f463..4d370d5 100644 --- a/yaml/AccountService-v3.yaml +++ b/yaml/AccountService-v3.yaml @@ -2144,6 +2144,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -3011,7 +3012,9 @@ components: schedule: description: 'The payout schedule to which the account is to be updated. - Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. + Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, + `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`. `HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.' @@ -3159,6 +3162,9 @@ components: type: array idNumber: deprecated: true + x-deprecatedInVersion: '3' + x-deprecatedMessage: Use `individualDetails.personalData.documentData.number` + instead. description: An ID number of the person. type: string nationality: diff --git a/yaml/AccountService-v4.yaml b/yaml/AccountService-v4.yaml index e1313f5..120e848 100644 --- a/yaml/AccountService-v4.yaml +++ b/yaml/AccountService-v4.yaml @@ -2178,6 +2178,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -3092,7 +3093,9 @@ components: schedule: description: 'The payout schedule to which the account is to be updated. - Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. + Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, + `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`. `HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.' @@ -3240,6 +3243,9 @@ components: type: array idNumber: deprecated: true + x-deprecatedInVersion: '3' + x-deprecatedMessage: Use `individualDetails.personalData.documentData.number` + instead. description: An ID number of the person. type: string nationality: diff --git a/yaml/AccountService-v5.yaml b/yaml/AccountService-v5.yaml index f7186cd..12388d5 100644 --- a/yaml/AccountService-v5.yaml +++ b/yaml/AccountService-v5.yaml @@ -2528,6 +2528,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -2932,16 +2933,28 @@ components: PayoutMethod: properties: merchantAccount: + description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) + you used in the `/payments` request when you [saved the account holder's + card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string payoutMethodCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + payout method, returned in the response when you create a payout method. + Required when updating an existing payout method in an `/updateAccountHolder` + request. type: string - payoutMethodType: - enum: - - CardToken + payoutMethodReference: + description: Your reference for the payout method. type: string recurringDetailReference: + description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned + in the `/payments` response when you [saved the account holder's card + details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string shopperReference: + description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) + you sent in the `/payments` request when you [saved the account holder's + card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string required: - merchantAccount @@ -3634,7 +3647,9 @@ components: schedule: description: 'The payout schedule to which the account is to be updated. - Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. + Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, + `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`. `HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.' diff --git a/yaml/AccountService-v6.yaml b/yaml/AccountService-v6.yaml index a8b5a59..f169a37 100644 --- a/yaml/AccountService-v6.yaml +++ b/yaml/AccountService-v6.yaml @@ -2570,6 +2570,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -3192,16 +3193,28 @@ components: PayoutMethod: properties: merchantAccount: + description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) + you used in the `/payments` request when you [saved the account holder's + card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string payoutMethodCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + payout method, returned in the response when you create a payout method. + Required when updating an existing payout method in an `/updateAccountHolder` + request. type: string - payoutMethodType: - enum: - - CardToken + payoutMethodReference: + description: Your reference for the payout method. type: string recurringDetailReference: + description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned + in the `/payments` response when you [saved the account holder's card + details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string shopperReference: + description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) + you sent in the `/payments` request when you [saved the account holder's + card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string required: - merchantAccount @@ -3906,7 +3919,9 @@ components: schedule: description: 'The payout schedule to which the account is to be updated. - Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. + Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, + `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, + `MONTHLY`, `HOLD`. `HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.' diff --git a/yaml/BalancePlatformNotificationService-v1.yaml b/yaml/BalancePlatformNotificationService-v1.yaml index dbca1fe..f90d07d 100644 --- a/yaml/BalancePlatformNotificationService-v1.yaml +++ b/yaml/BalancePlatformNotificationService-v1.yaml @@ -339,9 +339,12 @@ webhooks: tags: - Reports summary: A report was generated. - description: Adyen sends this webhook after a report was generated and is ready + description: 'Adyen sends this webhook after a report was generated and is ready to be downloaded. The webhook contains a URL at which the report can be downloaded. - To download, you must authenticate your GET request with your [API credentials](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/overview). + + + Before you can download reports, ask your Adyen contact for your report credentials. + You must use your report credentials to authenticate your GET request.' operationId: post-alancePlatform.report.created x-groupName: Reports x-sortIndex: 6 @@ -423,7 +426,6 @@ components: \ containing the sweep configuration.\n\n" type: object required: - - contactDetails - id AccountHolderNotificationData: properties: @@ -676,7 +678,11 @@ components: Card: properties: authentication: - description: Authentication details for 3D Secure and wallet activation. + description: Contains the card user's password and mobile phone number. + This is required when you issue cards that can be used to make online + payments within the EEA and the UK, or can be added to digital wallets. + Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) + for more information. $ref: '#/components/schemas/Authentication' bin: description: The BIN of the card number. @@ -1030,8 +1036,11 @@ components: example, **ecommerce** for online or **pos** for point-of-sale payments. type: string purposeCode: - description: Indicates the purpose of the transaction. Adyen sets this to - **payout** when transferring funds out of the balance platform. + description: "Indicates the purpose of the outgoing transfer. Adyen sets\ + \ this to:\n\n* **payoutManual** when the transfer was triggered by a\ + \ one-off payout using the [`/transfers`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers)\ + \ endpoint.\n\n * **payoutSweep** when the transfer was triggered by a\ + \ scheduled payout using [`sweepConfigurations`](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_sweepConfigurations)." type: string reference: description: The reference for the transfer. @@ -1651,8 +1660,11 @@ components: example, **ecommerce** for online or **pos** for point-of-sale payments. type: string purposeCode: - description: Indicates the purpose of the transaction. Adyen sets this to - **payout** when transferring funds out of the balance platform. + description: "Indicates the purpose of the outgoing transfer. Adyen sets\ + \ this to:\n\n* **payoutManual** when the transfer was triggered by a\ + \ one-off payout using the [`/transfers`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers)\ + \ endpoint.\n\n * **payoutSweep** when the transfer was triggered by a\ + \ scheduled payout using [`sweepConfigurations`](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_sweepConfigurations)." type: string reference: description: The reference for the transfer. diff --git a/yaml/BalancePlatformService-v1.yaml b/yaml/BalancePlatformService-v1.yaml index b060d1e..1add6e6 100644 --- a/yaml/BalancePlatformService-v1.yaml +++ b/yaml/BalancePlatformService-v1.yaml @@ -2543,7 +2543,6 @@ components: \ containing the sweep configuration.\n\n" type: object required: - - contactDetails - id AccountHolderInfo: properties: @@ -2584,8 +2583,7 @@ components: \ and in uppercase. For example, **EUR**. The value must be an object\ \ containing the sweep configuration.\n\n" type: object - required: - - contactDetails + required: [] Address: properties: city: @@ -2915,7 +2913,11 @@ components: Card: properties: authentication: - description: Authentication details for 3D Secure and wallet activation. + description: Contains the card user's password and mobile phone number. + This is required when you issue cards that can be used to make online + payments within the EEA and the UK, or can be added to digital wallets. + Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) + for more information. $ref: '#/components/schemas/Authentication' bin: description: The BIN of the card number. @@ -3002,7 +3004,11 @@ components: CardInfo: properties: authentication: - description: Authentication details for 3D Secure and wallet activation. + description: Contains the card user's password and mobile phone number. + This is required when you issue cards that can be used to make online + payments within the EEA and the UK, or can be added to digital wallets. + Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) + for more information. $ref: '#/components/schemas/Authentication' brand: description: 'The brand for the payment instrument. @@ -3427,7 +3433,7 @@ components: type: description: 'The type of organization. Possible values: **associationIncorporated**, **governmentalOrganization**, **listedPublicCompany**,**nonProfit**, **partnershipIncorporated**, - **privateCompany**, **unlistedPublicCompany**, **soleProprietorship**.' + **privateCompany**.' enum: - associationIncorporated - governmentalOrganization @@ -3435,8 +3441,6 @@ components: - nonProfit - partnershipIncorporated - privateCompany - - unlistedPublicCompany - - soleProprietorship type: string webData: deprecated: true @@ -3889,6 +3893,36 @@ components: - title - detail - status + ServiceError: + properties: + errorCode: + description: The error code mapped to the error message. + type: string + errorType: + description: The category of the error. + type: string + message: + description: A short explanation of the issue. + type: string + pspReference: + description: The PSP reference of the payment. + type: string + status: + description: The HTTP response status. + format: int32 + type: integer + StockData: + properties: + marketIdentifier: + description: The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) + of the stock market where the organization's stocks are traded. + type: string + stockNumber: + description: The stock number. + type: string + tickerSymbol: + description: The stock ticker symbol. + type: string SweepConfiguration: properties: balanceAccountId: diff --git a/yaml/BinLookupService-v40.yaml b/yaml/BinLookupService-v40.yaml index 279836e..78bdda0 100644 --- a/yaml/BinLookupService-v40.yaml +++ b/yaml/BinLookupService-v40.yaml @@ -372,10 +372,10 @@ components: - POS type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string required: - amount diff --git a/yaml/BinLookupService-v50.yaml b/yaml/BinLookupService-v50.yaml index 22a6df0..002f117 100644 --- a/yaml/BinLookupService-v50.yaml +++ b/yaml/BinLookupService-v50.yaml @@ -377,10 +377,10 @@ components: - POS type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string required: - amount diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index f92aa2e..67d6cbc 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -2994,6 +2994,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3456,6 +3461,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3640,6 +3646,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -3933,10 +3940,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4466,8 +4473,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -4973,7 +4983,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -5701,9 +5711,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -5864,10 +5882,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string store: x-addedInVersion: '23' @@ -6139,8 +6157,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -6331,10 +6349,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -6860,10 +6878,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -6928,7 +6946,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9740,7 +9758,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 7812428..f4dc5f8 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -3176,6 +3176,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3638,6 +3643,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3868,6 +3874,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4180,10 +4187,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4719,8 +4726,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5275,7 +5285,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6084,9 +6094,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6247,10 +6265,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string store: x-addedInVersion: '23' @@ -6541,8 +6559,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -6742,10 +6760,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7289,10 +7307,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7357,7 +7375,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -10312,7 +10330,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index 47aaf64..b9b882d 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -3186,6 +3186,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3648,6 +3653,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3878,6 +3884,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4190,10 +4197,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4729,8 +4736,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5285,7 +5295,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6098,9 +6108,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6261,10 +6279,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string store: x-addedInVersion: '23' @@ -6555,8 +6573,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -6756,10 +6774,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7307,10 +7325,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7375,7 +7393,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -8743,8 +8761,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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 ThreeDSecureData: properties: @@ -10356,7 +10374,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 0527b7e..232b5c3 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -3186,6 +3186,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3648,6 +3653,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3878,6 +3884,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4190,10 +4197,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4729,8 +4736,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5285,7 +5295,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6098,9 +6108,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6261,10 +6279,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string store: x-addedInVersion: '23' @@ -6555,8 +6573,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -6756,10 +6774,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7307,10 +7325,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7375,7 +7393,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -8751,8 +8769,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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 ThreeDSecureData: properties: @@ -10364,7 +10382,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index b87b2ae..c14b45a 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -3194,6 +3194,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3680,6 +3685,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3926,6 +3932,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4258,10 +4265,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5084,8 +5091,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5680,7 +5690,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6531,9 +6541,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6700,10 +6718,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string store: x-addedInVersion: '23' @@ -7005,8 +7023,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7206,10 +7224,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7792,10 +7810,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7865,7 +7883,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9354,8 +9372,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -10995,7 +11013,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index 3b3e783..8669380 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -3215,6 +3215,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3701,6 +3706,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3947,6 +3953,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4279,10 +4286,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5111,8 +5118,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5713,7 +5723,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6564,9 +6574,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6738,10 +6756,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string store: x-addedInVersion: '23' @@ -7043,8 +7061,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7244,10 +7262,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7836,10 +7854,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7915,7 +7933,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9399,7 +9417,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -9422,8 +9440,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -11063,7 +11081,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index 636843f..19dc213 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -3217,6 +3217,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3703,6 +3708,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3949,6 +3955,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4287,10 +4294,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5119,8 +5126,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5721,7 +5731,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6577,9 +6587,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6758,10 +6776,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string store: x-addedInVersion: '23' @@ -7069,8 +7087,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7270,10 +7288,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7868,10 +7886,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7947,7 +7965,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9431,7 +9449,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -9454,8 +9472,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -11095,7 +11113,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index eb95e8b..1362669 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -3217,6 +3217,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3703,6 +3708,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3949,6 +3955,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4287,10 +4294,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5119,8 +5126,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5721,7 +5731,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6581,9 +6591,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6762,10 +6780,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string store: x-addedInVersion: '23' @@ -7073,8 +7091,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7274,10 +7292,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7876,10 +7894,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7955,7 +7973,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9439,7 +9457,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -9462,8 +9480,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -11103,7 +11121,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index 3884fb5..78c340f 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -3217,6 +3217,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3703,6 +3708,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3949,6 +3955,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4287,10 +4294,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5119,8 +5126,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5721,7 +5731,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6581,9 +6591,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6768,10 +6786,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string splitCardFundingSources: x-addedInVersion: '53' @@ -7085,8 +7103,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7286,10 +7304,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7888,10 +7906,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7967,7 +7985,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9457,7 +9475,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -9480,8 +9498,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -11121,7 +11139,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 36878d0..f7272b0 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -3217,6 +3217,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3703,6 +3708,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3949,6 +3955,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4287,10 +4294,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5119,8 +5126,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5768,7 +5778,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6642,9 +6652,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6834,10 +6852,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string splitCardFundingSources: x-addedInVersion: '53' @@ -7151,8 +7169,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7352,10 +7370,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7968,10 +7986,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -8047,7 +8065,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9537,7 +9555,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -9560,8 +9578,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -11201,7 +11219,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 45cd2de..d5bf2cb 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -3217,6 +3217,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3715,6 +3720,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3961,6 +3967,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4293,10 +4300,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5134,8 +5141,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5783,7 +5793,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6661,9 +6671,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6834,10 +6852,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string splitCardFundingSources: x-addedInVersion: '53' @@ -7135,8 +7153,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7336,10 +7354,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7946,10 +7964,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -8025,7 +8043,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9526,7 +9544,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -9549,8 +9567,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -11192,7 +11210,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index a384f72..260eafd 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -3217,6 +3217,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3715,6 +3720,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -3961,6 +3967,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4293,10 +4300,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5134,8 +5141,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5783,7 +5793,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6665,9 +6675,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -6838,10 +6856,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string splitCardFundingSources: x-addedInVersion: '53' @@ -7139,8 +7157,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7340,10 +7358,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7954,10 +7972,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -8033,7 +8051,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -9534,7 +9552,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -9557,8 +9575,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -11200,7 +11218,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index 99365c2..33b7692 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -181,7 +181,7 @@ paths: x-addedInVersion: '67' operationId: post-donations x-groupName: Payments - x-sortIndex: 4 + x-sortIndex: 5 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -803,7 +803,7 @@ paths: it once a week.' operationId: post-paymentMethods x-groupName: Payments - x-sortIndex: 1 + x-sortIndex: 2 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1087,7 +1087,7 @@ paths: \ For a redirect or additional action, the response contains an `action` object. " operationId: post-payments x-groupName: Payments - x-sortIndex: 2 + x-sortIndex: 3 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -1230,7 +1230,7 @@ paths: ' operationId: post-payments-details x-groupName: Payments - x-sortIndex: 3 + x-sortIndex: 4 security: - BasicAuth: [] - ApiKeyAuth: [] @@ -3306,6 +3306,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3804,6 +3809,7 @@ components: - billdesk_online - billdesk_wallet - onlinebanking_IN + - wallet_IN type: string required: - type @@ -4050,6 +4056,7 @@ components: - kcp_naverpay - upi - onlinebanking_IN + - wallet_IN - entercash - primeiropay_boleto - gopay_wallet @@ -4155,9 +4162,12 @@ components: x-addedInVersion: '4' description: 'The address where to send the invoice. - > For 3D Secure 2 transactions, schemes require `billingAddress` for all - browser-based and mobile implementations. Include all of the fields within - this object.' + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -4382,10 +4392,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5221,8 +5231,11 @@ components: Seller Protection program. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters.' + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' type: string splits: description: An array of objects specifying how the payment should be split @@ -5240,6 +5253,10 @@ components: provided, the payment details will be stored. From api version 68 use `storePaymentMethodMode` instead. type: boolean + themeId: + x-addedInVersion: '67' + description: Use to set a theme to shopper other than default + type: string required: - amount - reference @@ -5919,7 +5936,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -6672,9 +6689,12 @@ components: x-addedInVersion: '4' description: 'The address where to send the invoice. - > For 3D Secure 2 transactions, schemes require `billingAddress` for all - browser-based and mobile implementations. Include all of the fields within - this object.' + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -6862,8 +6882,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7063,10 +7083,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -7267,9 +7287,17 @@ components: $ref: '#/components/schemas/Split' type: array status: - description: "Status of the payment link. Possible values:\n* **active**\ - \ \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and\ - \ below)" + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' enum: - active - completed @@ -7284,6 +7312,13 @@ components: description: When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. type: boolean + themeId: + x-addedInVersion: '67' + description: A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/api#themes) + to customize the appearance of the payment page.If not specified, the + payment page is rendered according to the theme set as default in your + Customer Area. + type: string url: description: The URL at which the shopper can complete the payment. readOnly: true @@ -7440,10 +7475,10 @@ components: the language to be used in the payment. type: string shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string splitCardFundingSources: x-addedInVersion: '53' @@ -7561,9 +7596,12 @@ components: x-addedInVersion: '4' description: 'The address where to send the invoice. - > For 3D Secure 2 transactions, schemes require `billingAddress` for all - browser-based and mobile implementations. Include all of the fields within - this object.' + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -7741,8 +7779,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' order: description: Contains the order information which is required for partial @@ -7942,10 +7980,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -8224,9 +8262,12 @@ components: x-addedInVersion: '4' description: 'The address where to send the invoice. - > For 3D Secure 2 transactions, schemes require `billingAddress` for all - browser-based and mobile implementations. Include all of the fields within - this object.' + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: x-addedInVersion: '33' @@ -8524,10 +8565,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -8603,7 +8644,7 @@ components: payload: description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. - maxLength: 10000 + maxLength: 40000 type: string required: - payload @@ -10152,15 +10193,43 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string challengeCancel: x-addedInVersion: '67' - description: Indicator informing the ACS and the DS that the authentication - has been canceled. + 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 challengeIndicator: x-addedInVersion: '67' + description: 'Specifies a preference for receiving a challenge from the + issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -10170,6 +10239,25 @@ components: type: string exemptionIndicator: x-addedInVersion: '67' + description: 'Indicates the exemption type that was applied by the issuer + to the authentication, if exemption applied. + + Allowed values: + + * `lowValue` + + * `secureCorporate` + + * `trustedBeneficiary` + + * `transactionRiskAnalysis` + + ' + enum: + - lowValue + - secureCorporate + - trustedBeneficiary + - transactionRiskAnalysis type: string messageVersion: x-addedInVersion: '49' @@ -10177,6 +10265,8 @@ components: type: string riskScore: x-addedInVersion: '67' + description: Risk score calculated by Cartes Bancaires Directory Server + (DS). type: string threeDSServerTransID: description: The `threeDSServerTransID` value as defined in the 3D Secure @@ -10189,8 +10279,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -10221,6 +10311,17 @@ components: 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 directoryResponse: description: 'In 3D Secure 1, this is the enrollment response from the 3D @@ -10248,6 +10349,8 @@ components: type: string riskScore: x-addedInVersion: '67' + description: Risk score calculated by Directory Server (DS). Required for + Cartes Bancaires integrations. type: string threeDSVersion: x-addedInVersion: '40' @@ -10255,6 +10358,8 @@ components: type: string transStatusReason: x-addedInVersion: '67' + 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 xid: description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, @@ -11891,7 +11996,7 @@ components: type: onebip - name: One Two Three type: onetwothree - - name: Local Polish Payment Methods (P24) + - name: Online Banking PL type: onlineBanking_PL - details: - items: diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml new file mode 100644 index 0000000..d32f6be --- /dev/null +++ b/yaml/CheckoutService-v68.yaml @@ -0,0 +1,14648 @@ +openapi: 3.1.0 +servers: +- url: https://checkout-test.adyen.com/v68 +info: + version: '68' + x-publicVersion: true + title: Adyen Checkout API + description: 'Adyen Checkout API provides a simple and flexible way to initiate + and authorise online payments. You can use the same integration for payments made + with cards (including 3D Secure), mobile wallets, and local payment methods (for + example, iDEAL and Sofort). + + + This API reference provides information on available endpoints and how to interact + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). + + + ## Authentication + + Each request to the Checkout API must be signed with an API key. For this, obtain + an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: + + + ``` + + curl + + -H "Content-Type: application/json" \ + + -H "X-API-Key: Your_Checkout_API_key" \ + + ... + + ``` + + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Checkout API supports versioning of its endpoints through a version suffix in + the endpoint URL. This suffix has the following format: "vXX", where XX is the + version number. + + + For example: + + ``` + + https://checkout-test.adyen.com/v68/payments + + ```' + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- Payments +- Payment links +- Modifications +- Orders +- Classic Checkout SDK +- Utility +paths: + /cancels: + post: + tags: + - Modifications + summary: Cancels an authorised payment. + description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), + and returns a unique reference for this request. You get the outcome of the + request asynchronously, in a [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-cancels + x-groupName: Modifications + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateStandalonePaymentCancelRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /donations: + post: + tags: + - Payments + summary: Starts a transaction for donation. + description: 'Takes in the donation token generated by the `/payments` request + and uses it to make the donation for the donation account specified in the + request. + + + For more information, see [Donations](https://docs.adyen.com/online-payments/donations).' + x-addedInVersion: '67' + operationId: post-donations + x-groupName: Payments + x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + donations: + $ref: '#/components/examples/post-donations-donations' + donations-with-token: + $ref: '#/components/examples/post-donations-donations-with-token' + schema: + $ref: '#/components/schemas/PaymentDonationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + donations: + $ref: '#/components/examples/post-donations-donations-200' + schema: + $ref: '#/components/schemas/DonationResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /orders: + post: + tags: + - Orders + summary: Creates an order for the given amount. + description: Creates an order to be used for partial payments. Make a POST `/orders` + call before making a `/payments` call when processing payments with different + payment methods. + operationId: post-orders + x-groupName: Orders + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-orders-basic' + schema: + $ref: '#/components/schemas/CheckoutCreateOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-orders-basic-200' + schema: + $ref: '#/components/schemas/CheckoutCreateOrderResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /orders/cancel: + post: + tags: + - Orders + summary: Cancels the given order. + description: Cancels an order. Cancellation of an order results in an automatic + rollback of all payments made in the order, either by canceling or refunding + the payment, depending on the type of payment method. + operationId: post-orders-cancel + x-groupName: Orders + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-orders-cancel-basic' + schema: + $ref: '#/components/schemas/CheckoutCancelOrderRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-orders-cancel-basic-200' + schema: + $ref: '#/components/schemas/CheckoutCancelOrderResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /originKeys: + post: + tags: + - Utility + summary: Create originKey values for one or more merchant domains. + description: "This operation takes the origin domains and returns a JSON object\ + \ containing the corresponding origin keys for the domains. \n> If you're\ + \ still using origin key for your Web Drop-in or Components integration, we\ + \ recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key).\ + \ This allows you to use a single key for all origins, add or remove origins\ + \ without generating a new key, and detect the card type from the number entered\ + \ in your payment form. " + deprecated: true + x-deprecatedInVersion: '67' + operationId: post-originKeys + x-groupName: Utility + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-originKeys-basic' + schema: + $ref: '#/components/schemas/CheckoutUtilityRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-originKeys-basic-200' + schema: + $ref: '#/components/schemas/CheckoutUtilityResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /paymentLinks: + post: + tags: + - Payment links + summary: Creates a payment link. + description: 'Creates a payment link to our hosted payment form where shoppers + can pay. The list of payment methods presented to the shopper depends on the + `currency` and `country` parameters sent in the request. + + + For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).' + operationId: post-paymentLinks + x-groupName: Payment links + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-paymentLinks-basic' + schema: + $ref: '#/components/schemas/CreatePaymentLinkRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-paymentLinks-basic-200' + schema: + $ref: '#/components/schemas/PaymentLinkResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentLinkResource' + description: Created - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /paymentLinks/{linkId}: + get: + tags: + - Payment links + summary: Retrieve a payment link. + description: Retrieves the payment link details using the payment link `id`. + operationId: get-paymentLinks-linkId + x-groupName: Payment links + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - description: Unique identifier of the payment link. + name: linkId + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + basic: + $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' + schema: + $ref: '#/components/schemas/PaymentLinkResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + patch: + tags: + - Payment links + summary: Update the status of a payment link + description: Updates the status of a payment link. Use this endpoint to [force + the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status). + operationId: patch-paymentLinks-linkId + x-groupName: Payment links + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic' + schema: + $ref: '#/components/schemas/UpdatePaymentLinkRequest' + parameters: + - description: Unique identifier of the payment link. + name: linkId + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + basic: + $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' + schema: + $ref: '#/components/schemas/PaymentLinkResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /paymentMethods: + post: + tags: + - Payments + summary: Returns available payment methods. + description: 'Queries the available payment methods for a transaction based + on the transaction context (like amount, country, and currency). Besides giving + back a list of the available payment methods, the response also returns which + input details you need to collect from the shopper (to be submitted to `/payments`). + + + Although we highly recommend using this endpoint to ensure you are always + offering the most up-to-date list of payment methods, its usage is optional. + You can, for example, also cache the `/paymentMethods` response and update + it once a week.' + operationId: post-paymentMethods + x-groupName: Payments + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick' + schema: + $ref: '#/components/schemas/PaymentMethodsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-paymentMethods-basic-200' + filtered: + $ref: '#/components/examples/post-paymentMethods-filtered-200' + include-oneclick: + $ref: '#/components/examples/post-paymentMethods-include-oneclick-200' + schema: + $ref: '#/components/schemas/PaymentMethodsResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /paymentMethods/balance: + post: + tags: + - Orders + summary: Returns the available balance on gift card. + description: Retrieves the balance remaining on a shopper's gift card. To check + a gift card's balance, make a POST `/paymentMethods/balance` call and include + the gift card's details inside a `paymentMethod` object. + operationId: post-paymentMethods-balance + x-groupName: Orders + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-paymentMethods-balance-basic' + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix' + schema: + $ref: '#/components/schemas/CheckoutBalanceCheckRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + plastix: + $ref: '#/components/examples/post-paymentMethods-balance-plastix-200' + schema: + $ref: '#/components/schemas/CheckoutBalanceCheckResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /paymentSession: + post: + tags: + - Classic Checkout SDK + summary: Creates a payment session. + description: 'Provides the data object that can be used to start the Checkout + SDK. To set up the payment, pass its amount, currency, and other required + parameters. We use this to optimise the payment flow and perform better risk + assessment of the transaction. + + + For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + operationId: post-paymentSession + x-groupName: Classic Checkout SDK + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + android: + $ref: '#/components/examples/post-paymentSession-android' + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick' + ios: + $ref: '#/components/examples/post-paymentSession-ios' + split: + $ref: '#/components/examples/post-paymentSession-split' + web: + $ref: '#/components/examples/post-paymentSession-web' + schema: + $ref: '#/components/schemas/PaymentSetupRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + enableOneClick: + $ref: '#/components/examples/post-paymentSession-enableOneClick-200' + web: + $ref: '#/components/examples/post-paymentSession-web-200' + schema: + $ref: '#/components/schemas/PaymentSetupResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments: + post: + tags: + - Payments + summary: Starts a transaction. + description: "Sends payment parameters (like amount, country, and currency)\ + \ together with other required input details collected from the shopper. To\ + \ know more about required parameters for specific payment methods, refer\ + \ to our [payment method guides](https://docs.adyen.com/payment-methods).\ + \ \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n\ + * For a direct flow, the response includes a `pspReference` and a `resultCode`\ + \ with the payment result, for example **Authorised** or **Refused**. \n*\ + \ For a redirect or additional action, the response contains an `action` object. " + operationId: post-payments + x-groupName: Payments + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + applepay: + $ref: '#/components/examples/post-payments-applepay' + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields' + card-direct: + $ref: '#/components/examples/post-payments-card-direct' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw' + giropay: + $ref: '#/components/examples/post-payments-giropay' + googlepay: + $ref: '#/components/examples/post-payments-googlepay' + ideal: + $ref: '#/components/examples/post-payments-ideal' + klarna: + $ref: '#/components/examples/post-payments-klarna' + oneclick-direct: + $ref: '#/components/examples/post-payments-oneclick-direct' + oneclick-securedfields: + $ref: '#/components/examples/post-payments-oneclick-securedfields' + recurring: + $ref: '#/components/examples/post-payments-recurring' + sofort: + $ref: '#/components/examples/post-payments-sofort' + split: + $ref: '#/components/examples/post-payments-split' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction' + schema: + $ref: '#/components/schemas/PaymentRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + examples: + card-3d-secure-2-web: + $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' + card-3d-secure-direct: + $ref: '#/components/examples/post-payments-card-3d-secure-direct-200' + card-3d-secure-securedfields: + $ref: '#/components/examples/post-payments-card-3d-secure-securedfields-200' + card-direct: + $ref: '#/components/examples/post-payments-card-direct-200' + card-securedfields: + $ref: '#/components/examples/post-payments-card-securedfields-200' + enableOneClick-SF: + $ref: '#/components/examples/post-payments-enableOneClick-SF-200' + enableOneClick-raw: + $ref: '#/components/examples/post-payments-enableOneClick-raw-200' + giropay: + $ref: '#/components/examples/post-payments-giropay-200' + ideal: + $ref: '#/components/examples/post-payments-ideal-200' + sofort: + $ref: '#/components/examples/post-payments-sofort-200' + subscription-first-transaction: + $ref: '#/components/examples/post-payments-subscription-first-transaction-200' + schema: + $ref: '#/components/schemas/PaymentResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/details: + post: + tags: + - Payments + summary: Submits details for a payment. + description: 'Submits details for a payment created using `/payments`. This + step is only needed when no final state has been reached on the `/payments` + request, for example when the shopper was redirected to another page to complete + the payment. + + + ' + operationId: post-payments-details + x-groupName: Payments + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + 3d-secure-2-native: + $ref: '#/components/examples/post-payments-details-3d-secure-2-native' + redirect: + $ref: '#/components/examples/post-payments-details-redirect' + schema: + $ref: '#/components/schemas/DetailsRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentDetailsResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/result: + post: + tags: + - Classic Checkout SDK + summary: Verifies payment result. + description: 'Verifies the payment result using the payload returned from the + Checkout SDK. + + + For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' + operationId: post-payments-result + x-groupName: Classic Checkout SDK + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + basic: + $ref: '#/components/examples/post-payments-result-basic' + schema: + $ref: '#/components/schemas/PaymentVerificationRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentVerificationResponse' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/amountUpdates: + post: + tags: + - Modifications + summary: Increases or decreases the authorised amount. + description: 'Increases or decreases the authorised payment amount and returns + a unique reference for this request. You get the outcome of the request asynchronously, + in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). + + + You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures). + + + The amount you specify in the request is the updated amount, which is larger + or smaller than the initial authorised amount. + + + For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).' + operationId: post-payments-paymentPspReference-amountUpdates + x-groupName: Modifications + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentAmountUpdateRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentAmountUpdateResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/cancels: + post: + tags: + - Modifications + summary: Cancels an authorised payment. + description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), + and returns a unique reference for this request. You get the outcome of the + request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). + + + If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), + use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) + endpoint instead. + + + If you want to cancel a payment but are not sure whether it has been captured, + use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) + endpoint instead. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).' + operationId: post-payments-paymentPspReference-cancels + x-groupName: Modifications + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCancelRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to cancel. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCancelResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/captures: + post: + tags: + - Modifications + summary: Captures an authorised payment. + description: " Captures an authorised payment and returns a unique reference\ + \ for this request. You get the outcome of the request asynchronously, in\ + \ a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\ + \nYou can capture either the full authorised amount or a part of the authorised\ + \ amount. By default, any unclaimed amount after a partial capture gets cancelled.\ + \ This does not apply if you enabled multiple partial captures on your account\ + \ and the payment method supports multiple partial captures. \n\n[Automatic\ + \ capture](https://docs.adyen.com/online-payments/capture#automatic-capture)\ + \ is the default setting for most payment methods. In these cases, you don't\ + \ need to make capture requests. However, making capture requests for payments\ + \ that are captured automatically does not result in double charges.\n\nFor\ + \ more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)." + operationId: post-payments-paymentPspReference-captures + x-groupName: Modifications + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentCaptureRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to capture. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentCaptureResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/refunds: + post: + tags: + - Modifications + summary: Refunds a captured payment. + description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),\ + \ and returns a unique reference for this request. You get the outcome of\ + \ the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\ + \nYou can refund either the full captured amount or a part of the captured\ + \ amount. You can also perform multiple partial refunds, as long as their\ + \ sum doesn't exceed the captured amount.\n\n> Some payment methods do not\ + \ support partial refunds. To learn if a payment method supports partial refunds,\ + \ refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards),\ + \ [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna).\ + \ \n\nIf you want to refund a payment but are not sure whether it has been\ + \ captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals)\ + \ endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)." + operationId: post-payments-paymentPspReference-refunds + x-groupName: Modifications + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentRefundRequest' + parameters: + - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to refund. + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentRefundResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payments/{paymentPspReference}/reversals: + post: + tags: + - Modifications + summary: Cancels or refunds a payment. + description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) + a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) + a payment if it has not yet been captured. Returns a unique reference for + this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** + webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook). + + + The reversed amount is always the full payment amount. + + > Do not use this request for payments that involve multiple partial captures. + + + For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).' + operationId: post-payments-paymentPspReference-reversals + x-groupName: Modifications + x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePaymentReversalRequest' + parameters: + - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment that you want to reverse. ' + name: paymentPspReference + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: OK - the request has succeeded. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentReversalResource' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-403' + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-422' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /sessions: + post: + tags: + - Payments + summary: Create a payment session + description: 'Creates a payment session for [Web Drop-in](https://docs.adyen.com/online-payments/web-drop-in) + and [Web Components](https://docs.adyen.com/online-payments/web-components) + integrations. + + + The response contains encrypted payment session data. The front end then uses + the session data to make any required server-side calls for the payment flow. + + + You get the payment outcome asynchrnonously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) + webhook.' + x-addedInVersion: '68' + operationId: post-sessions + x-groupName: Payments + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCheckoutSessionRequest' + parameters: + - $ref: '#/components/parameters/Idempotency-Key' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCheckoutSessionResponse' + description: Created - the request has been fulfilled and has resulted in + one or more new resources being created. + headers: + Idempotency-Key: + $ref: '#/components/headers/Idempotency-Key' +components: + schemas: + AccountInfo: + properties: + accountAgeIndicator: + description: 'Indicator for the length of time since this shopper account + was created in the merchant''s environment. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountChangeDate: + description: Date when the shopper's account was last changed. + format: date-time + type: string + accountChangeIndicator: + description: 'Indicator for the length of time since the shopper''s account + was last updated. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountCreationDate: + description: Date when the shopper's account was created. + format: date-time + type: string + accountType: + x-addedInVersion: '50' + description: 'Indicates the type of account. For example, for a multi-account + card product. + + Allowed values: + + * notApplicable + + * credit + + * debit' + enum: + - notApplicable + - credit + - debit + type: string + addCardAttemptsDay: + description: Number of attempts the shopper tried to add a card to their + account in the last day. + format: int32 + type: integer + deliveryAddressUsageDate: + description: Date the selected delivery address was first used. + format: date-time + type: string + deliveryAddressUsageIndicator: + description: 'Indicator for the length of time since this delivery address + was first used. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + homePhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.homePhone` instead. + description: Shopper's home phone number (including the country code). + type: string + mobilePhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.mobilePhone` instead. + description: Shopper's mobile phone number (including the country code). + type: string + passwordChangeDate: + description: Date when the shopper last changed their password. + format: date-time + type: string + passwordChangeIndicator: + description: 'Indicator when the shopper has changed their password. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + pastTransactionsDay: + description: Number of all transactions (successful and abandoned) from + this shopper in the past 24 hours. + format: int32 + type: integer + pastTransactionsYear: + description: Number of all transactions (successful and abandoned) from + this shopper in the past year. + format: int32 + type: integer + paymentAccountAge: + description: Date this payment method was added to the shopper's account. + format: date-time + type: string + paymentAccountIndicator: + description: 'Indicator for the length of time since this payment method + was added to this shopper''s account. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + purchasesLast6Months: + description: Number of successful purchases in the last six months. + format: int32 + type: integer + suspiciousActivity: + description: Whether suspicious activity was recorded on this account. + type: boolean + workPhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. + description: Shopper's work phone number (including the country code). + type: string + AcctInfo: + properties: + chAccAgeInd: + description: "Length of time that the cardholder has had the account with\ + \ the 3DS Requestor. \nAllowed values:\n* **01** \u2014 No account\n*\ + \ **02** \u2014 Created during this transaction\n* **03** \u2014 Less\ + \ than 30 days\n* **04** \u2014 30\u201360 days\n* **05** \u2014 More\ + \ than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + chAccChange: + description: "Date that the cardholder\u2019s account with the 3DS Requestor\ + \ was last changed, including Billing or Shipping address, new payment\ + \ account, or new user(s) added. \nFormat: **YYYYMMDD**" + type: string + chAccChangeInd: + description: "Length of time since the cardholder\u2019s account information\ + \ with the 3DS Requestor was last changed, including Billing or Shipping\ + \ address, new payment account, or new user(s) added. \nAllowed values:\n\ + * **01** \u2014 Changed during this transaction\n* **02** \u2014 Less\ + \ than 30 days\n* **03** \u2014 30\u201360 days\n* **04** \u2014 More\ + \ than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + chAccPwChange: + description: "Date that cardholder\u2019s account with the 3DS Requestor\ + \ had a password change or account reset. \nFormat: **YYYYMMDD**" + type: string + chAccPwChangeInd: + description: "Indicates the length of time since the cardholder\u2019s account\ + \ with the 3DS Requestor had a password change or account reset. \nAllowed\ + \ values:\n* **01** \u2014 No change\n* **02** \u2014 Changed during this\ + \ transaction\n* **03** \u2014 Less than 30 days\n* **04** \u2014 30\u2013\ + 60 days\n* **05** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + chAccString: + description: "Date that the cardholder opened the account with the 3DS Requestor.\ + \ \nFormat: **YYYYMMDD**" + type: string + nbPurchaseAccount: + description: 'Number of purchases with this cardholder account during the + previous six months. Max length: 4 characters.' + type: string + paymentAccAge: + description: "String that the payment account was enrolled in the cardholder\u2019\ + s account with the 3DS Requestor. \nFormat: **YYYYMMDD**" + type: string + paymentAccInd: + description: "Indicates the length of time that the payment account was\ + \ enrolled in the cardholder\u2019s account with the 3DS Requestor. \n\ + Allowed values:\n* **01** \u2014 No account (guest checkout)\n* **02**\ + \ \u2014 During this transaction\n* **03** \u2014 Less than 30 days\n\ + * **04** \u2014 30\u201360 days\n* **05** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + provisionAttemptsDay: + description: 'Number of Add Card attempts in the last 24 hours. Max length: + 3 characters.' + type: string + shipAddressUsage: + description: "String when the shipping address used for this transaction\ + \ was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**" + type: string + shipAddressUsageInd: + description: "Indicates when the shipping address used for this transaction\ + \ was first used with the 3DS Requestor. \nAllowed values:\n* **01** \u2014\ + \ This transaction\n* **02** \u2014 Less than 30 days\n* **03** \u2014\ + \ 30\u201360 days\n* **04** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + shipNameIndicator: + description: "Indicates if the Cardholder Name on the account is identical\ + \ to the shipping Name used for this transaction. \nAllowed values:\n\ + * **01** \u2014 Account Name identical to shipping Name\n* **02** \u2014\ + \ Account Name different to shipping Name" + enum: + - '01' + - '02' + maxLength: 2 + minLength: 2 + type: string + suspiciousAccActivity: + description: "Indicates whether the 3DS Requestor has experienced suspicious\ + \ activity (including previous fraud) on the cardholder account. \nAllowed\ + \ values:\n* **01** \u2014 No suspicious activity has been observed\n\ + * **02** \u2014 Suspicious activity has been observed" + enum: + - '01' + - '02' + maxLength: 2 + minLength: 2 + type: string + txnActivityDay: + description: 'Number of transactions (successful and abandoned) for this + cardholder account with the 3DS Requestor across all payment accounts + in the previous 24 hours. Max length: 3 characters.' + maxLength: 3 + type: string + txnActivityYear: + description: 'Number of transactions (successful and abandoned) for this + cardholder account with the 3DS Requestor across all payment accounts + in the previous year. Max length: 3 characters.' + maxLength: 3 + type: string + AchDetails: + additionalProperties: false + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankLocationId: + description: The bank routing number of the account. The field value is + `nil` in most cases. + type: string + encryptedBankAccountNumber: + description: Encrypted bank account number. The bank account number (without + separators). + type: string + encryptedBankLocationId: + description: Encrypted location id. The bank routing number of the account. + The field value is `nil` in most cases. + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ach + description: '**ach**' + enum: + - ach + type: string + required: + - bankAccountNumber + title: ACH Direct Debit + AdditionalData3DSecure: + properties: + allow3DS2: + description: "Indicates if you are able to process 3D Secure 2 transactions\ + \ natively on your payment page. Send this parameter when you are using\ + \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ + \n > This parameter only indicates readiness to support native 3D Secure\ + \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ + \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ + \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ + \ support native 3D Secure 2 authentication. Setting this to true does\ + \ not mean always applying 3D Secure 2. Adyen still selects the version\ + \ of 3D Secure based on configuration to optimize authorisation rates\ + \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ + \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ + \ Secure 2 to your shopper regardless of your configuration.\n" + type: string + executeThreeD: + description: "Indicates if you want to perform 3D Secure authentication\ + \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ + \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ + \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ + \ 3D Secure authentication. Note that this setting results in refusals\ + \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ + \ national regulations. \n" + type: string + mpiImplementationType: + description: In case of Secure+, this field must be set to **CUPSecurePlus**. + type: string + scaExemption: + description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that you want to request for the transaction.\n\n Possible values:\n\ + * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ + \ **transactionRiskAnalysis** " + type: string + threeDSVersion: + description: "Indicates your preference for the 3D Secure version. \n> If\ + \ you use this parameter, you override the checks from Adyen's Authentication\ + \ Engine. We recommend to use this field only if you have an extensive\ + \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ + \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ + \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ + \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ + \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ + \ in the `ARes`, we will apply the fallback policy configured in your\ + \ account. For example, if the configuration is to fall back to 3D Secure\ + \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ + \ the BIN is not enrolled, you will receive an error.\n\n" + type: string + AdditionalDataAirline: + properties: + airline.agency_invoice_number: + description: 'Reference number for the invoice, issued by the agency. + + * minLength: 1 + + * maxLength: 6' + type: string + airline.agency_plan_name: + description: '2-letter agency plan identifier; alphabetical. + + * minLength: 2 + + * maxLength: 2' + type: string + airline.airline_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit + accounting code (PAX); numeric. It identifies the carrier. + + * Format: IATA 3-digit accounting code (PAX) + + * Example: KLM = 074 + + * minLength: 3 + + * maxLength: 3' + type: string + airline.airline_designator_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.boarding_fee: + description: 'Chargeable amount for boarding the plane. + + The transaction amount needs to be represented in minor units according + to the [following table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 18' + type: string + airline.computerized_reservation_system: + description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) + used to make the reservation and purchase the ticket. + + * Format: alphanumeric. + + * minLength: 4 + + * maxLength: 4' + type: string + airline.customer_reference_number: + description: 'Reference number; alphanumeric. + + * minLength: 0 + + * maxLength: 20' + type: string + airline.document_type: + description: 'Optional 2-digit code; alphanumeric. It identifies the type + of product of the transaction. The description of the code may appear + on credit card statements. + + * Format: 2-digit code + + * Example: Passenger ticket = 01 + + * minLength: 2 + + * maxLength: 2' + type: string + airline.flight_date: + description: 'Flight departure date. Local time `(HH:mm)` is optional. + + * Date format: `yyyy-MM-dd` + + * Date and time format: `yyyy-MM-dd HH:mm` + + * minLength: 10 + + * maxLength: 16' + type: string + airline.leg.carrier_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + This field is required/mandatory if the airline data includes leg details. + + * Format: IATA 2-letter airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.leg.class_of_travel: + description: '1-letter travel class identifier; alphabetical. There is no + standard; however, the following codes are used rather consistently: + + * F: first class + + * J: business class + + * Y: economy class + + * W: premium economy + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.leg.date_of_travel: + description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ + * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" + type: string + airline.leg.depart_airport: + description: 'Alphabetical identifier of the departure airport. + + This field is required if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.depart_tax: + description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). + Amount charged by a country to an individual upon their leaving. The transaction + amount needs to be represented in minor units according to the [following + table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 12' + type: string + airline.leg.destination_code: + description: 'Alphabetical identifier of the destination/arrival airport. + + This field is required/mandatory if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.fare_base_code: + description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); + alphanumeric. + + * minLength: 1 + + * maxLength: 7' + type: string + airline.leg.flight_number: + description: 'The flight identifier. + + * minLength: 1 + + * maxLength: 5' + type: string + airline.leg.stop_over_code: + description: '1-letter code that indicates whether the passenger is entitled + to make a stopover. Only two types of characters are allowed: + + * O: Stopover allowed + + * X: Stopover not allowed + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.passenger.date_of_birth: + description: 'Date of birth of the passenger. + + + Date format: `yyyy-MM-dd` + + * minLength: 10 + + * maxLength: 10' + type: string + airline.passenger.first_name: + description: 'Passenger first name/given name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.last_name: + description: 'Passenger last name/family name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.telephone_number: + description: 'Telephone number of the passenger, including country code. + This is an alphanumeric field that can include the ''+'' and ''-'' signs. + + * minLength: 3 + + * maxLength: 30' + type: string + airline.passenger.traveller_type: + description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. + Example: ADT, SRC, CNN, INS. + + + However, several carriers use non-standard codes that can be up to 5 alphanumeric + characters. + + * minLength: 3 + + * maxLength: 6' + type: string + airline.passenger_name: + description: 'Passenger name, initials, and a title. + + * Format: last name + first name or initials + title. + + * Example: *FLYER / MARY MS*. + + * minLength: 1 + + * maxLength: 49' + type: string + airline.ticket_issue_address: + description: 'Address of the place/agency that issued the ticket. + + * minLength: 0 + + * maxLength: 16' + type: string + airline.ticket_number: + description: 'The ticket''s unique identifier. + + * minLength: 1 + + * maxLength: 150' + type: string + airline.travel_agency_code: + description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier + number for travel agencies. + + * minLength: 1 + + * maxLength: 8' + type: string + airline.travel_agency_name: + description: 'The name of the travel agency. + + * minLength: 1 + + * maxLength: 25' + type: string + required: + - airline.passenger_name + AdditionalDataCarRental: + properties: + carRental.checkOutDate: + description: 'Pick-up date. + + * Date format: `yyyyMMdd`' + type: string + carRental.customerServiceTollFreeNumber: + description: 'The customer service phone number of the car rental company. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + carRental.daysRented: + description: 'Number of days for which the car is being rented. + + * Format: Numeric + + * maxLength: 19' + type: string + carRental.fuelCharges: + description: 'Any fuel charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.insuranceCharges: + description: 'Any insurance charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.locationCity: + description: 'The city from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.locationCountry: + description: 'The country from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.locationStateProvince: + description: 'The state or province from where the car is rented. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + * Y - Customer was a no show. + + * N - Not applicable.' + type: string + carRental.oneWayDropOffCharges: + description: Charge associated with not returning a vehicle to the original + rental location. + type: string + carRental.rate: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.rateIndicator: + description: 'Specifies whether the given rate is applied daily or weekly. + + * D - Daily rate. + + * W - Weekly rate.' + type: string + carRental.rentalAgreementNumber: + description: 'The rental agreement number associated with this car rental. + + * Format: Alphanumeric + + * maxLength: 9' + type: string + carRental.rentalClassId: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.renterName: + description: 'The name of the person renting the car. + + * Format: Alphanumeric + + * maxLength: 26' + type: string + carRental.returnCity: + description: 'The city where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.returnCountry: + description: 'The country where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.returnDate: + description: 'The last date to return the car by. + + * Date format: `yyyyMMdd`' + type: string + carRental.returnLocationId: + description: 'Agency code, phone number, or address abbreviation + + * Format: Alphanumeric + + * maxLength: 10' + type: string + carRental.returnStateProvince: + description: 'The state or province where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.taxExemptIndicator: + description: 'Indicates whether the goods or services were tax-exempt, or + tax was not collected. + + + Values: + + * Y - Goods or services were tax exempt + + * N - Tax was not collected' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "A" for Car rental. This should be + included in the auth message. + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataCommon: + properties: + RequestedTestErrorResponseCode: + description: "Triggers test scenarios that allow to replicate certain communication\ + \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ + \ wasn't a connection available to service the outgoing communication.\n\ + This is a transient, retriable error since no messaging could be initiated\ + \ to an issuing system (or third-party acquiring system). Therefore, the\ + \ header Transient-Error: true is returned in the response. A subsequent\ + \ request using the same idempotency key will be processed as if it was\ + \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ + \ wrong during transmission of the message or receiving the response.\n\ + This is a classified as non-transient because the message could have been\ + \ received by the issuing party and been acted upon. No transient error\ + \ header is returned. If using idempotency, the (error) response is stored\ + \ as the final result for the idempotency key. Subsequent messages with\ + \ the same idempotency key not be processed beyond returning the stored\ + \ response." + type: string + authorisationType: + description: "Flags a card payment request for either pre-authorisation\ + \ or final authorisation. For more information, refer to [Authorisation\ + \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ + \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ + \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ + \ request to be handled as a final authorisation." + type: string + customRoutingFlag: + description: 'Allows you to determine or override the acquirer account that + should be used for the transaction. + + + If you need to process a payment with an acquirer different from a default + one, you can set up a corresponding configuration on the Adyen payments + platform. Then you can pass a custom routing flag in a payment request''s + additional data to target a specific acquirer. + + + To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge + description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ + \ this field denotes why the additional payment is made.\n\nPossible values:\n\ + \n * **NoShow**: An incremental charge is carried out because of a no-show\ + \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ + \ charge is carried out to process an additional payment after the original\ + \ services have been rendered and the respective payment has been processed." + enum: + - NoShow + - DelayedCharge + type: string + networkTxReference: + description: 'Allows you to link the transaction to the original or previous + one in a subscription/card-on-file chain. This field is required for token-based + transactions where Adyen does not tokenize the card. + + + Transaction identifier from card schemes, for example, Mastercard Trace + ID or the Visa Transaction ID. + + + Submit the original transaction ID of the contract in your payment request + if you are not tokenizing card details with Adyen and are making a merchant-initiated + transaction (MIT) for subsequent charges. + + + Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` + **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction + is classified as MIT.' + type: string + overwriteBrand: + description: Boolean indicator that can be optionally used for performing + debit transactions on combo cards (for example, combo cards in Brazil). + This is not mandatory but we recommend that you set this to true if you + want to use the `selectedBrand` value to specify how to process the transaction. + type: string + subMerchantCity: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the city of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 13 characters.' + type: string + subMerchantCountry: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the three-letter + country code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Fixed length: 3 characters.' + type: string + subMerchantID: + description: 'This field contains an identifier of the actual merchant when + a transaction is submitted via a payment facilitator. The payment facilitator + must send in this unique ID. + + + A unique identifier per submerchant that is required if the transaction + is performed by a registered payment facilitator. + + * Format: alpha-numeric. + + * Fixed length: 15 characters.' + type: string + subMerchantName: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the name of + the actual merchant. + + * Format: alpha-numeric. + + * Maximum length: 22 characters.' + type: string + subMerchantPostalCode: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the postal code + of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 10 characters.' + type: string + subMerchantState: + description: 'This field is required if the transaction is performed by + a registered payment facilitator, and if applicable to the country. This + field must contain the state code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 3 characters.' + type: string + subMerchantStreet: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the street of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 60 characters.' + type: string + subMerchantTaxId: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the tax ID of + the actual merchant. + + * Format: alpha-numeric. + + * Fixed length: 11 or 14 characters.' + type: string + AdditionalDataLevel23: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + + Encoding: ASCII. + + + Max length: 25 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + enhancedSchemeData.destinationCountryCode: + description: 'Destination country code. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.destinationPostalCode: + description: 'The postal code of a destination address. + + + Encoding: ASCII. + + + Max length: 10 characters. + + + > Required for American Express.' + type: string + enhancedSchemeData.destinationStateProvinceCode: + description: 'Destination state or province code. + + + Encoding: ASCII.Max length: 3 characters.' + type: string + enhancedSchemeData.dutyAmount: + description: 'Duty amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.freightAmount: + description: 'Shipping amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].commodityCode: + description: 'Item commodity code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].description: + description: 'Item description. + + + Encoding: ASCII. + + + Max length: 26 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + description: 'Discount amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].productCode: + description: 'Product code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].quantity: + description: 'Quantity, specified as an integer value. + + + Value must be greater than 0. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + description: 'Total amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: + description: 'Item unit of measurement. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitPrice: + description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + + Max length: 12 characters.' + type: string + enhancedSchemeData.orderDate: + description: 'Order date. + + * Format: `ddMMyy` + + + Encoding: ASCII. + + + Max length: 6 characters.' + type: string + enhancedSchemeData.shipFromPostalCode: + description: 'The postal code of a "ship-from" address. + + + Encoding: ASCII. + + + Max length: 10 characters.' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + AdditionalDataLodging: + properties: + lodging.checkInDate: + description: 'The arrival date. + + * Date format: `yyyyMMdd`' + type: string + lodging.checkOutDate: + description: 'The departure date. + + * Date format: `yyyyMMdd`' + type: string + lodging.customerServiceTollFreeNumber: + description: 'The toll free phone number for the hotel/lodgings. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.fireSafetyActIndicator: + description: 'Identifies that the facility complies with the Hotel and Motel + Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. + + * Format: Alphabetic + + * maxLength: 1' + type: string + lodging.folioCashAdvances: + description: 'The folio cash advances. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.folioNumber: + description: "Card acceptor\u2019s internal invoice or billing ID reference\ + \ number.\n* Format: Alphanumeric\n* maxLength: 25" + type: string + lodging.foodBeverageCharges: + description: 'Any charges for food and beverages associated with the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + + Value should be Y or N. + + * Format: Numeric + + * maxLength: 1' + type: string + lodging.prepaidExpenses: + description: 'Prepaid expenses for the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.propertyPhoneNumber: + description: 'Identifies specific lodging property location by its local + phone number. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.room1.numberOfNights: + description: 'Total number of nights the room will be rented. + + * Format: Numeric + + * maxLength: 4' + type: string + lodging.room1.rate: + description: 'The rate of the room. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.room1.tax: + description: 'The total amount of tax to be paid. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalRoomTax: + description: 'Total room tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalTax: + description: 'Total tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "H" for Hotel. This should be included + in the auth message. + + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataOpenInvoice: + properties: + openinvoicedata.merchantData: + description: 'Holds different merchant data points like product, purchase, + customer, and so on. It takes data in a Base64 encoded string. + + + The `merchantData` parameter needs to be added to the `openinvoicedata` + signature at the end. + + + Since the field is optional, if it''s not included it does not impact + computing the merchant signature. + + + Applies only to Klarna. + + + You can contact Klarna for the format and structure of the string.' + type: string + openinvoicedata.numberOfLines: + description: 'The number of invoice lines included in `openinvoicedata`. + + + There needs to be at least one line, so `numberOfLines` needs to be at + least 1.' + type: string + openinvoicedataLine[itemNr].currencyCode: + description: The three-character ISO currency code. + type: string + openinvoicedataLine[itemNr].description: + description: A text description of the product the invoice line refers to. + type: string + openinvoicedataLine[itemNr].itemAmount: + description: 'The price for one item in the invoice line, represented in + minor units. + + + The due amount for the item, VAT excluded.' + type: string + openinvoicedataLine[itemNr].itemId: + description: A unique id for this item. Required for RatePay if the description + of each item is not unique. + type: string + openinvoicedataLine[itemNr].itemVatAmount: + description: The VAT due for one item in the invoice line, represented in + minor units. + type: string + openinvoicedataLine[itemNr].itemVatPercentage: + description: 'The VAT percentage for one item in the invoice line, represented + in minor units. + + + For example, 19% VAT is specified as 1900.' + type: string + openinvoicedataLine[itemNr].numberOfItems: + description: The number of units purchased of a specific product. + type: string + openinvoicedataLine[itemNr].returnShippingCompany: + description: Name of the shipping company handling the the return shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingNumber: + description: The tracking number for the return of the shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingUri: + description: URI where the customer can track the return of their shipment. + type: string + openinvoicedataLine[itemNr].shippingCompany: + description: Name of the shipping company handling the delivery. + type: string + openinvoicedataLine[itemNr].shippingMethod: + description: Shipping method. + type: string + openinvoicedataLine[itemNr].trackingNumber: + description: The tracking number for the shipment. + type: string + openinvoicedataLine[itemNr].trackingUri: + description: URI where the customer can track their shipment. + type: string + AdditionalDataOpi: + properties: + opi.includeTransToken: + description: 'Optional boolean indicator. Set to **true** if you want an + ecommerce transaction to return an `opi.transToken` as additional data + in the response. + + + You can store this Oracle Payment Interface token in your Oracle Opera + database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' + type: string + AdditionalDataRatepay: + properties: + ratepay.installmentAmount: + description: Amount the customer has to pay each month. + type: string + ratepay.interestRate: + description: Interest rate of this installment. + type: string + ratepay.lastInstallmentAmount: + description: Amount of the last installment. + type: string + ratepay.paymentFirstday: + description: Calendar day of the first payment. + type: string + ratepaydata.deliveryDate: + description: Date the merchant delivered the goods to the customer. + type: string + ratepaydata.dueDate: + description: Date by which the customer must settle the payment. + type: string + ratepaydata.invoiceDate: + description: Invoice date, defined by the merchant. If not included, the + invoice date is set to the delivery date. + type: string + ratepaydata.invoiceId: + description: Identification name or number for the invoice, defined by the + merchant. + type: string + AdditionalDataRetry: + properties: + retry.chainAttemptNumber: + description: 'The number of times the transaction (not order) has been retried + between different payment service providers. For instance, the `chainAttemptNumber` + set to 2 means that this transaction has been recently tried on another + provider before being sent to Adyen. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.orderAttemptNumber: + description: 'The index of the attempt to bill a particular order, which + is identified by the `merchantOrderReference` field. For example, if a + recurring transaction fails and is retried one day later, then the order + number for these attempts would be 1 and 2, respectively. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.skipRetry: + description: 'The Boolean value indicating whether Adyen should skip or + retry this transaction, if possible. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + AdditionalDataRisk: + properties: + riskdata.[customFieldName]: + description: The data for your custom risk field. For more information, + refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). + type: string + riskdata.basket.item[itemNr].amountPerItem: + description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.basket.item[itemNr].brand: + description: Brand of the item. + type: string + riskdata.basket.item[itemNr].category: + description: Category of the item. + type: string + riskdata.basket.item[itemNr].color: + description: Color of the item. + type: string + riskdata.basket.item[itemNr].currency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.basket.item[itemNr].itemID: + description: ID of the item. + type: string + riskdata.basket.item[itemNr].manufacturer: + description: Manufacturer of the item. + type: string + riskdata.basket.item[itemNr].productTitle: + description: A text description of the product the invoice line refers to. + type: string + riskdata.basket.item[itemNr].quantity: + description: Quantity of the item purchased. + type: string + riskdata.basket.item[itemNr].receiverEmail: + description: Email associated with the given product in the basket (usually + in electronic gift cards). + type: string + riskdata.basket.item[itemNr].size: + description: Size of the item. + type: string + riskdata.basket.item[itemNr].sku: + description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' + type: string + riskdata.basket.item[itemNr].upc: + description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' + type: string + riskdata.promotions.promotion[itemNr].promotionCode: + description: Code of the promotion. + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountAmount: + description: The discount amount of the promotion, represented in [minor + units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: + description: 'Promotion''s percentage discount. It is represented in percentage + value and there is no need to include the ''%'' sign. + + + e.g. for a promotion discount of 30%, the value of the field should be + 30.' + type: string + riskdata.promotions.promotion[itemNr].promotionName: + description: Name of the promotion. + type: string + riskdata.riskProfileReference: + description: Reference number of the risk profile that you want to apply + to the payment. If not provided or left blank, the merchant-level account's + default risk profile will be applied to the payment. For more information, + see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). + type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string + AdditionalDataRiskStandalone: + properties: + PayPal.CountryCode: + description: Shopper's country of residence in the form of ISO standard + 3166 2-character country codes. + type: string + PayPal.EmailId: + description: Shopper's email. + type: string + PayPal.FirstName: + description: Shopper's first name. + type: string + PayPal.LastName: + description: Shopper's last name. + type: string + PayPal.PayerId: + description: 'Unique PayPal Customer Account identification number. Character + length and limitations: 13 single-byte alphanumeric characters.' + type: string + PayPal.Phone: + description: Shopper's phone number. + type: string + PayPal.ProtectionEligibility: + description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ + \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ + \ \u2014 Merchant is not protected under the Seller Protection Policy." + type: string + PayPal.TransactionId: + description: Unique transaction ID of the payment. + type: string + avsResultRaw: + description: 'Raw AVS result received from the acquirer, where available. + Example: D' + type: string + bin: + description: The Bank Identification Number of a credit card, which is the + first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). + type: string + cvcResultRaw: + description: 'Raw CVC result received from the acquirer, where available. + Example: 1' + type: string + riskToken: + description: Unique identifier or token for the shopper's card details. + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. Example: true' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. Example: true' + type: string + tokenDataType: + description: 'Required for PayPal payments only. The only supported value + is: **paypal**.' + type: string + AdditionalDataSubMerchant: + properties: + subMerchant.numberOfSubSellers: + description: Required for transactions performed by registered payment facilitators. + Indicates the number of sub-merchants contained in the request. For example, + **3**. + type: string + subMerchant.subSeller[subSellerNr].city: + description: 'Required for transactions performed by registered payment + facilitators. The city of the sub-merchant''s address. + + * Format: Alphanumeric + + * Maximum length: 13 characters' + type: string + subMerchant.subSeller[subSellerNr].country: + description: "Required for transactions performed by registered payment\ + \ facilitators. The three-letter country code of the sub-merchant's address.\ + \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ + * Fixed length: 3 characters" + type: string + subMerchant.subSeller[subSellerNr].id: + description: "Required for transactions performed by registered payment\ + \ facilitators. A unique identifier that you create for the sub-merchant,\ + \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ + * Maximum length: 15 characters" + type: string + subMerchant.subSeller[subSellerNr].mcc: + description: "Required for transactions performed by registered payment\ + \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ + \ \n* Format: Numeric\n* Fixed length: 4 digits" + type: string + subMerchant.subSeller[subSellerNr].name: + description: 'Required for transactions performed by registered payment + facilitators. The name of the sub-merchant. Based on scheme specifications, + this value will overwrite the shopper statement that will appear in the + card statement. + + * Format: Alphanumeric + + * Maximum length: 22 characters' + type: string + subMerchant.subSeller[subSellerNr].postalCode: + description: 'Required for transactions performed by registered payment + facilitators. The postal code of the sub-merchant''s address, without + dashes. + + * Format: Numeric + + * Fixed length: 8 digits' + type: string + subMerchant.subSeller[subSellerNr].state: + description: 'Required for transactions performed by registered payment + facilitators. The state code of the sub-merchant''s address, if applicable + to the country. + + * Format: Alphanumeric + + * Maximum length: 2 characters' + type: string + subMerchant.subSeller[subSellerNr].street: + description: 'Required for transactions performed by registered payment + facilitators. The street name and house number of the sub-merchant''s + address. + + * Format: Alphanumeric + + * Maximum length: 60 characters' + type: string + subMerchant.subSeller[subSellerNr].taxId: + description: 'Required for transactions performed by registered payment + facilitators. The tax ID of the sub-merchant. + + * Format: Numeric + + * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' + type: string + AdditionalDataTemporaryServices: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + * Encoding: ASCII + + * maxLength: 25' + type: string + enhancedSchemeData.employeeName: + description: 'Name or ID associated with the individual working in a temporary + capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.jobDescription: + description: 'Description of the job or task of the individual working in + a temporary capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.regularHoursRate: + description: 'Amount paid per regular hours worked, minor units. + + * maxLength: 7' + type: string + enhancedSchemeData.regularHoursWorked: + description: 'Amount of time worked during a normal operation for the task + or job. + + * maxLength: 7' + type: string + enhancedSchemeData.requestName: + description: 'Name of the individual requesting temporary services. + + * maxLength: 40' + type: string + enhancedSchemeData.tempStartDate: + description: 'Date for the beginning of the pay period. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.tempWeekEnding: + description: 'Date of the end of the billing cycle. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. For example, 2000 means + USD 20.00 + + * maxLength: 12' + type: string + AdditionalDataWallets: + properties: + androidpay.token: + description: The Android Pay token retrieved from the SDK. + type: string + masterpass.transactionId: + description: The Mastercard Masterpass Transaction ID retrieved from the + SDK. + type: string + payment.token: + description: The Apple Pay token retrieved from the SDK. + type: string + paywithgoogle.token: + description: The Google Pay token retrieved from the SDK. + type: string + samsungpay.token: + description: The Samsung Pay token retrieved from the SDK. + type: string + visacheckout.callId: + description: The Visa Checkout Call ID retrieved from the SDK. + type: string + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + AfterpayDetails: + additionalProperties: false + properties: + billingAddress: + description: The address where to send the invoice. + type: string + deliveryAddress: + description: The address where the goods should be delivered. + type: string + personalDetails: + description: Shopper name, date of birth, phone number, and email address. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: afterpay_default + description: '**afterpay_default**' + enum: + - afterpay_default + - afterpaytouch + - afterpay_b2b + type: string + required: + - type + title: Afterpay + AmazonPayDetails: + additionalProperties: false + properties: + amazonPayToken: + description: This is the `amazonPayToken` that you obtained from the [Get + Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) + response. + type: string + type: + default: amazonpay + description: '**amazonpay**' + enum: + - amazonpay + type: string + title: Amazon Pay + 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 + AndroidPayDetails: + additionalProperties: false + properties: + type: + default: androidpay + description: '**androidpay**' + enum: + - androidpay + type: string + title: Android Pay + ApplePayDetails: + additionalProperties: false + properties: + applePayToken: + description: The stringified and base64 encoded `paymentData` you retrieved + from the Apple framework. + maxLength: 10000 + type: string + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: applepay + description: '**applepay**' + enum: + - applepay + type: string + required: + - applePayToken + title: Apple Pay + ApplicationInfo: + properties: + adyenLibrary: + description: Adyen-developed software, such as libraries and plugins, used + to interact with the Adyen API. For example, Magento plugin, Java API + library, etc. + $ref: '#/components/schemas/CommonField' + adyenPaymentSource: + description: Adyen-developed software to get payment details. For example, + Checkout SDK, Secured Fields SDK, etc. + $ref: '#/components/schemas/CommonField' + externalPlatform: + description: Third-party developed platform used to initiate payment requests. + For example, Magento, Zuora, etc. + $ref: '#/components/schemas/ExternalPlatform' + merchantApplication: + description: Merchant developed software, such as cashier application, used + to interact with the Adyen API. + $ref: '#/components/schemas/CommonField' + merchantDevice: + description: Merchant device information. + $ref: '#/components/schemas/MerchantDevice' + shopperInteractionDevice: + description: Shopper interaction device, such as terminal, mobile device + or web browser, to initiate payment requests. + $ref: '#/components/schemas/ShopperInteractionDevice' + Avs: + properties: + addressEditable: + description: Indicates whether the shopper is allowed to modify the billing + address for the current payment request. + type: boolean + enabled: + description: "Specifies whether the shopper should enter their billing address\ + \ during checkout.\n\nAllowed values:\n* yes \u2014 Perform AVS checks\ + \ for every card payment.\n* automatic \u2014 Perform AVS checks only\ + \ when required to optimize the conversion rate.\n* no \u2014 Do not perform\ + \ AVS checks." + enum: + - 'yes' + - 'no' + - automatic + type: string + BacsDirectDebitDetails: + additionalProperties: false + properties: + bankAccountNumber: + x-addedInVersion: '65' + description: The bank account number (without separators). + type: string + bankLocationId: + x-addedInVersion: '65' + description: The bank routing number of the account. + type: string + holderName: + x-addedInVersion: '65' + description: The name of the bank account holder. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: directdebit_GB + description: '**directdebit_GB**' + enum: + - directdebit_GB + type: string + title: BACS Direct Debit + BankAccount: + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCity: + x-addedInVersion: '18' + description: The bank city. + type: string + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. + type: string + bankName: + description: The name of the bank. + type: string + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. + type: string + countryCode: + description: 'Country code where the bank is located. + + + A valid value is an ISO two-character country code (e.g. ''NL'').' + type: string + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + taxId: + x-addedInVersion: '18' + description: The bank account holder's tax ID. + type: string + BillDeskDetails: + additionalProperties: false + properties: + issuer: + description: The issuer id of the shopper's selected bank. + type: string + type: + description: '**billdesk**' + enum: + - billdesk_online + - billdesk_wallet + - onlinebanking_IN + - wallet_IN + type: string + required: + - type + - issuer + title: BillDesk + BlikDetails: + additionalProperties: false + properties: + blikCode: + description: BLIK code consisting of 6 digits. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + description: '**blik**' + enum: + - blik + type: string + title: BLIK + BrowserInfo: + properties: + acceptHeader: + description: The accept header value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + colorDepth: + x-addedInVersion: '40' + description: 'The color depth of the shopper''s browser in bits per pixel. + This should be obtained by using the browser''s `screen.colorDepth` property. + Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' + format: int32 + type: integer + javaEnabled: + x-addedInVersion: '40' + description: Boolean value indicating if the shopper's browser is able to + execute Java. + type: boolean + javaScriptEnabled: + x-addedInVersion: '40' + default: true + description: Boolean value indicating if the shopper's browser is able to + execute JavaScript. A default 'true' value is assumed if the field is + not present. + type: boolean + language: + x-addedInVersion: '40' + description: The `navigator.language` value of the shopper's browser (as + defined in IETF BCP 47). + type: string + screenHeight: + x-addedInVersion: '40' + description: The total height of the shopper's device screen in pixels. + format: int32 + type: integer + screenWidth: + x-addedInVersion: '40' + description: The total width of the shopper's device screen in pixels. + format: int32 + type: integer + timeZoneOffset: + x-addedInVersion: '40' + description: Time difference between UTC time and the shopper's browser + local time, in minutes. + format: int32 + type: integer + userAgent: + description: The user agent value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + required: + - userAgent + - acceptHeader + - javaEnabled + - colorDepth + - screenHeight + - screenWidth + - timeZoneOffset + - language + Card: + properties: + cvc: + description: "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid)\ + \ (1-20 characters). Depending on the card brand, it is known also as:\n\ + * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n>\ + \ If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce),\ + \ the CVC code is present in the encrypted data. You must never post the\ + \ card details to the server.\n> This field must be always present in\ + \ a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n\ + > When this value is returned in a response, it is always empty because\ + \ it is not stored." + maxLength: 20 + minLength: 1 + type: string + expiryMonth: + description: 'The card expiry month. + + Format: 2 digits, zero-padded for single digits. For example: + + * 03 = March + + * 11 = November' + maxLength: 2 + minLength: 1 + type: string + expiryYear: + description: 'The card expiry year. + + Format: 4 digits. For example: 2020' + maxLength: 4 + minLength: 4 + type: string + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 + type: string + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 + type: string + number: + description: 'The card number (4-19 characters). Do not use any separators. + + When this value is returned in a response, only the last 4 digits of the + card number are returned.' + maxLength: 19 + minLength: 4 + type: string + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 + type: string + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 + type: string + required: + - number + - expiryMonth + - expiryYear + - holderName + CardDetails: + additionalProperties: false + properties: + cupsecureplus.smscode: + deprecated: true + type: string + cvc: + description: The card verification code. Only collect raw card data if you + are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + encryptedCardNumber: + description: The encrypted card number. + maxLength: 10000 + type: string + encryptedExpiryMonth: + description: The encrypted card expiry month. + maxLength: 10000 + type: string + encryptedExpiryYear: + description: The encrypted card expiry year. + maxLength: 10000 + type: string + encryptedSecurityCode: + description: The encrypted card verification code. + maxLength: 10000 + type: string + expiryMonth: + description: The card expiry month. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + expiryYear: + description: The card expiry year. Only collect raw card data if you are + [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + holderName: + description: The name of the card holder. + type: string + number: + description: The card number. Only collect raw card data if you are [fully + PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used only for recurring payments + in India. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + threeDS2SdkVersion: + description: Version of the 3D Secure 2 mobile SDK. + maxLength: 12 + type: string + type: + default: scheme + description: Default payment method details. Common for scheme payment methods, + and for simple payment method details. + enum: + - scheme + - networkToken + - giftcard + - alliancedata + - card + - moneybookers + - qiwiwallet + - alipay_hk + - alipay_hk_wap + - alipay_hk_web + - alipay_wap + - kcp_naverpay + - upi + - onlinebanking_IN + - wallet_IN + - entercash + - primeiropay_boleto + - gopay_wallet + - poli + - mada + - naps + - benefit + - knet + - fawry + - omannet + type: string + required: + - encryptedCardNumber + - encryptedExpiryMonth + - encryptedExpiryYear + title: Card + CellulantDetails: + additionalProperties: false + properties: + issuer: + description: The Cellulant issuer. + type: string + type: + default: cellulant + description: '**Cellulant**' + enum: + - cellulant + type: string + title: Cellulant + CheckoutAwaitAction: + additionalProperties: false + properties: + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + 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 + CheckoutBalanceCheckRequest: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + paymentMethod: + additionalProperties: + type: string + description: The collection that contains the type of the payment method + and its specific information. + type: object + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + - paymentMethod + CheckoutBalanceCheckResponse: + properties: + 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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + type: object + balance: + description: The balance for the payment method. + $ref: '#/components/schemas/Amount' + fraudResult: + description: The fraud result properties of the payment. + $ref: '#/components/schemas/FraudResult' + pspReference: + description: Adyen's 16-character reference associated with the transaction/request. + This value is globally unique; quote it when communicating with us about + this request. + 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. + + + For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' + type: string + resultCode: + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Success** \u2013 Indicates that the balance check was successful.\n\ + * **NotEnoughBalance** \u2013 Commonly indicates that the card did not\ + \ have enough balance to pay the amount in the request, or that the currency\ + \ of the balance on the card did not match the currency of the requested\ + \ amount.\n* **Failed** \u2013 Indicates that the balance check failed." + enum: + - Success + - NotEnoughBalance + - Failed + type: string + transactionLimit: + x-addedInVersion: '65' + description: The maximum spendable balance for a single transaction. Applicable + to some gift cards. + $ref: '#/components/schemas/Amount' + required: + - balance + - resultCode + CheckoutBankTransferAction: + additionalProperties: false + properties: + beneficiary: + description: The name of the account holder. + type: string + bic: + description: The BIC of the IBAN. + type: string + downloadUrl: + description: The url to download payment details with. + type: string + iban: + description: The IBAN of the bank transfer. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + reference: + description: The transfer reference. + type: string + shopperEmail: + description: The e-mail of the shopper, included if an e-mail was sent to + the shopper. + type: string + totalAmount: + description: The amount of the bank transfer. + $ref: '#/components/schemas/Amount' + type: + description: The type of the action. + enum: + - bankTransfer + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + CheckoutCancelOrderRequest: + properties: + merchantAccount: + description: The merchant account identifier that orderData belongs to. + type: string + order: + description: The order request object that contains a pspReference that + represents the order and the matching encrypted order data. + $ref: '#/components/schemas/CheckoutOrder' + required: + - order + - merchantAccount + CheckoutCancelOrderResponse: + properties: + pspReference: + description: A unique reference of the cancellation request. + type: string + resultCode: + description: "The result of the cancellation request.\n\nPossible values:\n\ + \n* **Received** \u2013 Indicates the cancellation has successfully been\ + \ received by Adyen, and will be processed." + enum: + - Received + type: string + required: + - pspReference + - resultCode + CheckoutCreateOrderRequest: + properties: + amount: + description: The total amount of the order. + $ref: '#/components/schemas/Amount' + expiresAt: + description: The date that order expires; e.g. 2019-03-23T12:25:28Z. If + not provided, the default expiry duration is 1 day. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the order. + type: string + reference: + description: A custom reference identifying the order. + type: string + required: + - merchantAccount + - amount + - reference + CheckoutCreateOrderResponse: + properties: + 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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + type: object + amount: + x-addedInVersion: '68' + description: The initial amount of the order. + $ref: '#/components/schemas/Amount' + expiresAt: + description: The date that the order will expire. + type: string + fraudResult: + description: The fraud result properties of the payment. + $ref: '#/components/schemas/FraudResult' + orderData: + description: The encrypted data that will be used by merchant for adding + payments to the order. + type: string + pspReference: + description: Adyen's 16-character reference associated with the transaction/request. + This value is globally unique; quote it when communicating with us about + this request. + type: string + reference: + description: The reference provided by merchant for creating the order. + 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. + + + For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).' + type: string + remainingAmount: + description: The remaining amount in the order. + $ref: '#/components/schemas/Amount' + resultCode: + description: "The result of the order creation request.\n The value is always\ + \ **Success**." + enum: + - Success + type: string + required: + - amount + - remainingAmount + - expiresAt + - orderData + - resultCode + CheckoutDonationAction: + additionalProperties: false + properties: + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + type: + description: The type of the action. + enum: + - donate + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + CheckoutOneTimePasscodeAction: + additionalProperties: false + properties: + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + type: string + paymentMethodType: + description: Specifies the payment method. + type: string + redirect: + description: When the payment flow requires a redirect as fallback, this + object contains information about the redirect. + $ref: '#/components/schemas/Redirect' + resendInterval: + description: The interval in second between OTP resend. + format: int32 + type: integer + resendMaxAttempts: + description: The maximum number of OTP resend attempts. + format: int32 + type: integer + resendUrl: + description: The URL, to which you make POST request to trigger OTP resend. + type: string + type: + description: The type of the action. + enum: + - oneTimePasscode + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + CheckoutOrder: + properties: + orderData: + description: The encrypted order data. + type: string + pspReference: + description: The `pspReference` that belongs to the order. + type: string + required: + - pspReference + - orderData + CheckoutOrderResponse: + properties: + amount: + description: The initial amount of the order. + $ref: '#/components/schemas/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: '#/components/schemas/Amount' + required: + - pspReference + CheckoutQrCodeAction: + additionalProperties: false + properties: + expiresAt: + x-addedInVersion: '68' + description: Expiry time of the QR code. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + 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 + 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 + CheckoutSDKAction: + additionalProperties: false + properties: + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + 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 + CheckoutThreeDS2Action: + additionalProperties: false + properties: + authorisationToken: + description: A token needed to authorise a payment. + type: string + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + 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 + CheckoutUtilityRequest: + properties: + originDomains: + description: The list of origin domains, for which origin keys are requested. + items: + type: string + type: array + required: + - originDomains + CheckoutUtilityResponse: + properties: + originKeys: + x-addedInVersion: '1' + additionalProperties: + type: string + description: The list of origin keys for all requested domains. For each + list item, the key is the domain and the value is the origin key. + 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: '#/components/schemas/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 + paymentData: + description: A value that must be submitted to the `/payments/details` endpoint + to verify this payment. + 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: '#/components/schemas/Amount' + totalAmount: + description: The total amount (initial plus surcharge amount). + $ref: '#/components/schemas/Amount' + type: + description: '**voucher**' + enum: + - voucher + type: string + url: + description: Specifies the URL to redirect to. + type: string + required: + - type + CommonField: + properties: + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + Company: + properties: + homepage: + description: The company website's home page. + type: string + name: + description: The company name. + type: string + registrationNumber: + description: Registration number of the company. + type: string + registryLocation: + description: Registry location of the company. + type: string + taxId: + description: Tax ID of the company. + type: string + type: + description: The company type. + type: string + Configuration: + properties: + avs: + description: Describes the configuration for AVS ([Address Verification + System](https://en.wikipedia.org/wiki/Address_Verification_System)). + $ref: '#/components/schemas/Avs' + cardHolderName: + x-addedInVersion: '37' + description: 'Determines whether the cardholder name should be provided + or not. + + + Permitted values: + + * NONE + + * OPTIONAL + + * REQUIRED' + enum: + - NONE + - OPTIONAL + - REQUIRED + type: string + installments: + description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/InstallmentsNumber' + shopperInput: + x-addedInVersion: '37' + description: Determines how to display the details fields. + $ref: '#/components/schemas/ShopperInput' + CreateCheckoutSessionRequest: + properties: + accountInfo: + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + allowedPaymentMethods: + description: 'List of payment methods to be presented to the shopper. To + refer to payment methods, use their `paymentMethod.type`from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"allowedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + amount: + description: The amount of the payment. + $ref: '#/components/schemas/Amount' + applicationInfo: + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + description: The address where to send the invoice. + $ref: '#/components/schemas/Address' + blockedPaymentMethods: + description: 'List of payment methods to be hidden from the shopper. To + refer to payment methods, use their `paymentMethod.type`from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"blockedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + captureDelayHours: + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + channel: + description: 'The platform where a payment transaction takes place. This + field is optional for filtering out payment methods that are only available + on specific platforms. If this value is not set, then we will try to infer + it from the `sdkVersion` or `token`. + + + Possible values: + + * iOS + + * Android + + * Web' + enum: + - iOS + - Android + - Web + type: string + company: + description: Information regarding the company. + $ref: '#/components/schemas/Company' + countryCode: + description: The shopper's two-letter country code. + type: string + dateOfBirth: + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + enableOneClick: + description: When true and `shopperReference` is provided, the shopper will + be asked if the payment details should be stored for future one-click + payments. + type: boolean + enablePayOut: + description: When true and `shopperReference` is provided, the payment details + will be tokenized for payouts. + type: boolean + enableRecurring: + description: When true and `shopperReference` is provided, the payment details + will be tokenized for recurring payments. + type: boolean + expiresAt: + description: The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. When not specified, the expiry date is set to 1 hour after session + creation. You cannot set the session expiry to more than 24 hours after + session creation. + format: date-time + type: string + lineItems: + description: 'Price and product information about the purchased items, to + be included on the invoice sent to the shopper. + + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' + items: + $ref: '#/components/schemas/LineItem' + type: array + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + metadata: + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request.* Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + type: string + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + recurringProcessingModel: + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + redirectFromIssuerMethod: + description: Specifies the redirect method (GET or POST) when redirecting + back from the issuer. + type: string + redirectToIssuerMethod: + description: Specifies the redirect method (GET or POST) when redirecting + to the issuer. + type: string + reference: + description: The reference to uniquely identify a payment. + type: string + returnUrl: + description: The URL to return to when a redirect payment is completed. + type: string + riskData: + description: Any risk-related settings to apply to the payment. + $ref: '#/components/schemas/RiskData' + shopperEmail: + description: The shopper's email address. + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + description: The shopper's full name. This object is required for some payment + methods such as AfterPay, Klarna, or if you're enrolled in the PayPal + Seller Protection program. + $ref: '#/components/schemas/Name' + shopperReference: + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + description: The shopper's social security number. + type: string + splitCardFundingSources: + default: false + description: Boolean value indicating whether the card payment method should + be split into separate debit and credit options. + type: boolean + splits: + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + storePaymentMethod: + description: When this is set to **true** and the `shopperReference` is + provided, the payment details will be stored. + type: boolean + telephoneNumber: + description: The shopper's telephone number. + type: string + threeDSAuthenticationOnly: + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + trustedShopper: + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - amount + - reference + - returnUrl + - merchantAccount + CreateCheckoutSessionResponse: + properties: + accountInfo: + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + allowedPaymentMethods: + description: 'List of payment methods to be presented to the shopper. To + refer to payment methods, use their `paymentMethod.type`from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"allowedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + amount: + description: The amount of the payment. + $ref: '#/components/schemas/Amount' + applicationInfo: + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + description: The address where to send the invoice. + $ref: '#/components/schemas/Address' + blockedPaymentMethods: + description: 'List of payment methods to be hidden from the shopper. To + refer to payment methods, use their `paymentMethod.type`from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"blockedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + captureDelayHours: + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + channel: + description: 'The platform where a payment transaction takes place. This + field is optional for filtering out payment methods that are only available + on specific platforms. If this value is not set, then we will try to infer + it from the `sdkVersion` or `token`. + + + Possible values: + + * iOS + + * Android + + * Web' + enum: + - iOS + - Android + - Web + type: string + company: + description: Information regarding the company. + $ref: '#/components/schemas/Company' + countryCode: + description: The shopper's two-letter country code. + type: string + dateOfBirth: + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + enableOneClick: + description: When true and `shopperReference` is provided, the shopper will + be asked if the payment details should be stored for future one-click + payments. + type: boolean + enablePayOut: + description: When true and `shopperReference` is provided, the payment details + will be tokenized for payouts. + type: boolean + enableRecurring: + description: When true and `shopperReference` is provided, the payment details + will be tokenized for recurring payments. + type: boolean + expiresAt: + description: The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) + format. When not specified, the expiry date is set to 1 hour after session + creation. You cannot set the session expiry to more than 24 hours after + session creation. + format: date-time + type: string + id: + description: A unique identifier of the session. + readOnly: true + type: string + lineItems: + description: 'Price and product information about the purchased items, to + be included on the invoice sent to the shopper. + + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' + items: + $ref: '#/components/schemas/LineItem' + type: array + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + metadata: + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request.* Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + type: string + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + recurringProcessingModel: + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + redirectFromIssuerMethod: + description: Specifies the redirect method (GET or POST) when redirecting + back from the issuer. + type: string + redirectToIssuerMethod: + description: Specifies the redirect method (GET or POST) when redirecting + to the issuer. + type: string + reference: + description: The reference to uniquely identify a payment. + type: string + returnUrl: + description: The URL to return to when a redirect payment is completed. + type: string + riskData: + description: Any risk-related settings to apply to the payment. + $ref: '#/components/schemas/RiskData' + sessionData: + type: string + shopperEmail: + description: The shopper's email address. + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + description: The shopper's full name. This object is required for some payment + methods such as AfterPay, Klarna, or if you're enrolled in the PayPal + Seller Protection program. + $ref: '#/components/schemas/Name' + shopperReference: + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + description: The shopper's social security number. + type: string + splitCardFundingSources: + default: false + description: Boolean value indicating whether the card payment method should + be split into separate debit and credit options. + type: boolean + splits: + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + storePaymentMethod: + description: When this is set to **true** and the `shopperReference` is + provided, the payment details will be stored. + type: boolean + telephoneNumber: + description: The shopper's telephone number. + type: string + threeDSAuthenticationOnly: + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + trustedShopper: + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - id + - amount + - reference + - returnUrl + - expiresAt + - merchantAccount + CreatePaymentAmountUpdateRequest: + properties: + amount: + description: The updated amount. The `currency` must match the currency + used in authorisation. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **delayedCharge**\ + \ \n* **noShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + splits: + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount + CreatePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreatePaymentCaptureRequest: + properties: + amount: + description: The amount that you want to capture. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the capture request. Maximum length: 80 + characters.' + type: string + splits: + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount + CreatePaymentLinkRequest: + properties: + allowedPaymentMethods: + description: 'List of payment methods to be presented to the shopper. To + refer to payment methods, use their `paymentMethod.type` from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"allowedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + amount: + description: The payment amount and currency. + $ref: '#/components/schemas/Amount' + applicationInfo: + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + description: The address where to send the invoice. + $ref: '#/components/schemas/Address' + blockedPaymentMethods: + description: 'List of payment methods to be hidden from the shopper. To + refer to payment methods, use their `paymentMethod.type` from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"blockedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + countryCode: + description: The shopper's two-letter country code. + type: string + deliverAt: + description: The date and time the purchased goods should be delivered. + format: date-time + type: string + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + description: + description: 'A short description visible on the payment page. + + Maximum length: 280 characters.' + type: string + expiresAt: + description: The date that the payment link expires, in ISO 8601 format. + For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum + expiry date should be 70 days from when the payment link is created. If + not provided, the default expiry is set to 24 hours after the payment + link is created. + type: string + installmentOptions: + additionalProperties: + $ref: '#/components/schemas/InstallmentOption' + description: A set of key-value pairs that specifies the installment options + available per payment method. The key must be a payment method name in + lowercase. For example, **card** to specify installment options for all + cards, or **visa** or **mc**. The value must be an object containing the + installment options. + type: object + lineItems: + description: 'Price and product information about the purchased items, to + be included on the invoice sent to the shopper. + + This parameter is required for open invoice (_buy now, pay later_) payment + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' + items: + $ref: '#/components/schemas/LineItem' + type: array + merchantAccount: + description: The merchant account identifier for which the payment link + is created. + type: string + merchantOrderReference: + description: This reference allows linking multiple transactions to each + other for reporting purposes (for example, order auth-rate). The reference + should be unique per billing cycle. + type: string + metadata: + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limitations: + + * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: + "Metadata size exceeds limit" + + * Maximum 20 characters per key. Otherwise, error "178" occurs: "Metadata + key size exceeds limit" + + * A key cannot have the name `checkout.linkId`. Any value that you provide + with this key is going to be replaced by the real payment link ID.' + type: object + recurringProcessingModel: + description: "Defines a recurring payment type.\nPossible values:\n* **Subscription**\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* **CardOnFile** \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* **UnscheduledCardOnFile**\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or has variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + reference: + description: A reference that is used to uniquely identify the payment in + future communications about the payment status. + type: string + requiredShopperFields: + x-addedInVersion: '67' + description: "List of fields that the shopper has to provide on the payment\ + \ page before completing the payment. For more information, refer to [Provide\ + \ shopper information](https://docs.adyen.com/online-payments/pay-by-link/api#shopper-information).\n\ + \nPossible values:\n* **billingAddress** \u2013 The address where to send\ + \ the invoice.\n* **deliveryAddress** \u2013 The address where the purchased\ + \ goods should be delivered.\n* **shopperEmail** \u2013 The shopper's\ + \ email address.\n* **shopperName** \u2013 The shopper's full name.\n\ + * **telephoneNumber** \u2013 The shopper's phone number.\n" + items: + enum: + - billingAddress + - deliveryAddress + - shopperEmail + - shopperName + - telephoneNumber + type: string + type: array + returnUrl: + description: 'Website URL used for redirection after payment is completed. + + If provided, a **Continue** button will be shown on the payment page. + If shoppers select the button, they are redirected to the specified URL.' + type: string + reusable: + description: Indicates whether the payment link can be reused for multiple + payments. If not provided, this defaults to **false** which means the + link can be used for one successful payment only. + type: boolean + riskData: + x-addedInVersion: '65' + description: Any risk-related settings to apply to the payment. + $ref: '#/components/schemas/RiskData' + shopperEmail: + description: The shopper's email address. + type: string + shopperLocale: + description: 'The language to be used in the payment page, specified by + a combination of a language and country code. For example, `en-US`. + + + For a list of shopper locales that Pay by Link supports, refer to [Language + and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + type: string + shopperName: + description: The shopper's full name. This object is required for some payment + methods such as AfterPay, Klarna, or if you're enrolled in the PayPal + Seller Protection program. + $ref: '#/components/schemas/Name' + shopperReference: + description: 'Your reference to uniquely identify this shopper, for example + user ID or account ID. Minimum length: 3 characters. + + > Your reference must not include personally identifiable information + (PII), for example name or email address.' + type: string + splits: + description: An array of objects specifying how the payment should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + store: + description: The physical store, for which this payment is processed. + type: string + storePaymentMethodMode: + x-addedInVersion: '68' + description: "Indicates if the details of the payment method will be stored\ + \ for the shopper. Possible values:* **disabled** \u2013 No details will\ + \ be stored.* **askForConsent** \u2013 If the `shopperReference` is provided\ + \ the shopper can decide whether or not the details will be stored.* **enabled**\ + \ \u2013 If the `shopperReference` is provided the details will be stored\ + \ without asking consent to the shopper." + enum: + - askForConsent + - disabled + - enabled + type: string + telephoneNumber: + x-addedInVersion: '68' + description: The shopper's telephone number. + type: string + themeId: + x-addedInVersion: '67' + description: Use to set a theme to shopper other than default + type: string + required: + - amount + - reference + - merchantAccount + CreatePaymentRefundRequest: + properties: + amount: + description: The amount that you want to refund. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the refund request. Maximum length: 80 + characters.' + type: string + splits: + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + required: + - merchantAccount + - amount + CreatePaymentReversalRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + reference: + description: 'Your reference for the reversal request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + CreateStandalonePaymentCancelRequest: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment that you want to cancel. + type: string + reference: + description: 'Your reference for the cancel request. Maximum length: 80 + characters.' + type: string + required: + - merchantAccount + - paymentReference + DetailsRequest: + properties: + details: + description: Use this collection to submit the details that were returned + as a result of the `/payments` call. + $ref: '#/components/schemas/PaymentCompletionDetails' + paymentData: + description: 'The `paymentData` value from the `/payments` response. Required + if the `/payments` response returns this value. ' + maxLength: 100000 + type: string + threeDSAuthenticationOnly: + x-addedInVersion: '40' + description: Change the `authenticationOnly` indicator originally set in + the `/payments` request. Only needs to be set if you want to modify the + value set previously. + type: boolean + required: + - details + DeviceRenderOptions: + properties: + sdkInterface: + default: both + description: 'Supported SDK interface types. + + Allowed values: + + * native + + * html + + * both' + enum: + - native + - html + - both + type: string + sdkUiType: + default: + - + description: 'UI types supported for displaying specific challenges. + + Allowed values: + + * text + + * singleSelect + + * outOfBand + + * otherHtml + + * multiSelect' + items: + enum: + - multiSelect + - otherHtml + - outOfBand + - singleSelect + - text + type: string + type: array + DokuDetails: + additionalProperties: false + properties: + firstName: + description: The shopper's first name. + type: string + lastName: + description: The shopper's last name. + type: string + shopperEmail: + description: The shopper's email. + type: string + type: + description: '**doku**' + enum: + - doku_mandiri_va + - doku_cimb_va + - doku_danamon_va + - doku_bni_va + - doku_permata_lite_atm + - doku_bri_va + - doku_bca_va + - doku_alfamart + - doku_indomaret + type: string + required: + - type + - firstName + - lastName + - shopperEmail + title: Doku + DonationResponse: + properties: + amount: + x-addedInVersion: '67' + description: Authorised amount in the transaction. + $ref: '#/components/schemas/Amount' + donationAccount: + x-addedInVersion: '67' + 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: + x-addedInVersion: '67' + description: Your unique resource identifier. + type: string + merchantAccount: + x-addedInVersion: '67' + description: The merchant account identifier, with which you want to process + the transaction. + type: string + payment: + x-addedInVersion: '67' + description: Action to be taken for completing the payment. + $ref: '#/components/schemas/PaymentResponse' + reference: + x-addedInVersion: '67' + 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: + x-addedInVersion: '67' + description: 'The status of the donation transaction. + + + Possible values: + + * **completed** + + * **pending** + + * **refused**' + enum: + - completed + - pending + - refused + type: string + DotpayDetails: + additionalProperties: false + properties: + issuer: + description: The Dotpay issuer value of the shopper's selected bank. Set + this to an **id** of a Dotpay issuer to preselect it. + type: string + type: + default: dotpay + description: '**dotpay**' + enum: + - dotpay + type: string + required: + - issuer + title: Dotpay + DragonpayDetails: + additionalProperties: false + properties: + issuer: + description: The Dragonpay issuer value of the shopper's selected bank. + Set this to an **id** of a Dragonpay issuer to preselect it. + type: string + shopperEmail: + description: "The shopper\u2019s email address." + type: string + type: + description: '**dragonpay**' + enum: + - dragonpay_ebanking + - dragonpay_otc_banking + - dragonpay_otc_non_banking + - dragonpay_otc_philippines + type: string + required: + - type + - issuer + title: Dragonpay + EcontextVoucherDetails: + additionalProperties: false + properties: + firstName: + description: The shopper's first name. + type: string + lastName: + description: The shopper's last name. + type: string + shopperEmail: + description: The shopper's email. + type: string + telephoneNumber: + description: The shopper's contact number. It must have an international + number format, for example **+31 20 779 1846**. Formats like **+31 (0)20 + 779 1846** or **0031 20 779 1846** are not accepted. + type: string + type: + description: '**econtextvoucher**' + enum: + - econtext_seveneleven + - econtext_stores + type: string + required: + - type + - firstName + - lastName + - shopperEmail + - telephoneNumber + title: Voucher + ExternalPlatform: + properties: + integrator: + description: External platform integrator. + type: string + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + ForexQuote: + properties: + account: + description: The account name. + type: string + accountType: + description: The account type. + type: string + baseAmount: + description: The base amount. + $ref: '#/components/schemas/Amount' + basePoints: + description: The base points. + format: int32 + type: integer + buy: + description: The buy rate. + $ref: '#/components/schemas/Amount' + interbank: + description: The interbank amount. + $ref: '#/components/schemas/Amount' + reference: + description: The reference assigned to the forex quote request. + type: string + sell: + description: The sell rate. + $ref: '#/components/schemas/Amount' + signature: + description: The signature to validate the integrity. + type: string + source: + description: The source of the forex quote. + type: string + type: + description: The type of forex. + type: string + validTill: + description: The date until which the forex quote is valid. + format: date-time + type: string + required: + - validTill + - basePoints + 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 + 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: '#/components/schemas/FraudCheckResult' + type: array + required: + - accountScore + GenericIssuerPaymentMethodDetails: + additionalProperties: false + properties: + issuer: + description: The issuer id of the shopper's selected bank. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + description: '**genericissuer**' + enum: + - eps + type: string + required: + - type + - issuer + title: Stored Payment Method + GiropayDetails: + additionalProperties: false + properties: + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: giropay + description: '**giropay**' + enum: + - giropay + type: string + title: Giropay + GooglePayDetails: + additionalProperties: false + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: googlepay + description: '**googlepay**, **paywithgoogle**' + enum: + - googlepay + type: string + required: + - googlePayToken + title: Google Pay + IdealDetails: + additionalProperties: false + properties: + issuer: + description: The iDEAL issuer value of the shopper's selected bank. Set + this to an **id** of an iDEAL issuer to preselect it. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ideal + description: '**ideal**' + enum: + - ideal + type: string + required: + - issuer + title: iDEAL + InputDetail: + properties: + configuration: + additionalProperties: + type: string + description: Configuration parameters for the required input. + type: object + details: + description: Input details can also be provided recursively. + items: + $ref: '#/components/schemas/SubInputDetail' + type: array + inputDetails: + deprecated: true + description: Input details can also be provided recursively (deprecated). + items: + $ref: '#/components/schemas/SubInputDetail' + type: array + itemSearchUrl: + description: In case of a select, the URL from which to query the items. + type: string + items: + description: In case of a select, the items to choose from. + items: + $ref: '#/components/schemas/Item' + type: array + key: + description: The value to provide in the result. + type: string + optional: + description: True if this input value is optional. + type: boolean + type: + description: The type of the required input. + type: string + value: + description: The value can be pre-filled, if available. + type: string + InstallmentOption: + properties: + maxValue: + description: The maximum number of installments offered for this payment + method. + format: int32 + type: integer + plans: + x-addedInVersion: '64' + description: 'Defines the type of installment plan. If not set, defaults + to **regular**. + + + Possible values: + + * **regular** + + * **revolving**' + items: + enum: + - regular + - revolving + type: string + type: array + preselectedValue: + x-addedInVersion: '64' + description: Preselected number of installments offered for this payment + method. + format: int32 + type: integer + values: + x-addedInVersion: '64' + description: An array of the number of installments that the shopper can + choose from. For example, **[2,3,5]**. This cannot be specified simultaneously + with `maxValue`. + items: + format: int32 + type: integer + type: array + Installments: + properties: + plan: + x-addedInVersion: '64' + description: 'Defines the type of installment plan. If not set, defaults + to **regular**. + + + Possible values: + + * **regular** + + * **revolving**' + enum: + - regular + - revolving + type: string + value: + description: 'Defines the number of installments. Its value needs to be + greater than zero. + + + Usually, the maximum allowed number of installments is capped. For example, + it may not be possible to split a payment in more than 24 installments. + The acquirer sets this upper limit, so its value may vary.' + format: int32 + type: integer + required: + - value + InstallmentsNumber: + properties: + maxNumberOfInstallments: + description: Maximum number of installments + format: int32 + type: integer + required: + - maxNumberOfInstallments + Item: + properties: + id: + description: The value to provide in the result. + type: string + name: + description: The display name. + type: string + KlarnaDetails: + additionalProperties: false + properties: + billingAddress: + description: The address where to send the invoice. + type: string + deliveryAddress: + description: The address where the goods should be delivered. + type: string + personalDetails: + description: Shopper name, date of birth, phone number, and email address. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: klarna + description: '**klarna**' + enum: + - klarna + - klarnapayments + - klarnapayments_account + - klarnapayments_b2b + - klarna_paynow + - klarna_account + - klarna_b2b + type: string + required: + - type + title: Klarna + LianLianPayDetails: + additionalProperties: false + properties: + telephoneNumber: + description: '' + type: string + type: + description: '**lianlianpay**' + enum: + - lianlianpay_ebanking_enterprise + - lianlianpay_ebanking_credit + - lianlianpay_ebanking_debit + type: string + required: + - type + - telephoneNumber + title: Lianlian Pay + LineItem: + properties: + amountExcludingTax: + description: Item amount excluding the tax, in minor units. + format: int64 + type: integer + amountIncludingTax: + description: Item amount including the tax, in minor units. + format: int64 + type: integer + description: + description: Description of the line item. + type: string + id: + description: ID of the line item. + type: string + imageUrl: + description: Link to the picture of the purchased item. + type: string + itemCategory: + description: Item category, used by the RatePay payment method. + type: string + productUrl: + description: Link to the purchased item. + type: string + quantity: + description: Number of items. + format: int64 + type: integer + taxAmount: + description: Tax amount, in minor units. + format: int64 + type: integer + taxPercentage: + description: Tax percentage, in minor units. + format: int64 + type: integer + Mandate: + properties: + amount: + description: The billing amount(in minor units) of the recurring transactions. + type: string + amountRule: + description: "The limitation rule of the billing amount.\n\nPossible values:\n\ + \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ + \ **exact**: The transaction amount should be the same as the `amount`.\n\ + \n" + enum: + - max + - exact + type: string + billingAttemptsRule: + description: "The rule to specify the period, within which the recurring\ + \ debit can happen, relative to the mandate recurring date.\n\nPossible\ + \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ + \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ + \n" + enum: + - 'on' + - before + - after + type: string + billingDay: + description: 'The number of the day, on which the recurring debit can happen. + Should be within the same calendar month as the mandate recurring date. + + + Possible values: 1-31 based on the `frequency`.' + type: string + endsAt: + description: End date of the billing plan, in YYYY-MM-DD format. + type: string + frequency: + description: 'The frequency with which a shopper should be charged. + + + Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, + **halfYearly**, **yearly**.' + enum: + - adhoc + - daily + - weekly + - biWeekly + - monthly + - quarterly + - halfYearly + - yearly + type: string + remarks: + description: The message shown by UPI to the shopper on the approval screen. + type: string + startsAt: + description: Start date of the billing plan, in YYYY-MM-DD format. By default, + the transaction date. + type: string + required: + - frequency + - amount + - endsAt + MasterpassDetails: + additionalProperties: false + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + masterpassTransactionId: + description: The Masterpass transaction ID. + type: string + type: + default: masterpass + description: '**masterpass**' + enum: + - masterpass + type: string + required: + - masterpassTransactionId + title: Masterpass + MbwayDetails: + additionalProperties: false + properties: + shopperEmail: + description: '' + type: string + telephoneNumber: + description: '' + type: string + type: + default: mbway + description: '**mbway**' + enum: + - mbway + type: string + required: + - telephoneNumber + - shopperEmail + title: MBWay + MerchantDevice: + properties: + os: + description: Operating system running on the merchant device. + type: string + osVersion: + description: Version of the operating system on the merchant device. + type: string + reference: + description: Merchant device reference. + type: string + MerchantRiskIndicator: + properties: + addressMatch: + description: Whether the chosen delivery address is identical to the billing + address. + type: boolean + deliveryAddressIndicator: + description: 'Indicator regarding the delivery address. + + Allowed values: + + * `shipToBillingAddress` + + * `shipToVerifiedAddress` + + * `shipToNewAddress` + + * `shipToStore` + + * `digitalGoods` + + * `goodsNotShipped` + + * `other`' + enum: + - shipToBillingAddress + - shipToVerifiedAddress + - shipToNewAddress + - shipToStore + - digitalGoods + - goodsNotShipped + - other + type: string + deliveryEmail: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `deliveryEmailAddress` instead. + description: The delivery email address (for digital goods). + type: string + deliveryEmailAddress: + x-addedInVersion: '68' + description: 'For Electronic delivery, the email address to which the merchandise + was delivered. Maximum length: 254 characters.' + maxLength: 254 + type: string + deliveryTimeframe: + description: 'The estimated delivery time for the shopper to receive the + goods. + + Allowed values: + + * `electronicDelivery` + + * `sameDayShipping` + + * `overnightShipping` + + * `twoOrMoreDaysShipping`' + enum: + - electronicDelivery + - sameDayShipping + - overnightShipping + - twoOrMoreDaysShipping + type: string + giftCardAmount: + description: For prepaid or gift card purchase, the purchase amount total + of prepaid or gift card(s). + $ref: '#/components/schemas/Amount' + giftCardCount: + description: For prepaid or gift card purchase, total count of individual + prepaid or gift cards/codes purchased. + format: int32 + type: integer + giftCardCurr: + x-addedInVersion: '68' + description: For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) + three-digit currency code of the gift card, other than those listed in + Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification. + type: string + preOrderDate: + description: For pre-order purchases, the expected date this product will + be available to the shopper. + format: date-time + type: string + preOrderPurchase: + description: Indicator for whether this transaction is for pre-ordering + a product. + type: boolean + preOrderPurchaseInd: + x-addedInVersion: '68' + description: Indicates whether Cardholder is placing an order for merchandise + with a future availability or release date. + type: string + reorderItems: + description: Indicator for whether the shopper has already purchased the + same items in the past. + type: boolean + reorderItemsInd: + x-addedInVersion: '68' + description: Indicates whether the cardholder is reordering previously purchased + merchandise. + type: string + shipIndicator: + x-addedInVersion: '68' + description: Indicates shipping method chosen for the transaction. + type: string + MobilePayDetails: + additionalProperties: false + properties: + type: + default: mobilepay + description: '**mobilepay**' + enum: + - mobilepay + type: string + title: MobilePay + MolPayDetails: + additionalProperties: false + properties: + issuer: + description: The shopper's bank. Specify this with the issuer value that + corresponds to this bank. + type: string + type: + description: '**molpay**' + enum: + - molpay_ebanking_fpx_MY + - molpay_ebanking_TH + type: string + required: + - type + - issuer + title: MOLPay + Name: + properties: + firstName: + description: The first name. + type: string + lastName: + description: The last name. + type: string + required: + - firstName + - lastName + OpenInvoiceDetails: + additionalProperties: false + properties: + billingAddress: + description: The address where to send the invoice. + type: string + deliveryAddress: + description: The address where the goods should be delivered. + type: string + personalDetails: + description: Shopper name, date of birth, phone number, and email address. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: openinvoice + description: '**openinvoice**' + enum: + - openinvoice + type: string + title: Open Invoice + PayPalDetails: + additionalProperties: false + properties: + orderID: + description: The unique ID associated with the order. + type: string + payerID: + description: The unique ID associated with the payer. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + subtype: + description: The type of flow to initiate. + enum: + - redirect + - sdk + type: string + type: + default: paypal + description: '**paypal**' + enum: + - paypal + type: string + required: + - type + title: PayPal + PayUUpiDetails: + additionalProperties: false + properties: + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used for recurring payment only. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: payu_IN_upi + description: '**payu_IN_upi**' + enum: + - payu_IN_upi + type: string + virtualPaymentAddress: + description: The virtual payment address for UPI. + type: string + required: + - type + title: PayU + PayWithGoogleDetails: + additionalProperties: false + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + googlePayToken: + description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) + `PaymentData` response. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: paywithgoogle + description: '**paywithgoogle**' + enum: + - paywithgoogle + type: string + required: + - googlePayToken + title: Google Pay + PaymentAmountUpdateResource: + properties: + amount: + description: The updated amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to update. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the amount update + request. + type: string + reason: + description: "The reason for the amount update. Possible values: \n* **DelayedCharge**\ + \ \n* **NoShow**" + enum: + - delayedCharge + - noShow + type: string + reference: + description: 'Your reference for the amount update request. Maximum length: + 80 characters.' + type: string + splits: + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - reference + - pspReference + - paymentPspReference + PaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to cancel. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - paymentPspReference + - pspReference + PaymentCaptureResource: + properties: + amount: + description: The captured amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to capture. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the capture + request. + type: string + reference: + description: Your reference for the capture request. + type: string + splits: + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + PaymentCompletionDetails: + properties: + MD: + description: A payment session identifier returned by the card issuer. + maxLength: 20000 + type: string + PaReq: + description: (3D) Payment Authentication Request data for the card issuer. + type: string + PaRes: + description: (3D) Payment Authentication Response data by the card issuer. + maxLength: 20000 + type: string + billingToken: + description: PayPal-generated token for recurring payments. + type: string + cupsecureplus.smscode: + description: The SMS verification code collected from the shopper. + type: string + facilitatorAccessToken: + description: PayPal-generated third party access token. + type: string + oneTimePasscode: + description: A random number sent to the mobile phone number of the shopper + to verify the payment. + type: string + orderID: + description: PayPal-assigned ID for the order. + type: string + payerID: + description: PayPal-assigned ID for the payer (shopper). + type: string + payload: + description: Payload appended to the `returnURL` as a result of the redirect. + maxLength: 20000 + type: string + paymentID: + description: PayPal-generated ID for the payment. + type: string + paymentStatus: + description: 'Value passed from the WeChat MiniProgram `wx.requestPayment` + **complete** callback. Possible values: any value starting with `requestPayment:`.' + type: string + redirectResult: + description: The result of the redirect as appended to the `returnURL`. + maxLength: 20000 + type: string + threeDSResult: + description: 'Base64-encoded string returned by the Component after the + challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.' + maxLength: 50000 + type: string + threeds2.challengeResult: + description: 'Base64-encoded string returned by the Component after the + challenge flow. It contains the following parameter: `transStatus`.' + maxLength: 50000 + type: string + threeds2.fingerprint: + description: 'Base64-encoded string returned by the Component after the + challenge flow. It contains the following parameter: `threeDSCompInd`.' + maxLength: 100000 + type: string + PaymentDetails: + additionalProperties: false + properties: + type: + description: The payment method type. + enum: + - alipay + - multibanco + - bankTransfer_IBAN + - paybright + - affirm + - oney + - facilypay + - facilypay_3x + - facilypay_4x + - facilypay_6x + - facilypay_10x + - facilypay_12x + - unionpay + - kcp_banktransfer + - kcp_payco + - kcp_creditcard + - wechatpaySDK + - wechatpayQR + - wechatpayWeb + - payu_IN_cashcard + - payu_IN_nb + - molpay_ebanking_VN + - openbanking_UK + - ebanking_FI + - molpay_ebanking_MY + - molpay_ebanking_direct_MY + - swish + - twint + - pix + - molpay_fpx + - konbini + - directEbanking + - boletobancario + - neteller + - dana + - paysafecard + - cashticket + - isracard + - ikano + - karenmillen + - oasis + - warehouse + type: string + title: Payment Details + PaymentDetailsResponse: + properties: + 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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + 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 used during the /payments request. + type: string + order: + description: Contains updated information regarding the order in case order + information was provided in the request. + $ref: '#/components/schemas/CheckoutOrderResponse' + paymentMethod: + description: The payment method used in the transaction. + type: string + 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. + 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. + + + For 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** \u2013 The payment\ + \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ + \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ + \ \u2013 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** \u2013 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** \u2013 Indicates the\ + \ payment has been cancelled (either by the shopper or the merchant) before\ + \ processing was completed. This is a final state.\n* **ChallengeShopper**\ + \ \u2013 The issuer requires further shopper interaction before the payment\ + \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ + \ \u2013 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** \u2013 The issuer requires the shopper's device\ + \ fingerprint before the payment can be authenticated. Returned for 3D\ + \ Secure 2 transactions.\n* **Pending** \u2013 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** \u2013 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** \u2013\ + \ Indicates the payment has successfully been received by Adyen, and will\ + \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ + \ \u2013 Indicates the shopper should be redirected to an external web\ + \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ + \ the payment was refused. The reason is given in the `refusalReason`\ + \ field. This is a final state." + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused + - Success + type: string + shopperLocale: + description: The shopperLocale. + 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 + PaymentDonationRequest: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + channel: + description: 'The platform where a payment transaction takes place. This + field is optional for filtering out payment methods that are only available + on specific platforms. If this value is not set, then we will try to infer + it from the `sdkVersion` or `token`. + + + Possible values: + + * iOS + + * Android + + * Web' + enum: + - iOS + - Android + - Web + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: Checkout attempt ID that corresponds to the Id generated for + tracking user payment journey. + type: string + company: + x-addedInVersion: '32' + description: Information regarding the company. + $ref: '#/components/schemas/Company' + conversionId: + x-addedInVersion: '49' + description: Conversion ID that corresponds to the Id generated for tracking + user payment journey. + type: string + countryCode: + description: 'The shopper country. + + + Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + + Example: NL or DE' + type: string + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + donationAccount: + description: Donation account to which the transaction is credited. + type: string + donationOriginalPspReference: + description: PSP reference of the transaction from which the donation token + is generated. + type: string + donationToken: + description: Donation token received in the `/payments` call. + type: string + enableOneClick: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the shopper will + be asked if the payment details should be stored for future one-click + payments. + type: boolean + enablePayOut: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the payment details + will be tokenized for payouts. + type: boolean + enableRecurring: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the payment details + will be tokenized for recurring payments. + type: boolean + entityType: + x-addedInVersion: '24' + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + lineItems: + x-addedInVersion: '32' + description: 'Price and product information about the purchased items, to + be included on the invoice sent to the shopper. + + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' + items: + $ref: '#/components/schemas/LineItem' + type: array + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + order: + description: Contains the order information which is required for partial + payments. + $ref: '#/components/schemas/CheckoutOrder' + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + origin: + x-addedInVersion: '40' + description: 'Required for the 3D Secure 2 `channel` **Web** integration. + + + Set this parameter to the origin URL of the page that you are loading + the 3D Secure Component from.' + maxLength: 8000 + type: string + paymentMethod: + description: The type and required details of a payment method to use. + oneOf: + - $ref: '#/components/schemas/AchDetails' + - $ref: '#/components/schemas/AfterpayDetails' + - $ref: '#/components/schemas/AmazonPayDetails' + - $ref: '#/components/schemas/AndroidPayDetails' + - $ref: '#/components/schemas/ApplePayDetails' + - $ref: '#/components/schemas/BacsDirectDebitDetails' + - $ref: '#/components/schemas/BillDeskDetails' + - $ref: '#/components/schemas/BlikDetails' + - $ref: '#/components/schemas/CardDetails' + - $ref: '#/components/schemas/CellulantDetails' + - $ref: '#/components/schemas/DokuDetails' + - $ref: '#/components/schemas/DotpayDetails' + - $ref: '#/components/schemas/DragonpayDetails' + - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' + - $ref: '#/components/schemas/GiropayDetails' + - $ref: '#/components/schemas/GooglePayDetails' + - $ref: '#/components/schemas/IdealDetails' + - $ref: '#/components/schemas/KlarnaDetails' + - $ref: '#/components/schemas/LianLianPayDetails' + - $ref: '#/components/schemas/MasterpassDetails' + - $ref: '#/components/schemas/MbwayDetails' + - $ref: '#/components/schemas/MobilePayDetails' + - $ref: '#/components/schemas/MolPayDetails' + - $ref: '#/components/schemas/OpenInvoiceDetails' + - $ref: '#/components/schemas/PayPalDetails' + - $ref: '#/components/schemas/PayUUpiDetails' + - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/PaymentDetails' + - $ref: '#/components/schemas/RatepayDetails' + - $ref: '#/components/schemas/SamsungPayDetails' + - $ref: '#/components/schemas/SepaDirectDebitDetails' + - $ref: '#/components/schemas/StoredPaymentMethodDetails' + - $ref: '#/components/schemas/UpiDetails' + - $ref: '#/components/schemas/VippsDetails' + - $ref: '#/components/schemas/VisaCheckoutDetails' + - $ref: '#/components/schemas/WeChatPayDetails' + - $ref: '#/components/schemas/WeChatPayMiniProgramDetails' + - $ref: '#/components/schemas/ZipDetails' + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + type: string + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + redirectFromIssuerMethod: + x-addedInVersion: '32' + description: Specifies the redirect method (GET or POST) when redirecting + back from the issuer. + type: string + redirectToIssuerMethod: + x-addedInVersion: '32' + description: Specifies the redirect method (GET or POST) when redirecting + to the issuer. + type: string + 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 + returnUrl: + description: 'The URL to return to in case of a redirection. + + The format depends on the channel. This URL can have a maximum of 1024 + characters. + + * For web, include the protocol `http://` or `https://`. You can also + include your own additional query parameters, for example, shopper ID + or order reference number. + + Example: `https://your-company.com/checkout?shopperOrder=12xy` + + * For iOS, use the custom URL for your app. To know more about setting + custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). + + Example: `my-app://` + + * For Android, use a custom URL handled by an Activity on your app. You + can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). + + Example: `my-app://your.package.name`' + maxLength: 8000 + type: string + riskData: + description: Contains risk data, such as client-side data, used to identify + risk for a transaction. + $ref: '#/components/schemas/RiskData' + sessionValidity: + description: 'The date and time until when the session remains valid, in + [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. + + + For example: 2020-07-18T15:42:40.428+01:00' + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + storePaymentMethod: + x-addedInVersion: '49' + description: When true and `shopperReference` is provided, the payment details + will be stored. + type: boolean + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + - returnUrl + - paymentMethod + - donationAccount + PaymentLinkResource: + properties: + allowedPaymentMethods: + description: 'List of payment methods to be presented to the shopper. To + refer to payment methods, use their `paymentMethod.type` from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"allowedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + amount: + description: The payment amount and currency. + $ref: '#/components/schemas/Amount' + applicationInfo: + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + description: The address where to send the invoice. + $ref: '#/components/schemas/Address' + blockedPaymentMethods: + description: 'List of payment methods to be hidden from the shopper. To + refer to payment methods, use their `paymentMethod.type` from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"blockedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + countryCode: + description: The shopper's two-letter country code. + type: string + deliverAt: + description: The date and time the purchased goods should be delivered. + In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. + format: date-time + type: string + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + description: + description: 'A short description visible on the payment page. + + Maximum length: 280 characters.' + type: string + expiresAt: + description: The date that the payment link expires, in ISO 8601 format. + For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum + expiry date should be 70 days from when the payment link is created. If + not provided, the default expiry is set to 24 hours after the payment + link is created. + type: string + id: + x-addedInVersion: '51' + description: A unique identifier of the payment link. + readOnly: true + type: string + lineItems: + description: 'Price and product information about the purchased items, to + be included on the invoice sent to the shopper. + + This parameter is required for open invoice (_buy now, pay later_) payment + methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.' + items: + $ref: '#/components/schemas/LineItem' + type: array + merchantAccount: + description: The merchant account identifier for which the payment link + is created. + type: string + merchantOrderReference: + description: This reference allows linking multiple transactions to each + other for reporting purposes (for example, order auth-rate). The reference + should be unique per billing cycle. + type: string + metadata: + x-addedInVersion: '68' + additionalProperties: + type: string + description: Metadata settings to apply to the payment. + type: object + recurringProcessingModel: + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or has variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + reference: + description: A reference that is used to uniquely identify the payment in + future communications about the payment status. + type: string + returnUrl: + description: 'Website URL used for redirection after payment is completed. + + If provided, a **Continue** button will be shown on the payment page. + If shoppers select the button, they are redirected to the specified URL.' + type: string + reusable: + description: Indicates whether the payment link can be reused for multiple + payments. If not provided, this defaults to **false** which means the + link can be used for one successful payment only. + type: boolean + riskData: + x-addedInVersion: '65' + description: Any risk-related settings to apply to the payment. + $ref: '#/components/schemas/RiskData' + shopperEmail: + description: The shopper's email address. + type: string + shopperLocale: + description: 'The language to be used in the payment page, specified by + a combination of a language and country code. For example, `en-US`. + + + For a list of shopper locales that Pay by Link supports, refer to [Language + and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).' + type: string + shopperName: + description: The shopper's full name. This object is required for some payment + methods such as AfterPay, Klarna, or if you're enrolled in the PayPal + Seller Protection program. + $ref: '#/components/schemas/Name' + shopperReference: + description: A unique identifier for the shopper (for example, user ID or + account ID). + type: string + splits: + description: An array of objects specifying how the payment should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: 'Status of the payment link. Possible values: + + * **active** + + * **expired** + + * **paymentPending** (v68 and later) + + * **completed** (v66 and later) + + * **paid** (v65 and earlier)' + enum: + - active + - completed + - expired + - paymentPending + type: string + store: + description: The physical store, for which this payment is processed. + type: string + storePaymentMethodMode: + x-addedInVersion: '68' + description: "Indicates if the details of the payment method will be stored\ + \ for the shopper. Possible values:* **disabled** \u2013 No details will\ + \ be stored.* **askForConsent** \u2013 If the `shopperReference` is provided\ + \ the shopper can decide whether or not the details will be stored.* **enabled**\ + \ \u2013 If the `shopperReference` is provided the details will be stored\ + \ without asking consent to the shopper." + enum: + - askForConsent + - disabled + - enabled + type: string + telephoneNumber: + x-addedInVersion: '68' + description: The shopper's telephone number. + type: string + themeId: + x-addedInVersion: '67' + description: A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/api#themes) + to customize the appearance of the payment page.If not specified, the + payment page is rendered according to the theme set as default in your + Customer Area. + type: string + url: + description: The URL at which the shopper can complete the payment. + readOnly: true + type: string + required: + - amount + - reference + - merchantAccount + - id + - url + - status + PaymentMethod: + properties: + brand: + x-addedInVersion: '65' + description: 'Brand for the selected gift card. For example: plastix, hmclub.' + type: string + brands: + x-addedInVersion: '49' + description: 'List of possible brands. For example: visa, mc.' + items: + type: string + type: array + configuration: + additionalProperties: + type: string + description: The configuration of the payment method. + type: object + fundingSource: + x-addedInVersion: '53' + description: The funding source of the payment method. + enum: + - debit + type: string + group: + description: The group where this payment method belongs to. + $ref: '#/components/schemas/PaymentMethodGroup' + inputDetails: + deprecated: true + description: All input details to be provided to complete the payment with + this payment method. + items: + $ref: '#/components/schemas/InputDetail' + type: array + issuers: + x-addedInVersion: '68' + description: A list of issuers for this payment method. + items: + $ref: '#/components/schemas/PaymentMethodIssuer' + type: array + name: + description: The displayable name of this payment method. + type: string + type: + description: The unique payment method code. + type: string + PaymentMethodGroup: + properties: + name: + description: The name of the group. + type: string + paymentMethodData: + description: Echo data to be used if the payment method is displayed as + part of this group. + type: string + type: + description: The unique code of the group. + type: string + PaymentMethodIssuer: + properties: + disabled: + default: false + description: A boolean value indicating whether this issuer is unavailable. + Can be `true` whenever the issuer is offline. + type: boolean + id: + description: The unique identifier of this issuer, to submit in requests + to /payments. + type: string + name: + description: A localized name of the issuer. + type: string + required: + - id + - name + PaymentMethodsRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + allowedPaymentMethods: + x-addedInVersion: '33' + description: 'List of payment methods to be presented to the shopper. To + refer to payment methods, use their `paymentMethod.type` from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"allowedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + blockedPaymentMethods: + x-addedInVersion: '33' + description: 'List of payment methods to be hidden from the shopper. To + refer to payment methods, use their `paymentMethod.type` from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"blockedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + channel: + description: 'The platform where a payment transaction takes place. This + field can be used for filtering out payment methods that are only available + on specific platforms. Possible values: + + * iOS + + * Android + + * Web' + enum: + - iOS + - Android + - Web + type: string + countryCode: + description: The shopper's country code. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + order: + x-addedInVersion: '64' + description: Contains the order information which is required for partial + payments. + $ref: '#/components/schemas/CheckoutOrder' + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + splitCardFundingSources: + x-addedInVersion: '53' + default: false + description: Boolean value indicating whether the card payment method should + be split into separate debit and credit options. + type: boolean + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + required: + - merchantAccount + PaymentMethodsResponse: + properties: + paymentMethods: + description: Detailed list of payment methods required to generate payment + forms. + items: + $ref: '#/components/schemas/PaymentMethod' + type: array + storedPaymentMethods: + x-addedInVersion: '49' + description: List of all stored payment methods. + items: + $ref: '#/components/schemas/StoredPaymentMethod' + type: array + PaymentRefundResource: + properties: + amount: + description: The refund amount. + $ref: '#/components/schemas/Amount' + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to refund. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the refund request. + type: string + reference: + description: Your reference for the refund request. + type: string + splits: + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - amount + - pspReference + - paymentPspReference + PaymentRequest: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + channel: + description: 'The platform where a payment transaction takes place. This + field is optional for filtering out payment methods that are only available + on specific platforms. If this value is not set, then we will try to infer + it from the `sdkVersion` or `token`. + + + Possible values: + + * iOS + + * Android + + * Web' + enum: + - iOS + - Android + - Web + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: Checkout attempt ID that corresponds to the Id generated for + tracking user payment journey. + type: string + company: + x-addedInVersion: '32' + description: Information regarding the company. + $ref: '#/components/schemas/Company' + conversionId: + x-addedInVersion: '49' + description: Conversion ID that corresponds to the Id generated for tracking + user payment journey. + type: string + countryCode: + description: 'The shopper country. + + + Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + + Example: NL or DE' + type: string + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + enableOneClick: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the shopper will + be asked if the payment details should be stored for future one-click + payments. + type: boolean + enablePayOut: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the payment details + will be tokenized for payouts. + type: boolean + enableRecurring: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the payment details + will be tokenized for recurring payments. + type: boolean + entityType: + x-addedInVersion: '24' + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + lineItems: + x-addedInVersion: '32' + description: 'Price and product information about the purchased items, to + be included on the invoice sent to the shopper. + + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' + items: + $ref: '#/components/schemas/LineItem' + type: array + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + order: + description: Contains the order information which is required for partial + payments. + $ref: '#/components/schemas/CheckoutOrder' + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + origin: + x-addedInVersion: '40' + description: 'Required for the 3D Secure 2 `channel` **Web** integration. + + + Set this parameter to the origin URL of the page that you are loading + the 3D Secure Component from.' + maxLength: 8000 + type: string + paymentMethod: + description: The type and required details of a payment method to use. + oneOf: + - $ref: '#/components/schemas/AchDetails' + - $ref: '#/components/schemas/AfterpayDetails' + - $ref: '#/components/schemas/AmazonPayDetails' + - $ref: '#/components/schemas/AndroidPayDetails' + - $ref: '#/components/schemas/ApplePayDetails' + - $ref: '#/components/schemas/BacsDirectDebitDetails' + - $ref: '#/components/schemas/BillDeskDetails' + - $ref: '#/components/schemas/BlikDetails' + - $ref: '#/components/schemas/CardDetails' + - $ref: '#/components/schemas/CellulantDetails' + - $ref: '#/components/schemas/DokuDetails' + - $ref: '#/components/schemas/DotpayDetails' + - $ref: '#/components/schemas/DragonpayDetails' + - $ref: '#/components/schemas/EcontextVoucherDetails' + - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' + - $ref: '#/components/schemas/GiropayDetails' + - $ref: '#/components/schemas/GooglePayDetails' + - $ref: '#/components/schemas/IdealDetails' + - $ref: '#/components/schemas/KlarnaDetails' + - $ref: '#/components/schemas/LianLianPayDetails' + - $ref: '#/components/schemas/MasterpassDetails' + - $ref: '#/components/schemas/MbwayDetails' + - $ref: '#/components/schemas/MobilePayDetails' + - $ref: '#/components/schemas/MolPayDetails' + - $ref: '#/components/schemas/OpenInvoiceDetails' + - $ref: '#/components/schemas/PayPalDetails' + - $ref: '#/components/schemas/PayUUpiDetails' + - $ref: '#/components/schemas/PayWithGoogleDetails' + - $ref: '#/components/schemas/PaymentDetails' + - $ref: '#/components/schemas/RatepayDetails' + - $ref: '#/components/schemas/SamsungPayDetails' + - $ref: '#/components/schemas/SepaDirectDebitDetails' + - $ref: '#/components/schemas/StoredPaymentMethodDetails' + - $ref: '#/components/schemas/UpiDetails' + - $ref: '#/components/schemas/VippsDetails' + - $ref: '#/components/schemas/VisaCheckoutDetails' + - $ref: '#/components/schemas/WeChatPayDetails' + - $ref: '#/components/schemas/WeChatPayMiniProgramDetails' + - $ref: '#/components/schemas/ZipDetails' + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + type: string + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + redirectFromIssuerMethod: + x-addedInVersion: '32' + description: Specifies the redirect method (GET or POST) when redirecting + back from the issuer. + type: string + redirectToIssuerMethod: + x-addedInVersion: '32' + description: Specifies the redirect method (GET or POST) when redirecting + to the issuer. + type: string + 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 + returnUrl: + description: 'The URL to return to in case of a redirection. + + The format depends on the channel. This URL can have a maximum of 1024 + characters. + + * For web, include the protocol `http://` or `https://`. You can also + include your own additional query parameters, for example, shopper ID + or order reference number. + + Example: `https://your-company.com/checkout?shopperOrder=12xy` + + * For iOS, use the custom URL for your app. To know more about setting + custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). + + Example: `my-app://` + + * For Android, use a custom URL handled by an Activity on your app. You + can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). + + Example: `my-app://your.package.name`' + maxLength: 8000 + type: string + riskData: + description: Contains risk data, such as client-side data, used to identify + risk for a transaction. + $ref: '#/components/schemas/RiskData' + sessionValidity: + description: 'The date and time until when the session remains valid, in + [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. + + + For example: 2020-07-18T15:42:40.428+01:00' + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + storePaymentMethod: + x-addedInVersion: '49' + description: When true and `shopperReference` is provided, the payment details + will be stored. + type: boolean + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + - returnUrl + - paymentMethod + PaymentResponse: + properties: + action: + x-addedInVersion: '49' + description: Action to be taken for completing the payment. + oneOf: + - $ref: '#/components/schemas/CheckoutAwaitAction' + - $ref: '#/components/schemas/CheckoutBankTransferAction' + - $ref: '#/components/schemas/CheckoutDonationAction' + - $ref: '#/components/schemas/CheckoutOneTimePasscodeAction' + - $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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + 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. + + If you need to provide multiple references for a transaction, separate + them with hyphens ("-"). + + Maximum 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' + 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. + + + > 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. + + + For 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** \u2013 The payment\ + \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ + \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ + \ \u2013 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** \u2013 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** \u2013 Indicates the\ + \ payment has been cancelled (either by the shopper or the merchant) before\ + \ processing was completed. This is a final state.\n* **ChallengeShopper**\ + \ \u2013 The issuer requires further shopper interaction before the payment\ + \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ + \ \u2013 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** \u2013 The issuer requires the shopper's device\ + \ fingerprint before the payment can be authenticated. Returned for 3D\ + \ Secure 2 transactions.\n* **Pending** \u2013 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** \u2013 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** \u2013\ + \ Indicates the payment has successfully been received by Adyen, and will\ + \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ + \ \u2013 Indicates the shopper should be redirected to an external web\ + \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ + \ the payment was refused. The reason is given in the `refusalReason`\ + \ field. This is a final state." + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - 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 + PaymentReversalResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentPspReference: + description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) + of the payment to reverse. ' + type: string + pspReference: + description: Adyen's 16-character reference associated with the reversal + request. + type: string + reference: + description: Your reference for the reversal request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentPspReference + PaymentSetupRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + allowedPaymentMethods: + x-addedInVersion: '33' + description: 'List of payment methods to be presented to the shopper. To + refer to payment methods, use their `paymentMethod.type`from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"allowedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + blockedPaymentMethods: + x-addedInVersion: '33' + description: 'List of payment methods to be hidden from the shopper. To + refer to payment methods, use their `paymentMethod.type`from [Payment + methods overview](https://docs.adyen.com/payment-methods). + + + Example: `"blockedPaymentMethods":["ideal","giropay"]`' + items: + type: string + type: array + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + channel: + description: 'The platform where a payment transaction takes place. This + field is optional for filtering out payment methods that are only available + on specific platforms. If this value is not set, then we will try to infer + it from the `sdkVersion` or `token`. + + + Possible values: + + * iOS + + * Android + + * Web' + enum: + - iOS + - Android + - Web + type: string + checkoutAttemptId: + x-addedInVersion: '68' + description: Checkout attempt ID that corresponds to the Id generated for + tracking user payment journey. + type: string + company: + x-addedInVersion: '32' + description: Information regarding the company. + $ref: '#/components/schemas/Company' + configuration: + description: Specify configurations to enable additional features. + $ref: '#/components/schemas/Configuration' + conversionId: + x-addedInVersion: '49' + description: Conversion ID that corresponds to the Id generated for tracking + user payment journey. + type: string + countryCode: + description: 'The shopper country. + + + Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + + Example: NL or DE' + type: string + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + enableOneClick: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the shopper will + be asked if the payment details should be stored for future one-click + payments. + type: boolean + enablePayOut: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the payment details + will be tokenized for payouts. + type: boolean + enableRecurring: + x-addedInVersion: '32' + description: When true and `shopperReference` is provided, the payment details + will be tokenized for recurring payments. + type: boolean + entityType: + x-addedInVersion: '24' + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + lineItems: + x-addedInVersion: '32' + description: 'Price and product information about the purchased items, to + be included on the invoice sent to the shopper. + + > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, + Ratepay, and Zip.' + items: + $ref: '#/components/schemas/LineItem' + type: array + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + origin: + description: 'Required for the Web integration. + + + Set this parameter to the origin URL of the page that you are loading + the SDK from.' + type: string + recurringExpiry: + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + type: string + recurringFrequency: + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + 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 + returnUrl: + description: 'The URL to return to in case of a redirection. + + The format depends on the channel. This URL can have a maximum of 1024 + characters. + + * For web, include the protocol `http://` or `https://`. You can also + include your own additional query parameters, for example, shopper ID + or order reference number. + + Example: `https://your-company.com/checkout?shopperOrder=12xy` + + * For iOS, use the custom URL for your app. To know more about setting + custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). + + Example: `my-app://` + + * For Android, use a custom URL handled by an Activity on your app. You + can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). + + Example: `my-app://your.package.name`' + maxLength: 8000 + type: string + riskData: + description: Contains risk data, such as client-side data, used to identify + risk for a transaction. + $ref: '#/components/schemas/RiskData' + sdkVersion: + x-addedInVersion: '32' + description: The version of the SDK you are using (for Web SDK integrations + only). + type: string + sessionValidity: + description: 'The date and time until when the session remains valid, in + [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. + + + For example: 2020-07-18T15:42:40.428+01:00' + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + storePaymentMethod: + x-addedInVersion: '49' + description: When true and `shopperReference` is provided, the payment details + will be stored. + type: boolean + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + token: + description: 'The token obtained when initializing the SDK. + + + > This parameter is required for iOS and Android; not required for Web.' + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + - returnUrl + - countryCode + PaymentSetupResponse: + properties: + paymentSession: + description: The encoded payment session that you need to pass to the SDK. + type: string + recurringDetails: + deprecated: true + description: The detailed list of stored payment details required to generate + payment forms. Will be empty if oneClick is set to false in the request. + items: + $ref: '#/components/schemas/RecurringDetail' + type: array + PaymentVerificationRequest: + properties: + payload: + description: Encrypted and signed payment result data. You should receive + this value from the Checkout SDK after the shopper completes the payment. + maxLength: 40000 + type: string + required: + - payload + PaymentVerificationResponse: + properties: + 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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + type: object + fraudResult: + description: The fraud result properties of the payment. + $ref: '#/components/schemas/FraudResult' + merchantReference: + description: A unique value that you provided in the initial `/paymentSession` + request as a `reference` field. + type: string + order: + description: Contains updated information regarding the order in case order + information was provided in the request. + $ref: '#/components/schemas/CheckoutOrderResponse' + paymentMethod: + description: The payment method used in the transaction. + type: string + pspReference: + description: Adyen's 16-character reference associated with the transaction/request. + This value is globally unique; quote it when communicating with us about + this request. + 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. + + + For 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** \u2013 The payment\ + \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ + \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ + \ \u2013 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** \u2013 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** \u2013 Indicates the\ + \ payment has been cancelled (either by the shopper or the merchant) before\ + \ processing was completed. This is a final state.\n* **ChallengeShopper**\ + \ \u2013 The issuer requires further shopper interaction before the payment\ + \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ + \ \u2013 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** \u2013 The issuer requires the shopper's device\ + \ fingerprint before the payment can be authenticated. Returned for 3D\ + \ Secure 2 transactions.\n* **Pending** \u2013 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** \u2013 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** \u2013\ + \ Indicates the payment has successfully been received by Adyen, and will\ + \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ + \ \u2013 Indicates the shopper should be redirected to an external web\ + \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ + \ the payment was refused. The reason is given in the `refusalReason`\ + \ field. This is a final state." + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused + - Success + type: string + serviceError: + description: The type of the error. + $ref: '#/components/schemas/ServiceError2' + shopperLocale: + description: The shopperLocale value provided in the payment request. + type: string + required: + - merchantReference + - paymentMethod + - shopperLocale + Phone: + properties: + cc: + description: "Country code. Length: 1\u20133 characters." + maxLength: 3 + minLength: 1 + type: string + subscriber: + description: 'Subscriber number. Maximum length: 15 characters.' + maxLength: 15 + type: string + RatepayDetails: + additionalProperties: false + properties: + billingAddress: + description: The address where to send the invoice. + type: string + deliveryAddress: + description: The address where the goods should be delivered. + type: string + personalDetails: + description: Shopper name, date of birth, phone number, and email address. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: ratepay + description: '**ratepay**' + enum: + - ratepay + type: string + required: + - type + title: Ratepay + Recurring: + properties: + contract: + description: "The type of recurring contract to be used.\nPossible values:\n\ + * `ONECLICK` \u2013 Payment details can be used to initiate a one-click\ + \ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\ + * `RECURRING` \u2013 Payment details can be used without the card security\ + \ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\ + * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\ + \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\ + \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)." + enum: + - ONECLICK + - RECURRING + - PAYOUT + type: string + recurringDetailName: + description: A descriptive name for this detail. + type: string + recurringExpiry: + x-addedInVersion: '40' + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time + type: string + recurringFrequency: + x-addedInVersion: '40' + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + tokenService: + x-addedInVersion: '25' + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE + type: string + RecurringDetail: + properties: + brand: + x-addedInVersion: '65' + description: 'Brand for the selected gift card. For example: plastix, hmclub.' + type: string + brands: + x-addedInVersion: '49' + description: 'List of possible brands. For example: visa, mc.' + items: + type: string + type: array + configuration: + additionalProperties: + type: string + description: The configuration of the payment method. + type: object + fundingSource: + x-addedInVersion: '53' + description: The funding source of the payment method. + enum: + - debit + type: string + group: + description: The group where this payment method belongs to. + $ref: '#/components/schemas/PaymentMethodGroup' + inputDetails: + deprecated: true + description: All input details to be provided to complete the payment with + this payment method. + items: + $ref: '#/components/schemas/InputDetail' + type: array + issuers: + x-addedInVersion: '68' + description: A list of issuers for this payment method. + items: + $ref: '#/components/schemas/PaymentMethodIssuer' + type: array + name: + description: The displayable name of this payment method. + type: string + recurringDetailReference: + description: The reference that uniquely identifies the recurring detail. + type: string + storedDetails: + description: Contains information on previously stored payment details. + $ref: '#/components/schemas/StoredDetails' + type: + description: The unique payment method code. + type: string + Redirect: + 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: 'The web method that you must use to access the redirect URL. + + + Possible values: GET, POST.' + enum: + - GET + - POST + type: string + url: + description: The URL, to which you must redirect a shopper to complete a + payment. + type: string + 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 + 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. + + + Example: 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. + + + Example: 1011 DJ' + type: string + billingAddress.stateOrProvince: + description: 'The billing address state or province passed in the payment + request. + + + Example: NH' + type: string + billingAddress.street: + description: The billing address street passed in the payment request. + type: string + ResponseAdditionalDataCard: + properties: + cardBin: + description: 'The Bank Identification Number of a credit card, which is + the first six digits of a card number. + + + Example: 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. + + + Example: 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. + + + Example: amex' + type: string + cardSummary: + description: 'The last four digits of a card number. + + + > Returned only in case of a card payment.' + type: string + ResponseAdditionalDataCommon: + properties: + acquirerAccountCode: + description: 'The name of the Adyen acquirer account. + + + Example: PayPalSandbox_TestAcquirer + + + > Only relevant for PayPal transactions.' + type: string + acquirerCode: + description: 'The name of the acquirer processing the payment request. + + + Example: TestPmmAcquirer' + type: string + acquirerReference: + description: 'The reference number that can be used for reconciliation in + case a non-Adyen acquirer is used for settlement. + + + Example: 7C9N3FNBKT9' + type: string + alias: + description: 'The Adyen alias of the card. + + + Example: H167852639363479' + type: string + aliasType: + description: 'The type of the card alias. + + + Example: Default' + type: string + authCode: + description: '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. + + + Example: 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. + + + This 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. + + + For 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. + + + Example: D' + type: string + bic: + description: 'BIC of a bank account. + + + Example: TESTNL01 + + + > 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. + example: 1 Matches + type: string + cvcResultRaw: + description: The raw result of CVC verification. + example: M + 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. + + + Example: 02' + type: string + expiryDate: + description: 'The expiry date on the card. + + + Example: 6/2016 + + + > 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. + + + Example: 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: + + * CHARGE + + * CREDIT + + * DEBIT + + * PREPAID + + * PREPAID_RELOADABLE + + + * PREPAID_NONRELOADABLE + + * DEFFERED_DEBIT + + + > This functionality requires additional configuration on Adyen''s end. + To enable it, contact the Support Team. + + + For receiving this field in the notification, enable **Include Funding + Source** in **Notifications** > **Additional settings**.' + type: string + fundsAvailability: + description: 'Indicates availability of funds. + + + Visa: + + * "I" (fast funds are supported) + + * "N" (otherwise) + + + Mastercard: + + * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM + list) + + * "N" (otherwise) + + + > 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". + + + Possible values: + + + * 3D Secure Mandated + + * Closed Account + + * ContAuth Not Supported + + * CVC Mandated + + * Ecommerce Not Allowed + + * Crossborder Not Supported + + * Card Updated + + + * Low Authrate Bin + + * 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. + + + Example: 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. + + + > Contact Support Team to enable this field.' + type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + 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. + + + This contains either the Mastercard Trace ID or the Visa Transaction ID.' + type: string + ownerName: + description: 'The owner name of a bank account. + + + Only 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. + + + For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + + + Example: mcpro' + type: string + payoutEligible: + description: 'Indicates whether a payout is eligible or not for this card. + + + Visa: + + * "Y" + + * "N" + + + Mastercard: + + * "Y" (domestic and cross-border) + + + * "D" (only domestic) + + * "N" (no MoneySend) + + * "U" (unknown)' + type: string + realtimeAccountUpdaterStatus: + description: 'The response code from the Real Time Account Updater service. + + + Possible return values are: + + * CardChanged + + * CardExpiryChanged + + * CloseAccount + + + * 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. + + + This 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. + + + This field is unavailable if the payment is referred and is usually not + returned with ecommerce transactions. + + + Example: true' + type: string + refusalReasonRaw: + description: 'Raw refusal reason received from the acquirer, where available. + + + Example: 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. + + + Example: Ecommerce' + type: string + shopperReference: + description: 'The shopperReference passed in the payment request. + + + Example: AdyenTestShopperXX' + type: string + terminalId: + description: 'The terminal ID used in a point-of-sale payment. + + + Example: 06022622' + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. + + + Example: true' + type: string + threeDAuthenticatedResponse: + description: 'The raw 3DS authentication result from the card issuer. + + + Example: N' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. + + + Example: true' + type: string + threeDOfferedResponse: + description: 'The raw enrollment result from the 3DS directory services + of the card schemes. + + + Example: Y' + type: string + threeDSVersion: + description: The 3D Secure 2 version. + type: string + visaTransactionId: + description: 'The `visaTransactionId`, has a fixed length of 15 numeric + characters. + + + > 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. + + + Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + type: string + ResponseAdditionalDataDeliveryAddress: + properties: + deliveryAddress.city: + description: The delivery address city passed in the payment request. + type: string + deliveryAddress.country: + description: 'The delivery address country passed in the payment request. + + + Example: NL' + type: string + deliveryAddress.houseNumberOrName: + description: The delivery address house number or name passed in the payment + request. + type: string + deliveryAddress.postalCode: + description: 'The delivery address postal code passed in the payment request. + + + Example: 1011 DJ' + type: string + deliveryAddress.stateOrProvince: + description: 'The delivery address state or province passed in the payment + request. + + + Example: NH' + type: string + deliveryAddress.street: + description: The delivery address street passed in the payment request. + type: string + 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: + + * PayInInstallmentsOnly + + * PayInFullOnly + + * PayInFullOrInstallments' + type: string + installments.value: + description: 'The number of installments that the payment amount should + be charged with. + + + Example: 5 + + > Only relevant for card payments in countries that support installments.' + type: string + 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 + 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 + ResponseAdditionalDataSepa: + properties: + sepadirectdebit.dateOfSignature: + description: 'The transaction signature date. + + + Format: 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: + + * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct + debit transaction. + + + * First: (FRST) Initial/first collection in a series of direct debit instructions. + + * Recurring: (RCUR) Direct debit instruction to carry out regular direct + debit transactions initiated by the creditor. + + * Final: (FNAL) Last/final collection in a series of direct debit instructions. + + + Example: OOFF' + type: string + RiskData: + properties: + clientData: + description: Contains client-side data, like the device fingerprint, cookies, + and specific browser settings. + type: string + customFields: + x-addedInVersion: '65' + additionalProperties: + type: string + description: Any custom fields used as part of the input to configured risk + rules. + type: object + fraudOffset: + x-addedInVersion: '65' + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + profileReference: + x-addedInVersion: '65' + description: The risk profile to assign to this payment. When left empty, + the merchant-level account's default risk profile will be applied. + type: string + SDKEphemPubKey: + properties: + crv: + description: The `crv` value as received from the 3D Secure 2 SDK. + type: string + kty: + description: The `kty` value as received from the 3D Secure 2 SDK. + type: string + x: + description: The `x` value as received from the 3D Secure 2 SDK. + type: string + y: + description: The `y` value as received from the 3D Secure 2 SDK. + type: string + SamsungPayDetails: + additionalProperties: false + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + samsungPayToken: + description: The payload you received from the Samsung Pay SDK response. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: samsungpay + description: '**samsungpay**' + enum: + - samsungpay + type: string + required: + - samsungPayToken + title: Samsung Pay + SepaDirectDebitDetails: + additionalProperties: false + properties: + iban: + description: The International Bank Account Number (IBAN). + type: string + ownerName: + description: The name of the bank account holder. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: sepadirectdebit + description: '**sepadirectdebit**' + enum: + - sepadirectdebit + type: string + required: + - iban + - ownerName + title: SEPA Direct Debit + ServiceError: + properties: + additionalData: + x-addedInVersion: '46' + additionalProperties: + type: string + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' + type: object + errorCode: + description: The error code mapped to the error message. + type: string + errorType: + description: The category of the error. + type: string + message: + description: A short explanation of the issue. + type: string + pspReference: + description: The PSP reference of the payment. + type: string + status: + description: The HTTP response status. + format: int32 + type: integer + ServiceError2: + properties: + errorCode: + type: string + errorType: + type: string + message: + type: string + ShopperInput: + properties: + billingAddress: + description: 'Specifies visibility of billing address fields. + + + Permitted values: + + * editable + + * hidden + + * readOnly' + enum: + - editable + - hidden + - readOnly + type: string + deliveryAddress: + description: 'Specifies visibility of delivery address fields. + + + Permitted values: + + * editable + + * hidden + + * readOnly' + enum: + - editable + - hidden + - readOnly + type: string + personalDetails: + description: 'Specifies visibility of personal details. + + + Permitted values: + + * editable + + * hidden + + * readOnly' + enum: + - editable + - hidden + - readOnly + type: string + ShopperInteractionDevice: + properties: + locale: + description: Locale on the shopper interaction device. + type: string + os: + description: Operating system running on the shopper interaction device. + type: string + osVersion: + description: Version of the operating system on the shopper interaction + device. + type: string + Split: + properties: + account: + description: 'Unique identifier of the account where the split amount should + be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. + + + ' + type: string + amount: + description: The amount of this split. + $ref: '#/components/schemas/SplitAmount' + description: + description: A description of this split. + type: string + reference: + description: 'Your reference for the split, which you can use to link the + split to other operations such as captures and refunds. + + + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + in Adyen for Platforms.' + type: string + type: + description: 'The type of split. + + Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, + **MarketPlace**, **BalanceAccount**.' + enum: + - BalanceAccount + - Commission + - Default + - MarketPlace + - PaymentFee + - VAT + - Verification + type: string + required: + - amount + - type + SplitAmount: + properties: + currency: + description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + + + If this value is not provided, the currency in which the payment is made + will be used.' + maxLength: 3 + minLength: 3 + type: string + value: + description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - value + StandalonePaymentCancelResource: + properties: + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + paymentReference: + description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) + of the payment to cancel. + type: string + pspReference: + description: Adyen's 16-character reference associated with the cancel request. + type: string + reference: + description: Your reference for the cancel request. + type: string + status: + description: The status of your request. This will always have the value + **received**. + enum: + - received + type: string + required: + - status + - merchantAccount + - pspReference + - paymentReference + StoredDetails: + properties: + bank: + description: The stored bank account. + $ref: '#/components/schemas/BankAccount' + card: + description: The stored card information. + $ref: '#/components/schemas/Card' + emailAddress: + description: The email associated with stored payment details. + type: string + StoredPaymentMethod: + properties: + brand: + description: The brand of the card. + type: string + expiryMonth: + description: The month the card expires. + type: string + expiryYear: + description: The year the card expires. + type: string + holderName: + description: The unique payment method code. + type: string + iban: + x-addedInVersion: '67' + description: The IBAN of the bank account. + type: string + id: + description: A unique identifier of this stored payment method. + type: string + lastFour: + description: The last four digits of the PAN. + type: string + name: + description: The display name of the stored payment method. + type: string + networkTxReference: + x-addedInVersion: '68' + 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. + + + This contains either the Mastercard Trace ID or the Visa Transaction ID.' + type: string + ownerName: + x-addedInVersion: '67' + description: The name of the bank account holder. + type: string + shopperEmail: + description: "The shopper\u2019s email address." + type: string + supportedShopperInteractions: + description: The supported shopper interactions for this stored payment + method. + items: + type: string + type: array + type: + description: The type of payment method. + type: string + StoredPaymentMethodDetails: + additionalProperties: false + properties: + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + description: The payment method type. + enum: + - bcmc_mobile + - bcmc_mobile_QR + - bcmc_mobile_app + - momo_wallet + - momo_wallet_app + - paymaya_wallet + - grabpay_SG + - grabpay_MY + - grabpay_TH + - grabpay_ID + - grabpay_VN + - grabpay_PH + - oxxo + - gcash + - kakaopay + - truemoney + type: string + title: Stored Payment Method + SubInputDetail: + properties: + configuration: + additionalProperties: + type: string + description: Configuration parameters for the required input. + type: object + items: + description: In case of a select, the items to choose from. + items: + $ref: '#/components/schemas/Item' + type: array + key: + description: The value to provide in the result. + type: string + optional: + description: True if this input is optional to provide. + type: boolean + type: + description: The type of the required input. + type: string + value: + description: The value can be pre-filled, if available. + type: string + ThreeDS2RequestData: + properties: + acctInfo: + x-addedInVersion: '68' + description: "Additional information about the Cardholder\u2019s account\ + \ provided by the 3DS Requestor." + $ref: '#/components/schemas/AcctInfo' + acctType: + x-addedInVersion: '68' + description: "Indicates the type of account. For example, for a multi-account\ + \ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\ + \ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit" + enum: + - '01' + - '02' + - '03' + maxLength: 2 + minLength: 2 + type: string + acquirerBIN: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The acquiring BIN enrolled for 3D Secure 2. This string should match the + value that you will use in the authorisation. Use 123456 on the Test platform. + type: string + acquirerMerchantID: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. + This string should match the value that you will use in the authorisation. + Use 123456 on the Test platform. + type: string + addrMatch: + x-addedInVersion: '68' + description: "Indicates whether the Cardholder Shipping Address and Cardholder\ + \ Billing Address are the same. Allowed values:\n* **Y** \u2014 Shipping\ + \ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\ + \ not match Billing Address." + enum: + - Y + - N + maxLength: 1 + minLength: 1 + type: string + authenticationOnly: + deprecated: true + x-deprecatedInVersion: '50' + x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + challengeIndicator: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead. + description: 'Possibility to specify a preference for receiving a challenge + from the issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate + type: string + deviceChannel: + description: 'The environment of the shopper. + + Allowed values: + + * `app` + + * `browser`' + type: string + deviceRenderOptions: + description: 'Display options for the 3D Secure 2 SDK. + + Optional and only for `deviceChannel` **app**.' + $ref: '#/components/schemas/DeviceRenderOptions' + homePhone: + x-addedInVersion: '68' + description: The home phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + mcc: + x-addedInVersion: '49' + description: Required for merchants that have been enrolled for 3D Secure + 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` + is registered at the scheme. + type: string + merchantName: + x-addedInVersion: '49' + description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchant name that the issuer presents to the shopper if they get + a challenge. We recommend to use the same value that you will use in the + authorization. Maximum length is 40 characters. + + > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). + Use this field if you are enrolled for 3D Secure 2 with us and want to + override the merchant name already configured on your account.' + type: string + messageVersion: + default: 2.1.0 + description: The `messageVersion` value indicating the 3D Secure 2 protocol + version. + type: string + mobilePhone: + x-addedInVersion: '68' + description: The mobile phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + notificationURL: + description: URL to where the issuer should send the `CRes`. Required if + you are not using components for `channel` **Web** or if you are using + classic integration `deviceChannel` **browser**. + type: string + payTokenInd: + x-addedInVersion: '68' + description: Value **true** indicates that the transaction was de-tokenised + prior to being received by the ACS. + type: boolean + paymentAuthenticationUseCase: + x-addedInVersion: '68' + description: Indicates the type of payment for which an authentication is + requested (message extension) + type: string + purchaseInstalData: + x-addedInVersion: '68' + description: "Indicates the maximum number of authorisations permitted for\ + \ instalment payments. Length: 1\u20133 characters." + maxLength: 3 + minLength: 1 + type: string + recurringExpiry: + x-addedInVersion: '68' + description: 'Date after which no further authorisations shall be performed. + Format: YYYYMMDD' + type: string + recurringFrequency: + x-addedInVersion: '68' + description: 'Indicates the minimum number of days between authorisations. + Maximum length: 4 characters.' + maxLength: 4 + type: string + sdkAppID: + description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEncData: + description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEphemPubKey: + description: 'The `sdkEphemPubKey` value as received from the 3D Secure + 2 SDK. + + Required for `deviceChannel` set to **app**.' + $ref: '#/components/schemas/SDKEphemPubKey' + sdkMaxTimeout: + default: 60 + description: 'The maximum amount of time in minutes for the 3D Secure 2 + authentication process. + + Optional and only for `deviceChannel` set to **app**. Defaults to **60** + minutes.' + format: int32 + type: integer + sdkReferenceNumber: + description: 'The `sdkReferenceNumber` value as received from the 3D Secure + 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkTransID: + description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkVersion: + x-addedInVersion: '40' + description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ + \ set to **app**." + type: string + threeDSCompInd: + description: Completion indicator for the device fingerprinting. + type: string + threeDSRequestorAuthenticationInd: + x-addedInVersion: '68' + description: Indicates the type of Authentication request. + type: string + threeDSRequestorAuthenticationInfo: + x-addedInVersion: '68' + description: Information about how the 3DS Requestor authenticated the cardholder + before or during the transaction + $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo' + threeDSRequestorChallengeInd: + x-addedInVersion: '68' + description: Indicates whether a challenge is requested for this transaction. + type: string + threeDSRequestorID: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor identifier assigned by the Directory + Server when you enrol for 3D Secure 2. + type: string + threeDSRequestorName: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor name assigned by the Directory Server + when you enrol for 3D Secure 2. + type: string + threeDSRequestorPriorAuthenticationInfo: + x-addedInVersion: '68' + description: Information about how the 3DS Requestor authenticated the cardholder + as part of a previous 3DS transaction. + $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo' + threeDSRequestorURL: + description: URL of the (customer service) website that will be shown to + the shopper in case of technical errors during the 3D Secure 2 process. + type: string + transType: + x-addedInVersion: '68' + description: "Identifies the type of transaction being authenticated. Length:\ + \ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\ + * **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\ + \ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\ + \ Load" + enum: + - '01' + - '03' + - '10' + - '11' + - '28' + maxLength: 2 + minLength: 2 + type: string + transactionType: + x-addedInVersion: '50' + description: Identify the type of the transaction being authenticated. + enum: + - goodsOrServicePurchase + - checkAcceptance + - accountFunding + - quasiCashTransaction + - prepaidActivationAndLoad + type: string + whiteListStatus: + x-addedInVersion: '49' + description: The `whiteListStatus` value returned from a previous 3D Secure + 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. + type: string + workPhone: + x-addedInVersion: '68' + description: The work phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + required: + - deviceChannel + 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 + 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 + challengeIndicator: + x-addedInVersion: '67' + description: 'Specifies a preference for receiving a challenge from the + issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate + 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. + + Allowed values: + + * `lowValue` + + * `secureCorporate` + + * `trustedBeneficiary` + + * `transactionRiskAnalysis` + + ' + 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 + 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 + ThreeDSRequestorAuthenticationInfo: + properties: + threeDSReqAuthData: + description: 'Data that documents and supports a specific authentication + process. Maximum length: 2048 bytes.' + type: string + threeDSReqAuthMethod: + description: "Mechanism used by the Cardholder to authenticate to the 3DS\ + \ Requestor. Allowed values:\n* **01** \u2014 No 3DS Requestor authentication\ + \ occurred (for example, cardholder \u201Clogged in\u201D as guest).\n\ + * **02** \u2014 Login to the cardholder account at the 3DS Requestor system\ + \ using 3DS Requestor\u2019s own credentials.\n* **03** \u2014 Login to\ + \ the cardholder account at the 3DS Requestor system using federated ID.\n\ + * **04** \u2014 Login to the cardholder account at the 3DS Requestor system\ + \ using issuer credentials.\n* **05** \u2014 Login to the cardholder account\ + \ at the 3DS Requestor system using third-party authentication.\n* **06**\ + \ \u2014 Login to the cardholder account at the 3DS Requestor system using\ + \ FIDO Authenticator." + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + - '06' + maxLength: 2 + minLength: 2 + type: string + threeDSReqAuthTimestamp: + description: 'Date and time in UTC of the cardholder authentication. Format: + YYYYMMDDHHMM' + maxLength: 12 + minLength: 12 + type: string + ThreeDSRequestorPriorAuthenticationInfo: + properties: + threeDSReqPriorAuthData: + description: 'Data that documents and supports a specific authentication + process. Maximum length: 2048 bytes.' + type: string + threeDSReqPriorAuthMethod: + description: "Mechanism used by the Cardholder to previously authenticate\ + \ to the 3DS Requestor. Allowed values:\n* **01** \u2014 Frictionless\ + \ authentication occurred by ACS.\n* **02** \u2014 Cardholder challenge\ + \ occurred by ACS.\n* **03** \u2014 AVS verified.\n* **04** \u2014 Other\ + \ issuer methods." + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + threeDSReqPriorAuthTimestamp: + description: 'Date and time in UTC of the prior cardholder authentication. + Format: YYYYMMDDHHMM' + maxLength: 12 + minLength: 12 + type: string + threeDSReqPriorRef: + description: 'This data element provides additional information to the ACS + to determine the best approach for handing a request. This data element + contains an ACS Transaction ID for a prior authenticated transaction. + For example, the first recurring transaction that was authenticated with + the cardholder. Length: 30 characters.' + maxLength: 36 + minLength: 36 + type: string + ThreeDSecureData: + properties: + authenticationResponse: + description: 'In 3D Secure 1, the authentication response if the shopper + was redirected. + + + In 3D Secure 2, this is the `transStatus` from the challenge result. If + the transaction was frictionless, omit this parameter.' + enum: + - Y + - N + - U + - A + type: string + cavv: + description: The cardholder authentication value (base64 encoded, 20 bytes + in a decoded form). + format: byte + type: string + cavvAlgorithm: + description: The CAVV algorithm used. Include this only for 3D Secure 1. + 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 + directoryResponse: + description: 'In 3D Secure 1, this is the enrollment response from the 3D + directory server. + + + In 3D Secure 2, this is the `transStatus` from the `ARes`.' + enum: + - A + - C + - D + - I + - N + - R + - U + - Y + type: string + dsTransID: + x-addedInVersion: '40' + description: Supported for 3D Secure 2. The unique transaction identifier + assigned by the Directory Server (DS) to identify a single transaction. + type: string + eci: + description: The electronic commerce indicator. + type: string + riskScore: + x-addedInVersion: '67' + description: Risk score calculated by Directory Server (DS). Required for + Cartes Bancaires integrations. + type: string + threeDSVersion: + x-addedInVersion: '40' + description: The version of the 3D Secure protocol. + type: string + tokenAuthenticationVerificationValue: + x-addedInVersion: '68' + description: Network token authentication verification value (TAVV). The + network token cryptogram. + format: byte + type: string + transStatusReason: + x-addedInVersion: '67' + 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 + xid: + description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, + 20 bytes in a decoded form). + format: byte + type: string + UpdatePaymentLinkRequest: + properties: + status: + description: 'Status of the payment link. Possible values: + + * **expired**' + enum: + - expired + type: string + required: + - status + UpiDetails: + additionalProperties: false + properties: + billingSequenceNumber: + description: The sequence number for the debit. For example, send **2** + if this is the second debit for the subscription. The sequence number + is included in the notification sent to the shopper. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + shopperNotificationReference: + description: The `shopperNotificationReference` returned in the response + when you requested to notify the shopper. Used for recurring payment only. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: upi_collect + description: '**upi_collect**' + enum: + - upi_collect + type: string + virtualPaymentAddress: + description: The virtual payment address for UPI. + type: string + required: + - type + - billingSequenceNumber + title: UPI + VippsDetails: + additionalProperties: false + properties: + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + telephoneNumber: + description: '' + type: string + type: + default: vipps + description: '**vipps**' + enum: + - vipps + type: string + required: + - telephoneNumber + title: Vipps + VisaCheckoutDetails: + additionalProperties: false + properties: + fundingSource: + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + type: + default: visacheckout + description: '**visacheckout**' + enum: + - visacheckout + type: string + visaCheckoutCallId: + description: The Visa Click to Pay Call ID value. When your shopper selects + a payment and/or a shipping address from Visa Click to Pay, you will receive + a Visa Click to Pay Call ID. + type: string + required: + - visaCheckoutCallId + title: Visa Checkout + WeChatPayDetails: + additionalProperties: false + properties: + type: + default: wechatpay + description: '**wechatpay**' + enum: + - wechatpay + type: string + title: WeChat Pay + WeChatPayMiniProgramDetails: + additionalProperties: false + properties: + appId: + type: string + openid: + type: string + type: + default: wechatpayMiniProgram + description: '**wechatpayMiniProgram**' + enum: + - wechatpayMiniProgram + type: string + title: WeChat Pay - Mini Program + ZipDetails: + additionalProperties: false + properties: + clickAndCollect: + description: Set this to **true** if the shopper would like to pick up and + collect their order, instead of having the goods delivered to them. + type: string + recurringDetailReference: + deprecated: true + x-deprecatedInVersion: '49' + x-deprecatedMessage: Use `storedPaymentMethodId` instead. + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + storedPaymentMethodId: + x-addedInVersion: '49' + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + type: + default: zip + description: '**zip**' + enum: + - zip + type: string + title: Zip + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + headers: + Idempotency-Key: + description: The idempotency key used for processing the request. Present if + the key was provided in the request. + schema: + type: string + parameters: + Idempotency-Key: + description: A unique identifier for the message with a maximum of 64 characters + (we recommend a UUID). + example: 37ca9c97-d1d1-4c62-89e8-706891a563ed + name: Idempotency-Key + in: header + schema: + type: string + examples: + generic-400: + summary: Response code 400. Bad request. + value: + status: 400 + errorCode: '702' + message: 'Unexpected input: ", expected: }' + errorType: validation + generic-401: + summary: Response code 401. Unauthorized. + value: + status: 401 + errorCode: '000' + message: HTTP Status Response - Unauthorized + errorType: security + generic-403: + summary: Response code 403. Forbidden. + value: + status: 403 + errorCode: '901' + message: Invalid Merchant Account + errorType: security + pspReference: 881611827877203B + generic-422: + summary: Response code 422. Unprocessable entity. + value: + status: 422 + errorCode: '14_030' + message: Return URL is missing. + errorType: validation + pspReference: '8816118280275544' + generic-500: + summary: Response code 500. Internal server error. + value: + status: 500 + errorCode: '905' + message: Payment details are not supported + errorType: configuration + pspReference: '8516091485743033' + get-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: active + url: https://test.adyen.link/PL61C53A8B97E6915A + patch-paymentLinks-linkId-basic: + summary: Update the status of a payment link + value: + status: expired + patch-paymentLinks-linkId-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 8700 + countryCode: NL + expiresAt: '2021-04-08T14:06:39Z' + merchantAccount: TestMerchantCheckout + reference: shopper-reference-ekvL83 + shopperLocale: hu-HU + shopperReference: shopper-reference-LZfdWZ + status: expired + url: https://test.adyen.link/PL61C53A8B97E6915A + post-donations-donations: + summary: Start a donation transaction + value: + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + paymentMethod: + type: scheme + cvc: '123' + donationToken: YOUR_DONATION_TOKEN + donationOriginalPspReference: 991559660454807J + donationAccount: CHARITY_ACCOUNT + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + shopperInteraction: Ecommerce + post-donations-donations-200: + summary: Example response + value: + id: UNIQUE_RESOURCE_ID + status: completed + donationAccount: CHARITY_ACCOUNT + merchantAccount: YOUR_MERCHANT_ACCOUNT + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + payment: + pspReference: '8535762347980628' + resultCode: Authorised + amount: + currency: EUR + value: 1000 + merchantReference: YOUR_DONATION_REFERENCE + post-donations-donations-with-token: + summary: Start a donation transaction with a token + value: + amount: + currency: EUR + value: 1000 + reference: YOUR_DONATION_REFERENCE + paymentMethod: + type: scheme + storedPaymentMethodId: '8415718415172200' + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + donationAccount: CHARITY_ACCOUNT + shopperInteraction: Ecommerce + shopperReference: YOUR_UNIQUE_SHOPPER_ID + recurringProcessingModel: CardOnFile + post-orders-basic: + summary: Create an order + value: + reference: YOUR_ORDER_REFERENCE + amount: + value: 2500 + currency: EUR + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8616178914061985' + resultCode: Success + expiresAt: '2021-04-09T14:16:46Z' + orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== + reference: shopper-reference-ekvL83 + remainingAmount: + currency: EUR + value: 2500 + post-orders-cancel-basic: + summary: Cancel an order + value: + order: + pspReference: '8815517812932012' + orderData: 823fh892f8f18f4...148f13f9f3f + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-orders-cancel-basic-200: + summary: Example response for request 'basic' + value: + pspReference: '8816178914079738' + resultCode: Received + post-originKeys-basic: + summary: Get origin keys + value: + originDomains: + - https://www.your-domain1.com + - https://www.your-domain2.com + - https://www.your-domain3.com + post-originKeys-basic-200: + summary: Example response for request 'basic' + value: + originKeys: + https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw + https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc + https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg + post-paymentLinks-basic: + summary: Create a payment link + value: + reference: YOUR_ORDER_NUMBER + amount: + value: 1250 + currency: BRL + countryCode: BR + merchantAccount: YOUR_MERCHANT_ACCOUNT + shopperReference: YOUR_UNIQUE_SHOPPER_ID + shopperEmail: test@email.com + shopperLocale: pt-BR + billingAddress: + street: Roque Petroni Jr + postalCode: '59000060' + city: "S\xE3o Paulo" + houseNumberOrName: '999' + country: BR + stateOrProvince: SP + deliveryAddress: + street: Roque Petroni Jr + postalCode: '59000060' + city: "S\xE3o Paulo" + houseNumberOrName: '999' + country: BR + stateOrProvince: SP + post-paymentLinks-basic-200: + summary: Example response for request 'basic' + value: + amount: + currency: EUR + value: 1250 + expiresAt: '2021-04-09T14:17:31Z' + reference: shopper-reference-ekvL83 + url: https://test.adyen.link/PL6DB3157D27FFBBCF + post-paymentMethods-balance-basic: + summary: Retrieve gift card balance + value: + paymentMethod: + type: givex + number: '4126491073027401' + cvc: '737' + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix: + summary: Retrieve gift card balance + value: + paymentMethod: + type: plastix + number: '4010100000000000000' + cvc: '73737' + holderName: BALANCE EUR 888 + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-balance-plastix-200: + summary: Example response for request 'plastix' + value: + additionalData: + nonScheme.transactionLimit: '5000' + nonScheme.transactionLimitCcy: EUR + pspReference: 851617891188737F + resultCode: Success + balance: + currency: EUR + value: 888 + post-paymentMethods-basic: + summary: Get available payment methods + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentMethods-basic-200: + summary: Example response for request 'basic' + value: + paymentMethods: + - details: + - details: + - key: ownerName + type: text + - key: bankLocationId + type: text + - key: bankAccountNumber + type: text + key: bankAccount + type: bankAccount + name: ACH Direct Debit + type: ach + - name: Adyen Voucher + type: adyen_test_voucher + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: Afterpay + type: afterpaytouch + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: AliPay + type: alipay + - name: AliPay HK + type: alipay_hk + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Credit Card via AsiaPay + type: asiapay + - name: China UnionPay + type: asiapay_unionpay + - name: Baby Gift Card + type: babygiftcard + - name: Baloto + type: baloto + - name: BancNet + type: bancnet + - name: Bank Transfer (BG) + type: bankTransfer_BG + - name: Bank Transfer (CH) + type: bankTransfer_CH + - name: Bank Transfer (DE) + type: bankTransfer_DE + - name: Bank Transfer (FI) + type: bankTransfer_FI + - name: Bank Transfer (GB) + type: bankTransfer_GB + - name: Bank Transfer (HU) + type: bankTransfer_HU + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bank Transfer (IE) + type: bankTransfer_IE + - name: Electronic Bank Transfer (MX) + type: bankTransfer_MX_linked + - name: Bank Transfer (MX) + type: bankTransfer_MX_offline + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Bank Transfer (PL) + type: bankTransfer_PL + - name: Bank Transfer (SE) + type: bankTransfer_SE + - name: Bank Transfer (US) + type: bankTransfer_US + - name: Payconiq by Bancontact + type: bcmc_mobile + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: 99Bill + type: bill99 + - details: + - items: + - id: AUB_DIRECT + name: AU Small Finance Bank + - id: ALB_DIRECT + name: 'Allahabad Bank ' + - id: APG_DIRECT + name: Andhra Pragathi Grameena Bank + - id: BDN_DIRECT + name: Bandhan bank + - id: BBK_DIRECT + name: Bank of Bahrain and Kuwait + - id: BBR_DIRECT + name: Bank of Baroda - Retail Banking + - id: BCB_DIRECT + name: 'Bassien Catholic Co-Operative Bank ' + - id: CNB_DIRECT + name: Canara Bank + - id: SYD_DIRECT + name: Canara Bank (e-Syndicate) + - id: CSB_DIRECT + name: Catholic Syrian Bank + - id: CBI_DIRECT + name: Central Bank of India + - id: CUB_DIRECT + name: City Union Bank + - id: COB_DIRECT + name: Cosmos Bank + - id: DEN_DIRECT + name: Dena Bank + - id: DBK_DIRECT + name: Deutsche Bank + - id: DCB_DIRECT + name: Development Credit Bank + - id: DLB_DIRECT + name: Dhanlakshmi Bank - Retail Net Banking + - id: ESF_DIRECT + name: ESAF Small Finance Bank + - id: EQB_DIRECT + name: Equitas Small Finance Bank + - id: FBK_DIRECT + name: Federal Bank + - id: FNC_DIRECT + name: Fincare Bank + - id: HDF_DIRECT + name: HDFC Bank + - id: ICI_DIRECT + name: 'ICICI Bank ' + - id: IDB_DIRECT + name: IDBI Bank - Retail Net Banking + - id: IDN_DIRECT + name: IDFC FIRST Bank + - id: INB_DIRECT + name: Indian Bank + - id: IOB_DIRECT + name: Indian Overseas Bank + - id: IDS_DIRECT + name: IndusInd Bank + - id: JKB_DIRECT + name: Jammu & Kashmir Bank + - id: JNB_DIRECT + name: Jana Small Finance Bank + - id: JSB_DIRECT + name: Janata Sahakari Bank Ltd Pune + - id: KJB_DIRECT + name: Kalyan Janata Sahakari Bank + - id: KBL_DIRECT + name: Karnataka Bank Ltd + - id: KVB_DIRECT + name: Karur Vysya Bank + - id: 162_DIRECT + name: Kotak Bank + - id: LVR_DIRECT + name: Laxmi Vilas Bank - Retail + - id: NKB_DIRECT + name: NKGSB Co-op Bank + - id: NEB_DIRECT + name: North East Small Finance Bank + - id: OBC_DIRECT + name: PNB (Erstwhile-Oriental Bank of Commerce) + - id: UNI_DIRECT + name: PNB (Erstwhile-United Bank of India) + - id: PMC_DIRECT + name: Punjab & Maharastra Co-op Bank + - id: PSB_DIRECT + name: Punjab & Sind Bank + - id: CPN_DIRECT + name: 'Punjab National Bank - Corporate ' + - id: PNB_DIRECT + name: Punjab National Bank - Retail Banking + - id: RBL_DIRECT + name: RBL Bank Limited + - id: SWB_DIRECT + name: Saraswat Bank + - id: SHB_DIRECT + name: Shivalik Mercantile Cooperative Bank Ltd + - id: SIB_DIRECT + name: South Indian Bank + - id: SCB_DIRECT + name: Standard Chartered Bank + - id: SBI_DIRECT + name: State Bank of India + - id: SRB_DIRECT + name: Suryoday Small Finance Bank + - id: TJB_DIRECT + name: TJSB Bank + - id: TNC_DIRECT + name: Tamil Nadu State Co-operative Bank + - id: TMB_DIRECT + name: Tamilnad Mercantile Bank Ltd + - id: TBB_DIRECT + name: Thane Bharat Sahakari Bank Ltd + - id: MSB_DIRECT + name: The Mehsana Urban Co Op Bank Ltd + - id: UCO_DIRECT + name: UCO Bank + - id: UBI_DIRECT + name: Union Bank of India + - id: ADB_DIRECT + name: Union Bank of India (Erstwhile Andhra Bank) + - id: CRP_DIRECT + name: Union Bank of India (Erstwhile Corporation Bank) + - id: VRB_DIRECT + name: Varachha Co-operative Bank Limited + - id: VJB_DIRECT + name: Vijaya Bank + - id: YBK_DIRECT + name: Yes Bank + - id: ZOB_DIRECT + name: Zoroastrian Co-operative Bank Limited + - id: DBS_DIRECT + name: digibank by DBS + key: issuer + type: select + name: Online Banking India + type: billdesk_online + - name: UPI + type: billdesk_upi + - details: + - items: + - id: DCW_DIRECT + name: DCB Cippy + - id: ICC_DIRECT + name: ICC Cash Card + - id: OXY_DIRECT + name: Oxigen Wallet + - id: PCH_DIRECT + name: Pay World Money + key: issuer + type: select + name: Wallets India + type: billdesk_wallet + - name: Blik + type: blik + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Boleto + type: boleto + - name: Boleto Bancario + type: boletobancario_santander + - name: Bradesco + type: bradesco + - name: Cash-Ticket + type: cashticket + - name: CashU + type: cashu + - name: CCAvenue + type: ccavenue + - name: Mula Checkout + type: cellulant + - name: Chasin Giftcard + type: chasingiftcard + - name: Clearpay + type: clearpay + - name: ClickandBuy + type: clickandbuy + - name: Paiement en 3 fois par Cartes Bancaires + type: cofinoga_3xcb + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: DANA + type: dana + - name: DineroMail + type: dineromail + - name: Online bank transfer. + type: directEbanking + - name: Direct Debit Brazil - Banco do Brazil + type: directdebit_BR_bancodobrasil + - name: Direct Debit Brazil - Bradesco + type: directdebit_BR_bradesco + - name: Direct Debit Brazil - Caixa Economica Federal + type: directdebit_BR_caixa + - name: Direct Debit Brazil - HSBC + type: directdebit_BR_hsbc + - name: Direct Debit Brazil - Itau + type: directdebit_BR_itau + - name: Direct Debit Brazil - Santander + type: directdebit_BR_santander + - name: BACS Direct Debit + type: directdebit_GB + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Alfamart + type: doku_alfamart + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BCA Bank Transfer + type: doku_bca_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BNI VA + type: doku_bni_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: BRI VA + type: doku_bri_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: CIMB VA + type: doku_cimb_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Danamon VA + type: doku_danamon_va + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Indomaret + type: doku_indomaret + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Mandiri VA + type: doku_mandiri_va + - details: + - key: ovoId + type: text + name: OVO + type: doku_ovo + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: Bank Transfer + type: doku_permata_lite_atm + - details: + - key: shopperEmail + type: emailAddress + - key: firstName + type: text + - key: lastName + type: text + - key: infix + optional: true + type: text + name: DOKU wallet + type: doku_wallet + - details: + - items: + - id: '66' + name: Bank Nowy BFG S.A. + - id: '92' + name: "Bank Sp\xF3\u0142dzielczy w Brodnicy" + - id: '11' + name: Bank transfer / postal + - id: '74' + name: "Banki Sp\xF3\u0142dzielcze" + - id: '73' + name: BLIK + - id: '90' + name: "BNP Paribas - p\u0142ac\u0119 z Pl@net" + - id: '59' + name: CinkciarzPAY + - id: '87' + name: Credit Agricole PBL + - id: '83' + name: EnveloBank + - id: '76' + name: Getin Bank PBL + - id: '81' + name: Idea Cloud + - id: '7' + name: ING Corporate customers + - id: '93' + name: Kasa Stefczyka + - id: '44' + name: "Millennium - P\u0142atno\u015Bci Internetowe" + - id: '10' + name: Millennium Corporate customers + - id: '68' + name: mRaty + - id: '1' + name: mTransfer + - id: '91' + name: Nest Bank + - id: '80' + name: Noble Pay + - id: '50' + name: Pay Way Toyota Bank + - id: '45' + name: Pay with Alior Bank + - id: '36' + name: Pekao24Przelew + - id: '70' + name: Pocztowy24 + - id: '6' + name: Przelew24 + - id: '46' + name: "P\u0142ac\u0119 z Citi Handlowy" + - id: '38' + name: "P\u0142ac\u0119 z ING" + - id: '2' + name: "P\u0142ac\u0119 z Inteligo" + - id: '4' + name: "P\u0142ac\u0119 z iPKO" + - id: '75' + name: "P\u0142ac\u0119 z Plus Bank" + - id: '51' + name: "P\u0142a\u0107 z BO\u015A" + - id: '55' + name: Raty z Alior Bankiem PLN + - id: '89' + name: Santander + - id: '52' + name: SkyCash + key: issuer + type: select + name: Local Polish Payment Methods + type: dotpay + - name: Dragonpay Prepaid Credits + type: dragonpay_credits + - name: Online Banking + type: dragonpay_ebanking + - name: GCash + type: dragonpay_gcash + - name: Over The Counter Banks + type: dragonpay_otc_banking + - name: OTC non-Bank via Dragonpay + type: dragonpay_otc_non_banking + - name: Convenience Stores + type: dragonpay_otc_philippines + - name: 7/11 + type: dragonpay_seveneleven + - name: eagleeye_voucher + type: eagleeye_voucher + - name: Finnish E-Banking + type: ebanking_FI + - name: Pay-easy ATM + type: econtext_atm + - name: Online Banking + type: econtext_online + - name: 7-Eleven + type: econtext_seven_eleven + - name: Convenience Stores + type: econtext_stores + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Lastschrift (ELV) + type: elv + - details: + - items: + - id: '231' + name: POP Pankki + - id: '551' + name: "Komer\u010Dn\xED banka" + - id: '232' + name: Aktia + - id: '552' + name: Raiffeisen + - id: '233' + name: "S\xE4\xE4st\xF6pankki" + - id: '750' + name: Swedbank + - id: '211' + name: Nordea + - id: '553' + name: "\u010CSOB" + - id: '234' + name: S-Pankki + - id: '751' + name: SEB + - id: '554' + name: Moneta + - id: '235' + name: OmaSP + - id: '752' + name: Nordea + - id: '213' + name: Op-Pohjola + - id: '555' + name: UniCredit + - id: '753' + name: LHV + - id: '556' + name: Fio + - id: '557' + name: mBank + - id: '216' + name: Handelsbanken + - id: '558' + name: Air Bank + - id: '260' + name: "L\xE4nsf\xF6rs\xE4kringar" + - id: '240' + name: BankDeposit + - id: '265' + name: Sparbanken + - id: '640' + name: BankDeposit + - id: '200' + name: "\xC5landsbanken" + - id: '940' + name: Swedbank + - id: '500' + name: "\u010Cesk\xE1 spo\u0159itelna" + - id: '720' + name: Swedbank + - id: '941' + name: SEB + - id: '204' + name: Danske Bank + - id: '721' + name: SEB + - id: '942' + name: Citadele + - id: '205' + name: Handelsbanken + - id: '722' + name: DNB + - id: '943' + name: DNB + - id: '206' + name: Nordea + - id: '723' + name: "\u0160iauli\u0173 bankas" + - id: '207' + name: SEB + - id: '724' + name: Nordea + - id: '505' + name: "Komer\u010Dn\xED banka" + - id: '208' + name: Skandiabanken + - id: '209' + name: Swedbank + key: issuer + type: select + name: Bank Payment + type: entercash + - name: Nationale Entertainment Card + type: entertainmentcard + - details: + - items: + - id: d5d5b133-1c0d-4c08-b2be-3c9b116dc326 + name: Dolomitenbank + - id: ee9fc487-ebe0-486c-8101-17dce5141a67 + name: Raiffeissen Bankengruppe + - id: 6765e225-a0dc-4481-9666-e26303d4f221 + name: Hypo Tirol Bank AG + - id: 8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc + name: Sparda Bank Wien + - id: 1190c4d1-b37a-487e-9355-e0a067f54a9f + name: Schoellerbank AG + - id: e2e97aaa-de4c-4e18-9431-d99790773433 + name: Volksbank Gruppe + - id: bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9 + name: Immo-Bank + - id: e6819e7a-f663-414b-92ec-cf7c82d2f4e5 + name: Bank Austria + - id: eff103e6-843d-48b7-a6e6-fbd88f511b11 + name: Easybank AG + - id: 25942cc9-617d-42a1-89ba-d1ab5a05770a + name: VR-BankBraunau + - id: 4a0a975b-0594-4b40-9068-39f77b3a91f9 + name: Volkskreditbank + - id: 3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3 + name: Erste Bank und Sparkassen + - id: ba7199cc-f057-42f2-9856-2378abf21638 + name: BAWAG P.S.K. Gruppe + key: issuer + type: select + name: EPS + type: eps + - name: Expert Cadeaukaart + type: expertgiftcard + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 3x Oney + type: facilypay_3x + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: FR + name: France + - id: ES + name: Spain + key: country + type: select + key: deliveryAddress + optional: true + type: address + name: 4x Oney + type: facilypay_4x + - name: Fashioncheque + type: fashioncheque + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: Fawry + type: fawry + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Fonq Giftcard + type: fonqgiftcard + - name: Gall & Gall + type: gallgall + - name: GCash + type: gcash + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - details: + - key: bic + type: text + name: GiroPay + type: giropay + - name: Givex + type: givex + - name: Globe GCash + type: globegcash + - name: Goldsmiths Card + type: goldsmithscard + - name: GoPay Wallet + type: gopay_wallet + - name: OVO + type: grabpay_ID + - name: GrabPay + type: grabpay_PH + - name: GrabPay + type: grabpay_SG + - name: Hallmark Card + type: hallmarkcard + - name: HDFC + type: hdfc + - name: Hunkemoller Member Card + type: hmclub + - name: Hunkemoller Lingerie Card + type: hmlingerie + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - name: igive + type: igive + - name: Korean Account Transfer (IniPay) + type: inicisIniPay_accounttransfer + - name: Korean Credit Cards (IniPay) + type: inicisIniPay_creditcard + - name: Korean Mobile Phone (IniPay) + type: inicisIniPay_mobilephone + - name: Korean Virtual Account (IniPay) + type: inicisIniPay_virtualaccount + - name: Korean Account Transfer (Mobile) + type: inicisMobile_accounttransfer + - name: Korean Credit Cards (Mobile) + type: inicisMobile_creditcard + - name: Korean Mobile Phone (Mobile) + type: inicisMobile_mobilephone + - name: Korean Virtual Account (Mobile) + type: inicisMobile_virtualaccount + - name: Korean Credit Cards + type: inicis_creditcard + - name: "Interac\xAE Online" + type: interac + - name: Instant EFT + type: ipay + - name: iPay88 + type: ipay88 + - name: isracard + type: isracard + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: KakaoPay + type: kakaopay + - name: Karen Millen Card + type: karenmillen + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Bank Transfer + type: kcp_banktransfer + - name: "Korea\u2013issued cards" + type: kcp_creditcard + - name: PayCo + type: kcp_payco + - name: Naver Pay + type: kcp_naverpay + - name: Virtual Account via KCP + type: kcp_va + - name: Pay later with Klarna. + type: klarna + - name: Pay over time with Klarna. + type: klarna_account + - name: Klarna B2B + type: klarna_b2b + - name: Pay now with Klarna. + type: klarna_paynow + - name: Leisure Card + type: leisurecard + - name: China Credit Card + type: lianlianpay_creditcard + - name: China Debit Card + type: lianlianpay_debitcard + - details: + - key: telephoneNumber + type: tel + name: China Online Banking - Credit Card + type: lianlianpay_ebanking_credit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '4031000' + name: Bank of Beijing + - id: '01040000' + name: Bank of China + - id: '03020000' + name: China Citic Bank + - id: '01050000' + name: China Construction Bank + - id: '03030000' + name: China Everbright Bank + - id: 03080000 + name: China Merchants Bank + - id: '03050000' + name: China Minsheng Banking Group + - id: '03040000' + name: Hua Xia Bank Co + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03070000' + name: PingAn Bank + - id: '1000000' + name: Postal Savings Bank of China + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Debit Card + type: lianlianpay_ebanking_debit + - details: + - items: + - id: '01030000' + name: Agricultural Bank of China + - id: '01050000' + name: China Construction Bank + - id: 03080000 + name: China Merchants Bank + - id: '01020000' + name: Industrial and Commercial Bank of China + - id: '03100000' + name: Shanghai Pudong Development Bank + key: issuer + type: select + - key: telephoneNumber + type: tel + name: China Online Banking - Enterprise + type: lianlianpay_ebanking_enterprise + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - name: Love2Shop GiftCard + type: love2shop + - details: + - key: shopper.firstName + type: text + - key: shopper.lastName + type: text + - key: shopper.gender + type: text + - key: shopperEmail + type: emailAddress + - key: telephoneNumber + type: tel + - key: countryCode + type: text + name: mada + type: mada + - name: Mappin & Webb Card + type: mappinwebbcard + - name: MB WAY + type: mbway + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: Mercado Pago + type: mercadopago + - name: MobilePay + type: mobilepay + - name: AliPay via Razer Merchant Services + type: molpay_alipay + - name: 7-Eleven + type: molpay_cash + - name: CIMB Virtual Account + type: molpay_cimb_va + - name: Malaysia E-Banking via Razer Merchant Services + type: molpay_ebanking_MY + - details: + - items: + - id: vtcpay-vietinbank + name: Vietinbank + - id: vtcpay-bidv + name: BIDV + - id: vtcpay-agribank + name: Agribank + - id: vtcpay-mb + name: MB Bank + - id: vtcpay-sacombank + name: Sacombank + - id: vtcpay-dongabank + name: DongABank + - id: vtcpay-maritimebank + name: MaritimeBank + - id: vtcpay-vietcombank + name: Vietcombank + - id: vtcpay-acb + name: ACB + - id: vtcpay-techcombank + name: Techcombank + key: issuer + type: select + name: Vietnam E-Banking + type: molpay_ebanking_VN + - details: + - items: + - id: fpx_bimb + name: Bank Islam + - id: fpx_uob + name: UOB Bank + - id: fpx_cimbclicks + name: CIMB Clicks + - id: fpx_kfh + name: Kuwait Finance House + - id: fpx_rhb + name: RHB Now + - id: fpx_abmb + name: Alliance Bank + - id: fpx_amb + name: Am Online + - id: fpx_hsbc + name: HSBC + - id: fpx_abb + name: Affin Bank + - id: fpx_ocbc + name: OCBC Bank + - id: fpx_pbb + name: Public Bank + - id: fpx_scb + name: Standard Chartered Bank + - id: fpx_bsn + name: Bank Simpanan Nasional + - id: fpx_mb2u + name: Maybank2u + - id: fpx_hlb + name: Hong Leong Connect + - id: fpx_bmmb + name: Bank Muamalat + - id: fpx_bkrm + name: Bank Rakyat + key: issuer + type: select + name: Malaysia E-Banking + type: molpay_ebanking_fpx_MY + - name: eNETS Debit + type: molpay_enetsd + - name: epay + type: molpay_epay + - name: Esapay + type: molpay_esapay + - name: MyClear FPX + type: molpay_fpx + - name: Maybank2u + type: molpay_maybank2u + - name: Nganluong + type: molpay_nganluong + - name: Tesco Lotus + type: molpay_paysbuy + - name: MOLPoints + type: molpay_points + - name: RHB Now + type: molpay_rhb + - name: SAM by SingPost + type: molpay_singpost + - name: MOLWallet + type: molpay_wallet + - name: MoMo ATM + type: momo_atm + - name: Momo Wallet + type: momo_wallet + - name: Moneybookers + type: moneybookers + - name: Multibanco + type: multibanco + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: BankAxess + type: netaxept_bankaxess + - name: NETELLER + type: neteller + - name: Onebip + type: onebip + - name: One Two Three + type: onetwothree + - name: Online Banking PL + type: onlineBanking_PL + - details: + - items: + - id: '1' + name: Model Bank v2 + key: issuer + type: select + name: Online banking + type: openbanking_UK + - name: Oxxo + type: oxxo + - name: Pathe Giftcard + type: pathegiftcard + - name: PayBright + type: paybright + - name: PayMaya Wallet + type: paymaya_wallet + - name: PayPal + type: paypal + - name: Paysafecard + type: paysafecard + - name: Payshop + type: payshop + - name: PayD AMT via Paythru + type: paythru_amt + - name: EFT via Paythru + type: paythru_eft + - name: PayTM + type: paytm + - details: + - key: virtualPaymentAddress + type: text + name: PayU UPI + type: payu_IN_upi + - name: EFT Pro via PayU + type: payu_ZA_eftpro + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: pix + type: pix + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Podium Card + type: podiumcard + - name: POLi + type: poli + - name: PPS + type: pps + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Illicado Gift Card + type: prosodie_illicado + - name: PSE + type: pse + - details: + - items: + - id: '+7' + name: RU + - id: '+9955' + name: GE + - id: '+507' + name: PA + - id: '+44' + name: GB + - id: '+992' + name: TJ + - id: '+370' + name: LT + - id: '+972' + name: IL + - id: '+996' + name: KG + - id: '+380' + name: UA + - id: '+84' + name: VN + - id: '+90' + name: TR + - id: '+994' + name: AZ + - id: '+374' + name: AM + - id: '+371' + name: LV + - id: '+91' + name: IN + - id: '+66' + name: TH + - id: '+373' + name: MD + - id: '+1' + name: US + - id: '+81' + name: JP + - id: '+998' + name: UZ + - id: '+77' + name: KZ + - id: '+375' + name: BY + - id: '+372' + name: EE + - id: '+40' + name: RO + - id: '+82' + name: KR + key: qiwiwallet.telephoneNumberPrefix + type: select + - key: qiwiwallet.telephoneNumber + type: text + name: Qiwi Wallet + type: qiwiwallet + - name: RatePay Invoice + type: ratepay + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: SafetyPay + type: safetypay + - name: SafetyPay Cash + type: safetypay_cash + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: SEB Direktbetalning + type: sebdirectpayment + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: 7-Eleven + type: seveneleven + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: Swish + type: swish + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: TenPay + type: tenpay + - name: The Sting Giftcard + type: thestinggiftcard + - name: TrueMoney + type: truemoney + - name: Trustly + type: trustly + - name: Online Banking by Trustpay + type: trustpay + - name: TWINT + type: twint + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - details: + - key: virtualPaymentAddress + type: text + name: UPI Collect + type: upi_collect + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: telephoneNumber + optional: true + type: tel + name: Vipps + type: vipps + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: VVV Giftcard + type: vvvgiftcard + - name: Webshop Giftcard + type: webshopgiftcard + - name: WeChat Pay + type: wechatpayMiniProgram + - name: WeChat Pay + type: wechatpayQR + - name: WeChat Pay + type: wechatpayWeb + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: WOS Card + type: woscard + - name: Alfa-Click + type: yandex_alfaclick + - name: Pay using bank card + type: yandex_bank_card + - name: Cash terminals + type: yandex_cash + - name: Pay using installments + type: yandex_installments + - name: YooMoney + type: yandex_money + - name: Promsvyazbank + type: yandex_promsvyazbank + - name: Sberbank Online + type: yandex_sberbank + - name: WebMoney + type: yandex_webmoney + - name: Your Gift + type: yourgift + - name: Zip + type: zip + post-paymentMethods-filtered: + summary: Get payment methods based on the country and amount + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + shopperLocale: nl-NL + amount: + currency: EUR + value: 1000 + post-paymentMethods-filtered-200: + summary: Example response for request 'filtered' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: "Hitelk\xE1rtya" + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift + post-paymentMethods-include-oneclick: + summary: Get payment methods including stored card details + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + countryCode: NL + amount: + currency: EUR + value: 1000 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-paymentMethods-include-oneclick-200: + summary: Example response for request 'include-oneclick' + value: + paymentMethods: + - details: + - items: + - id: '1121' + name: Test Issuer + - id: '1154' + name: Test Issuer 5 + - id: '1153' + name: Test Issuer 4 + - id: '1152' + name: Test Issuer 3 + - id: '1151' + name: Test Issuer 2 + - id: '1162' + name: Test Issuer Cancelled + - id: '1161' + name: Test Issuer Pending + - id: '1160' + name: Test Issuer Refused + - id: '1159' + name: Test Issuer 10 + - id: '1158' + name: Test Issuer 9 + - id: '1157' + name: Test Issuer 8 + - id: '1156' + name: Test Issuer 7 + - id: '1155' + name: Test Issuer 6 + key: issuer + type: select + name: iDEAL + type: ideal + - details: + - key: encryptedCardNumber + type: cardToken + - key: encryptedSecurityCode + type: cardToken + - key: encryptedExpiryMonth + type: cardToken + - key: encryptedExpiryYear + type: cardToken + - key: holderName + optional: true + type: text + name: Credit Card + type: scheme + - name: PayPal + type: paypal + - details: + - details: + - key: firstName + type: text + - key: lastName + type: text + - items: + - id: M + name: male + - id: F + name: female + key: gender + type: radio + - key: dateOfBirth + type: date + - key: telephoneNumber + type: tel + - key: shopperEmail + type: emailAddress + key: personalDetails + type: fieldSet + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: billingAddress + type: address + - key: separateDeliveryAddress + optional: true + type: boolean + value: 'false' + - details: + - key: street + type: text + - key: houseNumberOrName + type: text + - key: city + type: text + - key: postalCode + type: text + - key: stateOrProvince + optional: true + type: text + - items: + - id: NL + name: Netherlands + - id: BE + name: Belgium + key: country + type: select + value: NL + key: deliveryAddress + optional: true + type: address + name: AfterPay Invoice + type: afterpay_default + - name: Pay later with Klarna. + type: klarna + - details: + - key: sepa.ownerName + type: text + - key: sepa.ibanNumber + type: text + name: SEPA Direct Debit + type: sepadirectdebit + - name: Paysafecard + type: paysafecard + - name: Bijenkorf Cadeaucard + type: bijcadeaucard + - name: Fonq Giftcard + type: fonqgiftcard + - name: Bank Transfer (NL) + type: bankTransfer_NL + - name: Pathe Giftcard + type: pathegiftcard + - name: VVV Giftcard + type: vvvgiftcard + - name: Podium Card + type: podiumcard + - name: RatePay Direct Debit + type: ratepay_directdebit + - name: Rituals Giftcard + type: rituals + - name: Hunkemoller Lingerie Card + type: hmlingerie + - name: Primera Cadeaukaart + type: primeracadeaucard + - name: Fashioncheque + type: fashioncheque + - name: NETELLER + type: neteller + - name: Adyen Voucher + type: adyen_test_voucher + - name: AfterPay B2B + type: afterpay_b2b + - name: AfterPay DirectDebit + type: afterpay_directdebit + - name: AliPay + type: alipay + - name: AliPay + type: alipay_wap + - details: + - key: additionalData.androidpay.token + type: androidPayToken + name: Android Pay + type: androidpay + - details: + - key: additionalData.applepay.token + type: applePayToken + name: Apple Pay + type: applepay + - name: Baby Gift Card + type: babygiftcard + - name: SEPA Bank Transfer + type: bankTransfer_IBAN + - name: Bloemen Giftcard + type: bloemengiftcard + - name: Boekenbon Giftcard + type: boekenbon + - name: Cash-Ticket + type: cashticket + - name: Chasin Giftcard + type: chasingiftcard + - name: ClickandBuy + type: clickandbuy + - name: Costes Giftcard + type: costesgiftcard + - name: custom_settlement + type: custom_settlement + - name: eft_directdebit_CA + type: eft_directdebit_CA + - name: Nationale Entertainment Card + type: entertainmentcard + - name: Expert Cadeaukaart + type: expertgiftcard + - name: FijnCadeau + type: fijncadeau + - name: Fleurop Bloemenbon + type: fleuropbloemenbon + - name: Gall & Gall + type: gallgall + - name: Generic GiftCard + type: genericgiftcard + - name: GiftFor2 + type: giftfor2card + - name: Givex + type: givex + - name: Goldsmiths Card + type: goldsmithscard + - name: Hunkemoller Member Card + type: hmclub + - name: Phone Payment + type: ivr + - name: Landline phone + type: ivrLandline + - name: Mobile phone + type: ivrMobile + - name: Kado Wereld + type: kadowereld + - name: Karen Millen GiftCard + type: karenmillengiftcard + - name: Leisure Card + type: leisurecard + - name: Loods5 Cadeaukaart + type: loods5giftcard + - name: Loods5 Tegoedbon + type: loods5prepaidcard + - details: + - key: additionalData.amazonPayToken + type: text + name: Amazon Pay + supportsRecurring: true + type: amazonpay + - name: MOLPoints + type: molpay_points + - name: Moneybookers + type: moneybookers + - name: De Nationale Musicalcard + type: musicalcard + - name: Nationale Bioscoopbon + type: nationalebioscoopbon + - name: Nationale Tuinbon + type: nationaletuinbon + - name: Nationale Verwen Cadeaubon + type: nationaleverwencadeaubon + - name: Onebip + type: onebip + - details: + - key: additionalData.paywithgoogle.token + type: payWithGoogleToken + name: Google Pay + type: paywithgoogle + - name: Plastix + type: plastix + - name: Pluim + type: pluimgiftcard + - name: Illicado Gift Card + type: prosodie_illicado + - name: RatePay Invoice + type: ratepay + - name: Rob Peetoom Giftcard + type: robpeetoomgiftcard + - name: Shoes&Accessories Cadeau + type: sagiftcard + - name: Score Giftcard + type: scoregiftcard + - name: Premium SMS + type: sms + - name: SVS + type: svs + - name: TCS Test GiftCard + type: tcstestgiftcard + - name: The Sting Giftcard + type: thestinggiftcard + - name: Ukash + type: ukash + - name: UnionPay + type: unionpay + - name: Valuelink + type: valuelink + - name: V&D Cadeaukaart + type: vdcadeaucard + - details: + - key: additionalData.visacheckout.callId + type: text + name: Visa Checkout + type: visacheckout + - name: VVV Cadeaubon + type: vvvcadeaubon + - name: Webshop Giftcard + type: webshopgiftcard + - name: WE Fashion Giftcard + type: wefashiongiftcard + - name: Western Union + type: westernunion + - name: Winkel Cheque + type: winkelcheque + - name: Your Gift + type: yourgift + post-paymentSession-android: + summary: Set up a payment session (Android) + value: + amount: + currency: EUR + value: 17408 + reference: Your order number + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + channel: Android + token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK + returnUrl: app:// + countryCode: NL + shopperLocale: nl_NL + sessionValidity: '2017-04-06T13:09:13Z' + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentSession-enableOneClick: + summary: Set up a payment session with the option to store card details + value: + amount: + currency: EUR + value: 17408 + reference: Your order number + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + enableOneClick: true + enableRecurring: true + channel: Web + html: true + origin: https://www.yourwebsite.com + returnUrl: https://www.yourshop.com/checkout/result + countryCode: NL + shopperLocale: nl_NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + sdkVersion: 1.7.0 + post-paymentSession-enableOneClick-200: + summary: Example response for request 'enableOneClick' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... + post-paymentSession-ios: + summary: Set up a payment session (iOS) + value: + amount: + currency: EUR + value: 17408 + reference: Your order number + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + channel: iOS + token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK + returnUrl: app:// + countryCode: NL + shopperLocale: nl_NL + sessionValidity: '2017-04-06T13:09:13Z' + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentSession-split: + summary: Split a payment between a sub-merchant and a platform account + value: + amount: + currency: EUR + value: 6200 + additionalData: + split.api: '1' + split.nrOfItems: '2' + split.totalAmount: '6200' + split.currencyCode: EUR + split.item1.amount: '6000' + split.item1.type: MarketPlace + split.item1.account: '151272963' + split.item1.reference: '6124145' + split.item1.description: 'Porcelain Doll: Eliza (20cm)' + split.item2.amount: '200' + split.item2.type: Commission + split.item2.reference: '6124146' + reference: Your order number + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + channel: Android + token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK + returnUrl: app:// + countryCode: NL + shopperLocale: nl_NL + sessionValidity: '2017-04-06T13:09:13Z' + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-paymentSession-web: + summary: Set up a payment session (Web) + value: + amount: + currency: EUR + value: 17408 + reference: Your order number + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + channel: Web + html: true + origin: https://www.yourwebsite.com + returnUrl: https://www.yourshop.com/checkout/result + countryCode: NL + shopperLocale: nl_NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + sdkVersion: 1.9.5 + post-paymentSession-web-200: + summary: Example response for request 'web' + value: + paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... + post-payments-applepay: + summary: Make an Apple Pay payment + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: applepay + applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU... + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-card-3d-secure-2-web: + summary: Make a card payment with 3D Secure 2 native authentication + value: + amount: + currency: USD + value: 1000 + reference: YOUR_ORDER_NUMBER + paymentMethod: + type: scheme + number: '4917610000000000' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + cvc: '737' + additionalData: + allow3DS2: true + accountInfo: + accountCreationDate: '2019-01-17T13:42:40+01:00' + billingAddress: + country: US + city: New York + street: Redwood Block + houseNumberOrName: 37C + stateOrProvince: NY + postalCode: '10039' + shopperEmail: s.hopper@test.com + shopperIP: 192.0.2.1 + browserInfo: + userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 + (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 + acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 + language: nl-NL + colorDepth: 24 + screenHeight: 723 + screenWidth: 1536 + timeZoneOffset: 0 + javaEnabled: true + channel: web + origin: https://your-company.com + returnUrl: https://your-company.com/checkout/ + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-card-3d-secure-2-web-200: + summary: Example response for request 'card-3d-secure-2-web' + value: + additionalData: + cvcResult: 1 Matches + authCode: 097410 + avsResult: 4 AVS not supported for this card type + avsResultRaw: C + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9VHQOF + pspReference: 993617895214576G + resultCode: Authorised + merchantReference: string + post-payments-card-3d-secure-direct: + summary: Make card payment with 3D Secure redirect authentication + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + number: '4212345678901237' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + cvc: '737' + browserInfo: + userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 + Firefox/3.0 + acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-card-3d-secure-direct-200: + summary: Example response for request 'card-3d-secure-direct' + value: + additionalData: + cvcResult: 1 Matches + authCode: 054817 + avsResult: 4 AVS not supported for this card type + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9VIO26 + pspReference: 993617895217578K + resultCode: Authorised + merchantReference: string + post-payments-card-3d-secure-securedfields: + summary: Make a payment with 3D Secure 2 native authentication + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + encryptedCardNumber: test_4212345678901237 + encryptedExpiryMonth: test_03 + encryptedExpiryYear: test_2030 + encryptedSecurityCode: test_737 + holderName: John Smith + browserInfo: + userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 + Firefox/3.0 + acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-card-3d-secure-securedfields-200: + summary: Example response for request 'card-3d-secure-securedfields' + value: + additionalData: + cvcResult: 1 Matches + authCode: '046773' + avsResult: 4 AVS not supported for this card type + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9VCAVH + pspReference: 993617895196572H + resultCode: Authorised + merchantReference: string + post-payments-card-direct: + summary: Make a card payment + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + cvc: '737' + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-card-direct-200: + summary: Example response for request 'card-direct' + value: + additionalData: + cvcResult: 1 Matches + authCode: 044925 + avsResult: 4 AVS not supported for this card type + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9VEP3H + pspReference: 993617895204576J + resultCode: Authorised + merchantReference: string + post-payments-card-securedfields: + summary: Make a card payment (using encrypted card details) + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + encryptedCardNumber: test_4111111111111111 + encryptedExpiryMonth: test_03 + encryptedExpiryYear: test_2030 + encryptedSecurityCode: test_737 + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-card-securedfields-200: + summary: Example response for request 'card-securedfields' + value: + additionalData: + cvcResult: 1 Matches + authCode: 065696 + avsResult: 4 AVS not supported for this card type + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9VIE9N + pspReference: 993617895215577D + resultCode: Authorised + merchantReference: string + post-payments-details-3d-secure-2-native: + summary: Submit 3D Secure 2 authentication result + value: + details: + threeDSResult: eyJ0cmFuc1N0YXR1cyI6IlkifQ== + post-payments-details-redirect: + summary: Submit the redirect result + value: + details: + redirectResult: X6XtfGC3!Y... + post-payments-enableOneClick-SF: + summary: Tokenize card details for one-off payments (using encrypted card details) + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + encryptedCardNumber: test_4111111111111111 + encryptedExpiryMonth: test_03 + encryptedExpiryYear: test_2030 + encryptedSecurityCode: test_737 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + storePaymentMethod: true + shopperInteraction: Ecommerce + recurringProcessingModel: CardOnFile + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-enableOneClick-SF-200: + summary: Example response for request 'enableOneClick-SF' + value: + additionalData: + cvcResult: 1 Matches + authCode: 082338 + avsResult: 4 AVS not supported for this card type + recurring.recurringDetailReference: '9916178934434753' + recurringProcessingModel: CardOnFile + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9VC172 + pspReference: 993617895195570C + resultCode: Authorised + merchantReference: string + post-payments-enableOneClick-raw: + summary: Tokenize card details for one-off payments + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + cvc: '737' + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperInteraction: Ecommerce + recurringProcessingModel: CardOnFile + storePaymentMethod: true + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-enableOneClick-raw-200: + summary: Example response for request 'enableOneClick-raw' + value: + additionalData: + cvcResult: 1 Matches + authCode: '003704' + avsResult: 4 AVS not supported for this card type + recurring.recurringDetailReference: '9916178934434753' + recurringProcessingModel: CardOnFile + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9VCKO0 + pspReference: 993617895197573E + resultCode: Authorised + merchantReference: string + post-payments-giropay: + summary: Make a giropay payment + value: + amount: + currency: EUR + value: 1000 + reference: Your order number + paymentMethod: + type: giropay + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-giropay-200: + summary: Example response for request 'giropay' + value: + resultCode: RedirectShopper + action: + paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 + paymentMethodType: giropay + url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA + method: GET + type: redirect + details: + - key: payload + type: text + paymentData: Ab02b4c0!BQABAgAt9sA8lQOSEpwOpedJBZvOI6J4xAEGqCpPCfZkvEQPbXSQBP0O+HEElyemCjzTkp4G70QJLaMvq6IlQ5uPk8rlFoPbTb59E9vrOS4IXxlxQH2TQ6iAAGJvU/SIBHAqENNbg1MjG5HR04c6GgpmaO/9LISgGVlqyoY8FlyHvJQcPcMqkK1hYh0mGmbHLtXqyCAx6yRIOGpV3aaI3GMNkSwf3007BwxJBNd7o0o3XktxLuqU8T9OJquwqWoD2FtfUZ9ZEPk2m5/AbOvhoFYuWrKCW1xptWw04m3JyAJHB2F7gPMjwAi5rE0hlMu3d19WucrxsXakeA/noqubbvsHqqtWdRAn+2fMrpOacX5C4VDdE/xrED6iHM6VoqCztCH8mBtyPxPPU5DMnfxUmmeTrIrrf8j95S1FBman8UORs3jiFtCgCD6uS7y0cFSs6J2DWijpO0chjxNM4xR4q5gedL2idE6rRjZjm6cLhrM21XeroNvQYJtoW2q+gDxl9o/3M74jP+3sPafBZMkdHZ8vUdCueHDdw7bST5UCPHRnEfNHy5XaYf2kG0meaE3tpAAmoCNO2qPdcozHJZggVl9lqHQ394BLpLfYr3YROyWu+36HQRZoa2U2Yz/sFYhF81Iimx6FQWEtLZzT/kGJHsXawb68gqd7xf9jo4p6qokklGkzCRC3iOTKmbnmADUPLdy/qNw7AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifX48+5ZqamGvpSW2oKGEqf2KQdVyjcJrlnNiJKp613bt+5k9/OD8G/5T00dp7aNtQx9nGc+mWf17T7VZ6OmooTBV9bmL0ZcGccD+z4UvQbxjXYnMXKLfQmHKi58x6skXW0y3PhxfCLbm/BClmKuCIrACpLmqX/Mu9mJU4DpdOFMpf047WLI9T9yFQ/6ciUpi09DD89bOGQwvlVTkJhvPu31u7OZCd1r8sZ+NsyoEv5Pe3VPRh6R+OoGuY8cDOt9GhMfjGxp7whTcxtKzwnvETJrMrsRfCVIXv95DefR/YsVL8kchNmljNwwzvCGWACeNM7lY6/96+d27Cf2VBf5fS9EcSGtlZpYpNXsdOMLyJBYdiCujp6r1Sd68jsLJG8/XGw9MPODz8Bhqg5XSLuukhGlmVgSkp/TwHwl+p0bhnS0fz+VWDp90mrEY1B8vxFe4yZ1v0sWWaX5USb1/sEZVT3X/1X2qFCbpM6jr498Kk3w3dUGPmDlZ+XiFk0HUt2800jTYrTZYRMjQjnEOrL15aW5h2ynCtxAJXewfk+9NSYjqScbvHKjLGA8FUB6v5TVhsf+sNFSf/zVtNs+PczPZDZMLTiUnZih36iAu5f4HYjl1o4/K+V1JSKHjegDggW+RCUokGH6kKRnMcs2pU3KoG9kOdGDBOQYj94a+CPWfgE7j97v2bQxmbFHOWgJLzX0lPGM3RR5dDboH3k2BrDHb92K88i+2IHMO8WvrW2qhkB4lGpecupG0XEBOUTH4Lnc3TzUFgsDCvF8mnLweIbRyohzd4SAfn2W4wR7QK1S0 + redirect: + method: GET + url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1vozAQ-DXwFoT5zoMfIkpbmqRtSDhVfakcswUrxKa24UJ--Rku16tOJ1m71oy1O7ProyS8SkUFuGZSdGS0aS8lcDrOYFYW9hkkbQjXK0pFzzU*gNLbK-ZF5lxDLYlmgjt67ACn91m6fioPb3fZY1bk6X9fDiCVyThEX3QB7zD1B6y0ZLz*Ruhe8huiCV4uUYTiZBmiZRBH6G-tPatx*7CG-fFJtt1OslMx7P3oMd9dVq9pOyq9e6Z36*1LF6F689Pyb2xj*QzG3Hn2hlzXtSWostjgRuvO8leWd2tOKyhpG6G0QRI3cQ1EG6An0WvViK4DaRAFcmAUlLk*-y6bcyrOxkUBFZNAtWEG9Kfc9c0WdCMqy7-9Z9BG3fdRW14k5xEYbYaa1JlG4SQwnCSaMIpeLkzDjvDRMXkGHcexFahpzj9IyyqmR*y5Hlq4wcJNDigyjtDShDB4ta9eph1JQqcd4cwUmpSBrU6Mz7*i64-O4DnXNcRRHMco8QPnMx9e-MNDVCXDmHnN6vJGq6a5lG5efr4HH5uP7H6T1TBWlfgFnQraMA + post-payments-googlepay: + summary: Make a Google Pay payment + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: paywithgoogle + googlePayToken: ==Payload as retrieved from Google Pay response== + returnUrl: https://your-company.com/... + merchantAccount: YourMerchantAccount + post-payments-ideal: + summary: Make an iDEAL payment + value: + amount: + currency: EUR + value: 1000 + reference: Your order number + paymentMethod: + type: ideal + issuer: '1121' + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-ideal-200: + summary: Example response for request 'ideal' + value: + resultCode: RedirectShopper + action: + paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== + paymentMethodType: ideal + url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ + method: GET + type: redirect + details: + - key: payload + type: text + paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag== + redirect: + method: GET + url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ + post-payments-klarna: + summary: Make a Klarna payment + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: YOUR_ORDER_REFERENCE + paymentMethod: + type: klarna + amount: + currency: SEK + value: '1000' + shopperLocale: en_US + countryCode: SE + telephoneNumber: +46 840 839 298 + shopperEmail: youremail@email.com + shopperName: + firstName: Testperson-se + gender: UNKNOWN + lastName: Approved + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + billingAddress: + city: Ankeborg + country: SE + houseNumberOrName: '1' + postalCode: '12345' + street: Stargatan + deliveryAddress: + city: Ankeborg + country: SE + houseNumberOrName: '1' + postalCode: '12345' + street: Stargatan + returnUrl: https://www.your-company.com/... + lineItems: + - quantity: '1' + amountExcludingTax: '331' + taxPercentage: '2100' + description: Shoes + id: 'Item #1' + taxAmount: '69' + amountIncludingTax: '400' + productUrl: URL_TO_PURCHASED_ITEM + imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM + - quantity: '2' + amountExcludingTax: '248' + taxPercentage: '2100' + description: Socks + id: 'Item #2' + taxAmount: '52' + amountIncludingTax: '300' + productUrl: URL_TO_PURCHASED_ITEM + imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM + post-payments-oneclick-direct: + summary: Make a one-off payment with a token and CVV + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + storedPaymentMethodId: '8416038790273850' + cardDetails.cvc: '737' + shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-oneclick-securedfields: + summary: Make a one-off payment with a token and CVV (using encrypted card details) + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + storedPaymentMethodId: '8416038790273850' + encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH... + shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + shopperInteraction: ContAuth + recurringProcessingModel: CardOnFile + post-payments-recurring: + summary: Make a card payment with a token + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + storedPaymentMethodId: '8316038796685850' + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + shopperInteraction: ContAuth + recurringProcessingModel: Subscription + post-payments-result-basic: + summary: Verify payment results + value: + payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK + post-payments-sofort: + summary: Make a Sofort payment + value: + amount: + currency: EUR + value: 1000 + reference: Your order number + paymentMethod: + type: directEbanking + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-sofort-200: + summary: Example response for request 'sofort' + value: + resultCode: RedirectShopper + action: + paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== + paymentMethodType: directEbanking + url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA + method: GET + type: redirect + details: + - key: payload + type: text + paymentData: Ab02b4c0!BQABAgB1H7lBY8Uxf1bWoNkA9C2/BuD1Fa2+f3+u8Q3sZLCf6/nmkhPEg1CleH0L6NnNoxwgiHBzmljYF6QFoshWsEZ4Hp1fyq9S/IGHFcl6GlQHlQf/RATlCw21Il1BDhcjSib3JpxXWk/NeZbk/ZEvNrWNQOmHo0/eYxCSLl7OgE+PVyKfWogK8awCPNcqV52wgy27P7MlKQaZVfMTTlMfA2tS+xnGgXCXK+BpdLGXagCyRkhmi4QQLVv/sgSv4Zycu829yhaorOkum7hKEW3Os/DaIZbZjKglVpfFk4N2Qsa8ReydNGI1EeX9CfntJMFOMIWJeyfTimHhxZvUnIJ1cgIBLA8rdSxf3xExRXnK8xphXX+Aah4BIgRmLfOsnwsf6lnYcvPKg/3rMV/gK/g9iOC32wMGbzB7J+nPbW+ht5LJOK9ax/63H1bLT2Zm5UxcbzZsm8BccCyGqkMq8vZAE262urS4rGLzDCZXyJ22bq9yzQ/wUDVMhbTn55Cxotx+FwIhQA2SF0yZ+wgi1ty9ovl251eYbRdWNasvCwPaXxdTCVVD7wrdQbC5wQTpQO64EnQvYfiRerVQ5mCAu82VL4dCesNHvpKv2hKENa3p9ZFRJrle6wIUYX5fyscZDvEoqHvuqF+SpTXANK9PKGl6aaTCpg497/2x3wSU9Sxf8lzsrxAymOZnLENryrDr0v9IrYfDAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifexJovSnPKAg5NtTcILGEFLB/SoybKa3lEbVdUI76QewA8VFXNI8Ulnwlriy07AS4NDbZSfSfNYijSBS1uVsfo9kiabnFe0CQ29377TnsI1Bliv/CM6lBFp9SWQcLgSQQZkD1j4daab9L33mkUhQ/6Q+ERVtx2g+MAYNjl4xyJrc2IOQQ+0IUVGUZgJ4xKNTbf4TN0+EZXPvqxQ3ejsdtE3UhGjlZGS4HND7nkdljh/AfN5+JLe0fnvEgdfPZFttHCvdoOwosLL4ACSD5HH5v3Dc6wXuHAILopU+P/JUWa04gKInYMc1ABOzR9kOwzOHvWey7vrjONxyvUgietuYsuXkyozuL+hCgaJ4uZAIIvKqR/uTAZm76T82ds8+OcWoVgywHJRp+Vgn9Q2N5zf36DI/OWkQuYgRITz0NlT9QTjFwuWi15igdBlfufW/Gzp3mUXfYwj5GfJQBALOIGMzr9VEH6iukqHnA6tpdDOqAo9l5gsjzbPIMGkz66memwj5ZkxSSN69mgi+VEhOebAxSDDbGX0ONGY4gu12UQiiCOYx29LH3D7ANQTOjuyMmFBnHzMMRf+RoSzfrPLqiGvEC7b4vHwdzqCYNsz/cFAEouXFrZ72zzoWgpx62j/yKacRSW/PjmnEK/BOzjcovKfE3+thEybC0sjvDQSrMxQ34BvZM/+pWLXK5dY2QlBlHzRVPxmcw0tqO7dIcklC9GtEBrcr6Oc4U9ry0USIRLphRlP2eC4DOudUhbJ9AjujilVAocGy/BXOufpLJuhbaprux++0RRpxQ3ZdpMP//TiWuw== + redirect: + method: GET + url: https://test.adyen.com/hpp/checkout.shtml?u=skipDetails&p=eJxtUl1zmzAQ-DXmzYwE5sMPenAJjmmdtqHGTfuSkcUFaGyJSIKa-PoexHU7nc4wErN7c7e7p4PmskxUCaxsNAibHrh8bmTliE5rkGKYuLTInRNoUXNpV0KoTlq2A2PvLtiVzKSFSnPbKOnaoQWWbNLkw6di93ibfkzzLPlvZQ-a4M0CeqVzeIJxPjBj9ajnD2E7LW*45Wy5pCGN4mXg0SAKF**uNV*aitGvXrK3tw-forjdn5fdWp*LIg88UtzbtviRHVN1X9lNuJ15658z-8Zp*XACtHea3FFCiKPBFPmW1da2M3*FhfgdleDHWhmLSExigpCoQTyrzppatS1oRAzovhFg8PfzW9tMCnVCHzm85YxMT3*3u9Tcga1VOfPX-0SN6v4Oe*aFegoBtSE1qsNBwSgwGCXiMahOz3Fgy*Xg4j2Brus6BsyY9J4fm7KxA-OIR*dkMSfxjoboyCN40OC7c-EybklzMW6JpdhoVAaOwRcyvYu2O7i9514WEYVRFNHYX7ivWf-g796HZdwPqVevzo*irOtzQbLi9Wnxsn1JN9u0gqEs1S-zMtxA + post-payments-split: + summary: Split a payment between a sub-merchant and a platform account + value: + paymentMethod: + type: scheme + number: '4111111111111111' + cvc: '737' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + amount: + value: 6200 + currency: EUR + reference: YOUR_ORDER_NUMBER + merchantAccount: YOUR_MERCHANT_ACCOUNT + returnUrl: https://your-company.com/... + splits: + - amount: + value: 6000 + type: MarketPlace + account: '151272963' + reference: '6124145' + description: 'Porcelain Doll: Eliza (20cm)' + - amount: + value: 200 + type: Commission + reference: '6124146' + post-payments-subscription-first-transaction: + summary: Tokenize card details for a subscription + value: + amount: + currency: USD + value: 1000 + reference: Your order number + paymentMethod: + type: scheme + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + cvc: '737' + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + storePaymentMethod: true + shopperInteraction: Ecommerce + recurringProcessingModel: Subscription + returnUrl: https://your-company.com/... + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-payments-subscription-first-transaction-200: + summary: Example response for request 'subscription-first-transaction' + value: + additionalData: + cvcResult: 1 Matches + authCode: 098871 + avsResult: 4 AVS not supported for this card type + recurring.recurringDetailReference: '9916178934434753' + recurringProcessingModel: Subscription + avsResultRaw: '4' + cvcResultRaw: M + refusalReasonRaw: AUTHORISED + recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + acquirerCode: TestPmmAcquirer + acquirerReference: 8PQMP9VD896 + pspReference: 993617895199574A + resultCode: Authorised + merchantReference: string diff --git a/yaml/FundService-v5.yaml b/yaml/FundService-v5.yaml index d27553d..767d71c 100644 --- a/yaml/FundService-v5.yaml +++ b/yaml/FundService-v5.yaml @@ -1183,6 +1183,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber diff --git a/yaml/FundService-v6.yaml b/yaml/FundService-v6.yaml index 2cb948d..40975b8 100644 --- a/yaml/FundService-v6.yaml +++ b/yaml/FundService-v6.yaml @@ -1183,6 +1183,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber diff --git a/yaml/HopService-v1.yaml b/yaml/HopService-v1.yaml index 3a55801..e198355 100644 --- a/yaml/HopService-v1.yaml +++ b/yaml/HopService-v1.yaml @@ -306,6 +306,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -513,6 +514,10 @@ components: description: Indicates whether the page with the individual's details must be shown. Defaults to **true**. type: boolean + legalArrangementsDetailsSummaryPage: + description: Indicates whether the page with the legal arrangements' details + must be shown. Defaults to **true**. + type: boolean shareholderDetailsSummaryPage: description: Indicates whether the page with the shareholders' details must be shown. Defaults to **true**. diff --git a/yaml/HopService-v5.yaml b/yaml/HopService-v5.yaml index d5dfdf1..8e11ab6 100644 --- a/yaml/HopService-v5.yaml +++ b/yaml/HopService-v5.yaml @@ -309,6 +309,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -495,6 +496,10 @@ components: description: Indicates whether the page with the individual's details must be shown. Defaults to **true**. type: boolean + legalArrangementsDetailsSummaryPage: + description: Indicates whether the page with the legal arrangements' details + must be shown. Defaults to **true**. + type: boolean shareholderDetailsSummaryPage: description: Indicates whether the page with the shareholders' details must be shown. Defaults to **true**. diff --git a/yaml/HopService-v6.yaml b/yaml/HopService-v6.yaml index e21e156..a88ebdd 100644 --- a/yaml/HopService-v6.yaml +++ b/yaml/HopService-v6.yaml @@ -309,6 +309,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -495,6 +496,10 @@ components: description: Indicates whether the page with the individual's details must be shown. Defaults to **true**. type: boolean + legalArrangementsDetailsSummaryPage: + description: Indicates whether the page with the legal arrangements' details + must be shown. Defaults to **true**. + type: boolean shareholderDetailsSummaryPage: description: Indicates whether the page with the shareholders' details must be shown. Defaults to **true**. diff --git a/yaml/MarketPayNotificationService-v3.yaml b/yaml/MarketPayNotificationService-v3.yaml index 75a5e0a..b757e15 100644 --- a/yaml/MarketPayNotificationService-v3.yaml +++ b/yaml/MarketPayNotificationService-v3.yaml @@ -1778,6 +1778,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -2823,6 +2824,9 @@ components: type: array idNumber: deprecated: true + x-deprecatedInVersion: '3' + x-deprecatedMessage: Use `individualDetails.personalData.documentData.number` + instead. description: An ID number of the person. type: string nationality: diff --git a/yaml/MarketPayNotificationService-v4.yaml b/yaml/MarketPayNotificationService-v4.yaml index 3efea12..7f2e1ca 100644 --- a/yaml/MarketPayNotificationService-v4.yaml +++ b/yaml/MarketPayNotificationService-v4.yaml @@ -1884,6 +1884,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -2968,6 +2969,9 @@ components: type: array idNumber: deprecated: true + x-deprecatedInVersion: '3' + x-deprecatedMessage: Use `individualDetails.personalData.documentData.number` + instead. description: An ID number of the person. type: string nationality: diff --git a/yaml/MarketPayNotificationService-v5.yaml b/yaml/MarketPayNotificationService-v5.yaml index d370911..f51f20d 100644 --- a/yaml/MarketPayNotificationService-v5.yaml +++ b/yaml/MarketPayNotificationService-v5.yaml @@ -2060,6 +2060,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -2369,16 +2370,28 @@ components: PayoutMethod: properties: merchantAccount: + description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) + you used in the `/payments` request when you [saved the account holder's + card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string payoutMethodCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + payout method, returned in the response when you create a payout method. + Required when updating an existing payout method in an `/updateAccountHolder` + request. type: string - payoutMethodType: - enum: - - CardToken + payoutMethodReference: + description: Your reference for the payout method. type: string recurringDetailReference: + description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned + in the `/payments` response when you [saved the account holder's card + details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string shopperReference: + description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) + you sent in the `/payments` request when you [saved the account holder's + card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string required: - merchantAccount diff --git a/yaml/MarketPayNotificationService-v6.yaml b/yaml/MarketPayNotificationService-v6.yaml index 465a8cc..2d94a6a 100644 --- a/yaml/MarketPayNotificationService-v6.yaml +++ b/yaml/MarketPayNotificationService-v6.yaml @@ -868,23 +868,23 @@ components: type: string payoutAccountCountry: x-addedInVersion: '6' - description: Payout account country. + description: The country code of the bank from which the payout was initiated. type: string payoutAccountNumber: x-addedInVersion: '6' - description: Payout bank account number. + description: The account number of the bank from which the payout was initiated. type: string payoutBankName: x-addedInVersion: '6' - description: Payout bank name. + description: The name of the bank the payout from which the payout was initiated. type: string payoutBranchCode: x-addedInVersion: '6' - description: Payout branch code. + description: The branch code of the bank from which the payout was initiated. type: string payoutReference: x-addedInVersion: '6' - description: Payout transaction id. + description: The unique payout identifier. format: int64 type: integer payoutSpeed: @@ -2113,6 +2113,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber @@ -2634,16 +2635,28 @@ components: PayoutMethod: properties: merchantAccount: + description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) + you used in the `/payments` request when you [saved the account holder's + card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string payoutMethodCode: + description: Adyen-generated unique alphanumeric identifier (UUID) for the + payout method, returned in the response when you create a payout method. + Required when updating an existing payout method in an `/updateAccountHolder` + request. type: string - payoutMethodType: - enum: - - CardToken + payoutMethodReference: + description: Your reference for the payout method. type: string recurringDetailReference: + description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference) returned + in the `/payments` response when you [saved the account holder's card + details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string shopperReference: + description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) + you sent in the `/payments` request when you [saved the account holder's + card details](https://docs.adyen.com/platforms/payout-to-cards#check-and-store). type: string required: - merchantAccount diff --git a/yaml/NotificationConfigurationService-v5.yaml b/yaml/NotificationConfigurationService-v5.yaml index 866124b..6e9004d 100644 --- a/yaml/NotificationConfigurationService-v5.yaml +++ b/yaml/NotificationConfigurationService-v5.yaml @@ -548,6 +548,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber diff --git a/yaml/NotificationConfigurationService-v6.yaml b/yaml/NotificationConfigurationService-v6.yaml index 6322aca..a205819 100644 --- a/yaml/NotificationConfigurationService-v6.yaml +++ b/yaml/NotificationConfigurationService-v6.yaml @@ -548,6 +548,7 @@ components: - passportNumber - payoutMethodCode - payoutSchedule + - pciSelfAssessment - personalData - phoneCountryCode - phoneNumber diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index fda7016..46a1f70 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -1809,6 +1809,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2490,7 +2495,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -2755,8 +2760,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -2860,10 +2865,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -3146,10 +3151,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 51dd6e4..7e17382 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -1971,6 +1971,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2737,7 +2742,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -3002,8 +3007,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -3124,10 +3129,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -3427,10 +3432,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index bd9115f..e19ae22 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -2348,6 +2348,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -3307,7 +3312,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -3679,8 +3684,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -3801,10 +3806,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4141,10 +4146,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4474,10 +4479,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -5775,8 +5780,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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 ThreeDS2ResultRequest: properties: diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index 9d57e5b..36e6753 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -2348,6 +2348,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2638,8 +2643,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2868,8 +2873,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2940,8 +2945,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3025,8 +3030,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3327,7 +3332,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -3699,8 +3704,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -3821,10 +3826,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4161,10 +4166,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4494,10 +4499,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4752,8 +4757,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5644,8 +5649,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5813,8 +5818,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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 ThreeDS2ResultRequest: properties: @@ -5929,8 +5934,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index fc8e3ba..9fdbbb0 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -2348,6 +2348,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2638,8 +2643,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2868,8 +2873,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2940,8 +2945,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3025,8 +3030,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3327,7 +3332,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -3699,8 +3704,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -3821,10 +3826,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4161,10 +4166,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4494,10 +4499,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4752,8 +4757,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5644,8 +5649,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5853,8 +5858,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -5973,8 +5978,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index ea6a0eb..0c695c9 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -2365,6 +2365,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2655,8 +2660,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2885,8 +2890,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2957,8 +2962,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3042,8 +3047,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3344,7 +3349,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -3716,8 +3721,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -3838,10 +3843,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4184,10 +4189,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4523,10 +4528,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4787,8 +4792,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5679,8 +5684,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5883,7 +5888,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -5906,8 +5911,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -6026,8 +6031,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index 3d80d34..16dcaa9 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -2434,6 +2434,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2724,8 +2729,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2974,8 +2979,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3046,8 +3051,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3131,8 +3136,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3433,7 +3438,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -3811,8 +3816,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -3933,10 +3938,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4285,10 +4290,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4630,10 +4635,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4894,8 +4899,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5786,8 +5791,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -6011,7 +6016,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -6034,8 +6039,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -6154,8 +6159,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index ab43d7d..71e5169 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -2434,6 +2434,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2724,8 +2729,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2974,8 +2979,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3046,8 +3051,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3131,8 +3136,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3433,7 +3438,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -3819,8 +3824,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -3941,10 +3946,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4293,10 +4298,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4638,10 +4643,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4902,8 +4907,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5794,8 +5799,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -6019,7 +6024,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -6042,8 +6047,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -6162,8 +6167,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index bb3883e..68fc7ed 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -2434,6 +2434,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2724,8 +2729,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -2974,8 +2979,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3046,8 +3051,8 @@ components: type: string mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3131,8 +3136,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -3448,7 +3453,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -3834,8 +3839,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -3956,10 +3961,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4308,10 +4313,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4653,10 +4658,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4917,8 +4922,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -5809,8 +5814,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' @@ -6034,7 +6039,7 @@ components: cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication - value, only for CartesBancaires integrations. + value, only for Cartes Bancaires integrations. type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. @@ -6057,8 +6062,8 @@ components: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: - description: The `transStatusReason` value as defined in the 3D Secure 2 - specification. + 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' @@ -6177,8 +6182,8 @@ components: $ref: '#/components/schemas/Amount' mpiData: x-addedInVersion: '46' - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' originalMerchantReference: x-addedInVersion: '30' diff --git a/yaml/PaymentService-v67.yaml b/yaml/PaymentService-v67.yaml new file mode 100644 index 0000000..129b702 --- /dev/null +++ b/yaml/PaymentService-v67.yaml @@ -0,0 +1,6605 @@ +openapi: 3.1.0 +servers: +- url: https://pal-test.adyen.com/pal/servlet/Payment/v67 +info: + version: '67' + x-publicVersion: true + title: Adyen Payment API + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports versioning of its endpoints through a version suffix in + the endpoint URL. This suffix has the following format: "vXX", where XX is the + version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v67/authorise + + ```' + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- General +- Modifications +paths: + /adjustAuthorisation: + post: + tags: + - Modifications + summary: Increases or decreases the authorised amount. + description: 'Allows you to increase or decrease the authorised amount after + the initial authorisation has taken place. This functionality enables for + example tipping, improving the chances your authorisation will be valid, or + charging the shopper when they have already left the merchant premises. + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + + > If you have a [newer integration](https://docs.adyen.com/online-payments), + and are doing: + + > * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), + use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) + endpoint on Checkout API. + + > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), + use this endpoint.' + x-addedInVersion: '30' + operationId: post-adjustAuthorisation + x-groupName: Modifications + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' + schema: + $ref: '#/components/schemas/AdjustAuthorisationRequest' + responses: + '200': + content: + application/json: + examples: + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /authorise: + post: + tags: + - General + summary: Creates a payment authorisation. + description: 'Creates a payment with a unique reference (`pspReference`) and + attempts to obtain an authorisation hold. For cards, this amount can be captured + or cancelled later. Non-card payment methods typically don''t support this + and will automatically capture as part of the authorisation. + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) + endpoint under Checkout API instead.' + operationId: post-authorise + x-groupName: General + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + authorise-3d-secure-2: + $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' + authorise-recurringoneclick: + $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' + schema: + $ref: '#/components/schemas/PaymentRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /authorise3d: + post: + tags: + - General + summary: Completes a 3D Secure payment authorisation. + description: 'For an authenticated 3D Secure session, completes the payment + authorisation. This endpoint must receive the `md` and `paResponse` parameters + that you get from the card issuer after a shopper pays via 3D Secure. + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) + endpoint under Checkout API instead.' + operationId: post-authorise3d + x-groupName: General + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + authorise3d: + $ref: '#/components/examples/post-authorise3d-authorise3d' + schema: + $ref: '#/components/schemas/PaymentRequest3d' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /authorise3ds2: + post: + tags: + - General + summary: Completes a 3D Secure 2 payment authorisation. + description: 'For an authenticated 3D Secure 2 session, completes the payment + authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` + parameters. + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) + endpoint under Checkout API instead.' + x-addedInVersion: '37' + operationId: post-authorise3ds2 + x-groupName: General + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + authorise3ds2: + $ref: '#/components/examples/post-authorise3ds2-authorise3ds2' + schema: + $ref: '#/components/schemas/PaymentRequest3ds2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /cancel: + post: + tags: + - Modifications + summary: Cancels an authorised payment. + description: 'Cancels the authorisation hold on a payment, returning a unique + reference for this request. You can cancel payments after authorisation only + for payment methods that support distinct authorisations and captures. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel). + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) + endpoint under Checkout API instead.' + operationId: post-cancel + x-groupName: Modifications + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + cancel: + $ref: '#/components/examples/post-cancel-cancel' + schema: + $ref: '#/components/schemas/CancelRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /cancelOrRefund: + post: + tags: + - Modifications + summary: Cancels or refunds a payment. + description: "Cancels a payment if it has not been captured yet, or refunds\ + \ it if it has already been captured. This is useful when it is not certain\ + \ if the payment has been captured or not (for example, when using auto-capture).\n\ + \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ + \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ + \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ + \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ + \nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\ + \n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\ + \ If using a [newer integration](https://docs.adyen.com/online-payments),\ + \ use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals)\ + \ endpoint under Checkout API instead." + operationId: post-cancelOrRefund + x-groupName: Modifications + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' + schema: + $ref: '#/components/schemas/CancelOrRefundRequest' + responses: + '200': + content: + application/json: + examples: + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /capture: + post: + tags: + - Modifications + summary: Captures an authorised payment. + description: 'Captures the authorisation hold on a payment, returning a unique + reference for this request. Usually the full authorisation amount is captured, + however it''s also possible to capture a smaller amount, which results in + cancelling the remaining authorisation balance. + + + Payment methods that are captured automatically after authorisation don''t + need to be captured. However, submitting a capture request on these transactions + will not result in double charges. If immediate or delayed auto-capture is + enabled, calling the capture method is not neccessary. + + + For more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture). + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) + endpoint on Checkout API instead. + + + ' + operationId: post-capture + x-groupName: Modifications + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + capture: + $ref: '#/components/examples/post-capture-capture' + schema: + $ref: '#/components/schemas/CaptureRequest' + responses: + '200': + content: + application/json: + examples: + capture: + $ref: '#/components/examples/post-capture-capture-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /donate: + post: + tags: + - Modifications + summary: Creates a payment for the specified donation. + description: 'Schedules a new payment to be created (including a new authorisation + request) for the specified donation using the payment details of the original + payment. + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' + operationId: post-donate + x-groupName: Modifications + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + donate: + $ref: '#/components/examples/post-donate-donate' + schema: + $ref: '#/components/schemas/DonationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /getAuthenticationResult: + post: + tags: + - General + summary: Return the authentication result after doing a 3D Secure authentication + only. + description: Return the authentication result after doing a 3D Secure authentication + only. + x-addedInVersion: '51' + operationId: post-getAuthenticationResult + x-groupName: General + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + getAuthenticationResult: + $ref: '#/components/examples/post-getAuthenticationResult-getAuthenticationResult' + schema: + $ref: '#/components/schemas/AuthenticationResultRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationResultResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /refund: + post: + tags: + - Modifications + summary: Refunds a captured payment. + description: 'Refunds a payment that has previously been captured, returning + a unique reference for this request. Refunding can be done on the full captured + amount or a partial amount. Multiple (partial) refunds will be accepted as + long as their sum doesn''t exceed the captured amount. Payments which have + been authorised, but not captured, cannot be refunded, use the /cancel method + instead. + + + Some payment methods/gateways do not support partial/multiple refunds. + + A margin above the captured limit can be configured to cover shipping/handling + costs. + + + For more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund). + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) + endpoint under Checkout API instead.' + operationId: post-refund + x-groupName: Modifications + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + refund: + $ref: '#/components/examples/post-refund-refund' + schema: + $ref: '#/components/schemas/RefundRequest' + responses: + '200': + content: + application/json: + examples: + refund: + $ref: '#/components/examples/post-refund-refund-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /retrieve3ds2Result: + post: + tags: + - General + summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication + only. + description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication + only. + x-addedInVersion: '40' + operationId: post-retrieve3ds2Result + x-groupName: General + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + retrieve3ds2Result: + $ref: '#/components/examples/post-retrieve3ds2Result-retrieve3ds2Result' + schema: + $ref: '#/components/schemas/ThreeDS2ResultRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ThreeDS2ResultResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /technicalCancel: + post: + tags: + - Modifications + summary: Cancels a payment using your custom reference. + description: "This endpoint allows you to cancel a payment if you do not have\ + \ the PSP reference of the original payment request available.\n\nIn your\ + \ call, refer to the original payment by using the `reference` that you specified\ + \ in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel).\ + \ \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\ + \ If using a [newer integration](https://docs.adyen.com/online-payments),\ + \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ + \ endpoint under Checkout API instead." + x-addedInVersion: '30' + operationId: post-technicalCancel + x-groupName: Modifications + x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' + schema: + $ref: '#/components/schemas/TechnicalCancelRequest' + responses: + '200': + content: + application/json: + examples: + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /voidPendingRefund: + post: + tags: + - Modifications + summary: Cancels a POS refund request before it has been completed. + description: 'This endpoint allows you to cancel the refund request before it + has been completed. + + + In your call, you can refer to the original refund request either by using + the `tenderReference`, or the `pspReference`. We recommend implementing based + on the `tenderReference`, as this is generated for both offline and online + transactions. + + + For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' + x-addedInVersion: '25' + operationId: post-voidPendingRefund + x-groupName: Modifications + x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' + schema: + $ref: '#/components/schemas/VoidPendingRefundRequest' + responses: + '200': + content: + application/json: + examples: + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. +components: + schemas: + AccountInfo: + properties: + accountAgeIndicator: + description: 'Indicator for the length of time since this shopper account + was created in the merchant''s environment. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountChangeDate: + description: Date when the shopper's account was last changed. + format: date-time + type: string + accountChangeIndicator: + description: 'Indicator for the length of time since the shopper''s account + was last updated. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountCreationDate: + description: Date when the shopper's account was created. + format: date-time + type: string + accountType: + x-addedInVersion: '50' + description: 'Indicates the type of account. For example, for a multi-account + card product. + + Allowed values: + + * notApplicable + + * credit + + * debit' + enum: + - notApplicable + - credit + - debit + type: string + addCardAttemptsDay: + description: Number of attempts the shopper tried to add a card to their + account in the last day. + format: int32 + type: integer + deliveryAddressUsageDate: + description: Date the selected delivery address was first used. + format: date-time + type: string + deliveryAddressUsageIndicator: + description: 'Indicator for the length of time since this delivery address + was first used. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + homePhone: + description: Shopper's home phone number (including the country code). + type: string + mobilePhone: + description: Shopper's mobile phone number (including the country code). + type: string + passwordChangeDate: + description: Date when the shopper last changed their password. + format: date-time + type: string + passwordChangeIndicator: + description: 'Indicator when the shopper has changed their password. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + pastTransactionsDay: + description: Number of all transactions (successful and abandoned) from + this shopper in the past 24 hours. + format: int32 + type: integer + pastTransactionsYear: + description: Number of all transactions (successful and abandoned) from + this shopper in the past year. + format: int32 + type: integer + paymentAccountAge: + description: Date this payment method was added to the shopper's account. + format: date-time + type: string + paymentAccountIndicator: + description: 'Indicator for the length of time since this payment method + was added to this shopper''s account. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + purchasesLast6Months: + description: Number of successful purchases in the last six months. + format: int32 + type: integer + suspiciousActivity: + description: Whether suspicious activity was recorded on this account. + type: boolean + workPhone: + description: Shopper's work phone number (including the country code). + type: string + AdditionalData3DSecure: + properties: + allow3DS2: + description: "Indicates if you are able to process 3D Secure 2 transactions\ + \ natively on your payment page. Send this parameter when you are using\ + \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ + \n > This parameter only indicates readiness to support native 3D Secure\ + \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ + \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ + \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ + \ support native 3D Secure 2 authentication. Setting this to true does\ + \ not mean always applying 3D Secure 2. Adyen still selects the version\ + \ of 3D Secure based on configuration to optimize authorisation rates\ + \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ + \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ + \ Secure 2 to your shopper regardless of your configuration.\n" + type: string + executeThreeD: + description: "Indicates if you want to perform 3D Secure authentication\ + \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ + \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ + \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ + \ 3D Secure authentication. Note that this setting results in refusals\ + \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ + \ national regulations. \n" + type: string + mpiImplementationType: + description: In case of Secure+, this field must be set to **CUPSecurePlus**. + type: string + scaExemption: + description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that you want to request for the transaction.\n\n Possible values:\n\ + * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ + \ **transactionRiskAnalysis** " + type: string + threeDSVersion: + description: "Indicates your preference for the 3D Secure version. \n> If\ + \ you use this parameter, you override the checks from Adyen's Authentication\ + \ Engine. We recommend to use this field only if you have an extensive\ + \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ + \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ + \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ + \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ + \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ + \ in the `ARes`, we will apply the fallback policy configured in your\ + \ account. For example, if the configuration is to fall back to 3D Secure\ + \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ + \ the BIN is not enrolled, you will receive an error.\n\n" + type: string + AdditionalDataAirline: + properties: + airline.agency_invoice_number: + description: 'Reference number for the invoice, issued by the agency. + + * minLength: 1 + + * maxLength: 6' + type: string + airline.agency_plan_name: + description: '2-letter agency plan identifier; alphabetical. + + * minLength: 2 + + * maxLength: 2' + type: string + airline.airline_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit + accounting code (PAX); numeric. It identifies the carrier. + + * Format: IATA 3-digit accounting code (PAX) + + * Example: KLM = 074 + + * minLength: 3 + + * maxLength: 3' + type: string + airline.airline_designator_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.boarding_fee: + description: 'Chargeable amount for boarding the plane. + + The transaction amount needs to be represented in minor units according + to the [following table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 18' + type: string + airline.computerized_reservation_system: + description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) + used to make the reservation and purchase the ticket. + + * Format: alphanumeric. + + * minLength: 4 + + * maxLength: 4' + type: string + airline.customer_reference_number: + description: 'Reference number; alphanumeric. + + * minLength: 0 + + * maxLength: 20' + type: string + airline.document_type: + description: 'Optional 2-digit code; alphanumeric. It identifies the type + of product of the transaction. The description of the code may appear + on credit card statements. + + * Format: 2-digit code + + * Example: Passenger ticket = 01 + + * minLength: 2 + + * maxLength: 2' + type: string + airline.flight_date: + description: 'Flight departure date. Local time `(HH:mm)` is optional. + + * Date format: `yyyy-MM-dd` + + * Date and time format: `yyyy-MM-dd HH:mm` + + * minLength: 10 + + * maxLength: 16' + type: string + airline.leg.carrier_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + This field is required/mandatory if the airline data includes leg details. + + * Format: IATA 2-letter airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.leg.class_of_travel: + description: '1-letter travel class identifier; alphabetical. There is no + standard; however, the following codes are used rather consistently: + + * F: first class + + * J: business class + + * Y: economy class + + * W: premium economy + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.leg.date_of_travel: + description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ + * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" + type: string + airline.leg.depart_airport: + description: 'Alphabetical identifier of the departure airport. + + This field is required if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.depart_tax: + description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). + Amount charged by a country to an individual upon their leaving. The transaction + amount needs to be represented in minor units according to the [following + table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 12' + type: string + airline.leg.destination_code: + description: 'Alphabetical identifier of the destination/arrival airport. + + This field is required/mandatory if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.fare_base_code: + description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); + alphanumeric. + + * minLength: 1 + + * maxLength: 7' + type: string + airline.leg.flight_number: + description: 'The flight identifier. + + * minLength: 1 + + * maxLength: 5' + type: string + airline.leg.stop_over_code: + description: '1-letter code that indicates whether the passenger is entitled + to make a stopover. Only two types of characters are allowed: + + * O: Stopover allowed + + * X: Stopover not allowed + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.passenger.date_of_birth: + description: 'Date of birth of the passenger. + + + Date format: `yyyy-MM-dd` + + * minLength: 10 + + * maxLength: 10' + type: string + airline.passenger.first_name: + description: 'Passenger first name/given name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.last_name: + description: 'Passenger last name/family name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.telephone_number: + description: 'Telephone number of the passenger, including country code. + This is an alphanumeric field that can include the ''+'' and ''-'' signs. + + * minLength: 3 + + * maxLength: 30' + type: string + airline.passenger.traveller_type: + description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. + Example: ADT, SRC, CNN, INS. + + + However, several carriers use non-standard codes that can be up to 5 alphanumeric + characters. + + * minLength: 3 + + * maxLength: 6' + type: string + airline.passenger_name: + description: 'Passenger name, initials, and a title. + + * Format: last name + first name or initials + title. + + * Example: *FLYER / MARY MS*. + + * minLength: 1 + + * maxLength: 49' + type: string + airline.ticket_issue_address: + description: 'Address of the place/agency that issued the ticket. + + * minLength: 0 + + * maxLength: 16' + type: string + airline.ticket_number: + description: 'The ticket''s unique identifier. + + * minLength: 1 + + * maxLength: 150' + type: string + airline.travel_agency_code: + description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier + number for travel agencies. + + * minLength: 1 + + * maxLength: 8' + type: string + airline.travel_agency_name: + description: 'The name of the travel agency. + + * minLength: 1 + + * maxLength: 25' + type: string + required: + - airline.passenger_name + AdditionalDataCarRental: + properties: + carRental.checkOutDate: + description: 'Pick-up date. + + * Date format: `yyyyMMdd`' + type: string + carRental.customerServiceTollFreeNumber: + description: 'The customer service phone number of the car rental company. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + carRental.daysRented: + description: 'Number of days for which the car is being rented. + + * Format: Numeric + + * maxLength: 19' + type: string + carRental.fuelCharges: + description: 'Any fuel charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.insuranceCharges: + description: 'Any insurance charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.locationCity: + description: 'The city from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.locationCountry: + description: 'The country from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.locationStateProvince: + description: 'The state or province from where the car is rented. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + * Y - Customer was a no show. + + * N - Not applicable.' + type: string + carRental.oneWayDropOffCharges: + description: Charge associated with not returning a vehicle to the original + rental location. + type: string + carRental.rate: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.rateIndicator: + description: 'Specifies whether the given rate is applied daily or weekly. + + * D - Daily rate. + + * W - Weekly rate.' + type: string + carRental.rentalAgreementNumber: + description: 'The rental agreement number associated with this car rental. + + * Format: Alphanumeric + + * maxLength: 9' + type: string + carRental.rentalClassId: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.renterName: + description: 'The name of the person renting the car. + + * Format: Alphanumeric + + * maxLength: 26' + type: string + carRental.returnCity: + description: 'The city where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.returnCountry: + description: 'The country where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.returnDate: + description: 'The last date to return the car by. + + * Date format: `yyyyMMdd`' + type: string + carRental.returnLocationId: + description: 'Agency code, phone number, or address abbreviation + + * Format: Alphanumeric + + * maxLength: 10' + type: string + carRental.returnStateProvince: + description: 'The state or province where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.taxExemptIndicator: + description: 'Indicates whether the goods or services were tax-exempt, or + tax was not collected. + + + Values: + + * Y - Goods or services were tax exempt + + * N - Tax was not collected' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "A" for Car rental. This should be + included in the auth message. + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataCommon: + properties: + RequestedTestErrorResponseCode: + description: "Triggers test scenarios that allow to replicate certain communication\ + \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ + \ wasn't a connection available to service the outgoing communication.\n\ + This is a transient, retriable error since no messaging could be initiated\ + \ to an issuing system (or third-party acquiring system). Therefore, the\ + \ header Transient-Error: true is returned in the response. A subsequent\ + \ request using the same idempotency key will be processed as if it was\ + \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ + \ wrong during transmission of the message or receiving the response.\n\ + This is a classified as non-transient because the message could have been\ + \ received by the issuing party and been acted upon. No transient error\ + \ header is returned. If using idempotency, the (error) response is stored\ + \ as the final result for the idempotency key. Subsequent messages with\ + \ the same idempotency key not be processed beyond returning the stored\ + \ response." + type: string + authorisationType: + description: "Flags a card payment request for either pre-authorisation\ + \ or final authorisation. For more information, refer to [Authorisation\ + \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ + \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ + \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ + \ request to be handled as a final authorisation." + type: string + customRoutingFlag: + description: 'Allows you to determine or override the acquirer account that + should be used for the transaction. + + + If you need to process a payment with an acquirer different from a default + one, you can set up a corresponding configuration on the Adyen payments + platform. Then you can pass a custom routing flag in a payment request''s + additional data to target a specific acquirer. + + + To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge + description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ + \ this field denotes why the additional payment is made.\n\nPossible values:\n\ + \n * **NoShow**: An incremental charge is carried out because of a no-show\ + \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ + \ charge is carried out to process an additional payment after the original\ + \ services have been rendered and the respective payment has been processed." + enum: + - NoShow + - DelayedCharge + type: string + networkTxReference: + description: 'Allows you to link the transaction to the original or previous + one in a subscription/card-on-file chain. This field is required for token-based + transactions where Adyen does not tokenize the card. + + + Transaction identifier from card schemes, for example, Mastercard Trace + ID or the Visa Transaction ID. + + + Submit the original transaction ID of the contract in your payment request + if you are not tokenizing card details with Adyen and are making a merchant-initiated + transaction (MIT) for subsequent charges. + + + Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` + **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction + is classified as MIT.' + type: string + overwriteBrand: + description: Boolean indicator that can be optionally used for performing + debit transactions on combo cards (for example, combo cards in Brazil). + This is not mandatory but we recommend that you set this to true if you + want to use the `selectedBrand` value to specify how to process the transaction. + type: string + subMerchantCity: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the city of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 13 characters.' + type: string + subMerchantCountry: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the three-letter + country code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Fixed length: 3 characters.' + type: string + subMerchantID: + description: 'This field contains an identifier of the actual merchant when + a transaction is submitted via a payment facilitator. The payment facilitator + must send in this unique ID. + + + A unique identifier per submerchant that is required if the transaction + is performed by a registered payment facilitator. + + * Format: alpha-numeric. + + * Fixed length: 15 characters.' + type: string + subMerchantName: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the name of + the actual merchant. + + * Format: alpha-numeric. + + * Maximum length: 22 characters.' + type: string + subMerchantPostalCode: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the postal code + of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 10 characters.' + type: string + subMerchantState: + description: 'This field is required if the transaction is performed by + a registered payment facilitator, and if applicable to the country. This + field must contain the state code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 3 characters.' + type: string + subMerchantStreet: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the street of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 60 characters.' + type: string + subMerchantTaxId: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the tax ID of + the actual merchant. + + * Format: alpha-numeric. + + * Fixed length: 11 or 14 characters.' + type: string + AdditionalDataLevel23: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + + Encoding: ASCII. + + + Max length: 25 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + enhancedSchemeData.destinationCountryCode: + description: 'Destination country code. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.destinationPostalCode: + description: 'The postal code of a destination address. + + + Encoding: ASCII. + + + Max length: 10 characters. + + + > Required for American Express.' + type: string + enhancedSchemeData.destinationStateProvinceCode: + description: 'Destination state or province code. + + + Encoding: ASCII.Max length: 3 characters.' + type: string + enhancedSchemeData.dutyAmount: + description: 'Duty amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.freightAmount: + description: 'Shipping amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].commodityCode: + description: 'Item commodity code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].description: + description: 'Item description. + + + Encoding: ASCII. + + + Max length: 26 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + description: 'Discount amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].productCode: + description: 'Product code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].quantity: + description: 'Quantity, specified as an integer value. + + + Value must be greater than 0. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + description: 'Total amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: + description: 'Item unit of measurement. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitPrice: + description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + + Max length: 12 characters.' + type: string + enhancedSchemeData.orderDate: + description: 'Order date. + + * Format: `ddMMyy` + + + Encoding: ASCII. + + + Max length: 6 characters.' + type: string + enhancedSchemeData.shipFromPostalCode: + description: 'The postal code of a "ship-from" address. + + + Encoding: ASCII. + + + Max length: 10 characters.' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + AdditionalDataLodging: + properties: + lodging.checkInDate: + description: 'The arrival date. + + * Date format: `yyyyMMdd`' + type: string + lodging.checkOutDate: + description: 'The departure date. + + * Date format: `yyyyMMdd`' + type: string + lodging.customerServiceTollFreeNumber: + description: 'The toll free phone number for the hotel/lodgings. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.fireSafetyActIndicator: + description: 'Identifies that the facility complies with the Hotel and Motel + Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. + + * Format: Alphabetic + + * maxLength: 1' + type: string + lodging.folioCashAdvances: + description: 'The folio cash advances. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.folioNumber: + description: "Card acceptor\u2019s internal invoice or billing ID reference\ + \ number.\n* Format: Alphanumeric\n* maxLength: 25" + type: string + lodging.foodBeverageCharges: + description: 'Any charges for food and beverages associated with the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + + Value should be Y or N. + + * Format: Numeric + + * maxLength: 1' + type: string + lodging.prepaidExpenses: + description: 'Prepaid expenses for the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.propertyPhoneNumber: + description: 'Identifies specific lodging property location by its local + phone number. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.room1.numberOfNights: + description: 'Total number of nights the room will be rented. + + * Format: Numeric + + * maxLength: 4' + type: string + lodging.room1.rate: + description: 'The rate of the room. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.room1.tax: + description: 'The total amount of tax to be paid. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalRoomTax: + description: 'Total room tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalTax: + description: 'Total tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "H" for Hotel. This should be included + in the auth message. + + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataModifications: + properties: + installmentPaymentData.selectedInstallmentOption: + description: This is the installment option selected by the shopper. It + is required only if specified by the user. + type: string + AdditionalDataOpenInvoice: + properties: + openinvoicedata.merchantData: + description: 'Holds different merchant data points like product, purchase, + customer, and so on. It takes data in a Base64 encoded string. + + + The `merchantData` parameter needs to be added to the `openinvoicedata` + signature at the end. + + + Since the field is optional, if it''s not included it does not impact + computing the merchant signature. + + + Applies only to Klarna. + + + You can contact Klarna for the format and structure of the string.' + type: string + openinvoicedata.numberOfLines: + description: 'The number of invoice lines included in `openinvoicedata`. + + + There needs to be at least one line, so `numberOfLines` needs to be at + least 1.' + type: string + openinvoicedataLine[itemNr].currencyCode: + description: The three-character ISO currency code. + type: string + openinvoicedataLine[itemNr].description: + description: A text description of the product the invoice line refers to. + type: string + openinvoicedataLine[itemNr].itemAmount: + description: 'The price for one item in the invoice line, represented in + minor units. + + + The due amount for the item, VAT excluded.' + type: string + openinvoicedataLine[itemNr].itemId: + description: A unique id for this item. Required for RatePay if the description + of each item is not unique. + type: string + openinvoicedataLine[itemNr].itemVatAmount: + description: The VAT due for one item in the invoice line, represented in + minor units. + type: string + openinvoicedataLine[itemNr].itemVatPercentage: + description: 'The VAT percentage for one item in the invoice line, represented + in minor units. + + + For example, 19% VAT is specified as 1900.' + type: string + openinvoicedataLine[itemNr].numberOfItems: + description: The number of units purchased of a specific product. + type: string + openinvoicedataLine[itemNr].returnShippingCompany: + description: Name of the shipping company handling the the return shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingNumber: + description: The tracking number for the return of the shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingUri: + description: URI where the customer can track the return of their shipment. + type: string + openinvoicedataLine[itemNr].shippingCompany: + description: Name of the shipping company handling the delivery. + type: string + openinvoicedataLine[itemNr].shippingMethod: + description: Shipping method. + type: string + openinvoicedataLine[itemNr].trackingNumber: + description: The tracking number for the shipment. + type: string + openinvoicedataLine[itemNr].trackingUri: + description: URI where the customer can track their shipment. + type: string + AdditionalDataOpi: + properties: + opi.includeTransToken: + description: 'Optional boolean indicator. Set to **true** if you want an + ecommerce transaction to return an `opi.transToken` as additional data + in the response. + + + You can store this Oracle Payment Interface token in your Oracle Opera + database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' + type: string + AdditionalDataRatepay: + properties: + ratepay.installmentAmount: + description: Amount the customer has to pay each month. + type: string + ratepay.interestRate: + description: Interest rate of this installment. + type: string + ratepay.lastInstallmentAmount: + description: Amount of the last installment. + type: string + ratepay.paymentFirstday: + description: Calendar day of the first payment. + type: string + ratepaydata.deliveryDate: + description: Date the merchant delivered the goods to the customer. + type: string + ratepaydata.dueDate: + description: Date by which the customer must settle the payment. + type: string + ratepaydata.invoiceDate: + description: Invoice date, defined by the merchant. If not included, the + invoice date is set to the delivery date. + type: string + ratepaydata.invoiceId: + description: Identification name or number for the invoice, defined by the + merchant. + type: string + AdditionalDataRetry: + properties: + retry.chainAttemptNumber: + description: 'The number of times the transaction (not order) has been retried + between different payment service providers. For instance, the `chainAttemptNumber` + set to 2 means that this transaction has been recently tried on another + provider before being sent to Adyen. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.orderAttemptNumber: + description: 'The index of the attempt to bill a particular order, which + is identified by the `merchantOrderReference` field. For example, if a + recurring transaction fails and is retried one day later, then the order + number for these attempts would be 1 and 2, respectively. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.skipRetry: + description: 'The Boolean value indicating whether Adyen should skip or + retry this transaction, if possible. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + AdditionalDataRisk: + properties: + riskdata.[customFieldName]: + description: The data for your custom risk field. For more information, + refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). + type: string + riskdata.basket.item[itemNr].amountPerItem: + description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.basket.item[itemNr].brand: + description: Brand of the item. + type: string + riskdata.basket.item[itemNr].category: + description: Category of the item. + type: string + riskdata.basket.item[itemNr].color: + description: Color of the item. + type: string + riskdata.basket.item[itemNr].currency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.basket.item[itemNr].itemID: + description: ID of the item. + type: string + riskdata.basket.item[itemNr].manufacturer: + description: Manufacturer of the item. + type: string + riskdata.basket.item[itemNr].productTitle: + description: A text description of the product the invoice line refers to. + type: string + riskdata.basket.item[itemNr].quantity: + description: Quantity of the item purchased. + type: string + riskdata.basket.item[itemNr].receiverEmail: + description: Email associated with the given product in the basket (usually + in electronic gift cards). + type: string + riskdata.basket.item[itemNr].size: + description: Size of the item. + type: string + riskdata.basket.item[itemNr].sku: + description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' + type: string + riskdata.basket.item[itemNr].upc: + description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' + type: string + riskdata.promotions.promotion[itemNr].promotionCode: + description: Code of the promotion. + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountAmount: + description: The discount amount of the promotion, represented in [minor + units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: + description: 'Promotion''s percentage discount. It is represented in percentage + value and there is no need to include the ''%'' sign. + + + e.g. for a promotion discount of 30%, the value of the field should be + 30.' + type: string + riskdata.promotions.promotion[itemNr].promotionName: + description: Name of the promotion. + type: string + riskdata.riskProfileReference: + description: Reference number of the risk profile that you want to apply + to the payment. If not provided or left blank, the merchant-level account's + default risk profile will be applied to the payment. For more information, + see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). + type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string + AdditionalDataRiskStandalone: + properties: + PayPal.CountryCode: + description: Shopper's country of residence in the form of ISO standard + 3166 2-character country codes. + type: string + PayPal.EmailId: + description: Shopper's email. + type: string + PayPal.FirstName: + description: Shopper's first name. + type: string + PayPal.LastName: + description: Shopper's last name. + type: string + PayPal.PayerId: + description: 'Unique PayPal Customer Account identification number. Character + length and limitations: 13 single-byte alphanumeric characters.' + type: string + PayPal.Phone: + description: Shopper's phone number. + type: string + PayPal.ProtectionEligibility: + description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ + \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ + \ \u2014 Merchant is not protected under the Seller Protection Policy." + type: string + PayPal.TransactionId: + description: Unique transaction ID of the payment. + type: string + avsResultRaw: + description: 'Raw AVS result received from the acquirer, where available. + Example: D' + type: string + bin: + description: The Bank Identification Number of a credit card, which is the + first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). + type: string + cvcResultRaw: + description: 'Raw CVC result received from the acquirer, where available. + Example: 1' + type: string + riskToken: + description: Unique identifier or token for the shopper's card details. + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. Example: true' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. Example: true' + type: string + tokenDataType: + description: 'Required for PayPal payments only. The only supported value + is: **paypal**.' + type: string + AdditionalDataSubMerchant: + properties: + subMerchant.numberOfSubSellers: + description: Required for transactions performed by registered payment facilitators. + Indicates the number of sub-merchants contained in the request. For example, + **3**. + type: string + subMerchant.subSeller[subSellerNr].city: + description: 'Required for transactions performed by registered payment + facilitators. The city of the sub-merchant''s address. + + * Format: Alphanumeric + + * Maximum length: 13 characters' + type: string + subMerchant.subSeller[subSellerNr].country: + description: "Required for transactions performed by registered payment\ + \ facilitators. The three-letter country code of the sub-merchant's address.\ + \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ + * Fixed length: 3 characters" + type: string + subMerchant.subSeller[subSellerNr].id: + description: "Required for transactions performed by registered payment\ + \ facilitators. A unique identifier that you create for the sub-merchant,\ + \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ + * Maximum length: 15 characters" + type: string + subMerchant.subSeller[subSellerNr].mcc: + description: "Required for transactions performed by registered payment\ + \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ + \ \n* Format: Numeric\n* Fixed length: 4 digits" + type: string + subMerchant.subSeller[subSellerNr].name: + description: 'Required for transactions performed by registered payment + facilitators. The name of the sub-merchant. Based on scheme specifications, + this value will overwrite the shopper statement that will appear in the + card statement. + + * Format: Alphanumeric + + * Maximum length: 22 characters' + type: string + subMerchant.subSeller[subSellerNr].postalCode: + description: 'Required for transactions performed by registered payment + facilitators. The postal code of the sub-merchant''s address, without + dashes. + + * Format: Numeric + + * Fixed length: 8 digits' + type: string + subMerchant.subSeller[subSellerNr].state: + description: 'Required for transactions performed by registered payment + facilitators. The state code of the sub-merchant''s address, if applicable + to the country. + + * Format: Alphanumeric + + * Maximum length: 2 characters' + type: string + subMerchant.subSeller[subSellerNr].street: + description: 'Required for transactions performed by registered payment + facilitators. The street name and house number of the sub-merchant''s + address. + + * Format: Alphanumeric + + * Maximum length: 60 characters' + type: string + subMerchant.subSeller[subSellerNr].taxId: + description: 'Required for transactions performed by registered payment + facilitators. The tax ID of the sub-merchant. + + * Format: Numeric + + * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' + type: string + AdditionalDataTemporaryServices: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + * Encoding: ASCII + + * maxLength: 25' + type: string + enhancedSchemeData.employeeName: + description: 'Name or ID associated with the individual working in a temporary + capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.jobDescription: + description: 'Description of the job or task of the individual working in + a temporary capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.regularHoursRate: + description: 'Amount paid per regular hours worked, minor units. + + * maxLength: 7' + type: string + enhancedSchemeData.regularHoursWorked: + description: 'Amount of time worked during a normal operation for the task + or job. + + * maxLength: 7' + type: string + enhancedSchemeData.requestName: + description: 'Name of the individual requesting temporary services. + + * maxLength: 40' + type: string + enhancedSchemeData.tempStartDate: + description: 'Date for the beginning of the pay period. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.tempWeekEnding: + description: 'Date of the end of the billing cycle. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. For example, 2000 means + USD 20.00 + + * maxLength: 12' + type: string + AdditionalDataWallets: + properties: + androidpay.token: + description: The Android Pay token retrieved from the SDK. + type: string + masterpass.transactionId: + description: The Mastercard Masterpass Transaction ID retrieved from the + SDK. + type: string + payment.token: + description: The Apple Pay token retrieved from the SDK. + type: string + paywithgoogle.token: + description: The Google Pay token retrieved from the SDK. + type: string + samsungpay.token: + description: The Samsung Pay token retrieved from the SDK. + type: string + visacheckout.callId: + description: The Visa Checkout Call ID retrieved from the SDK. + type: string + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + AdjustAuthorisationRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be adjusted. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - modificationAmount + - originalReference + 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 + ApplicationInfo: + properties: + adyenLibrary: + description: Adyen-developed software, such as libraries and plugins, used + to interact with the Adyen API. For example, Magento plugin, Java API + library, etc. + $ref: '#/components/schemas/CommonField' + adyenPaymentSource: + description: Adyen-developed software to get payment details. For example, + Checkout SDK, Secured Fields SDK, etc. + $ref: '#/components/schemas/CommonField' + externalPlatform: + description: Third-party developed platform used to initiate payment requests. + For example, Magento, Zuora, etc. + $ref: '#/components/schemas/ExternalPlatform' + merchantApplication: + description: Merchant developed software, such as cashier application, used + to interact with the Adyen API. + $ref: '#/components/schemas/CommonField' + merchantDevice: + description: Merchant device information. + $ref: '#/components/schemas/MerchantDevice' + shopperInteractionDevice: + description: Shopper interaction device, such as terminal, mobile device + or web browser, to initiate payment requests. + $ref: '#/components/schemas/ShopperInteractionDevice' + AuthenticationResultRequest: + properties: + merchantAccount: + description: The merchant account identifier, with which the authentication + was processed. + type: string + pspReference: + description: The pspReference identifier for the transaction. + type: string + required: + - merchantAccount + - pspReference + AuthenticationResultResponse: + properties: + threeDS1Result: + description: The result of the 3D Secure authentication. + $ref: '#/components/schemas/ThreeDS1Result' + threeDS2Result: + description: The result of the 3D Secure 2 authentication. + $ref: '#/components/schemas/ThreeDS2Result' + BankAccount: + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCity: + x-addedInVersion: '18' + description: The bank city. + type: string + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. + type: string + bankName: + description: The name of the bank. + type: string + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. + type: string + countryCode: + description: 'Country code where the bank is located. + + + A valid value is an ISO two-character country code (e.g. ''NL'').' + type: string + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + taxId: + x-addedInVersion: '18' + description: The bank account holder's tax ID. + type: string + BrowserInfo: + properties: + acceptHeader: + description: The accept header value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + colorDepth: + x-addedInVersion: '40' + description: 'The color depth of the shopper''s browser in bits per pixel. + This should be obtained by using the browser''s `screen.colorDepth` property. + Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' + format: int32 + type: integer + javaEnabled: + x-addedInVersion: '40' + description: Boolean value indicating if the shopper's browser is able to + execute Java. + type: boolean + javaScriptEnabled: + x-addedInVersion: '40' + default: true + description: Boolean value indicating if the shopper's browser is able to + execute JavaScript. A default 'true' value is assumed if the field is + not present. + type: boolean + language: + x-addedInVersion: '40' + description: The `navigator.language` value of the shopper's browser (as + defined in IETF BCP 47). + type: string + screenHeight: + x-addedInVersion: '40' + description: The total height of the shopper's device screen in pixels. + format: int32 + type: integer + screenWidth: + x-addedInVersion: '40' + description: The total width of the shopper's device screen in pixels. + format: int32 + type: integer + timeZoneOffset: + x-addedInVersion: '40' + description: Time difference between UTC time and the shopper's browser + local time, in minutes. + format: int32 + type: integer + userAgent: + description: The user agent value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + required: + - userAgent + - acceptHeader + - javaEnabled + - colorDepth + - screenHeight + - screenWidth + - timeZoneOffset + - language + CancelOrRefundRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - originalReference + CancelRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - originalReference + CaptureRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be captured. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - modificationAmount + - originalReference + Card: + properties: + cvc: + description: "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid)\ + \ (1-20 characters). Depending on the card brand, it is known also as:\n\ + * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n>\ + \ If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce),\ + \ the CVC code is present in the encrypted data. You must never post the\ + \ card details to the server.\n> This field must be always present in\ + \ a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n\ + > When this value is returned in a response, it is always empty because\ + \ it is not stored." + maxLength: 20 + minLength: 1 + type: string + expiryMonth: + description: 'The card expiry month. + + Format: 2 digits, zero-padded for single digits. For example: + + * 03 = March + + * 11 = November' + maxLength: 2 + minLength: 1 + type: string + expiryYear: + description: 'The card expiry year. + + Format: 4 digits. For example: 2020' + maxLength: 4 + minLength: 4 + type: string + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 + type: string + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 + type: string + number: + description: 'The card number (4-19 characters). Do not use any separators. + + When this value is returned in a response, only the last 4 digits of the + card number are returned.' + maxLength: 19 + minLength: 4 + type: string + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 + type: string + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 + type: string + required: + - number + - expiryMonth + - expiryYear + - holderName + CommonField: + properties: + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + DeviceRenderOptions: + properties: + sdkInterface: + default: both + description: 'Supported SDK interface types. + + Allowed values: + + * native + + * html + + * both' + enum: + - native + - html + - both + type: string + sdkUiType: + default: + - + description: 'UI types supported for displaying specific challenges. + + Allowed values: + + * text + + * singleSelect + + * outOfBand + + * otherHtml + + * multiSelect' + items: + enum: + - multiSelect + - otherHtml + - outOfBand + - singleSelect + - text + type: string + type: array + DonationRequest: + properties: + donationAccount: + description: The Adyen account name of the charity. + type: string + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount to be donated.The `currency` must match the currency + used in authorisation, the `value` must be smaller than or equal to the + authorised amount. + $ref: '#/components/schemas/Amount' + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + required: + - merchantAccount + - donationAccount + - modificationAmount + ExternalPlatform: + properties: + integrator: + description: External platform integrator. + type: string + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + ForexQuote: + properties: + account: + description: The account name. + type: string + accountType: + description: The account type. + type: string + baseAmount: + description: The base amount. + $ref: '#/components/schemas/Amount' + basePoints: + description: The base points. + format: int32 + type: integer + buy: + description: The buy rate. + $ref: '#/components/schemas/Amount' + interbank: + description: The interbank amount. + $ref: '#/components/schemas/Amount' + reference: + description: The reference assigned to the forex quote request. + type: string + sell: + description: The sell rate. + $ref: '#/components/schemas/Amount' + signature: + description: The signature to validate the integrity. + type: string + source: + description: The source of the forex quote. + type: string + type: + description: The type of forex. + type: string + validTill: + description: The date until which the forex quote is valid. + format: date-time + type: string + required: + - validTill + - basePoints + 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 + 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: '#/components/schemas/FraudCheckResult' + type: array + required: + - accountScore + Installments: + properties: + plan: + x-addedInVersion: '64' + description: 'Defines the type of installment plan. If not set, defaults + to **regular**. + + + Possible values: + + * **regular** + + * **revolving**' + enum: + - regular + - revolving + type: string + value: + description: 'Defines the number of installments. Its value needs to be + greater than zero. + + + Usually, the maximum allowed number of installments is capped. For example, + it may not be possible to split a payment in more than 24 installments. + The acquirer sets this upper limit, so its value may vary.' + format: int32 + type: integer + required: + - value + Mandate: + properties: + amount: + description: The billing amount(in minor units) of the recurring transactions. + type: string + amountRule: + description: "The limitation rule of the billing amount.\n\nPossible values:\n\ + \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ + \ **exact**: The transaction amount should be the same as the `amount`.\n\ + \n" + enum: + - max + - exact + type: string + billingAttemptsRule: + description: "The rule to specify the period, within which the recurring\ + \ debit can happen, relative to the mandate recurring date.\n\nPossible\ + \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ + \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ + \n" + enum: + - 'on' + - before + - after + type: string + billingDay: + description: 'The number of the day, on which the recurring debit can happen. + Should be within the same calendar month as the mandate recurring date. + + + Possible values: 1-31 based on the `frequency`.' + type: string + endsAt: + description: End date of the billing plan, in YYYY-MM-DD format. + type: string + frequency: + description: 'The frequency with which a shopper should be charged. + + + Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, + **halfYearly**, **yearly**.' + enum: + - adhoc + - daily + - weekly + - biWeekly + - monthly + - quarterly + - halfYearly + - yearly + type: string + remarks: + description: The message shown by UPI to the shopper on the approval screen. + type: string + startsAt: + description: Start date of the billing plan, in YYYY-MM-DD format. By default, + the transaction date. + type: string + required: + - frequency + - amount + - endsAt + MerchantDevice: + properties: + os: + description: Operating system running on the merchant device. + type: string + osVersion: + description: Version of the operating system on the merchant device. + type: string + reference: + description: Merchant device reference. + type: string + MerchantRiskIndicator: + properties: + addressMatch: + description: Whether the chosen delivery address is identical to the billing + address. + type: boolean + deliveryAddressIndicator: + description: 'Indicator regarding the delivery address. + + Allowed values: + + * `shipToBillingAddress` + + * `shipToVerifiedAddress` + + * `shipToNewAddress` + + * `shipToStore` + + * `digitalGoods` + + * `goodsNotShipped` + + * `other`' + enum: + - shipToBillingAddress + - shipToVerifiedAddress + - shipToNewAddress + - shipToStore + - digitalGoods + - goodsNotShipped + - other + type: string + deliveryEmail: + description: The delivery email address (for digital goods). + type: string + deliveryTimeframe: + description: 'The estimated delivery time for the shopper to receive the + goods. + + Allowed values: + + * `electronicDelivery` + + * `sameDayShipping` + + * `overnightShipping` + + * `twoOrMoreDaysShipping`' + enum: + - electronicDelivery + - sameDayShipping + - overnightShipping + - twoOrMoreDaysShipping + type: string + giftCardAmount: + description: For prepaid or gift card purchase, the purchase amount total + of prepaid or gift card(s). + $ref: '#/components/schemas/Amount' + giftCardCount: + description: For prepaid or gift card purchase, total count of individual + prepaid or gift cards/codes purchased. + format: int32 + type: integer + preOrderDate: + description: For pre-order purchases, the expected date this product will + be available to the shopper. + format: date-time + type: string + preOrderPurchase: + description: Indicator for whether this transaction is for pre-ordering + a product. + type: boolean + reorderItems: + description: Indicator for whether the shopper has already purchased the + same items in the past. + type: boolean + ModificationResult: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular modification response. + type: object + 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. + type: string + response: + description: Indicates if the modification request has been received for + processing. + enum: + - '[capture-received]' + - '[cancel-received]' + - '[refund-received]' + - '[cancelOrRefund-received]' + - '[adjustAuthorisation-received]' + - '[donation-received]' + - '[technical-cancel-received]' + - '[voidPendingRefund-received]' + type: string + required: + - response + - pspReference + Name: + properties: + firstName: + description: The first name. + type: string + lastName: + description: The last name. + type: string + required: + - firstName + - lastName + PaymentRequest: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + bankAccount: + description: 'The details of the bank account, from which the payment should + be made. + + > Either `bankAccount` or `card` field must be provided in a payment request.' + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + card: + description: 'A container for card data. + + > Either `bankAccount` or `card` field must be provided in a payment request.' + $ref: '#/components/schemas/Card' + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + entityType: + x-addedInVersion: '24' + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + fundingSource: + x-addedInVersion: '52' + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + nationality: + x-addedInVersion: '24' + description: The two-character country code of the shopper's nationality. + maxLength: 2 + type: string + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + PaymentRequest3d: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + md: + description: The payment session identifier returned by the card issuer. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + paResponse: + description: Payment authorisation response returned by the card issuer. + The `paResponse` field holds the PaRes value received from the card issuer. + type: string + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - paResponse + - md + PaymentRequest3ds2: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDS2Result: + description: Thre ThreeDS2Result that was returned in the final CRes. + $ref: '#/components/schemas/ThreeDS2Result' + threeDS2Token: + description: The ThreeDS2Token that was returned in the /authorise call. + type: string + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + PaymentResult: + properties: + 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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + type: object + authCode: + description: '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.' + type: string + dccAmount: + description: '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](https://support.adyen.com/hc/en-us/requests/new).' + $ref: '#/components/schemas/Amount' + dccSignature: + description: 'Cryptographic signature used to verify `dccQuote`. + + > This value only applies if you have implemented Dynamic Currency Conversion. + For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + fraudResult: + description: The fraud result properties of the payment. + $ref: '#/components/schemas/FraudResult' + issuerUrl: + description: 'The URL to direct the shopper to. + + > In case of SecurePlus, do not redirect a shopper to this URL.' + type: string + md: + description: The payment session. + maxLength: 20000 + type: string + paRequest: + description: '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](https://docs.adyen.com/classic-integration/3d-secure).' + type: string + pspReference: + description: Adyen's 16-character reference associated with the transaction/request. + This value is globally unique; quote it when communicating with us about + this request. + 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. + + + For more information, see [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** \u2013 The payment\ + \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ + \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ + \ \u2013 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** \u2013 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** \u2013 Indicates the\ + \ payment has been cancelled (either by the shopper or the merchant) before\ + \ processing was completed. This is a final state.\n* **ChallengeShopper**\ + \ \u2013 The issuer requires further shopper interaction before the payment\ + \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ + \ \u2013 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** \u2013 The issuer requires the shopper's device\ + \ fingerprint before the payment can be authenticated. Returned for 3D\ + \ Secure 2 transactions.\n* **Pending** \u2013 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** \u2013 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** \u2013\ + \ Indicates the payment has successfully been received by Adyen, and will\ + \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ + \ \u2013 Indicates the shopper should be redirected to an external web\ + \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ + \ the payment was refused. The reason is given in the `refusalReason`\ + \ field. This is a final state." + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused + - Success + type: string + Recurring: + properties: + contract: + description: "The type of recurring contract to be used.\nPossible values:\n\ + * `ONECLICK` \u2013 Payment details can be used to initiate a one-click\ + \ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\ + * `RECURRING` \u2013 Payment details can be used without the card security\ + \ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\ + * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\ + \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\ + \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)." + enum: + - ONECLICK + - RECURRING + - PAYOUT + type: string + recurringDetailName: + description: A descriptive name for this detail. + type: string + recurringExpiry: + x-addedInVersion: '40' + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time + type: string + recurringFrequency: + x-addedInVersion: '40' + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + tokenService: + x-addedInVersion: '25' + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE + type: string + RefundRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be refunded. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - modificationAmount + - originalReference + 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 + 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. + + + Example: 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. + + + Example: 1011 DJ' + type: string + billingAddress.stateOrProvince: + description: 'The billing address state or province passed in the payment + request. + + + Example: NH' + type: string + billingAddress.street: + description: The billing address street passed in the payment request. + type: string + ResponseAdditionalDataCard: + properties: + cardBin: + description: 'The Bank Identification Number of a credit card, which is + the first six digits of a card number. + + + Example: 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. + + + Example: 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. + + + Example: amex' + type: string + cardSummary: + description: 'The last four digits of a card number. + + + > Returned only in case of a card payment.' + type: string + ResponseAdditionalDataCommon: + properties: + acquirerAccountCode: + description: 'The name of the Adyen acquirer account. + + + Example: PayPalSandbox_TestAcquirer + + + > Only relevant for PayPal transactions.' + type: string + acquirerCode: + description: 'The name of the acquirer processing the payment request. + + + Example: TestPmmAcquirer' + type: string + acquirerReference: + description: 'The reference number that can be used for reconciliation in + case a non-Adyen acquirer is used for settlement. + + + Example: 7C9N3FNBKT9' + type: string + alias: + description: 'The Adyen alias of the card. + + + Example: H167852639363479' + type: string + aliasType: + description: 'The type of the card alias. + + + Example: Default' + type: string + authCode: + description: '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. + + + Example: 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. + + + This 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. + + + For 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. + + + Example: D' + type: string + bic: + description: 'BIC of a bank account. + + + Example: TESTNL01 + + + > 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. + example: 1 Matches + type: string + cvcResultRaw: + description: The raw result of CVC verification. + example: M + 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. + + + Example: 02' + type: string + expiryDate: + description: 'The expiry date on the card. + + + Example: 6/2016 + + + > 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. + + + Example: 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: + + * CHARGE + + * CREDIT + + * DEBIT + + * PREPAID + + * PREPAID_RELOADABLE + + + * PREPAID_NONRELOADABLE + + * DEFFERED_DEBIT + + + > This functionality requires additional configuration on Adyen''s end. + To enable it, contact the Support Team. + + + For receiving this field in the notification, enable **Include Funding + Source** in **Notifications** > **Additional settings**.' + type: string + fundsAvailability: + description: 'Indicates availability of funds. + + + Visa: + + * "I" (fast funds are supported) + + * "N" (otherwise) + + + Mastercard: + + * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM + list) + + * "N" (otherwise) + + + > 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". + + + Possible values: + + + * 3D Secure Mandated + + * Closed Account + + * ContAuth Not Supported + + * CVC Mandated + + * Ecommerce Not Allowed + + * Crossborder Not Supported + + * Card Updated + + + * Low Authrate Bin + + * 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. + + + Example: 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. + + + > Contact Support Team to enable this field.' + type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + 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. + + + This contains either the Mastercard Trace ID or the Visa Transaction ID.' + type: string + ownerName: + description: 'The owner name of a bank account. + + + Only 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. + + + For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + + + Example: mcpro' + type: string + payoutEligible: + description: 'Indicates whether a payout is eligible or not for this card. + + + Visa: + + * "Y" + + * "N" + + + Mastercard: + + * "Y" (domestic and cross-border) + + + * "D" (only domestic) + + * "N" (no MoneySend) + + * "U" (unknown)' + type: string + realtimeAccountUpdaterStatus: + description: 'The response code from the Real Time Account Updater service. + + + Possible return values are: + + * CardChanged + + * CardExpiryChanged + + * CloseAccount + + + * 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. + + + This 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. + + + This field is unavailable if the payment is referred and is usually not + returned with ecommerce transactions. + + + Example: true' + type: string + refusalReasonRaw: + description: 'Raw refusal reason received from the acquirer, where available. + + + Example: 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. + + + Example: Ecommerce' + type: string + shopperReference: + description: 'The shopperReference passed in the payment request. + + + Example: AdyenTestShopperXX' + type: string + terminalId: + description: 'The terminal ID used in a point-of-sale payment. + + + Example: 06022622' + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. + + + Example: true' + type: string + threeDAuthenticatedResponse: + description: 'The raw 3DS authentication result from the card issuer. + + + Example: N' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. + + + Example: true' + type: string + threeDOfferedResponse: + description: 'The raw enrollment result from the 3DS directory services + of the card schemes. + + + Example: Y' + type: string + threeDSVersion: + description: The 3D Secure 2 version. + type: string + visaTransactionId: + description: 'The `visaTransactionId`, has a fixed length of 15 numeric + characters. + + + > 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. + + + Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + type: string + ResponseAdditionalDataDeliveryAddress: + properties: + deliveryAddress.city: + description: The delivery address city passed in the payment request. + type: string + deliveryAddress.country: + description: 'The delivery address country passed in the payment request. + + + Example: NL' + type: string + deliveryAddress.houseNumberOrName: + description: The delivery address house number or name passed in the payment + request. + type: string + deliveryAddress.postalCode: + description: 'The delivery address postal code passed in the payment request. + + + Example: 1011 DJ' + type: string + deliveryAddress.stateOrProvince: + description: 'The delivery address state or province passed in the payment + request. + + + Example: NH' + type: string + deliveryAddress.street: + description: The delivery address street passed in the payment request. + type: string + 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: + + * PayInInstallmentsOnly + + * PayInFullOnly + + * PayInFullOrInstallments' + type: string + installments.value: + description: 'The number of installments that the payment amount should + be charged with. + + + Example: 5 + + > Only relevant for card payments in countries that support installments.' + type: string + 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 + 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 + ResponseAdditionalDataSepa: + properties: + sepadirectdebit.dateOfSignature: + description: 'The transaction signature date. + + + Format: 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: + + * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct + debit transaction. + + + * First: (FRST) Initial/first collection in a series of direct debit instructions. + + * Recurring: (RCUR) Direct debit instruction to carry out regular direct + debit transactions initiated by the creditor. + + * Final: (FNAL) Last/final collection in a series of direct debit instructions. + + + Example: OOFF' + type: string + SDKEphemPubKey: + properties: + crv: + description: The `crv` value as received from the 3D Secure 2 SDK. + type: string + kty: + description: The `kty` value as received from the 3D Secure 2 SDK. + type: string + x: + description: The `x` value as received from the 3D Secure 2 SDK. + type: string + y: + description: The `y` value as received from the 3D Secure 2 SDK. + type: string + ServiceError: + properties: + additionalData: + x-addedInVersion: '46' + additionalProperties: + type: string + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' + type: object + errorCode: + description: The error code mapped to the error message. + type: string + errorType: + description: The category of the error. + type: string + message: + description: A short explanation of the issue. + type: string + pspReference: + description: The PSP reference of the payment. + type: string + status: + description: The HTTP response status. + format: int32 + type: integer + ShopperInteractionDevice: + properties: + locale: + description: Locale on the shopper interaction device. + type: string + os: + description: Operating system running on the shopper interaction device. + type: string + osVersion: + description: Version of the operating system on the shopper interaction + device. + type: string + Split: + properties: + account: + description: 'Unique identifier of the account where the split amount should + be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. + + + ' + type: string + amount: + description: The amount of this split. + $ref: '#/components/schemas/SplitAmount' + description: + description: A description of this split. + type: string + reference: + description: 'Your reference for the split, which you can use to link the + split to other operations such as captures and refunds. + + + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + in Adyen for Platforms.' + type: string + type: + description: 'The type of split. + + Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, + **MarketPlace**, **BalanceAccount**.' + enum: + - BalanceAccount + - Commission + - Default + - MarketPlace + - PaymentFee + - VAT + - Verification + type: string + required: + - amount + - type + SplitAmount: + properties: + currency: + description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + + + If this value is not provided, the currency in which the payment is made + will be used.' + maxLength: 3 + minLength: 3 + type: string + value: + description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - value + TechnicalCancelRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be captured/refunded. Required for + `/capture` and `/refund`, not allowed for `/cancel`. The `currency` must + match the currency used in authorisation, the `value` must be smaller + than or equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - originalMerchantReference + ThreeDS1Result: + properties: + cavv: + description: The cardholder authentication value (base64 encoded). + type: string + cavvAlgorithm: + description: The CAVV algorithm used. + type: string + eci: + description: 3D Secure Electronic Commerce Indicator (ECI). + type: string + threeDAuthenticatedResponse: + description: The authentication response from the ACS. + type: string + threeDOfferedResponse: + description: Whether 3D Secure was offered or not. + type: string + xid: + description: A unique transaction identifier generated by the MPI on behalf + of the merchant to identify the 3D Secure transaction, in `Base64` encoding. + type: string + ThreeDS2RequestData: + properties: + acquirerBIN: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The acquiring BIN enrolled for 3D Secure 2. This string should match the + value that you will use in the authorisation. Use 123456 on the Test platform. + type: string + acquirerMerchantID: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. + This string should match the value that you will use in the authorisation. + Use 123456 on the Test platform. + type: string + authenticationOnly: + deprecated: true + x-deprecatedInVersion: '50' + x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + challengeIndicator: + description: 'Possibility to specify a preference for receiving a challenge + from the issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate + type: string + deviceChannel: + description: 'The environment of the shopper. + + Allowed values: + + * `app` + + * `browser`' + type: string + deviceRenderOptions: + description: 'Display options for the 3D Secure 2 SDK. + + Optional and only for `deviceChannel` **app**.' + $ref: '#/components/schemas/DeviceRenderOptions' + mcc: + x-addedInVersion: '49' + description: Required for merchants that have been enrolled for 3D Secure + 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` + is registered at the scheme. + type: string + merchantName: + x-addedInVersion: '49' + description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchant name that the issuer presents to the shopper if they get + a challenge. We recommend to use the same value that you will use in the + authorization. Maximum length is 40 characters. + + > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). + Use this field if you are enrolled for 3D Secure 2 with us and want to + override the merchant name already configured on your account.' + type: string + messageVersion: + default: 2.1.0 + description: The `messageVersion` value indicating the 3D Secure 2 protocol + version. + type: string + notificationURL: + description: URL to where the issuer should send the `CRes`. Required if + you are not using components for `channel` **Web** or if you are using + classic integration `deviceChannel` **browser**. + type: string + sdkAppID: + description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEncData: + description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEphemPubKey: + description: 'The `sdkEphemPubKey` value as received from the 3D Secure + 2 SDK. + + Required for `deviceChannel` set to **app**.' + $ref: '#/components/schemas/SDKEphemPubKey' + sdkMaxTimeout: + default: 60 + description: 'The maximum amount of time in minutes for the 3D Secure 2 + authentication process. + + Optional and only for `deviceChannel` set to **app**. Defaults to **60** + minutes.' + format: int32 + type: integer + sdkReferenceNumber: + description: 'The `sdkReferenceNumber` value as received from the 3D Secure + 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkTransID: + description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkVersion: + x-addedInVersion: '40' + description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ + \ set to **app**." + type: string + threeDSCompInd: + description: Completion indicator for the device fingerprinting. + type: string + threeDSRequestorID: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor identifier assigned by the Directory + Server when you enrol for 3D Secure 2. + type: string + threeDSRequestorName: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor name assigned by the Directory Server + when you enrol for 3D Secure 2. + type: string + threeDSRequestorURL: + description: URL of the (customer service) website that will be shown to + the shopper in case of technical errors during the 3D Secure 2 process. + type: string + transactionType: + x-addedInVersion: '50' + description: Identify the type of the transaction being authenticated. + enum: + - goodsOrServicePurchase + - checkAcceptance + - accountFunding + - quasiCashTransaction + - prepaidActivationAndLoad + type: string + whiteListStatus: + x-addedInVersion: '49' + description: The `whiteListStatus` value returned from a previous 3D Secure + 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. + type: string + required: + - deviceChannel + 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 + challengeIndicator: + x-addedInVersion: '67' + description: 'Specifies a preference for receiving a challenge from the + issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate + 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. + + Allowed values: + + * `lowValue` + + * `secureCorporate` + + * `trustedBeneficiary` + + * `transactionRiskAnalysis` + + ' + 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 + 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 + ThreeDS2ResultRequest: + properties: + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + pspReference: + description: The pspReference returned in the /authorise call. + type: string + required: + - merchantAccount + - pspReference + ThreeDS2ResultResponse: + properties: + threeDS2Result: + description: The result of the 3D Secure 2 authentication. + $ref: '#/components/schemas/ThreeDS2Result' + ThreeDSecureData: + properties: + authenticationResponse: + description: 'In 3D Secure 1, the authentication response if the shopper + was redirected. + + + In 3D Secure 2, this is the `transStatus` from the challenge result. If + the transaction was frictionless, omit this parameter.' + enum: + - Y + - N + - U + - A + type: string + cavv: + description: The cardholder authentication value (base64 encoded, 20 bytes + in a decoded form). + format: byte + type: string + cavvAlgorithm: + description: The CAVV algorithm used. Include this only for 3D Secure 1. + 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 + directoryResponse: + description: 'In 3D Secure 1, this is the enrollment response from the 3D + directory server. + + + In 3D Secure 2, this is the `transStatus` from the `ARes`.' + enum: + - A + - C + - D + - I + - N + - R + - U + - Y + type: string + dsTransID: + x-addedInVersion: '40' + description: Supported for 3D Secure 2. The unique transaction identifier + assigned by the Directory Server (DS) to identify a single transaction. + type: string + eci: + description: The electronic commerce indicator. + type: string + riskScore: + x-addedInVersion: '67' + description: Risk score calculated by Directory Server (DS). Required for + Cartes Bancaires integrations. + type: string + threeDSVersion: + x-addedInVersion: '40' + description: The version of the 3D Secure protocol. + type: string + transStatusReason: + x-addedInVersion: '67' + 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 + xid: + description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, + 20 bytes in a decoded form). + format: byte + type: string + VoidPendingRefundRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be captured/refunded. Required for + `/capture` and `/refund`, not allowed for `/cancel`. The `currency` must + match the currency used in authorisation, the `value` must be smaller + than or equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: + generic-400: + summary: Response code 400. Bad request. + value: + status: 400 + errorCode: '702' + message: 'Unexpected input: ", expected: }' + errorType: validation + generic-401: + summary: Response code 401. Unauthorized. + value: + status: 401 + errorCode: '000' + message: HTTP Status Response - Unauthorized + errorType: security + generic-500: + summary: Response code 500. Internal server error. + value: + status: 500 + errorCode: '905' + message: Payment details are not supported + errorType: configuration + pspReference: '8516091485743033' + post-adjustAuthorisation-adjustAuthorisation: + summary: Increases or decreases the authorised amount + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + modificationAmount: + currency: USD + value: 1700 + reference: YourModificationReference + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' + value: + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' + post-authorise-authorise-3d-secure-2: + summary: Make a card payment with 3D Secure 2 native authentication + value: + amount: + currency: USD + value: 1500 + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: YOUR_REFERENCE_NUMBER + threeDS2RequestData: + deviceChannel: browser + notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL + browserInfo: + userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 + (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 + acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 + language: en + colorDepth: 24 + screenHeight: 723 + screenWidth: 1536 + timeZoneOffset: 0 + javaEnabled: false + billingAddress: + country: US + city: New York + street: Redwood Block + houseNumberOrName: 37C + stateOrProvince: NY + postalCode: '10039' + accountInfo: + accountCreationDate: '2019-01-17T13:42:40+01:00' + shopperEmail: s.hopper@test.com + shopperIP: 192.0.2.1 + card: + cvc: '737' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + number: '4917610000000000' + post-authorise-authorise-3dsecure: + summary: Initiate a 3D Secure payment + value: + amount: + value: 1500 + currency: EUR + browserInfo: + userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 + Firefox/3.0 + acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + card: + number: '5212345678901234' + expiryMonth: '03' + expiryYear: '2030' + cvc: '737' + holderName: John Smith + reference: YOUR_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-card: + summary: Authorise a card payment + value: + card: + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + cvc: '737' + holderName: John Smith + amount: + value: 1500 + currency: EUR + reference: YOUR_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-recurringcontauth: + summary: Authorise a recurring payment + value: + amount: + value: 2000 + currency: EUR + reference: YOUR_REFERENCE + shopperEmail: s.hopper@test.com + shopperIP: 61.294.12.12 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + selectedRecurringDetailReference: LATEST + recurring: + contract: RECURRING + shopperInteraction: ContAuth + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-recurringoneclick: + summary: Authorise a one-click payment + value: + amount: + value: 2000 + currency: EUR + card: + cvc: '737' + reference: YOUR_REFERENCE + shopperEmail: s.hopper@test.com + shopperIP: 61.294.12.12 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + selectedRecurringDetailReference: LATEST + recurring: + contract: ONECLICK + shopperInteraction: Ecommerce + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-recurringstore: + summary: Store card details for recurring payments + value: + amount: + value: 2000 + currency: EUR + card: + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + cvc: '737' + holderName: John Smith + reference: YOUR_REFERENCE + shopperEmail: s.hopper@test.com + shopperIP: 61.294.12.12 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + recurring: + contract: RECURRING,ONECLICK + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-split: + summary: Split a payment between a sub-merchant and a platform account + value: + card: + number: '4111111111111111' + cvc: '737' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + amount: + value: 6200 + currency: EUR + reference: YOUR_ORDER_NUMBER + merchantAccount: YOUR_MERCHANT_ACCOUNT + splits: + - amount: + value: 6000 + type: MarketPlace + account: '151272963' + reference: '6124145' + description: 'Porcelain Doll: Eliza (20cm)' + - amount: + value: 200 + type: Commission + reference: '6124146' + post-authorise3d-authorise3d: + summary: Complete a 3D Secure payment + value: + md: 31h..........vOXek7w + paResponse: eNqtmF........wGVA4Ch + shopperIP: 61.294.12.12 + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise3ds2-authorise3ds2: + summary: Submit 3D Secure 2 authentication data to the issuer + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + threeDS2RequestData: + threeDSCompInd: Y + threeDS2Token: "\u2014 - BINARY DATA - -" + post-cancel-cancel: + summary: Cancel an authorised payment + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + reference: YourModificationReference + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund: + summary: Cancel or refund a payment + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + reference: YourModificationReference + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' + post-capture-capture: + summary: Capture an authorised payment + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + modificationAmount: + value: 500 + currency: EUR + reference: YOUR_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-capture-capture-200: + summary: Example response for request 'capture' + value: + pspReference: 861617892359057J + response: '[capture-received]' + post-donate-donate: + summary: Create a payment for the specified donation + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + modificationAmount: + value: 500 + currency: EUR + reference: YOUR_DONATION_REFERENCE + donationAccount: AdyenGivingDemo + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-getAuthenticationResult-getAuthenticationResult: + summary: Retrieve the authentication result after doing a 3D Secure authentication + only + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: '9935272408535455' + post-refund-refund: + summary: Refund a captured payment + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + modificationAmount: + value: 500 + currency: EUR + reference: YOUR_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' + post-retrieve3ds2Result-retrieve3ds2Result: + summary: Retrieve authentication details after doing a 3D Secure 2 authentication + only + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: '9935272408535455' + post-technicalCancel-technicalCancel: + summary: Cancel a payment without a PSP reference + value: + originalMerchantReference: YOUR_MERCHANT_REFERENCE + reference: YOUR_MODIFICATION_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' + post-voidPendingRefund-voidpendingrefund-pspreference: + summary: Cancel a POS refund request with PSP reference before it has been completed + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' + post-voidPendingRefund-voidpendingrefund-tenderreference: + summary: Cancels a POS refund request with tender reference before it has been + completed + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + tenderReference: 5Iw8001176969533005 + uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PaymentService-v68.yaml b/yaml/PaymentService-v68.yaml new file mode 100644 index 0000000..d124d80 --- /dev/null +++ b/yaml/PaymentService-v68.yaml @@ -0,0 +1,6973 @@ +openapi: 3.1.0 +servers: +- url: https://pal-test.adyen.com/pal/servlet/Payment/v68 +info: + version: '68' + x-publicVersion: true + title: Adyen Payment API + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports versioning of its endpoints through a version suffix in + the endpoint URL. This suffix has the following format: "vXX", where XX is the + version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise + + ```' + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- General +- Modifications +paths: + /adjustAuthorisation: + post: + tags: + - Modifications + summary: Increases or decreases the authorised amount. + description: 'Allows you to increase or decrease the authorised amount after + the initial authorisation has taken place. This functionality enables for + example tipping, improving the chances your authorisation will be valid, or + charging the shopper when they have already left the merchant premises. + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + + > If you have a [newer integration](https://docs.adyen.com/online-payments), + and are doing: + + > * [Asynchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), + use the [`/payments/{paymentPspReference}/amountUpdates`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/amountUpdates) + endpoint on Checkout API. + + > * [Synchronous adjustments](https://docs.adyen.com/online-payments/adjust-authorisation#asynchronous-or-synchronous-adjustment), + use this endpoint.' + x-addedInVersion: '30' + operationId: post-adjustAuthorisation + x-groupName: Modifications + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation' + schema: + $ref: '#/components/schemas/AdjustAuthorisationRequest' + responses: + '200': + content: + application/json: + examples: + adjustAuthorisation: + $ref: '#/components/examples/post-adjustAuthorisation-adjustAuthorisation-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /authorise: + post: + tags: + - General + summary: Creates a payment authorisation. + description: 'Creates a payment with a unique reference (`pspReference`) and + attempts to obtain an authorisation hold. For cards, this amount can be captured + or cancelled later. Non-card payment methods typically don''t support this + and will automatically capture as part of the authorisation. + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) + endpoint under Checkout API instead.' + operationId: post-authorise + x-groupName: General + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + authorise-3d-secure-2: + $ref: '#/components/examples/post-authorise-authorise-3d-secure-2' + authorise-3dsecure: + $ref: '#/components/examples/post-authorise-authorise-3dsecure' + authorise-card: + $ref: '#/components/examples/post-authorise-authorise-card' + authorise-recurringcontauth: + $ref: '#/components/examples/post-authorise-authorise-recurringcontauth' + authorise-recurringoneclick: + $ref: '#/components/examples/post-authorise-authorise-recurringoneclick' + authorise-recurringstore: + $ref: '#/components/examples/post-authorise-authorise-recurringstore' + authorise-split: + $ref: '#/components/examples/post-authorise-authorise-split' + schema: + $ref: '#/components/schemas/PaymentRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /authorise3d: + post: + tags: + - General + summary: Completes a 3D Secure payment authorisation. + description: 'For an authenticated 3D Secure session, completes the payment + authorisation. This endpoint must receive the `md` and `paResponse` parameters + that you get from the card issuer after a shopper pays via 3D Secure. + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) + endpoint under Checkout API instead.' + operationId: post-authorise3d + x-groupName: General + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + authorise3d: + $ref: '#/components/examples/post-authorise3d-authorise3d' + schema: + $ref: '#/components/schemas/PaymentRequest3d' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /authorise3ds2: + post: + tags: + - General + summary: Completes a 3D Secure 2 payment authorisation. + description: 'For an authenticated 3D Secure 2 session, completes the payment + authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` + parameters. + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) + endpoint under Checkout API instead.' + x-addedInVersion: '37' + operationId: post-authorise3ds2 + x-groupName: General + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + authorise3ds2: + $ref: '#/components/examples/post-authorise3ds2-authorise3ds2' + schema: + $ref: '#/components/schemas/PaymentRequest3ds2' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /cancel: + post: + tags: + - Modifications + summary: Cancels an authorised payment. + description: 'Cancels the authorisation hold on a payment, returning a unique + reference for this request. You can cancel payments after authorisation only + for payment methods that support distinct authorisations and captures. + + + For more information, refer to [Cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel). + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/cancels) + endpoint under Checkout API instead.' + operationId: post-cancel + x-groupName: Modifications + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + cancel: + $ref: '#/components/examples/post-cancel-cancel' + schema: + $ref: '#/components/schemas/CancelRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /cancelOrRefund: + post: + tags: + - Modifications + summary: Cancels or refunds a payment. + description: "Cancels a payment if it has not been captured yet, or refunds\ + \ it if it has already been captured. This is useful when it is not certain\ + \ if the payment has been captured or not (for example, when using auto-capture).\n\ + \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ + \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ + \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ + \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ + \nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\ + \n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\ + \ If using a [newer integration](https://docs.adyen.com/online-payments),\ + \ use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals)\ + \ endpoint under Checkout API instead." + operationId: post-cancelOrRefund + x-groupName: Modifications + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund' + schema: + $ref: '#/components/schemas/CancelOrRefundRequest' + responses: + '200': + content: + application/json: + examples: + cancelOrRefund: + $ref: '#/components/examples/post-cancelOrRefund-cancelOrRefund-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /capture: + post: + tags: + - Modifications + summary: Captures an authorised payment. + description: 'Captures the authorisation hold on a payment, returning a unique + reference for this request. Usually the full authorisation amount is captured, + however it''s also possible to capture a smaller amount, which results in + cancelling the remaining authorisation balance. + + + Payment methods that are captured automatically after authorisation don''t + need to be captured. However, submitting a capture request on these transactions + will not result in double charges. If immediate or delayed auto-capture is + enabled, calling the capture method is not neccessary. + + + For more information refer to [Capture](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/capture). + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/{paymentPspReference}/captures`](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/payments/{paymentPspReference}/captures) + endpoint on Checkout API instead. + + + ' + operationId: post-capture + x-groupName: Modifications + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + capture: + $ref: '#/components/examples/post-capture-capture' + schema: + $ref: '#/components/schemas/CaptureRequest' + responses: + '200': + content: + application/json: + examples: + capture: + $ref: '#/components/examples/post-capture-capture-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /donate: + post: + tags: + - Modifications + summary: Creates a payment for the specified donation. + description: 'Schedules a new payment to be created (including a new authorisation + request) for the specified donation using the payment details of the original + payment. + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/donations`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/donations) + endpoint under Checkout API instead.' + x-addedInVersion: '40' + operationId: post-donate + x-groupName: Modifications + x-sortIndex: 6 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + donate: + $ref: '#/components/examples/post-donate-donate' + schema: + $ref: '#/components/schemas/DonationRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /getAuthenticationResult: + post: + tags: + - General + summary: Return the authentication result after doing a 3D Secure authentication + only. + description: Return the authentication result after doing a 3D Secure authentication + only. + x-addedInVersion: '51' + operationId: post-getAuthenticationResult + x-groupName: General + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + getAuthenticationResult: + $ref: '#/components/examples/post-getAuthenticationResult-getAuthenticationResult' + schema: + $ref: '#/components/schemas/AuthenticationResultRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationResultResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /refund: + post: + tags: + - Modifications + summary: Refunds a captured payment. + description: 'Refunds a payment that has previously been captured, returning + a unique reference for this request. Refunding can be done on the full captured + amount or a partial amount. Multiple (partial) refunds will be accepted as + long as their sum doesn''t exceed the captured amount. Payments which have + been authorised, but not captured, cannot be refunded, use the /cancel method + instead. + + + Some payment methods/gateways do not support partial/multiple refunds. + + A margin above the captured limit can be configured to cover shipping/handling + costs. + + + For more information, refer to [Refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/refund). + + + > This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). + If using a [newer integration](https://docs.adyen.com/online-payments), use + the [`/payments/{paymentPspReference}/refunds`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/refunds) + endpoint under Checkout API instead.' + operationId: post-refund + x-groupName: Modifications + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + refund: + $ref: '#/components/examples/post-refund-refund' + schema: + $ref: '#/components/schemas/RefundRequest' + responses: + '200': + content: + application/json: + examples: + refund: + $ref: '#/components/examples/post-refund-refund-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /retrieve3ds2Result: + post: + tags: + - General + summary: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication + only. + description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication + only. + x-addedInVersion: '40' + operationId: post-retrieve3ds2Result + x-groupName: General + x-sortIndex: 4 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + retrieve3ds2Result: + $ref: '#/components/examples/post-retrieve3ds2Result-retrieve3ds2Result' + schema: + $ref: '#/components/schemas/ThreeDS2ResultRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ThreeDS2ResultResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /technicalCancel: + post: + tags: + - Modifications + summary: Cancels a payment using your custom reference. + description: "This endpoint allows you to cancel a payment if you do not have\ + \ the PSP reference of the original payment request available.\n\nIn your\ + \ call, refer to the original payment by using the `reference` that you specified\ + \ in your payment request.\n\nFor more information, see [Technical cancel](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel#technical-cancel).\ + \ \n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce).\ + \ If using a [newer integration](https://docs.adyen.com/online-payments),\ + \ use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/cancels)\ + \ endpoint under Checkout API instead." + x-addedInVersion: '30' + operationId: post-technicalCancel + x-groupName: Modifications + x-sortIndex: 5 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel' + schema: + $ref: '#/components/schemas/TechnicalCancelRequest' + responses: + '200': + content: + application/json: + examples: + technicalCancel: + $ref: '#/components/examples/post-technicalCancel-technicalCancel-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /voidPendingRefund: + post: + tags: + - Modifications + summary: Cancels a POS refund request before it has been completed. + description: 'This endpoint allows you to cancel the refund request before it + has been completed. + + + In your call, you can refer to the original refund request either by using + the `tenderReference`, or the `pspReference`. We recommend implementing based + on the `tenderReference`, as this is generated for both offline and online + transactions. + + + For more information, refer to [Cancel a refund](https://docs.adyen.com/point-of-sale/refund-payment/cancel-a-pos-refund-request).' + x-addedInVersion: '25' + operationId: post-voidPendingRefund + x-groupName: Modifications + x-sortIndex: 7 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference' + schema: + $ref: '#/components/schemas/VoidPendingRefundRequest' + responses: + '200': + content: + application/json: + examples: + voidpendingrefund-pspreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-pspreference-200' + voidpendingrefund-tenderreference: + $ref: '#/components/examples/post-voidPendingRefund-voidpendingrefund-tenderreference-200' + schema: + $ref: '#/components/schemas/ModificationResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-401' + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-500' + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. +components: + schemas: + AccountInfo: + properties: + accountAgeIndicator: + description: 'Indicator for the length of time since this shopper account + was created in the merchant''s environment. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountChangeDate: + description: Date when the shopper's account was last changed. + format: date-time + type: string + accountChangeIndicator: + description: 'Indicator for the length of time since the shopper''s account + was last updated. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountCreationDate: + description: Date when the shopper's account was created. + format: date-time + type: string + accountType: + x-addedInVersion: '50' + description: 'Indicates the type of account. For example, for a multi-account + card product. + + Allowed values: + + * notApplicable + + * credit + + * debit' + enum: + - notApplicable + - credit + - debit + type: string + addCardAttemptsDay: + description: Number of attempts the shopper tried to add a card to their + account in the last day. + format: int32 + type: integer + deliveryAddressUsageDate: + description: Date the selected delivery address was first used. + format: date-time + type: string + deliveryAddressUsageIndicator: + description: 'Indicator for the length of time since this delivery address + was first used. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + homePhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.homePhone` instead. + description: Shopper's home phone number (including the country code). + type: string + mobilePhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.mobilePhone` instead. + description: Shopper's mobile phone number (including the country code). + type: string + passwordChangeDate: + description: Date when the shopper last changed their password. + format: date-time + type: string + passwordChangeIndicator: + description: 'Indicator when the shopper has changed their password. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + pastTransactionsDay: + description: Number of all transactions (successful and abandoned) from + this shopper in the past 24 hours. + format: int32 + type: integer + pastTransactionsYear: + description: Number of all transactions (successful and abandoned) from + this shopper in the past year. + format: int32 + type: integer + paymentAccountAge: + description: Date this payment method was added to the shopper's account. + format: date-time + type: string + paymentAccountIndicator: + description: 'Indicator for the length of time since this payment method + was added to this shopper''s account. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + purchasesLast6Months: + description: Number of successful purchases in the last six months. + format: int32 + type: integer + suspiciousActivity: + description: Whether suspicious activity was recorded on this account. + type: boolean + workPhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. + description: Shopper's work phone number (including the country code). + type: string + AcctInfo: + properties: + chAccAgeInd: + description: "Length of time that the cardholder has had the account with\ + \ the 3DS Requestor. \nAllowed values:\n* **01** \u2014 No account\n*\ + \ **02** \u2014 Created during this transaction\n* **03** \u2014 Less\ + \ than 30 days\n* **04** \u2014 30\u201360 days\n* **05** \u2014 More\ + \ than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + chAccChange: + description: "Date that the cardholder\u2019s account with the 3DS Requestor\ + \ was last changed, including Billing or Shipping address, new payment\ + \ account, or new user(s) added. \nFormat: **YYYYMMDD**" + type: string + chAccChangeInd: + description: "Length of time since the cardholder\u2019s account information\ + \ with the 3DS Requestor was last changed, including Billing or Shipping\ + \ address, new payment account, or new user(s) added. \nAllowed values:\n\ + * **01** \u2014 Changed during this transaction\n* **02** \u2014 Less\ + \ than 30 days\n* **03** \u2014 30\u201360 days\n* **04** \u2014 More\ + \ than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + chAccPwChange: + description: "Date that cardholder\u2019s account with the 3DS Requestor\ + \ had a password change or account reset. \nFormat: **YYYYMMDD**" + type: string + chAccPwChangeInd: + description: "Indicates the length of time since the cardholder\u2019s account\ + \ with the 3DS Requestor had a password change or account reset. \nAllowed\ + \ values:\n* **01** \u2014 No change\n* **02** \u2014 Changed during this\ + \ transaction\n* **03** \u2014 Less than 30 days\n* **04** \u2014 30\u2013\ + 60 days\n* **05** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + chAccString: + description: "Date that the cardholder opened the account with the 3DS Requestor.\ + \ \nFormat: **YYYYMMDD**" + type: string + nbPurchaseAccount: + description: 'Number of purchases with this cardholder account during the + previous six months. Max length: 4 characters.' + type: string + paymentAccAge: + description: "String that the payment account was enrolled in the cardholder\u2019\ + s account with the 3DS Requestor. \nFormat: **YYYYMMDD**" + type: string + paymentAccInd: + description: "Indicates the length of time that the payment account was\ + \ enrolled in the cardholder\u2019s account with the 3DS Requestor. \n\ + Allowed values:\n* **01** \u2014 No account (guest checkout)\n* **02**\ + \ \u2014 During this transaction\n* **03** \u2014 Less than 30 days\n\ + * **04** \u2014 30\u201360 days\n* **05** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + provisionAttemptsDay: + description: 'Number of Add Card attempts in the last 24 hours. Max length: + 3 characters.' + type: string + shipAddressUsage: + description: "String when the shipping address used for this transaction\ + \ was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**" + type: string + shipAddressUsageInd: + description: "Indicates when the shipping address used for this transaction\ + \ was first used with the 3DS Requestor. \nAllowed values:\n* **01** \u2014\ + \ This transaction\n* **02** \u2014 Less than 30 days\n* **03** \u2014\ + \ 30\u201360 days\n* **04** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + shipNameIndicator: + description: "Indicates if the Cardholder Name on the account is identical\ + \ to the shipping Name used for this transaction. \nAllowed values:\n\ + * **01** \u2014 Account Name identical to shipping Name\n* **02** \u2014\ + \ Account Name different to shipping Name" + enum: + - '01' + - '02' + maxLength: 2 + minLength: 2 + type: string + suspiciousAccActivity: + description: "Indicates whether the 3DS Requestor has experienced suspicious\ + \ activity (including previous fraud) on the cardholder account. \nAllowed\ + \ values:\n* **01** \u2014 No suspicious activity has been observed\n\ + * **02** \u2014 Suspicious activity has been observed" + enum: + - '01' + - '02' + maxLength: 2 + minLength: 2 + type: string + txnActivityDay: + description: 'Number of transactions (successful and abandoned) for this + cardholder account with the 3DS Requestor across all payment accounts + in the previous 24 hours. Max length: 3 characters.' + maxLength: 3 + type: string + txnActivityYear: + description: 'Number of transactions (successful and abandoned) for this + cardholder account with the 3DS Requestor across all payment accounts + in the previous year. Max length: 3 characters.' + maxLength: 3 + type: string + AdditionalData3DSecure: + properties: + allow3DS2: + description: "Indicates if you are able to process 3D Secure 2 transactions\ + \ natively on your payment page. Send this parameter when you are using\ + \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ + \n > This parameter only indicates readiness to support native 3D Secure\ + \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ + \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ + \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ + \ support native 3D Secure 2 authentication. Setting this to true does\ + \ not mean always applying 3D Secure 2. Adyen still selects the version\ + \ of 3D Secure based on configuration to optimize authorisation rates\ + \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ + \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ + \ Secure 2 to your shopper regardless of your configuration.\n" + type: string + executeThreeD: + description: "Indicates if you want to perform 3D Secure authentication\ + \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ + \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ + \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ + \ 3D Secure authentication. Note that this setting results in refusals\ + \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ + \ national regulations. \n" + type: string + mpiImplementationType: + description: In case of Secure+, this field must be set to **CUPSecurePlus**. + type: string + scaExemption: + description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that you want to request for the transaction.\n\n Possible values:\n\ + * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ + \ **transactionRiskAnalysis** " + type: string + threeDSVersion: + description: "Indicates your preference for the 3D Secure version. \n> If\ + \ you use this parameter, you override the checks from Adyen's Authentication\ + \ Engine. We recommend to use this field only if you have an extensive\ + \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ + \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ + \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ + \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ + \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ + \ in the `ARes`, we will apply the fallback policy configured in your\ + \ account. For example, if the configuration is to fall back to 3D Secure\ + \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ + \ the BIN is not enrolled, you will receive an error.\n\n" + type: string + AdditionalDataAirline: + properties: + airline.agency_invoice_number: + description: 'Reference number for the invoice, issued by the agency. + + * minLength: 1 + + * maxLength: 6' + type: string + airline.agency_plan_name: + description: '2-letter agency plan identifier; alphabetical. + + * minLength: 2 + + * maxLength: 2' + type: string + airline.airline_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit + accounting code (PAX); numeric. It identifies the carrier. + + * Format: IATA 3-digit accounting code (PAX) + + * Example: KLM = 074 + + * minLength: 3 + + * maxLength: 3' + type: string + airline.airline_designator_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.boarding_fee: + description: 'Chargeable amount for boarding the plane. + + The transaction amount needs to be represented in minor units according + to the [following table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 18' + type: string + airline.computerized_reservation_system: + description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) + used to make the reservation and purchase the ticket. + + * Format: alphanumeric. + + * minLength: 4 + + * maxLength: 4' + type: string + airline.customer_reference_number: + description: 'Reference number; alphanumeric. + + * minLength: 0 + + * maxLength: 20' + type: string + airline.document_type: + description: 'Optional 2-digit code; alphanumeric. It identifies the type + of product of the transaction. The description of the code may appear + on credit card statements. + + * Format: 2-digit code + + * Example: Passenger ticket = 01 + + * minLength: 2 + + * maxLength: 2' + type: string + airline.flight_date: + description: 'Flight departure date. Local time `(HH:mm)` is optional. + + * Date format: `yyyy-MM-dd` + + * Date and time format: `yyyy-MM-dd HH:mm` + + * minLength: 10 + + * maxLength: 16' + type: string + airline.leg.carrier_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + This field is required/mandatory if the airline data includes leg details. + + * Format: IATA 2-letter airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.leg.class_of_travel: + description: '1-letter travel class identifier; alphabetical. There is no + standard; however, the following codes are used rather consistently: + + * F: first class + + * J: business class + + * Y: economy class + + * W: premium economy + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.leg.date_of_travel: + description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ + * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" + type: string + airline.leg.depart_airport: + description: 'Alphabetical identifier of the departure airport. + + This field is required if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.depart_tax: + description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). + Amount charged by a country to an individual upon their leaving. The transaction + amount needs to be represented in minor units according to the [following + table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 12' + type: string + airline.leg.destination_code: + description: 'Alphabetical identifier of the destination/arrival airport. + + This field is required/mandatory if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.fare_base_code: + description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); + alphanumeric. + + * minLength: 1 + + * maxLength: 7' + type: string + airline.leg.flight_number: + description: 'The flight identifier. + + * minLength: 1 + + * maxLength: 5' + type: string + airline.leg.stop_over_code: + description: '1-letter code that indicates whether the passenger is entitled + to make a stopover. Only two types of characters are allowed: + + * O: Stopover allowed + + * X: Stopover not allowed + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.passenger.date_of_birth: + description: 'Date of birth of the passenger. + + + Date format: `yyyy-MM-dd` + + * minLength: 10 + + * maxLength: 10' + type: string + airline.passenger.first_name: + description: 'Passenger first name/given name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.last_name: + description: 'Passenger last name/family name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.telephone_number: + description: 'Telephone number of the passenger, including country code. + This is an alphanumeric field that can include the ''+'' and ''-'' signs. + + * minLength: 3 + + * maxLength: 30' + type: string + airline.passenger.traveller_type: + description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. + Example: ADT, SRC, CNN, INS. + + + However, several carriers use non-standard codes that can be up to 5 alphanumeric + characters. + + * minLength: 3 + + * maxLength: 6' + type: string + airline.passenger_name: + description: 'Passenger name, initials, and a title. + + * Format: last name + first name or initials + title. + + * Example: *FLYER / MARY MS*. + + * minLength: 1 + + * maxLength: 49' + type: string + airline.ticket_issue_address: + description: 'Address of the place/agency that issued the ticket. + + * minLength: 0 + + * maxLength: 16' + type: string + airline.ticket_number: + description: 'The ticket''s unique identifier. + + * minLength: 1 + + * maxLength: 150' + type: string + airline.travel_agency_code: + description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier + number for travel agencies. + + * minLength: 1 + + * maxLength: 8' + type: string + airline.travel_agency_name: + description: 'The name of the travel agency. + + * minLength: 1 + + * maxLength: 25' + type: string + required: + - airline.passenger_name + AdditionalDataCarRental: + properties: + carRental.checkOutDate: + description: 'Pick-up date. + + * Date format: `yyyyMMdd`' + type: string + carRental.customerServiceTollFreeNumber: + description: 'The customer service phone number of the car rental company. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + carRental.daysRented: + description: 'Number of days for which the car is being rented. + + * Format: Numeric + + * maxLength: 19' + type: string + carRental.fuelCharges: + description: 'Any fuel charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.insuranceCharges: + description: 'Any insurance charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.locationCity: + description: 'The city from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.locationCountry: + description: 'The country from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.locationStateProvince: + description: 'The state or province from where the car is rented. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + * Y - Customer was a no show. + + * N - Not applicable.' + type: string + carRental.oneWayDropOffCharges: + description: Charge associated with not returning a vehicle to the original + rental location. + type: string + carRental.rate: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.rateIndicator: + description: 'Specifies whether the given rate is applied daily or weekly. + + * D - Daily rate. + + * W - Weekly rate.' + type: string + carRental.rentalAgreementNumber: + description: 'The rental agreement number associated with this car rental. + + * Format: Alphanumeric + + * maxLength: 9' + type: string + carRental.rentalClassId: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.renterName: + description: 'The name of the person renting the car. + + * Format: Alphanumeric + + * maxLength: 26' + type: string + carRental.returnCity: + description: 'The city where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.returnCountry: + description: 'The country where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.returnDate: + description: 'The last date to return the car by. + + * Date format: `yyyyMMdd`' + type: string + carRental.returnLocationId: + description: 'Agency code, phone number, or address abbreviation + + * Format: Alphanumeric + + * maxLength: 10' + type: string + carRental.returnStateProvince: + description: 'The state or province where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.taxExemptIndicator: + description: 'Indicates whether the goods or services were tax-exempt, or + tax was not collected. + + + Values: + + * Y - Goods or services were tax exempt + + * N - Tax was not collected' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "A" for Car rental. This should be + included in the auth message. + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataCommon: + properties: + RequestedTestErrorResponseCode: + description: "Triggers test scenarios that allow to replicate certain communication\ + \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ + \ wasn't a connection available to service the outgoing communication.\n\ + This is a transient, retriable error since no messaging could be initiated\ + \ to an issuing system (or third-party acquiring system). Therefore, the\ + \ header Transient-Error: true is returned in the response. A subsequent\ + \ request using the same idempotency key will be processed as if it was\ + \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ + \ wrong during transmission of the message or receiving the response.\n\ + This is a classified as non-transient because the message could have been\ + \ received by the issuing party and been acted upon. No transient error\ + \ header is returned. If using idempotency, the (error) response is stored\ + \ as the final result for the idempotency key. Subsequent messages with\ + \ the same idempotency key not be processed beyond returning the stored\ + \ response." + type: string + authorisationType: + description: "Flags a card payment request for either pre-authorisation\ + \ or final authorisation. For more information, refer to [Authorisation\ + \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ + \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ + \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ + \ request to be handled as a final authorisation." + type: string + customRoutingFlag: + description: 'Allows you to determine or override the acquirer account that + should be used for the transaction. + + + If you need to process a payment with an acquirer different from a default + one, you can set up a corresponding configuration on the Adyen payments + platform. Then you can pass a custom routing flag in a payment request''s + additional data to target a specific acquirer. + + + To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge + description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ + \ this field denotes why the additional payment is made.\n\nPossible values:\n\ + \n * **NoShow**: An incremental charge is carried out because of a no-show\ + \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ + \ charge is carried out to process an additional payment after the original\ + \ services have been rendered and the respective payment has been processed." + enum: + - NoShow + - DelayedCharge + type: string + networkTxReference: + description: 'Allows you to link the transaction to the original or previous + one in a subscription/card-on-file chain. This field is required for token-based + transactions where Adyen does not tokenize the card. + + + Transaction identifier from card schemes, for example, Mastercard Trace + ID or the Visa Transaction ID. + + + Submit the original transaction ID of the contract in your payment request + if you are not tokenizing card details with Adyen and are making a merchant-initiated + transaction (MIT) for subsequent charges. + + + Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` + **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction + is classified as MIT.' + type: string + overwriteBrand: + description: Boolean indicator that can be optionally used for performing + debit transactions on combo cards (for example, combo cards in Brazil). + This is not mandatory but we recommend that you set this to true if you + want to use the `selectedBrand` value to specify how to process the transaction. + type: string + subMerchantCity: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the city of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 13 characters.' + type: string + subMerchantCountry: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the three-letter + country code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Fixed length: 3 characters.' + type: string + subMerchantID: + description: 'This field contains an identifier of the actual merchant when + a transaction is submitted via a payment facilitator. The payment facilitator + must send in this unique ID. + + + A unique identifier per submerchant that is required if the transaction + is performed by a registered payment facilitator. + + * Format: alpha-numeric. + + * Fixed length: 15 characters.' + type: string + subMerchantName: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the name of + the actual merchant. + + * Format: alpha-numeric. + + * Maximum length: 22 characters.' + type: string + subMerchantPostalCode: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the postal code + of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 10 characters.' + type: string + subMerchantState: + description: 'This field is required if the transaction is performed by + a registered payment facilitator, and if applicable to the country. This + field must contain the state code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 3 characters.' + type: string + subMerchantStreet: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the street of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 60 characters.' + type: string + subMerchantTaxId: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the tax ID of + the actual merchant. + + * Format: alpha-numeric. + + * Fixed length: 11 or 14 characters.' + type: string + AdditionalDataLevel23: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + + Encoding: ASCII. + + + Max length: 25 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + enhancedSchemeData.destinationCountryCode: + description: 'Destination country code. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.destinationPostalCode: + description: 'The postal code of a destination address. + + + Encoding: ASCII. + + + Max length: 10 characters. + + + > Required for American Express.' + type: string + enhancedSchemeData.destinationStateProvinceCode: + description: 'Destination state or province code. + + + Encoding: ASCII.Max length: 3 characters.' + type: string + enhancedSchemeData.dutyAmount: + description: 'Duty amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.freightAmount: + description: 'Shipping amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].commodityCode: + description: 'Item commodity code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].description: + description: 'Item description. + + + Encoding: ASCII. + + + Max length: 26 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + description: 'Discount amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].productCode: + description: 'Product code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].quantity: + description: 'Quantity, specified as an integer value. + + + Value must be greater than 0. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + description: 'Total amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: + description: 'Item unit of measurement. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitPrice: + description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + + Max length: 12 characters.' + type: string + enhancedSchemeData.orderDate: + description: 'Order date. + + * Format: `ddMMyy` + + + Encoding: ASCII. + + + Max length: 6 characters.' + type: string + enhancedSchemeData.shipFromPostalCode: + description: 'The postal code of a "ship-from" address. + + + Encoding: ASCII. + + + Max length: 10 characters.' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + AdditionalDataLodging: + properties: + lodging.checkInDate: + description: 'The arrival date. + + * Date format: `yyyyMMdd`' + type: string + lodging.checkOutDate: + description: 'The departure date. + + * Date format: `yyyyMMdd`' + type: string + lodging.customerServiceTollFreeNumber: + description: 'The toll free phone number for the hotel/lodgings. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.fireSafetyActIndicator: + description: 'Identifies that the facility complies with the Hotel and Motel + Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. + + * Format: Alphabetic + + * maxLength: 1' + type: string + lodging.folioCashAdvances: + description: 'The folio cash advances. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.folioNumber: + description: "Card acceptor\u2019s internal invoice or billing ID reference\ + \ number.\n* Format: Alphanumeric\n* maxLength: 25" + type: string + lodging.foodBeverageCharges: + description: 'Any charges for food and beverages associated with the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + + Value should be Y or N. + + * Format: Numeric + + * maxLength: 1' + type: string + lodging.prepaidExpenses: + description: 'Prepaid expenses for the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.propertyPhoneNumber: + description: 'Identifies specific lodging property location by its local + phone number. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.room1.numberOfNights: + description: 'Total number of nights the room will be rented. + + * Format: Numeric + + * maxLength: 4' + type: string + lodging.room1.rate: + description: 'The rate of the room. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.room1.tax: + description: 'The total amount of tax to be paid. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalRoomTax: + description: 'Total room tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalTax: + description: 'Total tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "H" for Hotel. This should be included + in the auth message. + + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataModifications: + properties: + installmentPaymentData.selectedInstallmentOption: + description: This is the installment option selected by the shopper. It + is required only if specified by the user. + type: string + AdditionalDataOpenInvoice: + properties: + openinvoicedata.merchantData: + description: 'Holds different merchant data points like product, purchase, + customer, and so on. It takes data in a Base64 encoded string. + + + The `merchantData` parameter needs to be added to the `openinvoicedata` + signature at the end. + + + Since the field is optional, if it''s not included it does not impact + computing the merchant signature. + + + Applies only to Klarna. + + + You can contact Klarna for the format and structure of the string.' + type: string + openinvoicedata.numberOfLines: + description: 'The number of invoice lines included in `openinvoicedata`. + + + There needs to be at least one line, so `numberOfLines` needs to be at + least 1.' + type: string + openinvoicedataLine[itemNr].currencyCode: + description: The three-character ISO currency code. + type: string + openinvoicedataLine[itemNr].description: + description: A text description of the product the invoice line refers to. + type: string + openinvoicedataLine[itemNr].itemAmount: + description: 'The price for one item in the invoice line, represented in + minor units. + + + The due amount for the item, VAT excluded.' + type: string + openinvoicedataLine[itemNr].itemId: + description: A unique id for this item. Required for RatePay if the description + of each item is not unique. + type: string + openinvoicedataLine[itemNr].itemVatAmount: + description: The VAT due for one item in the invoice line, represented in + minor units. + type: string + openinvoicedataLine[itemNr].itemVatPercentage: + description: 'The VAT percentage for one item in the invoice line, represented + in minor units. + + + For example, 19% VAT is specified as 1900.' + type: string + openinvoicedataLine[itemNr].numberOfItems: + description: The number of units purchased of a specific product. + type: string + openinvoicedataLine[itemNr].returnShippingCompany: + description: Name of the shipping company handling the the return shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingNumber: + description: The tracking number for the return of the shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingUri: + description: URI where the customer can track the return of their shipment. + type: string + openinvoicedataLine[itemNr].shippingCompany: + description: Name of the shipping company handling the delivery. + type: string + openinvoicedataLine[itemNr].shippingMethod: + description: Shipping method. + type: string + openinvoicedataLine[itemNr].trackingNumber: + description: The tracking number for the shipment. + type: string + openinvoicedataLine[itemNr].trackingUri: + description: URI where the customer can track their shipment. + type: string + AdditionalDataOpi: + properties: + opi.includeTransToken: + description: 'Optional boolean indicator. Set to **true** if you want an + ecommerce transaction to return an `opi.transToken` as additional data + in the response. + + + You can store this Oracle Payment Interface token in your Oracle Opera + database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' + type: string + AdditionalDataRatepay: + properties: + ratepay.installmentAmount: + description: Amount the customer has to pay each month. + type: string + ratepay.interestRate: + description: Interest rate of this installment. + type: string + ratepay.lastInstallmentAmount: + description: Amount of the last installment. + type: string + ratepay.paymentFirstday: + description: Calendar day of the first payment. + type: string + ratepaydata.deliveryDate: + description: Date the merchant delivered the goods to the customer. + type: string + ratepaydata.dueDate: + description: Date by which the customer must settle the payment. + type: string + ratepaydata.invoiceDate: + description: Invoice date, defined by the merchant. If not included, the + invoice date is set to the delivery date. + type: string + ratepaydata.invoiceId: + description: Identification name or number for the invoice, defined by the + merchant. + type: string + AdditionalDataRetry: + properties: + retry.chainAttemptNumber: + description: 'The number of times the transaction (not order) has been retried + between different payment service providers. For instance, the `chainAttemptNumber` + set to 2 means that this transaction has been recently tried on another + provider before being sent to Adyen. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.orderAttemptNumber: + description: 'The index of the attempt to bill a particular order, which + is identified by the `merchantOrderReference` field. For example, if a + recurring transaction fails and is retried one day later, then the order + number for these attempts would be 1 and 2, respectively. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.skipRetry: + description: 'The Boolean value indicating whether Adyen should skip or + retry this transaction, if possible. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + AdditionalDataRisk: + properties: + riskdata.[customFieldName]: + description: The data for your custom risk field. For more information, + refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). + type: string + riskdata.basket.item[itemNr].amountPerItem: + description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.basket.item[itemNr].brand: + description: Brand of the item. + type: string + riskdata.basket.item[itemNr].category: + description: Category of the item. + type: string + riskdata.basket.item[itemNr].color: + description: Color of the item. + type: string + riskdata.basket.item[itemNr].currency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.basket.item[itemNr].itemID: + description: ID of the item. + type: string + riskdata.basket.item[itemNr].manufacturer: + description: Manufacturer of the item. + type: string + riskdata.basket.item[itemNr].productTitle: + description: A text description of the product the invoice line refers to. + type: string + riskdata.basket.item[itemNr].quantity: + description: Quantity of the item purchased. + type: string + riskdata.basket.item[itemNr].receiverEmail: + description: Email associated with the given product in the basket (usually + in electronic gift cards). + type: string + riskdata.basket.item[itemNr].size: + description: Size of the item. + type: string + riskdata.basket.item[itemNr].sku: + description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' + type: string + riskdata.basket.item[itemNr].upc: + description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' + type: string + riskdata.promotions.promotion[itemNr].promotionCode: + description: Code of the promotion. + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountAmount: + description: The discount amount of the promotion, represented in [minor + units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: + description: 'Promotion''s percentage discount. It is represented in percentage + value and there is no need to include the ''%'' sign. + + + e.g. for a promotion discount of 30%, the value of the field should be + 30.' + type: string + riskdata.promotions.promotion[itemNr].promotionName: + description: Name of the promotion. + type: string + riskdata.riskProfileReference: + description: Reference number of the risk profile that you want to apply + to the payment. If not provided or left blank, the merchant-level account's + default risk profile will be applied to the payment. For more information, + see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). + type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string + AdditionalDataRiskStandalone: + properties: + PayPal.CountryCode: + description: Shopper's country of residence in the form of ISO standard + 3166 2-character country codes. + type: string + PayPal.EmailId: + description: Shopper's email. + type: string + PayPal.FirstName: + description: Shopper's first name. + type: string + PayPal.LastName: + description: Shopper's last name. + type: string + PayPal.PayerId: + description: 'Unique PayPal Customer Account identification number. Character + length and limitations: 13 single-byte alphanumeric characters.' + type: string + PayPal.Phone: + description: Shopper's phone number. + type: string + PayPal.ProtectionEligibility: + description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ + \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ + \ \u2014 Merchant is not protected under the Seller Protection Policy." + type: string + PayPal.TransactionId: + description: Unique transaction ID of the payment. + type: string + avsResultRaw: + description: 'Raw AVS result received from the acquirer, where available. + Example: D' + type: string + bin: + description: The Bank Identification Number of a credit card, which is the + first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). + type: string + cvcResultRaw: + description: 'Raw CVC result received from the acquirer, where available. + Example: 1' + type: string + riskToken: + description: Unique identifier or token for the shopper's card details. + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. Example: true' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. Example: true' + type: string + tokenDataType: + description: 'Required for PayPal payments only. The only supported value + is: **paypal**.' + type: string + AdditionalDataSubMerchant: + properties: + subMerchant.numberOfSubSellers: + description: Required for transactions performed by registered payment facilitators. + Indicates the number of sub-merchants contained in the request. For example, + **3**. + type: string + subMerchant.subSeller[subSellerNr].city: + description: 'Required for transactions performed by registered payment + facilitators. The city of the sub-merchant''s address. + + * Format: Alphanumeric + + * Maximum length: 13 characters' + type: string + subMerchant.subSeller[subSellerNr].country: + description: "Required for transactions performed by registered payment\ + \ facilitators. The three-letter country code of the sub-merchant's address.\ + \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ + * Fixed length: 3 characters" + type: string + subMerchant.subSeller[subSellerNr].id: + description: "Required for transactions performed by registered payment\ + \ facilitators. A unique identifier that you create for the sub-merchant,\ + \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ + * Maximum length: 15 characters" + type: string + subMerchant.subSeller[subSellerNr].mcc: + description: "Required for transactions performed by registered payment\ + \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ + \ \n* Format: Numeric\n* Fixed length: 4 digits" + type: string + subMerchant.subSeller[subSellerNr].name: + description: 'Required for transactions performed by registered payment + facilitators. The name of the sub-merchant. Based on scheme specifications, + this value will overwrite the shopper statement that will appear in the + card statement. + + * Format: Alphanumeric + + * Maximum length: 22 characters' + type: string + subMerchant.subSeller[subSellerNr].postalCode: + description: 'Required for transactions performed by registered payment + facilitators. The postal code of the sub-merchant''s address, without + dashes. + + * Format: Numeric + + * Fixed length: 8 digits' + type: string + subMerchant.subSeller[subSellerNr].state: + description: 'Required for transactions performed by registered payment + facilitators. The state code of the sub-merchant''s address, if applicable + to the country. + + * Format: Alphanumeric + + * Maximum length: 2 characters' + type: string + subMerchant.subSeller[subSellerNr].street: + description: 'Required for transactions performed by registered payment + facilitators. The street name and house number of the sub-merchant''s + address. + + * Format: Alphanumeric + + * Maximum length: 60 characters' + type: string + subMerchant.subSeller[subSellerNr].taxId: + description: 'Required for transactions performed by registered payment + facilitators. The tax ID of the sub-merchant. + + * Format: Numeric + + * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' + type: string + AdditionalDataTemporaryServices: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + * Encoding: ASCII + + * maxLength: 25' + type: string + enhancedSchemeData.employeeName: + description: 'Name or ID associated with the individual working in a temporary + capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.jobDescription: + description: 'Description of the job or task of the individual working in + a temporary capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.regularHoursRate: + description: 'Amount paid per regular hours worked, minor units. + + * maxLength: 7' + type: string + enhancedSchemeData.regularHoursWorked: + description: 'Amount of time worked during a normal operation for the task + or job. + + * maxLength: 7' + type: string + enhancedSchemeData.requestName: + description: 'Name of the individual requesting temporary services. + + * maxLength: 40' + type: string + enhancedSchemeData.tempStartDate: + description: 'Date for the beginning of the pay period. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.tempWeekEnding: + description: 'Date of the end of the billing cycle. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. For example, 2000 means + USD 20.00 + + * maxLength: 12' + type: string + AdditionalDataWallets: + properties: + androidpay.token: + description: The Android Pay token retrieved from the SDK. + type: string + masterpass.transactionId: + description: The Mastercard Masterpass Transaction ID retrieved from the + SDK. + type: string + payment.token: + description: The Apple Pay token retrieved from the SDK. + type: string + paywithgoogle.token: + description: The Google Pay token retrieved from the SDK. + type: string + samsungpay.token: + description: The Samsung Pay token retrieved from the SDK. + type: string + visacheckout.callId: + description: The Visa Checkout Call ID retrieved from the SDK. + type: string + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + AdjustAuthorisationRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be adjusted. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - modificationAmount + - originalReference + 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 + ApplicationInfo: + properties: + adyenLibrary: + description: Adyen-developed software, such as libraries and plugins, used + to interact with the Adyen API. For example, Magento plugin, Java API + library, etc. + $ref: '#/components/schemas/CommonField' + adyenPaymentSource: + description: Adyen-developed software to get payment details. For example, + Checkout SDK, Secured Fields SDK, etc. + $ref: '#/components/schemas/CommonField' + externalPlatform: + description: Third-party developed platform used to initiate payment requests. + For example, Magento, Zuora, etc. + $ref: '#/components/schemas/ExternalPlatform' + merchantApplication: + description: Merchant developed software, such as cashier application, used + to interact with the Adyen API. + $ref: '#/components/schemas/CommonField' + merchantDevice: + description: Merchant device information. + $ref: '#/components/schemas/MerchantDevice' + shopperInteractionDevice: + description: Shopper interaction device, such as terminal, mobile device + or web browser, to initiate payment requests. + $ref: '#/components/schemas/ShopperInteractionDevice' + AuthenticationResultRequest: + properties: + merchantAccount: + description: The merchant account identifier, with which the authentication + was processed. + type: string + pspReference: + description: The pspReference identifier for the transaction. + type: string + required: + - merchantAccount + - pspReference + AuthenticationResultResponse: + properties: + threeDS1Result: + description: The result of the 3D Secure authentication. + $ref: '#/components/schemas/ThreeDS1Result' + threeDS2Result: + description: The result of the 3D Secure 2 authentication. + $ref: '#/components/schemas/ThreeDS2Result' + BankAccount: + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCity: + x-addedInVersion: '18' + description: The bank city. + type: string + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. + type: string + bankName: + description: The name of the bank. + type: string + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. + type: string + countryCode: + description: 'Country code where the bank is located. + + + A valid value is an ISO two-character country code (e.g. ''NL'').' + type: string + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + taxId: + x-addedInVersion: '18' + description: The bank account holder's tax ID. + type: string + BrowserInfo: + properties: + acceptHeader: + description: The accept header value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + colorDepth: + x-addedInVersion: '40' + description: 'The color depth of the shopper''s browser in bits per pixel. + This should be obtained by using the browser''s `screen.colorDepth` property. + Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' + format: int32 + type: integer + javaEnabled: + x-addedInVersion: '40' + description: Boolean value indicating if the shopper's browser is able to + execute Java. + type: boolean + javaScriptEnabled: + x-addedInVersion: '40' + default: true + description: Boolean value indicating if the shopper's browser is able to + execute JavaScript. A default 'true' value is assumed if the field is + not present. + type: boolean + language: + x-addedInVersion: '40' + description: The `navigator.language` value of the shopper's browser (as + defined in IETF BCP 47). + type: string + screenHeight: + x-addedInVersion: '40' + description: The total height of the shopper's device screen in pixels. + format: int32 + type: integer + screenWidth: + x-addedInVersion: '40' + description: The total width of the shopper's device screen in pixels. + format: int32 + type: integer + timeZoneOffset: + x-addedInVersion: '40' + description: Time difference between UTC time and the shopper's browser + local time, in minutes. + format: int32 + type: integer + userAgent: + description: The user agent value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + required: + - userAgent + - acceptHeader + - javaEnabled + - colorDepth + - screenHeight + - screenWidth + - timeZoneOffset + - language + CancelOrRefundRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - originalReference + CancelRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - originalReference + CaptureRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be captured. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - modificationAmount + - originalReference + Card: + properties: + cvc: + description: "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid)\ + \ (1-20 characters). Depending on the card brand, it is known also as:\n\ + * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n>\ + \ If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce),\ + \ the CVC code is present in the encrypted data. You must never post the\ + \ card details to the server.\n> This field must be always present in\ + \ a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n\ + > When this value is returned in a response, it is always empty because\ + \ it is not stored." + maxLength: 20 + minLength: 1 + type: string + expiryMonth: + description: 'The card expiry month. + + Format: 2 digits, zero-padded for single digits. For example: + + * 03 = March + + * 11 = November' + maxLength: 2 + minLength: 1 + type: string + expiryYear: + description: 'The card expiry year. + + Format: 4 digits. For example: 2020' + maxLength: 4 + minLength: 4 + type: string + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 + type: string + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 + type: string + number: + description: 'The card number (4-19 characters). Do not use any separators. + + When this value is returned in a response, only the last 4 digits of the + card number are returned.' + maxLength: 19 + minLength: 4 + type: string + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 + type: string + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 + type: string + required: + - number + - expiryMonth + - expiryYear + - holderName + CommonField: + properties: + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + DeviceRenderOptions: + properties: + sdkInterface: + default: both + description: 'Supported SDK interface types. + + Allowed values: + + * native + + * html + + * both' + enum: + - native + - html + - both + type: string + sdkUiType: + default: + - + description: 'UI types supported for displaying specific challenges. + + Allowed values: + + * text + + * singleSelect + + * outOfBand + + * otherHtml + + * multiSelect' + items: + enum: + - multiSelect + - otherHtml + - outOfBand + - singleSelect + - text + type: string + type: array + DonationRequest: + properties: + donationAccount: + description: The Adyen account name of the charity. + type: string + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount to be donated.The `currency` must match the currency + used in authorisation, the `value` must be smaller than or equal to the + authorised amount. + $ref: '#/components/schemas/Amount' + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + required: + - merchantAccount + - donationAccount + - modificationAmount + ExternalPlatform: + properties: + integrator: + description: External platform integrator. + type: string + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + ForexQuote: + properties: + account: + description: The account name. + type: string + accountType: + description: The account type. + type: string + baseAmount: + description: The base amount. + $ref: '#/components/schemas/Amount' + basePoints: + description: The base points. + format: int32 + type: integer + buy: + description: The buy rate. + $ref: '#/components/schemas/Amount' + interbank: + description: The interbank amount. + $ref: '#/components/schemas/Amount' + reference: + description: The reference assigned to the forex quote request. + type: string + sell: + description: The sell rate. + $ref: '#/components/schemas/Amount' + signature: + description: The signature to validate the integrity. + type: string + source: + description: The source of the forex quote. + type: string + type: + description: The type of forex. + type: string + validTill: + description: The date until which the forex quote is valid. + format: date-time + type: string + required: + - validTill + - basePoints + 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 + 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: '#/components/schemas/FraudCheckResult' + type: array + required: + - accountScore + Installments: + properties: + plan: + x-addedInVersion: '64' + description: 'Defines the type of installment plan. If not set, defaults + to **regular**. + + + Possible values: + + * **regular** + + * **revolving**' + enum: + - regular + - revolving + type: string + value: + description: 'Defines the number of installments. Its value needs to be + greater than zero. + + + Usually, the maximum allowed number of installments is capped. For example, + it may not be possible to split a payment in more than 24 installments. + The acquirer sets this upper limit, so its value may vary.' + format: int32 + type: integer + required: + - value + Mandate: + properties: + amount: + description: The billing amount(in minor units) of the recurring transactions. + type: string + amountRule: + description: "The limitation rule of the billing amount.\n\nPossible values:\n\ + \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ + \ **exact**: The transaction amount should be the same as the `amount`.\n\ + \n" + enum: + - max + - exact + type: string + billingAttemptsRule: + description: "The rule to specify the period, within which the recurring\ + \ debit can happen, relative to the mandate recurring date.\n\nPossible\ + \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ + \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ + \n" + enum: + - 'on' + - before + - after + type: string + billingDay: + description: 'The number of the day, on which the recurring debit can happen. + Should be within the same calendar month as the mandate recurring date. + + + Possible values: 1-31 based on the `frequency`.' + type: string + endsAt: + description: End date of the billing plan, in YYYY-MM-DD format. + type: string + frequency: + description: 'The frequency with which a shopper should be charged. + + + Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, + **halfYearly**, **yearly**.' + enum: + - adhoc + - daily + - weekly + - biWeekly + - monthly + - quarterly + - halfYearly + - yearly + type: string + remarks: + description: The message shown by UPI to the shopper on the approval screen. + type: string + startsAt: + description: Start date of the billing plan, in YYYY-MM-DD format. By default, + the transaction date. + type: string + required: + - frequency + - amount + - endsAt + MerchantDevice: + properties: + os: + description: Operating system running on the merchant device. + type: string + osVersion: + description: Version of the operating system on the merchant device. + type: string + reference: + description: Merchant device reference. + type: string + MerchantRiskIndicator: + properties: + addressMatch: + description: Whether the chosen delivery address is identical to the billing + address. + type: boolean + deliveryAddressIndicator: + description: 'Indicator regarding the delivery address. + + Allowed values: + + * `shipToBillingAddress` + + * `shipToVerifiedAddress` + + * `shipToNewAddress` + + * `shipToStore` + + * `digitalGoods` + + * `goodsNotShipped` + + * `other`' + enum: + - shipToBillingAddress + - shipToVerifiedAddress + - shipToNewAddress + - shipToStore + - digitalGoods + - goodsNotShipped + - other + type: string + deliveryEmail: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `deliveryEmailAddress` instead. + description: The delivery email address (for digital goods). + type: string + deliveryEmailAddress: + x-addedInVersion: '68' + description: 'For Electronic delivery, the email address to which the merchandise + was delivered. Maximum length: 254 characters.' + maxLength: 254 + type: string + deliveryTimeframe: + description: 'The estimated delivery time for the shopper to receive the + goods. + + Allowed values: + + * `electronicDelivery` + + * `sameDayShipping` + + * `overnightShipping` + + * `twoOrMoreDaysShipping`' + enum: + - electronicDelivery + - sameDayShipping + - overnightShipping + - twoOrMoreDaysShipping + type: string + giftCardAmount: + description: For prepaid or gift card purchase, the purchase amount total + of prepaid or gift card(s). + $ref: '#/components/schemas/Amount' + giftCardCount: + description: For prepaid or gift card purchase, total count of individual + prepaid or gift cards/codes purchased. + format: int32 + type: integer + giftCardCurr: + x-addedInVersion: '68' + description: For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) + three-digit currency code of the gift card, other than those listed in + Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification. + type: string + preOrderDate: + description: For pre-order purchases, the expected date this product will + be available to the shopper. + format: date-time + type: string + preOrderPurchase: + description: Indicator for whether this transaction is for pre-ordering + a product. + type: boolean + preOrderPurchaseInd: + x-addedInVersion: '68' + description: Indicates whether Cardholder is placing an order for merchandise + with a future availability or release date. + type: string + reorderItems: + description: Indicator for whether the shopper has already purchased the + same items in the past. + type: boolean + reorderItemsInd: + x-addedInVersion: '68' + description: Indicates whether the cardholder is reordering previously purchased + merchandise. + type: string + shipIndicator: + x-addedInVersion: '68' + description: Indicates shipping method chosen for the transaction. + type: string + ModificationResult: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular modification response. + type: object + 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. + type: string + response: + description: Indicates if the modification request has been received for + processing. + enum: + - '[capture-received]' + - '[cancel-received]' + - '[refund-received]' + - '[cancelOrRefund-received]' + - '[adjustAuthorisation-received]' + - '[donation-received]' + - '[technical-cancel-received]' + - '[voidPendingRefund-received]' + type: string + required: + - response + - pspReference + Name: + properties: + firstName: + description: The first name. + type: string + lastName: + description: The last name. + type: string + required: + - firstName + - lastName + PaymentRequest: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + bankAccount: + description: 'The details of the bank account, from which the payment should + be made. + + > Either `bankAccount` or `card` field must be provided in a payment request.' + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + card: + description: 'A container for card data. + + > Either `bankAccount` or `card` field must be provided in a payment request.' + $ref: '#/components/schemas/Card' + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + entityType: + x-addedInVersion: '24' + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + fundingSource: + x-addedInVersion: '52' + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + nationality: + x-addedInVersion: '24' + description: The two-character country code of the shopper's nationality. + maxLength: 2 + type: string + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + PaymentRequest3d: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + md: + description: The payment session identifier returned by the card issuer. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + paResponse: + description: Payment authorisation response returned by the card issuer. + The `paResponse` field holds the PaRes value received from the card issuer. + type: string + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - paResponse + - md + PaymentRequest3ds2: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDS2Result: + description: Thre ThreeDS2Result that was returned in the final CRes. + $ref: '#/components/schemas/ThreeDS2Result' + threeDS2Token: + description: The ThreeDS2Token that was returned in the /authorise call. + type: string + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + PaymentResult: + properties: + 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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + type: object + authCode: + description: '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.' + type: string + dccAmount: + description: '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](https://support.adyen.com/hc/en-us/requests/new).' + $ref: '#/components/schemas/Amount' + dccSignature: + description: 'Cryptographic signature used to verify `dccQuote`. + + > This value only applies if you have implemented Dynamic Currency Conversion. + For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + fraudResult: + description: The fraud result properties of the payment. + $ref: '#/components/schemas/FraudResult' + issuerUrl: + description: 'The URL to direct the shopper to. + + > In case of SecurePlus, do not redirect a shopper to this URL.' + type: string + md: + description: The payment session. + maxLength: 20000 + type: string + paRequest: + description: '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](https://docs.adyen.com/classic-integration/3d-secure).' + type: string + pspReference: + description: Adyen's 16-character reference associated with the transaction/request. + This value is globally unique; quote it when communicating with us about + this request. + 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. + + + For more information, see [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** \u2013 The payment\ + \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ + \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ + \ \u2013 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** \u2013 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** \u2013 Indicates the\ + \ payment has been cancelled (either by the shopper or the merchant) before\ + \ processing was completed. This is a final state.\n* **ChallengeShopper**\ + \ \u2013 The issuer requires further shopper interaction before the payment\ + \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ + \ \u2013 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** \u2013 The issuer requires the shopper's device\ + \ fingerprint before the payment can be authenticated. Returned for 3D\ + \ Secure 2 transactions.\n* **Pending** \u2013 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** \u2013 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** \u2013\ + \ Indicates the payment has successfully been received by Adyen, and will\ + \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ + \ \u2013 Indicates the shopper should be redirected to an external web\ + \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ + \ the payment was refused. The reason is given in the `refusalReason`\ + \ field. This is a final state." + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused + - Success + type: string + Phone: + properties: + cc: + description: "Country code. Length: 1\u20133 characters." + maxLength: 3 + minLength: 1 + type: string + subscriber: + description: 'Subscriber number. Maximum length: 15 characters.' + maxLength: 15 + type: string + Recurring: + properties: + contract: + description: "The type of recurring contract to be used.\nPossible values:\n\ + * `ONECLICK` \u2013 Payment details can be used to initiate a one-click\ + \ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\ + * `RECURRING` \u2013 Payment details can be used without the card security\ + \ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\ + * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\ + \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\ + \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)." + enum: + - ONECLICK + - RECURRING + - PAYOUT + type: string + recurringDetailName: + description: A descriptive name for this detail. + type: string + recurringExpiry: + x-addedInVersion: '40' + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time + type: string + recurringFrequency: + x-addedInVersion: '40' + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + tokenService: + x-addedInVersion: '25' + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE + type: string + RefundRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be refunded. The `currency` must match + the currency used in authorisation, the `value` must be smaller than or + equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - modificationAmount + - originalReference + 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 + 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. + + + Example: 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. + + + Example: 1011 DJ' + type: string + billingAddress.stateOrProvince: + description: 'The billing address state or province passed in the payment + request. + + + Example: NH' + type: string + billingAddress.street: + description: The billing address street passed in the payment request. + type: string + ResponseAdditionalDataCard: + properties: + cardBin: + description: 'The Bank Identification Number of a credit card, which is + the first six digits of a card number. + + + Example: 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. + + + Example: 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. + + + Example: amex' + type: string + cardSummary: + description: 'The last four digits of a card number. + + + > Returned only in case of a card payment.' + type: string + ResponseAdditionalDataCommon: + properties: + acquirerAccountCode: + description: 'The name of the Adyen acquirer account. + + + Example: PayPalSandbox_TestAcquirer + + + > Only relevant for PayPal transactions.' + type: string + acquirerCode: + description: 'The name of the acquirer processing the payment request. + + + Example: TestPmmAcquirer' + type: string + acquirerReference: + description: 'The reference number that can be used for reconciliation in + case a non-Adyen acquirer is used for settlement. + + + Example: 7C9N3FNBKT9' + type: string + alias: + description: 'The Adyen alias of the card. + + + Example: H167852639363479' + type: string + aliasType: + description: 'The type of the card alias. + + + Example: Default' + type: string + authCode: + description: '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. + + + Example: 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. + + + This 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. + + + For 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. + + + Example: D' + type: string + bic: + description: 'BIC of a bank account. + + + Example: TESTNL01 + + + > 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. + example: 1 Matches + type: string + cvcResultRaw: + description: The raw result of CVC verification. + example: M + 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. + + + Example: 02' + type: string + expiryDate: + description: 'The expiry date on the card. + + + Example: 6/2016 + + + > 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. + + + Example: 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: + + * CHARGE + + * CREDIT + + * DEBIT + + * PREPAID + + * PREPAID_RELOADABLE + + + * PREPAID_NONRELOADABLE + + * DEFFERED_DEBIT + + + > This functionality requires additional configuration on Adyen''s end. + To enable it, contact the Support Team. + + + For receiving this field in the notification, enable **Include Funding + Source** in **Notifications** > **Additional settings**.' + type: string + fundsAvailability: + description: 'Indicates availability of funds. + + + Visa: + + * "I" (fast funds are supported) + + * "N" (otherwise) + + + Mastercard: + + * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM + list) + + * "N" (otherwise) + + + > 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". + + + Possible values: + + + * 3D Secure Mandated + + * Closed Account + + * ContAuth Not Supported + + * CVC Mandated + + * Ecommerce Not Allowed + + * Crossborder Not Supported + + * Card Updated + + + * Low Authrate Bin + + * 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. + + + Example: 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. + + + > Contact Support Team to enable this field.' + type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + 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. + + + This contains either the Mastercard Trace ID or the Visa Transaction ID.' + type: string + ownerName: + description: 'The owner name of a bank account. + + + Only 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. + + + For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + + + Example: mcpro' + type: string + payoutEligible: + description: 'Indicates whether a payout is eligible or not for this card. + + + Visa: + + * "Y" + + * "N" + + + Mastercard: + + * "Y" (domestic and cross-border) + + + * "D" (only domestic) + + * "N" (no MoneySend) + + * "U" (unknown)' + type: string + realtimeAccountUpdaterStatus: + description: 'The response code from the Real Time Account Updater service. + + + Possible return values are: + + * CardChanged + + * CardExpiryChanged + + * CloseAccount + + + * 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. + + + This 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. + + + This field is unavailable if the payment is referred and is usually not + returned with ecommerce transactions. + + + Example: true' + type: string + refusalReasonRaw: + description: 'Raw refusal reason received from the acquirer, where available. + + + Example: 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. + + + Example: Ecommerce' + type: string + shopperReference: + description: 'The shopperReference passed in the payment request. + + + Example: AdyenTestShopperXX' + type: string + terminalId: + description: 'The terminal ID used in a point-of-sale payment. + + + Example: 06022622' + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. + + + Example: true' + type: string + threeDAuthenticatedResponse: + description: 'The raw 3DS authentication result from the card issuer. + + + Example: N' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. + + + Example: true' + type: string + threeDOfferedResponse: + description: 'The raw enrollment result from the 3DS directory services + of the card schemes. + + + Example: Y' + type: string + threeDSVersion: + description: The 3D Secure 2 version. + type: string + visaTransactionId: + description: 'The `visaTransactionId`, has a fixed length of 15 numeric + characters. + + + > 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. + + + Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + type: string + ResponseAdditionalDataDeliveryAddress: + properties: + deliveryAddress.city: + description: The delivery address city passed in the payment request. + type: string + deliveryAddress.country: + description: 'The delivery address country passed in the payment request. + + + Example: NL' + type: string + deliveryAddress.houseNumberOrName: + description: The delivery address house number or name passed in the payment + request. + type: string + deliveryAddress.postalCode: + description: 'The delivery address postal code passed in the payment request. + + + Example: 1011 DJ' + type: string + deliveryAddress.stateOrProvince: + description: 'The delivery address state or province passed in the payment + request. + + + Example: NH' + type: string + deliveryAddress.street: + description: The delivery address street passed in the payment request. + type: string + 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: + + * PayInInstallmentsOnly + + * PayInFullOnly + + * PayInFullOrInstallments' + type: string + installments.value: + description: 'The number of installments that the payment amount should + be charged with. + + + Example: 5 + + > Only relevant for card payments in countries that support installments.' + type: string + 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 + 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 + ResponseAdditionalDataSepa: + properties: + sepadirectdebit.dateOfSignature: + description: 'The transaction signature date. + + + Format: 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: + + * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct + debit transaction. + + + * First: (FRST) Initial/first collection in a series of direct debit instructions. + + * Recurring: (RCUR) Direct debit instruction to carry out regular direct + debit transactions initiated by the creditor. + + * Final: (FNAL) Last/final collection in a series of direct debit instructions. + + + Example: OOFF' + type: string + SDKEphemPubKey: + properties: + crv: + description: The `crv` value as received from the 3D Secure 2 SDK. + type: string + kty: + description: The `kty` value as received from the 3D Secure 2 SDK. + type: string + x: + description: The `x` value as received from the 3D Secure 2 SDK. + type: string + y: + description: The `y` value as received from the 3D Secure 2 SDK. + type: string + ServiceError: + properties: + additionalData: + x-addedInVersion: '46' + additionalProperties: + type: string + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' + type: object + errorCode: + description: The error code mapped to the error message. + type: string + errorType: + description: The category of the error. + type: string + message: + description: A short explanation of the issue. + type: string + pspReference: + description: The PSP reference of the payment. + type: string + status: + description: The HTTP response status. + format: int32 + type: integer + ShopperInteractionDevice: + properties: + locale: + description: Locale on the shopper interaction device. + type: string + os: + description: Operating system running on the shopper interaction device. + type: string + osVersion: + description: Version of the operating system on the shopper interaction + device. + type: string + Split: + properties: + account: + description: 'Unique identifier of the account where the split amount should + be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. + + + ' + type: string + amount: + description: The amount of this split. + $ref: '#/components/schemas/SplitAmount' + description: + description: A description of this split. + type: string + reference: + description: 'Your reference for the split, which you can use to link the + split to other operations such as captures and refunds. + + + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + in Adyen for Platforms.' + type: string + type: + description: 'The type of split. + + Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, + **MarketPlace**, **BalanceAccount**.' + enum: + - BalanceAccount + - Commission + - Default + - MarketPlace + - PaymentFee + - VAT + - Verification + type: string + required: + - amount + - type + SplitAmount: + properties: + currency: + description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + + + If this value is not provided, the currency in which the payment is made + will be used.' + maxLength: 3 + minLength: 3 + type: string + value: + description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - value + TechnicalCancelRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be captured/refunded. Required for + `/capture` and `/refund`, not allowed for `/cancel`. The `currency` must + match the currency used in authorisation, the `value` must be smaller + than or equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + - originalMerchantReference + ThreeDS1Result: + properties: + cavv: + description: The cardholder authentication value (base64 encoded). + type: string + cavvAlgorithm: + description: The CAVV algorithm used. + type: string + eci: + description: 3D Secure Electronic Commerce Indicator (ECI). + type: string + threeDAuthenticatedResponse: + description: The authentication response from the ACS. + type: string + threeDOfferedResponse: + description: Whether 3D Secure was offered or not. + type: string + xid: + description: A unique transaction identifier generated by the MPI on behalf + of the merchant to identify the 3D Secure transaction, in `Base64` encoding. + type: string + ThreeDS2RequestData: + properties: + acctInfo: + x-addedInVersion: '68' + description: "Additional information about the Cardholder\u2019s account\ + \ provided by the 3DS Requestor." + $ref: '#/components/schemas/AcctInfo' + acctType: + x-addedInVersion: '68' + description: "Indicates the type of account. For example, for a multi-account\ + \ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\ + \ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit" + enum: + - '01' + - '02' + - '03' + maxLength: 2 + minLength: 2 + type: string + acquirerBIN: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The acquiring BIN enrolled for 3D Secure 2. This string should match the + value that you will use in the authorisation. Use 123456 on the Test platform. + type: string + acquirerMerchantID: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. + This string should match the value that you will use in the authorisation. + Use 123456 on the Test platform. + type: string + addrMatch: + x-addedInVersion: '68' + description: "Indicates whether the Cardholder Shipping Address and Cardholder\ + \ Billing Address are the same. Allowed values:\n* **Y** \u2014 Shipping\ + \ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\ + \ not match Billing Address." + enum: + - Y + - N + maxLength: 1 + minLength: 1 + type: string + authenticationOnly: + deprecated: true + x-deprecatedInVersion: '50' + x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + challengeIndicator: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead. + description: 'Possibility to specify a preference for receiving a challenge + from the issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate + type: string + deviceChannel: + description: 'The environment of the shopper. + + Allowed values: + + * `app` + + * `browser`' + type: string + deviceRenderOptions: + description: 'Display options for the 3D Secure 2 SDK. + + Optional and only for `deviceChannel` **app**.' + $ref: '#/components/schemas/DeviceRenderOptions' + homePhone: + x-addedInVersion: '68' + description: The home phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + mcc: + x-addedInVersion: '49' + description: Required for merchants that have been enrolled for 3D Secure + 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` + is registered at the scheme. + type: string + merchantName: + x-addedInVersion: '49' + description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchant name that the issuer presents to the shopper if they get + a challenge. We recommend to use the same value that you will use in the + authorization. Maximum length is 40 characters. + + > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). + Use this field if you are enrolled for 3D Secure 2 with us and want to + override the merchant name already configured on your account.' + type: string + messageVersion: + default: 2.1.0 + description: The `messageVersion` value indicating the 3D Secure 2 protocol + version. + type: string + mobilePhone: + x-addedInVersion: '68' + description: The mobile phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + notificationURL: + description: URL to where the issuer should send the `CRes`. Required if + you are not using components for `channel` **Web** or if you are using + classic integration `deviceChannel` **browser**. + type: string + payTokenInd: + x-addedInVersion: '68' + description: Value **true** indicates that the transaction was de-tokenised + prior to being received by the ACS. + type: boolean + paymentAuthenticationUseCase: + x-addedInVersion: '68' + description: Indicates the type of payment for which an authentication is + requested (message extension) + type: string + purchaseInstalData: + x-addedInVersion: '68' + description: "Indicates the maximum number of authorisations permitted for\ + \ instalment payments. Length: 1\u20133 characters." + maxLength: 3 + minLength: 1 + type: string + recurringExpiry: + x-addedInVersion: '68' + description: 'Date after which no further authorisations shall be performed. + Format: YYYYMMDD' + type: string + recurringFrequency: + x-addedInVersion: '68' + description: 'Indicates the minimum number of days between authorisations. + Maximum length: 4 characters.' + maxLength: 4 + type: string + sdkAppID: + description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEncData: + description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEphemPubKey: + description: 'The `sdkEphemPubKey` value as received from the 3D Secure + 2 SDK. + + Required for `deviceChannel` set to **app**.' + $ref: '#/components/schemas/SDKEphemPubKey' + sdkMaxTimeout: + default: 60 + description: 'The maximum amount of time in minutes for the 3D Secure 2 + authentication process. + + Optional and only for `deviceChannel` set to **app**. Defaults to **60** + minutes.' + format: int32 + type: integer + sdkReferenceNumber: + description: 'The `sdkReferenceNumber` value as received from the 3D Secure + 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkTransID: + description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkVersion: + x-addedInVersion: '40' + description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ + \ set to **app**." + type: string + threeDSCompInd: + description: Completion indicator for the device fingerprinting. + type: string + threeDSRequestorAuthenticationInd: + x-addedInVersion: '68' + description: Indicates the type of Authentication request. + type: string + threeDSRequestorAuthenticationInfo: + x-addedInVersion: '68' + description: Information about how the 3DS Requestor authenticated the cardholder + before or during the transaction + $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo' + threeDSRequestorChallengeInd: + x-addedInVersion: '68' + description: Indicates whether a challenge is requested for this transaction. + type: string + threeDSRequestorID: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor identifier assigned by the Directory + Server when you enrol for 3D Secure 2. + type: string + threeDSRequestorName: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor name assigned by the Directory Server + when you enrol for 3D Secure 2. + type: string + threeDSRequestorPriorAuthenticationInfo: + x-addedInVersion: '68' + description: Information about how the 3DS Requestor authenticated the cardholder + as part of a previous 3DS transaction. + $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo' + threeDSRequestorURL: + description: URL of the (customer service) website that will be shown to + the shopper in case of technical errors during the 3D Secure 2 process. + type: string + transType: + x-addedInVersion: '68' + description: "Identifies the type of transaction being authenticated. Length:\ + \ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\ + * **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\ + \ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\ + \ Load" + enum: + - '01' + - '03' + - '10' + - '11' + - '28' + maxLength: 2 + minLength: 2 + type: string + transactionType: + x-addedInVersion: '50' + description: Identify the type of the transaction being authenticated. + enum: + - goodsOrServicePurchase + - checkAcceptance + - accountFunding + - quasiCashTransaction + - prepaidActivationAndLoad + type: string + whiteListStatus: + x-addedInVersion: '49' + description: The `whiteListStatus` value returned from a previous 3D Secure + 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. + type: string + workPhone: + x-addedInVersion: '68' + description: The work phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + required: + - deviceChannel + 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 + challengeIndicator: + x-addedInVersion: '67' + description: 'Specifies a preference for receiving a challenge from the + issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate + 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. + + Allowed values: + + * `lowValue` + + * `secureCorporate` + + * `trustedBeneficiary` + + * `transactionRiskAnalysis` + + ' + 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 + 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 + ThreeDS2ResultRequest: + properties: + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + pspReference: + description: The pspReference returned in the /authorise call. + type: string + required: + - merchantAccount + - pspReference + ThreeDS2ResultResponse: + properties: + threeDS2Result: + description: The result of the 3D Secure 2 authentication. + $ref: '#/components/schemas/ThreeDS2Result' + ThreeDSRequestorAuthenticationInfo: + properties: + threeDSReqAuthData: + description: 'Data that documents and supports a specific authentication + process. Maximum length: 2048 bytes.' + type: string + threeDSReqAuthMethod: + description: "Mechanism used by the Cardholder to authenticate to the 3DS\ + \ Requestor. Allowed values:\n* **01** \u2014 No 3DS Requestor authentication\ + \ occurred (for example, cardholder \u201Clogged in\u201D as guest).\n\ + * **02** \u2014 Login to the cardholder account at the 3DS Requestor system\ + \ using 3DS Requestor\u2019s own credentials.\n* **03** \u2014 Login to\ + \ the cardholder account at the 3DS Requestor system using federated ID.\n\ + * **04** \u2014 Login to the cardholder account at the 3DS Requestor system\ + \ using issuer credentials.\n* **05** \u2014 Login to the cardholder account\ + \ at the 3DS Requestor system using third-party authentication.\n* **06**\ + \ \u2014 Login to the cardholder account at the 3DS Requestor system using\ + \ FIDO Authenticator." + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + - '06' + maxLength: 2 + minLength: 2 + type: string + threeDSReqAuthTimestamp: + description: 'Date and time in UTC of the cardholder authentication. Format: + YYYYMMDDHHMM' + maxLength: 12 + minLength: 12 + type: string + ThreeDSRequestorPriorAuthenticationInfo: + properties: + threeDSReqPriorAuthData: + description: 'Data that documents and supports a specific authentication + process. Maximum length: 2048 bytes.' + type: string + threeDSReqPriorAuthMethod: + description: "Mechanism used by the Cardholder to previously authenticate\ + \ to the 3DS Requestor. Allowed values:\n* **01** \u2014 Frictionless\ + \ authentication occurred by ACS.\n* **02** \u2014 Cardholder challenge\ + \ occurred by ACS.\n* **03** \u2014 AVS verified.\n* **04** \u2014 Other\ + \ issuer methods." + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + threeDSReqPriorAuthTimestamp: + description: 'Date and time in UTC of the prior cardholder authentication. + Format: YYYYMMDDHHMM' + maxLength: 12 + minLength: 12 + type: string + threeDSReqPriorRef: + description: 'This data element provides additional information to the ACS + to determine the best approach for handing a request. This data element + contains an ACS Transaction ID for a prior authenticated transaction. + For example, the first recurring transaction that was authenticated with + the cardholder. Length: 30 characters.' + maxLength: 36 + minLength: 36 + type: string + ThreeDSecureData: + properties: + authenticationResponse: + description: 'In 3D Secure 1, the authentication response if the shopper + was redirected. + + + In 3D Secure 2, this is the `transStatus` from the challenge result. If + the transaction was frictionless, omit this parameter.' + enum: + - Y + - N + - U + - A + type: string + cavv: + description: The cardholder authentication value (base64 encoded, 20 bytes + in a decoded form). + format: byte + type: string + cavvAlgorithm: + description: The CAVV algorithm used. Include this only for 3D Secure 1. + 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 + directoryResponse: + description: 'In 3D Secure 1, this is the enrollment response from the 3D + directory server. + + + In 3D Secure 2, this is the `transStatus` from the `ARes`.' + enum: + - A + - C + - D + - I + - N + - R + - U + - Y + type: string + dsTransID: + x-addedInVersion: '40' + description: Supported for 3D Secure 2. The unique transaction identifier + assigned by the Directory Server (DS) to identify a single transaction. + type: string + eci: + description: The electronic commerce indicator. + type: string + riskScore: + x-addedInVersion: '67' + description: Risk score calculated by Directory Server (DS). Required for + Cartes Bancaires integrations. + type: string + threeDSVersion: + x-addedInVersion: '40' + description: The version of the 3D Secure protocol. + type: string + tokenAuthenticationVerificationValue: + x-addedInVersion: '68' + description: Network token authentication verification value (TAVV). The + network token cryptogram. + format: byte + type: string + transStatusReason: + x-addedInVersion: '67' + 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 + xid: + description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, + 20 bytes in a decoded form). + format: byte + type: string + VoidPendingRefundRequest: + properties: + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataModifications' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular modification request. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + merchantAccount: + description: The merchant account that is used to process the payment. + type: string + modificationAmount: + description: The amount that needs to be captured/refunded. Required for + `/capture` and `/refund`, not allowed for `/cancel`. The `currency` must + match the currency used in authorisation, the `value` must be smaller + than or equal to the authorised amount. + $ref: '#/components/schemas/Amount' + mpiData: + x-addedInVersion: '46' + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + originalMerchantReference: + x-addedInVersion: '30' + description: The original merchant reference to cancel. + type: string + originalReference: + description: 'The original pspReference of the payment to modify. + + This reference is returned in: + + * authorisation response + + * authorisation notification + + + ' + type: string + reference: + description: 'Your reference for the payment modification. This reference + is visible in Customer Area and in reports. + + Maximum length: 80 characters.' + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the amount should be split + between accounts when using Adyen for Platforms. For details, refer to + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). + items: + $ref: '#/components/schemas/Split' + type: array + tenderReference: + x-addedInVersion: '25' + description: The transaction reference provided by the PED. For point-of-sale + integrations only. + type: string + uniqueTerminalId: + x-addedInVersion: '25' + description: Unique terminal ID for the PED that originally processed the + request. For point-of-sale integrations only. + type: string + required: + - merchantAccount + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: + generic-400: + summary: Response code 400. Bad request. + value: + status: 400 + errorCode: '702' + message: 'Unexpected input: ", expected: }' + errorType: validation + generic-401: + summary: Response code 401. Unauthorized. + value: + status: 401 + errorCode: '000' + message: HTTP Status Response - Unauthorized + errorType: security + generic-500: + summary: Response code 500. Internal server error. + value: + status: 500 + errorCode: '905' + message: Payment details are not supported + errorType: configuration + pspReference: '8516091485743033' + post-adjustAuthorisation-adjustAuthorisation: + summary: Increases or decreases the authorised amount + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + modificationAmount: + currency: USD + value: 1700 + reference: YourModificationReference + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-adjustAuthorisation-adjustAuthorisation-200: + summary: Example response for request 'adjustAuthorisation' + value: + pspReference: 851617892360718D + response: '[adjustAuthorisation-received]' + post-authorise-authorise-3d-secure-2: + summary: Make a card payment with 3D Secure 2 native authentication + value: + amount: + currency: USD + value: 1500 + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: YOUR_REFERENCE_NUMBER + threeDS2RequestData: + deviceChannel: browser + notificationURL: https://www.example.com/YOUR_3DS_NOTIFICATION_URL + browserInfo: + userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 + (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36 + acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8 + language: en + colorDepth: 24 + screenHeight: 723 + screenWidth: 1536 + timeZoneOffset: 0 + javaEnabled: false + billingAddress: + country: US + city: New York + street: Redwood Block + houseNumberOrName: 37C + stateOrProvince: NY + postalCode: '10039' + accountInfo: + accountCreationDate: '2019-01-17T13:42:40+01:00' + shopperEmail: s.hopper@test.com + shopperIP: 192.0.2.1 + card: + cvc: '737' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + number: '4917610000000000' + post-authorise-authorise-3dsecure: + summary: Initiate a 3D Secure payment + value: + amount: + value: 1500 + currency: EUR + browserInfo: + userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 + Firefox/3.0 + acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + card: + number: '5212345678901234' + expiryMonth: '03' + expiryYear: '2030' + cvc: '737' + holderName: John Smith + reference: YOUR_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-card: + summary: Authorise a card payment + value: + card: + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + cvc: '737' + holderName: John Smith + amount: + value: 1500 + currency: EUR + reference: YOUR_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-recurringcontauth: + summary: Authorise a recurring payment + value: + amount: + value: 2000 + currency: EUR + reference: YOUR_REFERENCE + shopperEmail: s.hopper@test.com + shopperIP: 61.294.12.12 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + selectedRecurringDetailReference: LATEST + recurring: + contract: RECURRING + shopperInteraction: ContAuth + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-recurringoneclick: + summary: Authorise a one-click payment + value: + amount: + value: 2000 + currency: EUR + card: + cvc: '737' + reference: YOUR_REFERENCE + shopperEmail: s.hopper@test.com + shopperIP: 61.294.12.12 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + selectedRecurringDetailReference: LATEST + recurring: + contract: ONECLICK + shopperInteraction: Ecommerce + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-recurringstore: + summary: Store card details for recurring payments + value: + amount: + value: 2000 + currency: EUR + card: + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + cvc: '737' + holderName: John Smith + reference: YOUR_REFERENCE + shopperEmail: s.hopper@test.com + shopperIP: 61.294.12.12 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + recurring: + contract: RECURRING,ONECLICK + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise-authorise-split: + summary: Split a payment between a sub-merchant and a platform account + value: + card: + number: '4111111111111111' + cvc: '737' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + amount: + value: 6200 + currency: EUR + reference: YOUR_ORDER_NUMBER + merchantAccount: YOUR_MERCHANT_ACCOUNT + splits: + - amount: + value: 6000 + type: MarketPlace + account: '151272963' + reference: '6124145' + description: 'Porcelain Doll: Eliza (20cm)' + - amount: + value: 200 + type: Commission + reference: '6124146' + post-authorise3d-authorise3d: + summary: Complete a 3D Secure payment + value: + md: 31h..........vOXek7w + paResponse: eNqtmF........wGVA4Ch + shopperIP: 61.294.12.12 + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-authorise3ds2-authorise3ds2: + summary: Submit 3D Secure 2 authentication data to the issuer + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + threeDS2RequestData: + threeDSCompInd: Y + threeDS2Token: "\u2014 - BINARY DATA - -" + post-cancel-cancel: + summary: Cancel an authorised payment + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + reference: YourModificationReference + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund: + summary: Cancel or refund a payment + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + reference: YourModificationReference + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-cancelOrRefund-cancelOrRefund-200: + summary: Example response for request 'cancelOrRefund' + value: + pspReference: 851617892359708H + response: '[cancelOrRefund-received]' + post-capture-capture: + summary: Capture an authorised payment + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + modificationAmount: + value: 500 + currency: EUR + reference: YOUR_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-capture-capture-200: + summary: Example response for request 'capture' + value: + pspReference: 861617892359057J + response: '[capture-received]' + post-donate-donate: + summary: Create a payment for the specified donation + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + modificationAmount: + value: 500 + currency: EUR + reference: YOUR_DONATION_REFERENCE + donationAccount: AdyenGivingDemo + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-getAuthenticationResult-getAuthenticationResult: + summary: Retrieve the authentication result after doing a 3D Secure authentication + only + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: '9935272408535455' + post-refund-refund: + summary: Refund a captured payment + value: + originalReference: COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE + modificationAmount: + value: 500 + currency: EUR + reference: YOUR_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-refund-refund-200: + summary: Example response for request 'refund' + value: + pspReference: 861617892360059B + response: '[refund-received]' + post-retrieve3ds2Result-retrieve3ds2Result: + summary: Retrieve authentication details after doing a 3D Secure 2 authentication + only + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + pspReference: '9935272408535455' + post-technicalCancel-technicalCancel: + summary: Cancel a payment without a PSP reference + value: + originalMerchantReference: YOUR_MERCHANT_REFERENCE + reference: YOUR_MODIFICATION_REFERENCE + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-technicalCancel-technicalCancel-200: + summary: Example response for request 'technicalCancel' + value: + pspReference: 881617892361436J + response: '[technical-cancel-received]' + post-voidPendingRefund-voidpendingrefund-pspreference: + summary: Cancel a POS refund request with PSP reference before it has been completed + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + originalReference: '9914748988390044' + post-voidPendingRefund-voidpendingrefund-pspreference-200: + summary: Example response for request 'voidpendingrefund-pspreference' + value: + pspReference: 861617892360062F + response: '[voidPendingRefund-received]' + post-voidPendingRefund-voidpendingrefund-tenderreference: + summary: Cancels a POS refund request with tender reference before it has been + completed + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + tenderReference: 5Iw8001176969533005 + uniqueTerminalId: VX820-123456789 + post-voidPendingRefund-voidpendingrefund-tenderreference-200: + summary: Example response for request 'voidpendingrefund-tenderreference' + value: + pspReference: 881617892360409G + response: '[voidPendingRefund-received]' diff --git a/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml index 710bad9..3c8a7ac 100644 --- a/yaml/PayoutService-v30.yaml +++ b/yaml/PayoutService-v30.yaml @@ -1616,6 +1616,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2125,7 +2130,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -2284,10 +2289,14 @@ components: $ref: '#/components/schemas/BankAccount' billingAddress: x-addedInVersion: '4' - description: "The address where to send the invoice.\n> For 3D Secure 2\ - \ transactions, schemes require `billingAddress` for all browser-based\ - \ and mobile implementations. Include all of the fields within this object.\ - \ \n\n> For cross-border payouts to and from Canada, this field is required." + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -2404,8 +2413,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -2526,10 +2535,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -3426,7 +3435,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. @@ -3564,7 +3574,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. diff --git a/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml index 3388c70..80c77ac 100644 --- a/yaml/PayoutService-v40.yaml +++ b/yaml/PayoutService-v40.yaml @@ -1772,6 +1772,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2415,7 +2420,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -2674,10 +2679,14 @@ components: $ref: '#/components/schemas/BankAccount' billingAddress: x-addedInVersion: '4' - description: "The address where to send the invoice.\n> For 3D Secure 2\ - \ transactions, schemes require `billingAddress` for all browser-based\ - \ and mobile implementations. Include all of the fields within this object.\ - \ \n\n> For cross-border payouts to and from Canada, this field is required." + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -2801,8 +2810,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -2923,10 +2932,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -3955,7 +3964,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. @@ -4093,7 +4103,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. diff --git a/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml index 760bdb9..5d87c3d 100644 --- a/yaml/PayoutService-v50.yaml +++ b/yaml/PayoutService-v50.yaml @@ -1789,6 +1789,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2432,7 +2437,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -2691,10 +2696,14 @@ components: $ref: '#/components/schemas/BankAccount' billingAddress: x-addedInVersion: '4' - description: "The address where to send the invoice.\n> For 3D Secure 2\ - \ transactions, schemes require `billingAddress` for all browser-based\ - \ and mobile implementations. Include all of the fields within this object.\ - \ \n\n> For cross-border payouts to and from Canada, this field is required." + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -2818,8 +2827,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -2940,10 +2949,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -3986,7 +3995,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. @@ -4124,7 +4134,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. diff --git a/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml index 4486c42..f7ccbd9 100644 --- a/yaml/PayoutService-v51.yaml +++ b/yaml/PayoutService-v51.yaml @@ -1789,6 +1789,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2432,7 +2437,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -2691,10 +2696,14 @@ components: $ref: '#/components/schemas/BankAccount' billingAddress: x-addedInVersion: '4' - description: "The address where to send the invoice.\n> For 3D Secure 2\ - \ transactions, schemes require `billingAddress` for all browser-based\ - \ and mobile implementations. Include all of the fields within this object.\ - \ \n\n> For cross-border payouts to and from Canada, this field is required." + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -2824,8 +2833,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -2946,10 +2955,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -3992,7 +4001,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. @@ -4130,7 +4140,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. diff --git a/yaml/PayoutService-v52.yaml b/yaml/PayoutService-v52.yaml index 041be3b..bca5eac 100644 --- a/yaml/PayoutService-v52.yaml +++ b/yaml/PayoutService-v52.yaml @@ -1789,6 +1789,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2432,7 +2437,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -2691,10 +2696,14 @@ components: $ref: '#/components/schemas/BankAccount' billingAddress: x-addedInVersion: '4' - description: "The address where to send the invoice.\n> For 3D Secure 2\ - \ transactions, schemes require `billingAddress` for all browser-based\ - \ and mobile implementations. Include all of the fields within this object.\ - \ \n\n> For cross-border payouts to and from Canada, this field is required." + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -2832,8 +2841,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -2954,10 +2963,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4000,7 +4009,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. @@ -4142,7 +4152,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. diff --git a/yaml/PayoutService-v64.yaml b/yaml/PayoutService-v64.yaml index 623eb6a..88e28a8 100644 --- a/yaml/PayoutService-v64.yaml +++ b/yaml/PayoutService-v64.yaml @@ -1789,6 +1789,11 @@ components: default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string AdditionalDataRiskStandalone: properties: PayPal.CountryCode: @@ -2447,7 +2452,7 @@ components: Mandate: properties: amount: - description: The billing amount of the recurring transactions. + description: The billing amount(in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n\ @@ -2706,10 +2711,14 @@ components: $ref: '#/components/schemas/BankAccount' billingAddress: x-addedInVersion: '4' - description: "The address where to send the invoice.\n> For 3D Secure 2\ - \ transactions, schemes require `billingAddress` for all browser-based\ - \ and mobile implementations. Include all of the fields within this object.\ - \ \n\n> For cross-border payouts to and from Canada, this field is required." + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' browserInfo: description: 'The shopper''s browser information. @@ -2847,8 +2856,8 @@ components: * Maximum 80 characters per value. ' type: object mpiData: - description: Authentication data produced by an MPI (Mastercard SecureCode - or Visa Secure). + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). $ref: '#/components/schemas/ThreeDSecureData' nationality: x-addedInVersion: '24' @@ -2969,10 +2978,10 @@ components: description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: - description: 'Your reference to uniquely identify this shopper (for example, - user ID or account ID). Minimum length: 3 characters. - - > This field is required for recurring payments.' + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement. To enable\ @@ -4015,7 +4024,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. @@ -4157,7 +4167,8 @@ components: description: 'The billing address. - > For cross-border payouts to and from Canada, this field is required.' + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' $ref: '#/components/schemas/Address' card: description: 'A container for card data. diff --git a/yaml/PayoutService-v67.yaml b/yaml/PayoutService-v67.yaml new file mode 100644 index 0000000..7ec55fc --- /dev/null +++ b/yaml/PayoutService-v67.yaml @@ -0,0 +1,4927 @@ +openapi: 3.1.0 +servers: +- url: https://pal-test.adyen.com/pal/servlet/Payout/v67 +info: + version: '67' + x-publicVersion: true + title: Adyen Payout API + description: 'A set of API endpoints that allow you to store payout details, confirm, + or decline a payout. + + + For more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts). + + ## Authentication + + To use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): + one for storing payout details and submitting payouts, and another one for confirming + or declining payouts. If you don''t have the required API credentials, contact + our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + + + Both of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The + following example shows how to authenticate your request when submitting a payout: + + + ``` + + curl + + -U "storePayout@Company.[YourCompany]":"YourBasicAuthenticationPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + When going live, you need to generate new API credentials to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ' + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- Initialization +- Reviewing +- Instant payouts +paths: + /confirmThirdParty: + post: + tags: + - Reviewing + summary: Confirms a payout. + description: 'Confirms a previously submitted payout. + + + To cancel a payout, use the `/declineThirdParty` endpoint.' + x-addedInVersion: '10' + operationId: post-confirmThirdParty + x-groupName: Reviewing + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty' + schema: + $ref: '#/components/schemas/ModifyRequest' + responses: + '200': + content: + application/json: + examples: + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' + schema: + $ref: '#/components/schemas/ModifyResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /declineThirdParty: + post: + tags: + - Reviewing + summary: Cancels a payout. + description: 'Cancels a previously submitted payout. + + + To confirm and send a payout, use the `/confirmThirdParty` endpoint.' + x-addedInVersion: '10' + operationId: post-declineThirdParty + x-groupName: Reviewing + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty' + schema: + $ref: '#/components/schemas/ModifyRequest' + responses: + '200': + content: + application/json: + examples: + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' + schema: + $ref: '#/components/schemas/ModifyResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payout: + post: + tags: + - Instant payouts + summary: Pay out directly. + description: With this call, you can pay out to your customers, and funds will + be made available within 30 minutes on the cardholder's bank account (this + is dependent on whether the issuer supports this functionality). Instant card + payouts are only supported for Visa and Mastercard cards. + x-addedInVersion: '11' + operationId: post-payout + x-groupName: Instant payouts + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + payout-b2c: + $ref: '#/components/examples/post-payout-payout-b2c' + payout-p2p: + $ref: '#/components/examples/post-payout-payout-p2p' + schema: + $ref: '#/components/schemas/PayoutRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PayoutResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /storeDetail: + post: + tags: + - Initialization + summary: Stores payout details. + description: Stores payment details under the `PAYOUT` recurring contract. These + payment details can be used later to submit a payout via the `/submitThirdParty` + call. + operationId: post-storeDetail + x-groupName: Initialization + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail' + schema: + $ref: '#/components/schemas/StoreDetailRequest' + responses: + '200': + content: + application/json: + examples: + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail-200' + schema: + $ref: '#/components/schemas/StoreDetailResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /storeDetailAndSubmitThirdParty: + post: + tags: + - Initialization + summary: Stores details and submits a payout. + description: 'Submits a payout and stores its details for subsequent payouts. + + + The submitted payout must be confirmed or declined either by a reviewer or + via `/confirmThirdParty` or `/declineThirdParty` calls.' + x-addedInVersion: '10' + operationId: post-storeDetailAndSubmitThirdParty + x-groupName: Initialization + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + storeDetailAndSubmitThirdParty: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' + storeDetailAndSubmitThirdParty-Neteller: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' + storeDetailAndSubmitThirdParty-PayPal: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' + storeDetailAndSubmitThirdParty-Paysafecard: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' + storeDetailAndSubmitThirdParty-Skrill: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' + schema: + $ref: '#/components/schemas/StoreDetailAndSubmitRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StoreDetailAndSubmitResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /submitThirdParty: + post: + tags: + - Initialization + summary: Submits a payout. + description: 'Submits a payout using the previously stored payment details. + To store payment details, use the `/storeDetail` API call. + + + The submitted payout must be confirmed or declined either by a reviewer or + via `/confirmThirdParty` or `/declineThirdParty` calls.' + x-addedInVersion: '10' + operationId: post-submitThirdParty + x-groupName: Initialization + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + submitThirdParty: + $ref: '#/components/examples/post-submitThirdParty-submitThirdParty' + schema: + $ref: '#/components/schemas/SubmitRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. +components: + schemas: + AccountInfo: + properties: + accountAgeIndicator: + description: 'Indicator for the length of time since this shopper account + was created in the merchant''s environment. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountChangeDate: + description: Date when the shopper's account was last changed. + format: date-time + type: string + accountChangeIndicator: + description: 'Indicator for the length of time since the shopper''s account + was last updated. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountCreationDate: + description: Date when the shopper's account was created. + format: date-time + type: string + accountType: + x-addedInVersion: '50' + description: 'Indicates the type of account. For example, for a multi-account + card product. + + Allowed values: + + * notApplicable + + * credit + + * debit' + enum: + - notApplicable + - credit + - debit + type: string + addCardAttemptsDay: + description: Number of attempts the shopper tried to add a card to their + account in the last day. + format: int32 + type: integer + deliveryAddressUsageDate: + description: Date the selected delivery address was first used. + format: date-time + type: string + deliveryAddressUsageIndicator: + description: 'Indicator for the length of time since this delivery address + was first used. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + homePhone: + description: Shopper's home phone number (including the country code). + type: string + mobilePhone: + description: Shopper's mobile phone number (including the country code). + type: string + passwordChangeDate: + description: Date when the shopper last changed their password. + format: date-time + type: string + passwordChangeIndicator: + description: 'Indicator when the shopper has changed their password. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + pastTransactionsDay: + description: Number of all transactions (successful and abandoned) from + this shopper in the past 24 hours. + format: int32 + type: integer + pastTransactionsYear: + description: Number of all transactions (successful and abandoned) from + this shopper in the past year. + format: int32 + type: integer + paymentAccountAge: + description: Date this payment method was added to the shopper's account. + format: date-time + type: string + paymentAccountIndicator: + description: 'Indicator for the length of time since this payment method + was added to this shopper''s account. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + purchasesLast6Months: + description: Number of successful purchases in the last six months. + format: int32 + type: integer + suspiciousActivity: + description: Whether suspicious activity was recorded on this account. + type: boolean + workPhone: + description: Shopper's work phone number (including the country code). + type: string + AdditionalData3DSecure: + properties: + allow3DS2: + description: "Indicates if you are able to process 3D Secure 2 transactions\ + \ natively on your payment page. Send this parameter when you are using\ + \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ + \n > This parameter only indicates readiness to support native 3D Secure\ + \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ + \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ + \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ + \ support native 3D Secure 2 authentication. Setting this to true does\ + \ not mean always applying 3D Secure 2. Adyen still selects the version\ + \ of 3D Secure based on configuration to optimize authorisation rates\ + \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ + \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ + \ Secure 2 to your shopper regardless of your configuration.\n" + type: string + executeThreeD: + description: "Indicates if you want to perform 3D Secure authentication\ + \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ + \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ + \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ + \ 3D Secure authentication. Note that this setting results in refusals\ + \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ + \ national regulations. \n" + type: string + mpiImplementationType: + description: In case of Secure+, this field must be set to **CUPSecurePlus**. + type: string + scaExemption: + description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that you want to request for the transaction.\n\n Possible values:\n\ + * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ + \ **transactionRiskAnalysis** " + type: string + threeDSVersion: + description: "Indicates your preference for the 3D Secure version. \n> If\ + \ you use this parameter, you override the checks from Adyen's Authentication\ + \ Engine. We recommend to use this field only if you have an extensive\ + \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ + \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ + \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ + \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ + \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ + \ in the `ARes`, we will apply the fallback policy configured in your\ + \ account. For example, if the configuration is to fall back to 3D Secure\ + \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ + \ the BIN is not enrolled, you will receive an error.\n\n" + type: string + AdditionalDataAirline: + properties: + airline.agency_invoice_number: + description: 'Reference number for the invoice, issued by the agency. + + * minLength: 1 + + * maxLength: 6' + type: string + airline.agency_plan_name: + description: '2-letter agency plan identifier; alphabetical. + + * minLength: 2 + + * maxLength: 2' + type: string + airline.airline_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit + accounting code (PAX); numeric. It identifies the carrier. + + * Format: IATA 3-digit accounting code (PAX) + + * Example: KLM = 074 + + * minLength: 3 + + * maxLength: 3' + type: string + airline.airline_designator_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.boarding_fee: + description: 'Chargeable amount for boarding the plane. + + The transaction amount needs to be represented in minor units according + to the [following table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 18' + type: string + airline.computerized_reservation_system: + description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) + used to make the reservation and purchase the ticket. + + * Format: alphanumeric. + + * minLength: 4 + + * maxLength: 4' + type: string + airline.customer_reference_number: + description: 'Reference number; alphanumeric. + + * minLength: 0 + + * maxLength: 20' + type: string + airline.document_type: + description: 'Optional 2-digit code; alphanumeric. It identifies the type + of product of the transaction. The description of the code may appear + on credit card statements. + + * Format: 2-digit code + + * Example: Passenger ticket = 01 + + * minLength: 2 + + * maxLength: 2' + type: string + airline.flight_date: + description: 'Flight departure date. Local time `(HH:mm)` is optional. + + * Date format: `yyyy-MM-dd` + + * Date and time format: `yyyy-MM-dd HH:mm` + + * minLength: 10 + + * maxLength: 16' + type: string + airline.leg.carrier_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + This field is required/mandatory if the airline data includes leg details. + + * Format: IATA 2-letter airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.leg.class_of_travel: + description: '1-letter travel class identifier; alphabetical. There is no + standard; however, the following codes are used rather consistently: + + * F: first class + + * J: business class + + * Y: economy class + + * W: premium economy + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.leg.date_of_travel: + description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ + * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" + type: string + airline.leg.depart_airport: + description: 'Alphabetical identifier of the departure airport. + + This field is required if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.depart_tax: + description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). + Amount charged by a country to an individual upon their leaving. The transaction + amount needs to be represented in minor units according to the [following + table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 12' + type: string + airline.leg.destination_code: + description: 'Alphabetical identifier of the destination/arrival airport. + + This field is required/mandatory if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.fare_base_code: + description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); + alphanumeric. + + * minLength: 1 + + * maxLength: 7' + type: string + airline.leg.flight_number: + description: 'The flight identifier. + + * minLength: 1 + + * maxLength: 5' + type: string + airline.leg.stop_over_code: + description: '1-letter code that indicates whether the passenger is entitled + to make a stopover. Only two types of characters are allowed: + + * O: Stopover allowed + + * X: Stopover not allowed + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.passenger.date_of_birth: + description: 'Date of birth of the passenger. + + + Date format: `yyyy-MM-dd` + + * minLength: 10 + + * maxLength: 10' + type: string + airline.passenger.first_name: + description: 'Passenger first name/given name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.last_name: + description: 'Passenger last name/family name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.telephone_number: + description: 'Telephone number of the passenger, including country code. + This is an alphanumeric field that can include the ''+'' and ''-'' signs. + + * minLength: 3 + + * maxLength: 30' + type: string + airline.passenger.traveller_type: + description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. + Example: ADT, SRC, CNN, INS. + + + However, several carriers use non-standard codes that can be up to 5 alphanumeric + characters. + + * minLength: 3 + + * maxLength: 6' + type: string + airline.passenger_name: + description: 'Passenger name, initials, and a title. + + * Format: last name + first name or initials + title. + + * Example: *FLYER / MARY MS*. + + * minLength: 1 + + * maxLength: 49' + type: string + airline.ticket_issue_address: + description: 'Address of the place/agency that issued the ticket. + + * minLength: 0 + + * maxLength: 16' + type: string + airline.ticket_number: + description: 'The ticket''s unique identifier. + + * minLength: 1 + + * maxLength: 150' + type: string + airline.travel_agency_code: + description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier + number for travel agencies. + + * minLength: 1 + + * maxLength: 8' + type: string + airline.travel_agency_name: + description: 'The name of the travel agency. + + * minLength: 1 + + * maxLength: 25' + type: string + required: + - airline.passenger_name + AdditionalDataCarRental: + properties: + carRental.checkOutDate: + description: 'Pick-up date. + + * Date format: `yyyyMMdd`' + type: string + carRental.customerServiceTollFreeNumber: + description: 'The customer service phone number of the car rental company. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + carRental.daysRented: + description: 'Number of days for which the car is being rented. + + * Format: Numeric + + * maxLength: 19' + type: string + carRental.fuelCharges: + description: 'Any fuel charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.insuranceCharges: + description: 'Any insurance charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.locationCity: + description: 'The city from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.locationCountry: + description: 'The country from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.locationStateProvince: + description: 'The state or province from where the car is rented. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + * Y - Customer was a no show. + + * N - Not applicable.' + type: string + carRental.oneWayDropOffCharges: + description: Charge associated with not returning a vehicle to the original + rental location. + type: string + carRental.rate: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.rateIndicator: + description: 'Specifies whether the given rate is applied daily or weekly. + + * D - Daily rate. + + * W - Weekly rate.' + type: string + carRental.rentalAgreementNumber: + description: 'The rental agreement number associated with this car rental. + + * Format: Alphanumeric + + * maxLength: 9' + type: string + carRental.rentalClassId: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.renterName: + description: 'The name of the person renting the car. + + * Format: Alphanumeric + + * maxLength: 26' + type: string + carRental.returnCity: + description: 'The city where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.returnCountry: + description: 'The country where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.returnDate: + description: 'The last date to return the car by. + + * Date format: `yyyyMMdd`' + type: string + carRental.returnLocationId: + description: 'Agency code, phone number, or address abbreviation + + * Format: Alphanumeric + + * maxLength: 10' + type: string + carRental.returnStateProvince: + description: 'The state or province where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.taxExemptIndicator: + description: 'Indicates whether the goods or services were tax-exempt, or + tax was not collected. + + + Values: + + * Y - Goods or services were tax exempt + + * N - Tax was not collected' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "A" for Car rental. This should be + included in the auth message. + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataCommon: + properties: + RequestedTestErrorResponseCode: + description: "Triggers test scenarios that allow to replicate certain communication\ + \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ + \ wasn't a connection available to service the outgoing communication.\n\ + This is a transient, retriable error since no messaging could be initiated\ + \ to an issuing system (or third-party acquiring system). Therefore, the\ + \ header Transient-Error: true is returned in the response. A subsequent\ + \ request using the same idempotency key will be processed as if it was\ + \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ + \ wrong during transmission of the message or receiving the response.\n\ + This is a classified as non-transient because the message could have been\ + \ received by the issuing party and been acted upon. No transient error\ + \ header is returned. If using idempotency, the (error) response is stored\ + \ as the final result for the idempotency key. Subsequent messages with\ + \ the same idempotency key not be processed beyond returning the stored\ + \ response." + type: string + authorisationType: + description: "Flags a card payment request for either pre-authorisation\ + \ or final authorisation. For more information, refer to [Authorisation\ + \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ + \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ + \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ + \ request to be handled as a final authorisation." + type: string + customRoutingFlag: + description: 'Allows you to determine or override the acquirer account that + should be used for the transaction. + + + If you need to process a payment with an acquirer different from a default + one, you can set up a corresponding configuration on the Adyen payments + platform. Then you can pass a custom routing flag in a payment request''s + additional data to target a specific acquirer. + + + To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge + description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ + \ this field denotes why the additional payment is made.\n\nPossible values:\n\ + \n * **NoShow**: An incremental charge is carried out because of a no-show\ + \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ + \ charge is carried out to process an additional payment after the original\ + \ services have been rendered and the respective payment has been processed." + enum: + - NoShow + - DelayedCharge + type: string + networkTxReference: + description: 'Allows you to link the transaction to the original or previous + one in a subscription/card-on-file chain. This field is required for token-based + transactions where Adyen does not tokenize the card. + + + Transaction identifier from card schemes, for example, Mastercard Trace + ID or the Visa Transaction ID. + + + Submit the original transaction ID of the contract in your payment request + if you are not tokenizing card details with Adyen and are making a merchant-initiated + transaction (MIT) for subsequent charges. + + + Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` + **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction + is classified as MIT.' + type: string + overwriteBrand: + description: Boolean indicator that can be optionally used for performing + debit transactions on combo cards (for example, combo cards in Brazil). + This is not mandatory but we recommend that you set this to true if you + want to use the `selectedBrand` value to specify how to process the transaction. + type: string + subMerchantCity: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the city of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 13 characters.' + type: string + subMerchantCountry: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the three-letter + country code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Fixed length: 3 characters.' + type: string + subMerchantID: + description: 'This field contains an identifier of the actual merchant when + a transaction is submitted via a payment facilitator. The payment facilitator + must send in this unique ID. + + + A unique identifier per submerchant that is required if the transaction + is performed by a registered payment facilitator. + + * Format: alpha-numeric. + + * Fixed length: 15 characters.' + type: string + subMerchantName: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the name of + the actual merchant. + + * Format: alpha-numeric. + + * Maximum length: 22 characters.' + type: string + subMerchantPostalCode: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the postal code + of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 10 characters.' + type: string + subMerchantState: + description: 'This field is required if the transaction is performed by + a registered payment facilitator, and if applicable to the country. This + field must contain the state code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 3 characters.' + type: string + subMerchantStreet: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the street of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 60 characters.' + type: string + subMerchantTaxId: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the tax ID of + the actual merchant. + + * Format: alpha-numeric. + + * Fixed length: 11 or 14 characters.' + type: string + AdditionalDataLevel23: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + + Encoding: ASCII. + + + Max length: 25 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + enhancedSchemeData.destinationCountryCode: + description: 'Destination country code. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.destinationPostalCode: + description: 'The postal code of a destination address. + + + Encoding: ASCII. + + + Max length: 10 characters. + + + > Required for American Express.' + type: string + enhancedSchemeData.destinationStateProvinceCode: + description: 'Destination state or province code. + + + Encoding: ASCII.Max length: 3 characters.' + type: string + enhancedSchemeData.dutyAmount: + description: 'Duty amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.freightAmount: + description: 'Shipping amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].commodityCode: + description: 'Item commodity code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].description: + description: 'Item description. + + + Encoding: ASCII. + + + Max length: 26 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + description: 'Discount amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].productCode: + description: 'Product code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].quantity: + description: 'Quantity, specified as an integer value. + + + Value must be greater than 0. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + description: 'Total amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: + description: 'Item unit of measurement. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitPrice: + description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + + Max length: 12 characters.' + type: string + enhancedSchemeData.orderDate: + description: 'Order date. + + * Format: `ddMMyy` + + + Encoding: ASCII. + + + Max length: 6 characters.' + type: string + enhancedSchemeData.shipFromPostalCode: + description: 'The postal code of a "ship-from" address. + + + Encoding: ASCII. + + + Max length: 10 characters.' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + AdditionalDataLodging: + properties: + lodging.checkInDate: + description: 'The arrival date. + + * Date format: `yyyyMMdd`' + type: string + lodging.checkOutDate: + description: 'The departure date. + + * Date format: `yyyyMMdd`' + type: string + lodging.customerServiceTollFreeNumber: + description: 'The toll free phone number for the hotel/lodgings. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.fireSafetyActIndicator: + description: 'Identifies that the facility complies with the Hotel and Motel + Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. + + * Format: Alphabetic + + * maxLength: 1' + type: string + lodging.folioCashAdvances: + description: 'The folio cash advances. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.folioNumber: + description: "Card acceptor\u2019s internal invoice or billing ID reference\ + \ number.\n* Format: Alphanumeric\n* maxLength: 25" + type: string + lodging.foodBeverageCharges: + description: 'Any charges for food and beverages associated with the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + + Value should be Y or N. + + * Format: Numeric + + * maxLength: 1' + type: string + lodging.prepaidExpenses: + description: 'Prepaid expenses for the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.propertyPhoneNumber: + description: 'Identifies specific lodging property location by its local + phone number. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.room1.numberOfNights: + description: 'Total number of nights the room will be rented. + + * Format: Numeric + + * maxLength: 4' + type: string + lodging.room1.rate: + description: 'The rate of the room. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.room1.tax: + description: 'The total amount of tax to be paid. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalRoomTax: + description: 'Total room tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalTax: + description: 'Total tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "H" for Hotel. This should be included + in the auth message. + + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataOpenInvoice: + properties: + openinvoicedata.merchantData: + description: 'Holds different merchant data points like product, purchase, + customer, and so on. It takes data in a Base64 encoded string. + + + The `merchantData` parameter needs to be added to the `openinvoicedata` + signature at the end. + + + Since the field is optional, if it''s not included it does not impact + computing the merchant signature. + + + Applies only to Klarna. + + + You can contact Klarna for the format and structure of the string.' + type: string + openinvoicedata.numberOfLines: + description: 'The number of invoice lines included in `openinvoicedata`. + + + There needs to be at least one line, so `numberOfLines` needs to be at + least 1.' + type: string + openinvoicedataLine[itemNr].currencyCode: + description: The three-character ISO currency code. + type: string + openinvoicedataLine[itemNr].description: + description: A text description of the product the invoice line refers to. + type: string + openinvoicedataLine[itemNr].itemAmount: + description: 'The price for one item in the invoice line, represented in + minor units. + + + The due amount for the item, VAT excluded.' + type: string + openinvoicedataLine[itemNr].itemId: + description: A unique id for this item. Required for RatePay if the description + of each item is not unique. + type: string + openinvoicedataLine[itemNr].itemVatAmount: + description: The VAT due for one item in the invoice line, represented in + minor units. + type: string + openinvoicedataLine[itemNr].itemVatPercentage: + description: 'The VAT percentage for one item in the invoice line, represented + in minor units. + + + For example, 19% VAT is specified as 1900.' + type: string + openinvoicedataLine[itemNr].numberOfItems: + description: The number of units purchased of a specific product. + type: string + openinvoicedataLine[itemNr].returnShippingCompany: + description: Name of the shipping company handling the the return shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingNumber: + description: The tracking number for the return of the shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingUri: + description: URI where the customer can track the return of their shipment. + type: string + openinvoicedataLine[itemNr].shippingCompany: + description: Name of the shipping company handling the delivery. + type: string + openinvoicedataLine[itemNr].shippingMethod: + description: Shipping method. + type: string + openinvoicedataLine[itemNr].trackingNumber: + description: The tracking number for the shipment. + type: string + openinvoicedataLine[itemNr].trackingUri: + description: URI where the customer can track their shipment. + type: string + AdditionalDataOpi: + properties: + opi.includeTransToken: + description: 'Optional boolean indicator. Set to **true** if you want an + ecommerce transaction to return an `opi.transToken` as additional data + in the response. + + + You can store this Oracle Payment Interface token in your Oracle Opera + database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' + type: string + AdditionalDataRatepay: + properties: + ratepay.installmentAmount: + description: Amount the customer has to pay each month. + type: string + ratepay.interestRate: + description: Interest rate of this installment. + type: string + ratepay.lastInstallmentAmount: + description: Amount of the last installment. + type: string + ratepay.paymentFirstday: + description: Calendar day of the first payment. + type: string + ratepaydata.deliveryDate: + description: Date the merchant delivered the goods to the customer. + type: string + ratepaydata.dueDate: + description: Date by which the customer must settle the payment. + type: string + ratepaydata.invoiceDate: + description: Invoice date, defined by the merchant. If not included, the + invoice date is set to the delivery date. + type: string + ratepaydata.invoiceId: + description: Identification name or number for the invoice, defined by the + merchant. + type: string + AdditionalDataRetry: + properties: + retry.chainAttemptNumber: + description: 'The number of times the transaction (not order) has been retried + between different payment service providers. For instance, the `chainAttemptNumber` + set to 2 means that this transaction has been recently tried on another + provider before being sent to Adyen. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.orderAttemptNumber: + description: 'The index of the attempt to bill a particular order, which + is identified by the `merchantOrderReference` field. For example, if a + recurring transaction fails and is retried one day later, then the order + number for these attempts would be 1 and 2, respectively. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.skipRetry: + description: 'The Boolean value indicating whether Adyen should skip or + retry this transaction, if possible. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + AdditionalDataRisk: + properties: + riskdata.[customFieldName]: + description: The data for your custom risk field. For more information, + refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). + type: string + riskdata.basket.item[itemNr].amountPerItem: + description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.basket.item[itemNr].brand: + description: Brand of the item. + type: string + riskdata.basket.item[itemNr].category: + description: Category of the item. + type: string + riskdata.basket.item[itemNr].color: + description: Color of the item. + type: string + riskdata.basket.item[itemNr].currency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.basket.item[itemNr].itemID: + description: ID of the item. + type: string + riskdata.basket.item[itemNr].manufacturer: + description: Manufacturer of the item. + type: string + riskdata.basket.item[itemNr].productTitle: + description: A text description of the product the invoice line refers to. + type: string + riskdata.basket.item[itemNr].quantity: + description: Quantity of the item purchased. + type: string + riskdata.basket.item[itemNr].receiverEmail: + description: Email associated with the given product in the basket (usually + in electronic gift cards). + type: string + riskdata.basket.item[itemNr].size: + description: Size of the item. + type: string + riskdata.basket.item[itemNr].sku: + description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' + type: string + riskdata.basket.item[itemNr].upc: + description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' + type: string + riskdata.promotions.promotion[itemNr].promotionCode: + description: Code of the promotion. + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountAmount: + description: The discount amount of the promotion, represented in [minor + units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: + description: 'Promotion''s percentage discount. It is represented in percentage + value and there is no need to include the ''%'' sign. + + + e.g. for a promotion discount of 30%, the value of the field should be + 30.' + type: string + riskdata.promotions.promotion[itemNr].promotionName: + description: Name of the promotion. + type: string + riskdata.riskProfileReference: + description: Reference number of the risk profile that you want to apply + to the payment. If not provided or left blank, the merchant-level account's + default risk profile will be applied to the payment. For more information, + see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). + type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string + AdditionalDataRiskStandalone: + properties: + PayPal.CountryCode: + description: Shopper's country of residence in the form of ISO standard + 3166 2-character country codes. + type: string + PayPal.EmailId: + description: Shopper's email. + type: string + PayPal.FirstName: + description: Shopper's first name. + type: string + PayPal.LastName: + description: Shopper's last name. + type: string + PayPal.PayerId: + description: 'Unique PayPal Customer Account identification number. Character + length and limitations: 13 single-byte alphanumeric characters.' + type: string + PayPal.Phone: + description: Shopper's phone number. + type: string + PayPal.ProtectionEligibility: + description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ + \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ + \ \u2014 Merchant is not protected under the Seller Protection Policy." + type: string + PayPal.TransactionId: + description: Unique transaction ID of the payment. + type: string + avsResultRaw: + description: 'Raw AVS result received from the acquirer, where available. + Example: D' + type: string + bin: + description: The Bank Identification Number of a credit card, which is the + first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). + type: string + cvcResultRaw: + description: 'Raw CVC result received from the acquirer, where available. + Example: 1' + type: string + riskToken: + description: Unique identifier or token for the shopper's card details. + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. Example: true' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. Example: true' + type: string + tokenDataType: + description: 'Required for PayPal payments only. The only supported value + is: **paypal**.' + type: string + AdditionalDataSubMerchant: + properties: + subMerchant.numberOfSubSellers: + description: Required for transactions performed by registered payment facilitators. + Indicates the number of sub-merchants contained in the request. For example, + **3**. + type: string + subMerchant.subSeller[subSellerNr].city: + description: 'Required for transactions performed by registered payment + facilitators. The city of the sub-merchant''s address. + + * Format: Alphanumeric + + * Maximum length: 13 characters' + type: string + subMerchant.subSeller[subSellerNr].country: + description: "Required for transactions performed by registered payment\ + \ facilitators. The three-letter country code of the sub-merchant's address.\ + \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ + * Fixed length: 3 characters" + type: string + subMerchant.subSeller[subSellerNr].id: + description: "Required for transactions performed by registered payment\ + \ facilitators. A unique identifier that you create for the sub-merchant,\ + \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ + * Maximum length: 15 characters" + type: string + subMerchant.subSeller[subSellerNr].mcc: + description: "Required for transactions performed by registered payment\ + \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ + \ \n* Format: Numeric\n* Fixed length: 4 digits" + type: string + subMerchant.subSeller[subSellerNr].name: + description: 'Required for transactions performed by registered payment + facilitators. The name of the sub-merchant. Based on scheme specifications, + this value will overwrite the shopper statement that will appear in the + card statement. + + * Format: Alphanumeric + + * Maximum length: 22 characters' + type: string + subMerchant.subSeller[subSellerNr].postalCode: + description: 'Required for transactions performed by registered payment + facilitators. The postal code of the sub-merchant''s address, without + dashes. + + * Format: Numeric + + * Fixed length: 8 digits' + type: string + subMerchant.subSeller[subSellerNr].state: + description: 'Required for transactions performed by registered payment + facilitators. The state code of the sub-merchant''s address, if applicable + to the country. + + * Format: Alphanumeric + + * Maximum length: 2 characters' + type: string + subMerchant.subSeller[subSellerNr].street: + description: 'Required for transactions performed by registered payment + facilitators. The street name and house number of the sub-merchant''s + address. + + * Format: Alphanumeric + + * Maximum length: 60 characters' + type: string + subMerchant.subSeller[subSellerNr].taxId: + description: 'Required for transactions performed by registered payment + facilitators. The tax ID of the sub-merchant. + + * Format: Numeric + + * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' + type: string + AdditionalDataTemporaryServices: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + * Encoding: ASCII + + * maxLength: 25' + type: string + enhancedSchemeData.employeeName: + description: 'Name or ID associated with the individual working in a temporary + capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.jobDescription: + description: 'Description of the job or task of the individual working in + a temporary capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.regularHoursRate: + description: 'Amount paid per regular hours worked, minor units. + + * maxLength: 7' + type: string + enhancedSchemeData.regularHoursWorked: + description: 'Amount of time worked during a normal operation for the task + or job. + + * maxLength: 7' + type: string + enhancedSchemeData.requestName: + description: 'Name of the individual requesting temporary services. + + * maxLength: 40' + type: string + enhancedSchemeData.tempStartDate: + description: 'Date for the beginning of the pay period. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.tempWeekEnding: + description: 'Date of the end of the billing cycle. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. For example, 2000 means + USD 20.00 + + * maxLength: 12' + type: string + AdditionalDataWallets: + properties: + androidpay.token: + description: The Android Pay token retrieved from the SDK. + type: string + masterpass.transactionId: + description: The Mastercard Masterpass Transaction ID retrieved from the + SDK. + type: string + payment.token: + description: The Apple Pay token retrieved from the SDK. + type: string + paywithgoogle.token: + description: The Google Pay token retrieved from the SDK. + type: string + samsungpay.token: + description: The Samsung Pay token retrieved from the SDK. + type: string + visacheckout.callId: + description: The Visa Checkout Call ID retrieved from the SDK. + type: string + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + 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 + ApplicationInfo: + properties: + adyenLibrary: + description: Adyen-developed software, such as libraries and plugins, used + to interact with the Adyen API. For example, Magento plugin, Java API + library, etc. + $ref: '#/components/schemas/CommonField' + adyenPaymentSource: + description: Adyen-developed software to get payment details. For example, + Checkout SDK, Secured Fields SDK, etc. + $ref: '#/components/schemas/CommonField' + externalPlatform: + description: Third-party developed platform used to initiate payment requests. + For example, Magento, Zuora, etc. + $ref: '#/components/schemas/ExternalPlatform' + merchantApplication: + description: Merchant developed software, such as cashier application, used + to interact with the Adyen API. + $ref: '#/components/schemas/CommonField' + merchantDevice: + description: Merchant device information. + $ref: '#/components/schemas/MerchantDevice' + shopperInteractionDevice: + description: Shopper interaction device, such as terminal, mobile device + or web browser, to initiate payment requests. + $ref: '#/components/schemas/ShopperInteractionDevice' + BankAccount: + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCity: + x-addedInVersion: '18' + description: The bank city. + type: string + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. + type: string + bankName: + description: The name of the bank. + type: string + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. + type: string + countryCode: + description: 'Country code where the bank is located. + + + A valid value is an ISO two-character country code (e.g. ''NL'').' + type: string + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + taxId: + x-addedInVersion: '18' + description: The bank account holder's tax ID. + type: string + BrowserInfo: + properties: + acceptHeader: + description: The accept header value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + colorDepth: + x-addedInVersion: '40' + description: 'The color depth of the shopper''s browser in bits per pixel. + This should be obtained by using the browser''s `screen.colorDepth` property. + Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' + format: int32 + type: integer + javaEnabled: + x-addedInVersion: '40' + description: Boolean value indicating if the shopper's browser is able to + execute Java. + type: boolean + javaScriptEnabled: + x-addedInVersion: '40' + default: true + description: Boolean value indicating if the shopper's browser is able to + execute JavaScript. A default 'true' value is assumed if the field is + not present. + type: boolean + language: + x-addedInVersion: '40' + description: The `navigator.language` value of the shopper's browser (as + defined in IETF BCP 47). + type: string + screenHeight: + x-addedInVersion: '40' + description: The total height of the shopper's device screen in pixels. + format: int32 + type: integer + screenWidth: + x-addedInVersion: '40' + description: The total width of the shopper's device screen in pixels. + format: int32 + type: integer + timeZoneOffset: + x-addedInVersion: '40' + description: Time difference between UTC time and the shopper's browser + local time, in minutes. + format: int32 + type: integer + userAgent: + description: The user agent value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + required: + - userAgent + - acceptHeader + - javaEnabled + - colorDepth + - screenHeight + - screenWidth + - timeZoneOffset + - language + Card: + properties: + cvc: + description: "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid)\ + \ (1-20 characters). Depending on the card brand, it is known also as:\n\ + * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n>\ + \ If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce),\ + \ the CVC code is present in the encrypted data. You must never post the\ + \ card details to the server.\n> This field must be always present in\ + \ a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n\ + > When this value is returned in a response, it is always empty because\ + \ it is not stored." + maxLength: 20 + minLength: 1 + type: string + expiryMonth: + description: 'The card expiry month. + + Format: 2 digits, zero-padded for single digits. For example: + + * 03 = March + + * 11 = November' + maxLength: 2 + minLength: 1 + type: string + expiryYear: + description: 'The card expiry year. + + Format: 4 digits. For example: 2020' + maxLength: 4 + minLength: 4 + type: string + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 + type: string + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 + type: string + number: + description: 'The card number (4-19 characters). Do not use any separators. + + When this value is returned in a response, only the last 4 digits of the + card number are returned.' + maxLength: 19 + minLength: 4 + type: string + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 + type: string + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 + type: string + required: + - number + - expiryMonth + - expiryYear + - holderName + CommonField: + properties: + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + DeviceRenderOptions: + properties: + sdkInterface: + default: both + description: 'Supported SDK interface types. + + Allowed values: + + * native + + * html + + * both' + enum: + - native + - html + - both + type: string + sdkUiType: + default: + - + description: 'UI types supported for displaying specific challenges. + + Allowed values: + + * text + + * singleSelect + + * outOfBand + + * otherHtml + + * multiSelect' + items: + enum: + - multiSelect + - otherHtml + - outOfBand + - singleSelect + - text + type: string + type: array + ExternalPlatform: + properties: + integrator: + description: External platform integrator. + type: string + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + ForexQuote: + properties: + account: + description: The account name. + type: string + accountType: + description: The account type. + type: string + baseAmount: + description: The base amount. + $ref: '#/components/schemas/Amount' + basePoints: + description: The base points. + format: int32 + type: integer + buy: + description: The buy rate. + $ref: '#/components/schemas/Amount' + interbank: + description: The interbank amount. + $ref: '#/components/schemas/Amount' + reference: + description: The reference assigned to the forex quote request. + type: string + sell: + description: The sell rate. + $ref: '#/components/schemas/Amount' + signature: + description: The signature to validate the integrity. + type: string + source: + description: The source of the forex quote. + type: string + type: + description: The type of forex. + type: string + validTill: + description: The date until which the forex quote is valid. + format: date-time + type: string + required: + - validTill + - basePoints + 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 + 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: '#/components/schemas/FraudCheckResult' + type: array + required: + - accountScore + FundSource: + properties: + additionalData: + additionalProperties: + type: string + description: a map of name/value pairs for passing in additional/industry-specific + data + type: object + billingAddress: + description: the address where to send the invoice + $ref: '#/components/schemas/Address' + card: + description: a representation of a (credit or debit) card + $ref: '#/components/schemas/Card' + shopperEmail: + description: the email address of the person + type: string + shopperName: + description: the name of the person + $ref: '#/components/schemas/Name' + telephoneNumber: + description: the telephone number of the person + type: string + Installments: + properties: + plan: + x-addedInVersion: '64' + description: 'Defines the type of installment plan. If not set, defaults + to **regular**. + + + Possible values: + + * **regular** + + * **revolving**' + enum: + - regular + - revolving + type: string + value: + description: 'Defines the number of installments. Its value needs to be + greater than zero. + + + Usually, the maximum allowed number of installments is capped. For example, + it may not be possible to split a payment in more than 24 installments. + The acquirer sets this upper limit, so its value may vary.' + format: int32 + type: integer + required: + - value + Mandate: + properties: + amount: + description: The billing amount(in minor units) of the recurring transactions. + type: string + amountRule: + description: "The limitation rule of the billing amount.\n\nPossible values:\n\ + \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ + \ **exact**: The transaction amount should be the same as the `amount`.\n\ + \n" + enum: + - max + - exact + type: string + billingAttemptsRule: + description: "The rule to specify the period, within which the recurring\ + \ debit can happen, relative to the mandate recurring date.\n\nPossible\ + \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ + \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ + \n" + enum: + - 'on' + - before + - after + type: string + billingDay: + description: 'The number of the day, on which the recurring debit can happen. + Should be within the same calendar month as the mandate recurring date. + + + Possible values: 1-31 based on the `frequency`.' + type: string + endsAt: + description: End date of the billing plan, in YYYY-MM-DD format. + type: string + frequency: + description: 'The frequency with which a shopper should be charged. + + + Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, + **halfYearly**, **yearly**.' + enum: + - adhoc + - daily + - weekly + - biWeekly + - monthly + - quarterly + - halfYearly + - yearly + type: string + remarks: + description: The message shown by UPI to the shopper on the approval screen. + type: string + startsAt: + description: Start date of the billing plan, in YYYY-MM-DD format. By default, + the transaction date. + type: string + required: + - frequency + - amount + - endsAt + MerchantDevice: + properties: + os: + description: Operating system running on the merchant device. + type: string + osVersion: + description: Version of the operating system on the merchant device. + type: string + reference: + description: Merchant device reference. + type: string + MerchantRiskIndicator: + properties: + addressMatch: + description: Whether the chosen delivery address is identical to the billing + address. + type: boolean + deliveryAddressIndicator: + description: 'Indicator regarding the delivery address. + + Allowed values: + + * `shipToBillingAddress` + + * `shipToVerifiedAddress` + + * `shipToNewAddress` + + * `shipToStore` + + * `digitalGoods` + + * `goodsNotShipped` + + * `other`' + enum: + - shipToBillingAddress + - shipToVerifiedAddress + - shipToNewAddress + - shipToStore + - digitalGoods + - goodsNotShipped + - other + type: string + deliveryEmail: + description: The delivery email address (for digital goods). + type: string + deliveryTimeframe: + description: 'The estimated delivery time for the shopper to receive the + goods. + + Allowed values: + + * `electronicDelivery` + + * `sameDayShipping` + + * `overnightShipping` + + * `twoOrMoreDaysShipping`' + enum: + - electronicDelivery + - sameDayShipping + - overnightShipping + - twoOrMoreDaysShipping + type: string + giftCardAmount: + description: For prepaid or gift card purchase, the purchase amount total + of prepaid or gift card(s). + $ref: '#/components/schemas/Amount' + giftCardCount: + description: For prepaid or gift card purchase, total count of individual + prepaid or gift cards/codes purchased. + format: int32 + type: integer + preOrderDate: + description: For pre-order purchases, the expected date this product will + be available to the shopper. + format: date-time + type: string + preOrderPurchase: + description: Indicator for whether this transaction is for pre-ordering + a product. + type: boolean + reorderItems: + description: Indicator for whether the shopper has already purchased the + same items in the past. + type: boolean + ModifyRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular payout request. + type: object + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + originalReference: + description: The PSP reference received in the `/submitThirdParty` response. + type: string + required: + - merchantAccount + - originalReference + ModifyResponse: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular response. + type: object + pspReference: + description: Adyen's 16-character string reference associated with the transaction. + This value is globally unique; quote it when communicating with us about + this response. + type: string + response: + description: 'The response: + + * In case of success, it is either `payout-confirm-received` or `payout-decline-received`. + + * In case of an error, an informational message is returned.' + type: string + required: + - pspReference + - response + Name: + properties: + firstName: + description: The first name. + type: string + lastName: + description: The last name. + type: string + required: + - firstName + - lastName + PayoutRequest: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + bankAccount: + description: 'The details of the bank account, from which the payment should + be made. + + > Either `bankAccount` or `card` field must be provided in a payment request.' + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + card: + description: 'A container for card data. + + > Either `bankAccount` or `card` field must be provided in a payment request.' + $ref: '#/components/schemas/Card' + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + entityType: + x-addedInVersion: '24' + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + fundSource: + description: The person or entity funding the money. + $ref: '#/components/schemas/FundSource' + fundingSource: + x-addedInVersion: '52' + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + nationality: + x-addedInVersion: '24' + description: The two-character country code of the shopper's nationality. + maxLength: 2 + type: string + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + PayoutResponse: + properties: + 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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + type: object + authCode: + description: '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.' + type: string + dccAmount: + description: '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](https://support.adyen.com/hc/en-us/requests/new).' + $ref: '#/components/schemas/Amount' + dccSignature: + description: 'Cryptographic signature used to verify `dccQuote`. + + > This value only applies if you have implemented Dynamic Currency Conversion. + For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + fraudResult: + description: The fraud result properties of the payment. + $ref: '#/components/schemas/FraudResult' + issuerUrl: + description: 'The URL to direct the shopper to. + + > In case of SecurePlus, do not redirect a shopper to this URL.' + type: string + md: + description: The payment session. + maxLength: 20000 + type: string + paRequest: + description: '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](https://docs.adyen.com/classic-integration/3d-secure).' + type: string + pspReference: + description: Adyen's 16-character reference associated with the transaction/request. + This value is globally unique; quote it when communicating with us about + this request. + 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. + + + For more information, see [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** \u2013 The payment\ + \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ + \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ + \ \u2013 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** \u2013 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** \u2013 Indicates the\ + \ payment has been cancelled (either by the shopper or the merchant) before\ + \ processing was completed. This is a final state.\n* **ChallengeShopper**\ + \ \u2013 The issuer requires further shopper interaction before the payment\ + \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ + \ \u2013 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** \u2013 The issuer requires the shopper's device\ + \ fingerprint before the payment can be authenticated. Returned for 3D\ + \ Secure 2 transactions.\n* **Pending** \u2013 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** \u2013 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** \u2013\ + \ Indicates the payment has successfully been received by Adyen, and will\ + \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ + \ \u2013 Indicates the shopper should be redirected to an external web\ + \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ + \ the payment was refused. The reason is given in the `refusalReason`\ + \ field. This is a final state." + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused + - Success + type: string + Recurring: + properties: + contract: + description: "The type of recurring contract to be used.\nPossible values:\n\ + * `ONECLICK` \u2013 Payment details can be used to initiate a one-click\ + \ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\ + * `RECURRING` \u2013 Payment details can be used without the card security\ + \ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\ + * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\ + \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\ + \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)." + enum: + - ONECLICK + - RECURRING + - PAYOUT + type: string + recurringDetailName: + description: A descriptive name for this detail. + type: string + recurringExpiry: + x-addedInVersion: '40' + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time + type: string + recurringFrequency: + x-addedInVersion: '40' + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + tokenService: + x-addedInVersion: '25' + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE + type: string + 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 + 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. + + + Example: 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. + + + Example: 1011 DJ' + type: string + billingAddress.stateOrProvince: + description: 'The billing address state or province passed in the payment + request. + + + Example: NH' + type: string + billingAddress.street: + description: The billing address street passed in the payment request. + type: string + ResponseAdditionalDataCard: + properties: + cardBin: + description: 'The Bank Identification Number of a credit card, which is + the first six digits of a card number. + + + Example: 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. + + + Example: 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. + + + Example: amex' + type: string + cardSummary: + description: 'The last four digits of a card number. + + + > Returned only in case of a card payment.' + type: string + ResponseAdditionalDataCommon: + properties: + acquirerAccountCode: + description: 'The name of the Adyen acquirer account. + + + Example: PayPalSandbox_TestAcquirer + + + > Only relevant for PayPal transactions.' + type: string + acquirerCode: + description: 'The name of the acquirer processing the payment request. + + + Example: TestPmmAcquirer' + type: string + acquirerReference: + description: 'The reference number that can be used for reconciliation in + case a non-Adyen acquirer is used for settlement. + + + Example: 7C9N3FNBKT9' + type: string + alias: + description: 'The Adyen alias of the card. + + + Example: H167852639363479' + type: string + aliasType: + description: 'The type of the card alias. + + + Example: Default' + type: string + authCode: + description: '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. + + + Example: 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. + + + This 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. + + + For 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. + + + Example: D' + type: string + bic: + description: 'BIC of a bank account. + + + Example: TESTNL01 + + + > 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. + example: 1 Matches + type: string + cvcResultRaw: + description: The raw result of CVC verification. + example: M + 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. + + + Example: 02' + type: string + expiryDate: + description: 'The expiry date on the card. + + + Example: 6/2016 + + + > 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. + + + Example: 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: + + * CHARGE + + * CREDIT + + * DEBIT + + * PREPAID + + * PREPAID_RELOADABLE + + + * PREPAID_NONRELOADABLE + + * DEFFERED_DEBIT + + + > This functionality requires additional configuration on Adyen''s end. + To enable it, contact the Support Team. + + + For receiving this field in the notification, enable **Include Funding + Source** in **Notifications** > **Additional settings**.' + type: string + fundsAvailability: + description: 'Indicates availability of funds. + + + Visa: + + * "I" (fast funds are supported) + + * "N" (otherwise) + + + Mastercard: + + * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM + list) + + * "N" (otherwise) + + + > 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". + + + Possible values: + + + * 3D Secure Mandated + + * Closed Account + + * ContAuth Not Supported + + * CVC Mandated + + * Ecommerce Not Allowed + + * Crossborder Not Supported + + * Card Updated + + + * Low Authrate Bin + + * 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. + + + Example: 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. + + + > Contact Support Team to enable this field.' + type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + 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. + + + This contains either the Mastercard Trace ID or the Visa Transaction ID.' + type: string + ownerName: + description: 'The owner name of a bank account. + + + Only 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. + + + For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + + + Example: mcpro' + type: string + payoutEligible: + description: 'Indicates whether a payout is eligible or not for this card. + + + Visa: + + * "Y" + + * "N" + + + Mastercard: + + * "Y" (domestic and cross-border) + + + * "D" (only domestic) + + * "N" (no MoneySend) + + * "U" (unknown)' + type: string + realtimeAccountUpdaterStatus: + description: 'The response code from the Real Time Account Updater service. + + + Possible return values are: + + * CardChanged + + * CardExpiryChanged + + * CloseAccount + + + * 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. + + + This 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. + + + This field is unavailable if the payment is referred and is usually not + returned with ecommerce transactions. + + + Example: true' + type: string + refusalReasonRaw: + description: 'Raw refusal reason received from the acquirer, where available. + + + Example: 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. + + + Example: Ecommerce' + type: string + shopperReference: + description: 'The shopperReference passed in the payment request. + + + Example: AdyenTestShopperXX' + type: string + terminalId: + description: 'The terminal ID used in a point-of-sale payment. + + + Example: 06022622' + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. + + + Example: true' + type: string + threeDAuthenticatedResponse: + description: 'The raw 3DS authentication result from the card issuer. + + + Example: N' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. + + + Example: true' + type: string + threeDOfferedResponse: + description: 'The raw enrollment result from the 3DS directory services + of the card schemes. + + + Example: Y' + type: string + threeDSVersion: + description: The 3D Secure 2 version. + type: string + visaTransactionId: + description: 'The `visaTransactionId`, has a fixed length of 15 numeric + characters. + + + > 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. + + + Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + type: string + ResponseAdditionalDataDeliveryAddress: + properties: + deliveryAddress.city: + description: The delivery address city passed in the payment request. + type: string + deliveryAddress.country: + description: 'The delivery address country passed in the payment request. + + + Example: NL' + type: string + deliveryAddress.houseNumberOrName: + description: The delivery address house number or name passed in the payment + request. + type: string + deliveryAddress.postalCode: + description: 'The delivery address postal code passed in the payment request. + + + Example: 1011 DJ' + type: string + deliveryAddress.stateOrProvince: + description: 'The delivery address state or province passed in the payment + request. + + + Example: NH' + type: string + deliveryAddress.street: + description: The delivery address street passed in the payment request. + type: string + 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: + + * PayInInstallmentsOnly + + * PayInFullOnly + + * PayInFullOrInstallments' + type: string + installments.value: + description: 'The number of installments that the payment amount should + be charged with. + + + Example: 5 + + > Only relevant for card payments in countries that support installments.' + type: string + 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 + 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 + ResponseAdditionalDataSepa: + properties: + sepadirectdebit.dateOfSignature: + description: 'The transaction signature date. + + + Format: 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: + + * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct + debit transaction. + + + * First: (FRST) Initial/first collection in a series of direct debit instructions. + + * Recurring: (RCUR) Direct debit instruction to carry out regular direct + debit transactions initiated by the creditor. + + * Final: (FNAL) Last/final collection in a series of direct debit instructions. + + + Example: OOFF' + type: string + SDKEphemPubKey: + properties: + crv: + description: The `crv` value as received from the 3D Secure 2 SDK. + type: string + kty: + description: The `kty` value as received from the 3D Secure 2 SDK. + type: string + x: + description: The `x` value as received from the 3D Secure 2 SDK. + type: string + y: + description: The `y` value as received from the 3D Secure 2 SDK. + type: string + ServiceError: + properties: + additionalData: + x-addedInVersion: '46' + additionalProperties: + type: string + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' + type: object + errorCode: + description: The error code mapped to the error message. + type: string + errorType: + description: The category of the error. + type: string + message: + description: A short explanation of the issue. + type: string + pspReference: + description: The PSP reference of the payment. + type: string + status: + description: The HTTP response status. + format: int32 + type: integer + ShopperInteractionDevice: + properties: + locale: + description: Locale on the shopper interaction device. + type: string + os: + description: Operating system running on the shopper interaction device. + type: string + osVersion: + description: Version of the operating system on the shopper interaction + device. + type: string + Split: + properties: + account: + description: 'Unique identifier of the account where the split amount should + be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. + + + ' + type: string + amount: + description: The amount of this split. + $ref: '#/components/schemas/SplitAmount' + description: + description: A description of this split. + type: string + reference: + description: 'Your reference for the split, which you can use to link the + split to other operations such as captures and refunds. + + + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + in Adyen for Platforms.' + type: string + type: + description: 'The type of split. + + Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, + **MarketPlace**, **BalanceAccount**.' + enum: + - BalanceAccount + - Commission + - Default + - MarketPlace + - PaymentFee + - VAT + - Verification + type: string + required: + - amount + - type + SplitAmount: + properties: + currency: + description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + + + If this value is not provided, the currency in which the payment is made + will be used.' + maxLength: 3 + minLength: 3 + type: string + value: + description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - value + StoreDetailAndSubmitRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular request. + type: object + amount: + description: A container object for the payable amount information of the + transaction. + $ref: '#/components/schemas/Amount' + bank: + description: 'A container for bank account data. + + > This field is mandatory if `card` is not provided.' + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '18' + description: 'The billing address. + + + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' + $ref: '#/components/schemas/Address' + card: + description: 'A container for card data. + + > This field is mandatory if `bank` is not provided.' + $ref: '#/components/schemas/Card' + dateOfBirth: + x-addedInVersion: '24' + description: 'The date of birth. + + Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD + + For Paysafecard it must be the same as used when registering the Paysafecard + account. + + > This field is mandatory for natural persons.' + format: date-time + type: string + entityType: + x-addedInVersion: '24' + description: The type of the entity the payout is processed for. + enum: + - NaturalPerson + - Company + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + nationality: + x-addedInVersion: '24' + description: 'The shopper''s nationality. + + + A valid value is an ISO 2-character country code (e.g. ''NL'').' + maxLength: 2 + type: string + recurring: + description: 'A container for the type of recurring contract to be retrieved. + + + The recurring.contract must be set to `PAYOUT`' + $ref: '#/components/schemas/Recurring' + reference: + description: The merchant reference for this payment. This reference will + be used in all communication to the merchant about the status of the payout. + Although it is a good idea to make sure it is unique, this is not a requirement. + type: string + selectedBrand: + x-addedInVersion: '24' + description: 'The name of the brand to make a payout to. + + + For Paysafecard it must be set to `paysafecard`.' + type: string + shopperEmail: + description: The shopper's email address. + type: string + shopperName: + x-addedInVersion: '24' + description: 'The shopper''s name. + + + When the `entityType` is `Company`, the `shopperName.lastName` must contain + the company name.' + $ref: '#/components/schemas/Name' + shopperReference: + description: The shopper's reference for the payment transaction. + type: string + shopperStatement: + x-addedInVersion: '2' + description: The description of this payout. This description is shown on + the bank statement of the shopper (if this is supported by the chosen + payment method). + type: string + socialSecurityNumber: + x-addedInVersion: '24' + description: The shopper's social security number. + type: string + telephoneNumber: + x-addedInVersion: '52' + description: The shopper's phone number. + type: string + required: + - merchantAccount + - shopperEmail + - shopperReference + - recurring + - dateOfBirth + - nationality + - entityType + - reference + - amount + StoreDetailAndSubmitResponse: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular response. + type: object + pspReference: + description: A new reference to uniquely identify this request. + type: string + refusalReason: + description: In case of refusal, an informational message for the reason. + type: string + resultCode: + description: 'The response: + + + * In case of success is payout-submit-received. + + * In case of an error, an informational message is returned.' + type: string + required: + - pspReference + - resultCode + StoreDetailRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular request. + type: object + bank: + description: 'A container for bank account data. + + > This field is mandatory if `card` is not provided.' + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '18' + description: 'The billing address. + + + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' + $ref: '#/components/schemas/Address' + card: + description: 'A container for card data. + + > This field is mandatory if `bank` is not provided.' + $ref: '#/components/schemas/Card' + dateOfBirth: + x-addedInVersion: '24' + description: 'The date of birth. + + Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD + + For Paysafecard it must be the same as used when registering the Paysafecard + account. + + > This field is mandatory for natural persons.' + format: date-time + type: string + entityType: + x-addedInVersion: '24' + description: The type of the entity the payout is processed for. + enum: + - NaturalPerson + - Company + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + nationality: + x-addedInVersion: '24' + description: 'The shopper''s nationality. + + + A valid value is an ISO 2-character country code (e.g. ''NL'').' + maxLength: 2 + type: string + recurring: + description: 'A container for the type of recurring contract to be retrieved. + + + The recurring.contract must be set to `PAYOUT`' + $ref: '#/components/schemas/Recurring' + selectedBrand: + x-addedInVersion: '24' + description: 'The name of the brand to make a payout to. + + + For Paysafecard it must be set to `paysafecard`.' + type: string + shopperEmail: + description: The shopper's email address. + type: string + shopperName: + x-addedInVersion: '24' + description: 'The shopper''s name. + + + When the `entityType` is `Company`, the `shopperName.lastName` must contain + the company name.' + $ref: '#/components/schemas/Name' + shopperReference: + description: The shopper's reference for the payment transaction. + type: string + socialSecurityNumber: + x-addedInVersion: '24' + description: The shopper's social security number. + type: string + telephoneNumber: + x-addedInVersion: '52' + description: The shopper's phone number. + type: string + required: + - merchantAccount + - shopperEmail + - shopperReference + - recurring + - dateOfBirth + - nationality + - entityType + StoreDetailResponse: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular response. + type: object + pspReference: + description: A new reference to uniquely identify this request. + type: string + recurringDetailReference: + description: The token which you can use later on for submitting the payout. + type: string + resultCode: + description: The result code of the transaction. `Success` indicates that + the details were stored successfully. + type: string + required: + - pspReference + - recurringDetailReference + - resultCode + SubmitRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular request. + type: object + amount: + description: A container object for the payable amount information of the + transaction. + $ref: '#/components/schemas/Amount' + dateOfBirth: + x-addedInVersion: '24' + description: "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\ + \nFor Paysafecard it must be the same as used when registering the Paysafecard\ + \ account.\n\n> This field is mandatory for natural persons. \n> This\ + \ field is required to update the existing `dateOfBirth` that is associated\ + \ with this recurring contract." + format: date-time + type: string + entityType: + x-addedInVersion: '24' + description: 'The type of the entity the payout is processed for. + + + Allowed values: + + * NaturalPerson + + * Company + + > This field is required to update the existing `entityType` that is associated + with this recurring contract.' + enum: + - NaturalPerson + - Company + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + merchantAccount: + description: The merchant account identifier you want to process the transaction + request with. + type: string + nationality: + x-addedInVersion: '24' + description: 'The shopper''s nationality. + + + A valid value is an ISO 2-character country code (e.g. ''NL''). + + + > This field is required to update the existing nationality that is associated + with this recurring contract.' + type: string + recurring: + description: 'A container for the type of recurring contract to be retrieved. + + + The `recurring.contract` must be set to "PAYOUT".' + $ref: '#/components/schemas/Recurring' + reference: + description: The merchant reference for this payout. This reference will + be used in all communication to the merchant about the status of the payout. + Although it is a good idea to make sure it is unique, this is not a requirement. + type: string + selectedRecurringDetailReference: + description: 'This is the `recurringDetailReference` you want to use for + this payout. + + + You can use the value LATEST to select the most recently used recurring + detail.' + type: string + shopperEmail: + description: The shopper's email address. + type: string + shopperName: + x-addedInVersion: '24' + description: 'The shopper''s name. + + + In case the `entityType` is `Company`, the `shopperName.lastName` must + contain the company name. + + + > This field is required to update the existing `shopperName` associated + with a recurring contract.' + $ref: '#/components/schemas/Name' + shopperReference: + description: The shopper's reference for the payout transaction. + type: string + shopperStatement: + x-addedInVersion: '2' + description: The description of this payout. This description is shown on + the bank statement of the shopper (if this is supported by the chosen + payment method). + type: string + socialSecurityNumber: + x-addedInVersion: '24' + description: The shopper's social security number. + type: string + required: + - merchantAccount + - reference + - amount + - shopperEmail + - shopperReference + - recurring + - selectedRecurringDetailReference + SubmitResponse: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular response. + type: object + pspReference: + description: A new reference to uniquely identify this request. + type: string + refusalReason: + description: In case of refusal, an informational message for the reason. + type: string + resultCode: + description: 'The response: + + * In case of success, it is `payout-submit-received`. + + * In case of an error, an informational message is returned.' + type: string + required: + - pspReference + - resultCode + ThreeDS2RequestData: + properties: + acquirerBIN: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The acquiring BIN enrolled for 3D Secure 2. This string should match the + value that you will use in the authorisation. Use 123456 on the Test platform. + type: string + acquirerMerchantID: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. + This string should match the value that you will use in the authorisation. + Use 123456 on the Test platform. + type: string + authenticationOnly: + deprecated: true + x-deprecatedInVersion: '50' + x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + challengeIndicator: + description: 'Possibility to specify a preference for receiving a challenge + from the issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate + type: string + deviceChannel: + description: 'The environment of the shopper. + + Allowed values: + + * `app` + + * `browser`' + type: string + deviceRenderOptions: + description: 'Display options for the 3D Secure 2 SDK. + + Optional and only for `deviceChannel` **app**.' + $ref: '#/components/schemas/DeviceRenderOptions' + mcc: + x-addedInVersion: '49' + description: Required for merchants that have been enrolled for 3D Secure + 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` + is registered at the scheme. + type: string + merchantName: + x-addedInVersion: '49' + description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchant name that the issuer presents to the shopper if they get + a challenge. We recommend to use the same value that you will use in the + authorization. Maximum length is 40 characters. + + > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). + Use this field if you are enrolled for 3D Secure 2 with us and want to + override the merchant name already configured on your account.' + type: string + messageVersion: + default: 2.1.0 + description: The `messageVersion` value indicating the 3D Secure 2 protocol + version. + type: string + notificationURL: + description: URL to where the issuer should send the `CRes`. Required if + you are not using components for `channel` **Web** or if you are using + classic integration `deviceChannel` **browser**. + type: string + sdkAppID: + description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEncData: + description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEphemPubKey: + description: 'The `sdkEphemPubKey` value as received from the 3D Secure + 2 SDK. + + Required for `deviceChannel` set to **app**.' + $ref: '#/components/schemas/SDKEphemPubKey' + sdkMaxTimeout: + default: 60 + description: 'The maximum amount of time in minutes for the 3D Secure 2 + authentication process. + + Optional and only for `deviceChannel` set to **app**. Defaults to **60** + minutes.' + format: int32 + type: integer + sdkReferenceNumber: + description: 'The `sdkReferenceNumber` value as received from the 3D Secure + 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkTransID: + description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkVersion: + x-addedInVersion: '40' + description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ + \ set to **app**." + type: string + threeDSCompInd: + description: Completion indicator for the device fingerprinting. + type: string + threeDSRequestorID: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor identifier assigned by the Directory + Server when you enrol for 3D Secure 2. + type: string + threeDSRequestorName: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor name assigned by the Directory Server + when you enrol for 3D Secure 2. + type: string + threeDSRequestorURL: + description: URL of the (customer service) website that will be shown to + the shopper in case of technical errors during the 3D Secure 2 process. + type: string + transactionType: + x-addedInVersion: '50' + description: Identify the type of the transaction being authenticated. + enum: + - goodsOrServicePurchase + - checkAcceptance + - accountFunding + - quasiCashTransaction + - prepaidActivationAndLoad + type: string + whiteListStatus: + x-addedInVersion: '49' + description: The `whiteListStatus` value returned from a previous 3D Secure + 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. + type: string + required: + - deviceChannel + ThreeDSecureData: + properties: + authenticationResponse: + description: 'In 3D Secure 1, the authentication response if the shopper + was redirected. + + + In 3D Secure 2, this is the `transStatus` from the challenge result. If + the transaction was frictionless, omit this parameter.' + enum: + - Y + - N + - U + - A + type: string + cavv: + description: The cardholder authentication value (base64 encoded, 20 bytes + in a decoded form). + format: byte + type: string + cavvAlgorithm: + description: The CAVV algorithm used. Include this only for 3D Secure 1. + 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 + directoryResponse: + description: 'In 3D Secure 1, this is the enrollment response from the 3D + directory server. + + + In 3D Secure 2, this is the `transStatus` from the `ARes`.' + enum: + - A + - C + - D + - I + - N + - R + - U + - Y + type: string + dsTransID: + x-addedInVersion: '40' + description: Supported for 3D Secure 2. The unique transaction identifier + assigned by the Directory Server (DS) to identify a single transaction. + type: string + eci: + description: The electronic commerce indicator. + type: string + riskScore: + x-addedInVersion: '67' + description: Risk score calculated by Directory Server (DS). Required for + Cartes Bancaires integrations. + type: string + threeDSVersion: + x-addedInVersion: '40' + description: The version of the 3D Secure protocol. + type: string + transStatusReason: + x-addedInVersion: '67' + 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 + xid: + description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, + 20 bytes in a decoded form). + format: byte + type: string + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: + generic-400: + summary: Response code 400. Bad Request. + value: + status: 400 + errorCode: '702' + message: 'Unexpected input: I' + errorType: validation + post-confirmThirdParty-confirmThirdParty: + summary: Confirm a payout + description: Confirm a previously submitted payout + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + originalReference: '9913140798220028' + post-confirmThirdParty-confirmThirdParty-200: + summary: Example response for request 'confirmThirdParty' + value: + pspReference: 991617894325358C + response: '[payout-confirm-received]' + post-declineThirdParty-declineThirdParty: + summary: Cancel a payout + description: Cancel a previously submitted payout + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + originalReference: '9913140798220028' + post-declineThirdParty-declineThirdParty-200: + summary: Example response for request 'declineThirdParty' + value: + pspReference: 991617894325360J + response: '[payout-decline-received]' + post-payout-payout-b2c: + summary: Instant card payout (B2C) + description: Pay out to your sellers, customers, freelancers, etc + value: + amount: + value: 2500 + currency: USD + card: + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + billingAddress: + houseNumberOrName: '121' + street: Populierenlaan + city: Beverly Hills + postalCode: '90210' + stateOrProvince: CA + country: US + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: P9999999999999999 + shopperName: + firstName: John + lastName: Smith + dateOfBirth: '1990-01-01' + nationality: NL + post-payout-payout-p2p: + summary: Instant card payout (P2P) + description: Facilitate the transfer of money between two individuals + value: + amount: + value: 2500 + currency: USD + card: + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + fundSource: + additionalData: + fundingSource: DEBIT + billingAddress: + country: US + postalCode: '90210' + city: Beverly Hills + card: + expiryMonth: '03' + expiryYear: '2030' + holderName: Payer Name + number: '4400000000000008' + shopperName: + firstName: Payer + lastName: Name + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: P9999999999999999 + shopperName: + firstName: John + lastName: Smith + shopperStatement: Payer Name + dateOfBirth: '1990-01-01' + nationality: NL + post-storeDetail-storeDetail: + summary: Store payout details + description: Store payment details under the PAYOUT recurring contract + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + bank: + bankName: AbnAmro + bic: ABNANL2A + countryCode: NL + iban: NL32ABNA0515071439 + ownerName: Adyen + bankCity: Amsterdam + taxId: bankTaxId + shopperEmail: shopper@email.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperName: + firstName: Adyen + gender: MALE + lastName: Test + dateOfBirth: '1990-01-01' + entityType: Company + nationality: NL + billingAddress: + houseNumberOrName: '17' + street: Teststreet 1 + city: Amsterdam + stateOrProvince: NY + country: US + postalCode: '12345' + post-storeDetail-storeDetail-200: + summary: Example response for request 'storeDetail' + value: + pspReference: 991617894326362D + recurringDetailReference: '9916178936754752' + resultCode: Success + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty: + summary: Submit a payout and stores details + description: Submit a payout and stores its details for subsequent payouts + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: RECURRING,PAYOUT + amount: + value: 2000 + currency: EUR + bank: + bankName: Wirecard + iban: DE87123456781234567890 + countryCode: DE + ownerName: Simon Hopper + reference: Your Reference Here + shopperEmail: s.hopper@test.com + shopperIP: 61.294.12.12 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperName: + firstName: Adyen + gender: MALE + lastName: Test + dateOfBirth: '1990-01-01' + entityType: Company + nationality: NL + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller: + summary: Submit a payout to Neteller + description: Submit a payout to Neteller and stores its details for subsequent + payouts + value: + amount: + currency: EUR + value: 100 + selectedBrand: neteller + additionalData: + tokenDataType: Neteller + account: myNetellerAccount + shopperName: + firstName: Test + gender: FEMALE + lastName: Test2 + dateOfBirth: '1982-07-17' + entityType: NaturalPerson + nationality: NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: Test Payout + shopperEmail: test@company.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal: + summary: Submit a payout to PayPal + description: Submit a payout to PayPal and stores its details for subsequent + payouts + value: + amount: + currency: EUR + value: 1750 + selectedBrand: paypal + additionalData: + tokenDataType: PayPal + emailId: EmailUsedForPayPalAccount@example.com + paypal.payerId: AK5HCWWRUV2KL + shopperName: + firstName: Test + gender: FEMALE + lastName: Test2 + dateOfBirth: '1982-07-17' + entityType: NaturalPerson + nationality: NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: Test Payout + shopperEmail: test@company.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard: + summary: Submit a payout to Paysafecard + description: Submit a payout to Paysafecard and stores its details for subsequent + payouts + value: + amount: + currency: EUR + value: 1000 + selectedBrand: paysafecard + additionalData: + emailId: EmailUsedForPaysafecardAccount@example.com + shopperName: + firstName: Test + gender: MALE + lastName: Test2 + dateOfBirth: '1982-07-17' + entityType: NaturalPerson + nationality: NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: Test Payout + shopperEmail: test@company.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperIP: 61.294.12.12 + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill: + summary: Submit a payout to Skrill + description: Submit a payout to Skrill and stores its details for subsequent + payouts + value: + amount: + currency: EUR + value: 100 + selectedBrand: moneybookers + additionalData: + tokenDataType: MoneyBookers + email: name@adyen.com + shopperName: + firstName: Test + gender: FEMALE + lastName: Test2 + dateOfBirth: '1982-07-17' + entityType: NaturalPerson + nationality: NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: Test Payout + shopperEmail: test@company.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-submitThirdParty-submitThirdParty: + summary: Submit a payout + description: Submit a payout using the previously stored payment details + value: + amount: + currency: EUR + value: '1000' + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: PayoutPayment-0001 + shopperEmail: shopper@email.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperName: + firstName: Adyen + gender: MALE + lastName: Test + dateOfBirth: '1990-01-01' + entityType: Company + nationality: NL + selectedRecurringDetailReference: LATEST diff --git a/yaml/PayoutService-v68.yaml b/yaml/PayoutService-v68.yaml new file mode 100644 index 0000000..29a2ea3 --- /dev/null +++ b/yaml/PayoutService-v68.yaml @@ -0,0 +1,5295 @@ +openapi: 3.1.0 +servers: +- url: https://pal-test.adyen.com/pal/servlet/Payout/v68 +info: + version: '68' + x-publicVersion: true + title: Adyen Payout API + description: 'A set of API endpoints that allow you to store payout details, confirm, + or decline a payout. + + + For more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts). + + ## Authentication + + To use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): + one for storing payout details and submitting payouts, and another one for confirming + or declining payouts. If you don''t have the required API credentials, contact + our [Support Team](https://support.adyen.com/hc/en-us/requests/new). + + + Both of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The + following example shows how to authenticate your request when submitting a payout: + + + ``` + + curl + + -U "storePayout@Company.[YourCompany]":"YourBasicAuthenticationPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + When going live, you need to generate new API credentials to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ' + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- Initialization +- Reviewing +- Instant payouts +paths: + /confirmThirdParty: + post: + tags: + - Reviewing + summary: Confirms a payout. + description: 'Confirms a previously submitted payout. + + + To cancel a payout, use the `/declineThirdParty` endpoint.' + x-addedInVersion: '10' + operationId: post-confirmThirdParty + x-groupName: Reviewing + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty' + schema: + $ref: '#/components/schemas/ModifyRequest' + responses: + '200': + content: + application/json: + examples: + confirmThirdParty: + $ref: '#/components/examples/post-confirmThirdParty-confirmThirdParty-200' + schema: + $ref: '#/components/schemas/ModifyResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /declineThirdParty: + post: + tags: + - Reviewing + summary: Cancels a payout. + description: 'Cancels a previously submitted payout. + + + To confirm and send a payout, use the `/confirmThirdParty` endpoint.' + x-addedInVersion: '10' + operationId: post-declineThirdParty + x-groupName: Reviewing + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty' + schema: + $ref: '#/components/schemas/ModifyRequest' + responses: + '200': + content: + application/json: + examples: + declineThirdParty: + $ref: '#/components/examples/post-declineThirdParty-declineThirdParty-200' + schema: + $ref: '#/components/schemas/ModifyResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /payout: + post: + tags: + - Instant payouts + summary: Pay out directly. + description: With this call, you can pay out to your customers, and funds will + be made available within 30 minutes on the cardholder's bank account (this + is dependent on whether the issuer supports this functionality). Instant card + payouts are only supported for Visa and Mastercard cards. + x-addedInVersion: '11' + operationId: post-payout + x-groupName: Instant payouts + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + payout-b2c: + $ref: '#/components/examples/post-payout-payout-b2c' + payout-p2p: + $ref: '#/components/examples/post-payout-payout-p2p' + schema: + $ref: '#/components/schemas/PayoutRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PayoutResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /storeDetail: + post: + tags: + - Initialization + summary: Stores payout details. + description: Stores payment details under the `PAYOUT` recurring contract. These + payment details can be used later to submit a payout via the `/submitThirdParty` + call. + operationId: post-storeDetail + x-groupName: Initialization + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail' + schema: + $ref: '#/components/schemas/StoreDetailRequest' + responses: + '200': + content: + application/json: + examples: + storeDetail: + $ref: '#/components/examples/post-storeDetail-storeDetail-200' + schema: + $ref: '#/components/schemas/StoreDetailResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /storeDetailAndSubmitThirdParty: + post: + tags: + - Initialization + summary: Stores details and submits a payout. + description: 'Submits a payout and stores its details for subsequent payouts. + + + The submitted payout must be confirmed or declined either by a reviewer or + via `/confirmThirdParty` or `/declineThirdParty` calls.' + x-addedInVersion: '10' + operationId: post-storeDetailAndSubmitThirdParty + x-groupName: Initialization + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + storeDetailAndSubmitThirdParty: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty' + storeDetailAndSubmitThirdParty-Neteller: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller' + storeDetailAndSubmitThirdParty-PayPal: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal' + storeDetailAndSubmitThirdParty-Paysafecard: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard' + storeDetailAndSubmitThirdParty-Skrill: + $ref: '#/components/examples/post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill' + schema: + $ref: '#/components/schemas/StoreDetailAndSubmitRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/StoreDetailAndSubmitResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /submitThirdParty: + post: + tags: + - Initialization + summary: Submits a payout. + description: 'Submits a payout using the previously stored payment details. + To store payment details, use the `/storeDetail` API call. + + + The submitted payout must be confirmed or declined either by a reviewer or + via `/confirmThirdParty` or `/declineThirdParty` calls.' + x-addedInVersion: '10' + operationId: post-submitThirdParty + x-groupName: Initialization + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + submitThirdParty: + $ref: '#/components/examples/post-submitThirdParty-submitThirdParty' + schema: + $ref: '#/components/schemas/SubmitRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + examples: + generic: + $ref: '#/components/examples/generic-400' + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. +components: + schemas: + AccountInfo: + properties: + accountAgeIndicator: + description: 'Indicator for the length of time since this shopper account + was created in the merchant''s environment. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountChangeDate: + description: Date when the shopper's account was last changed. + format: date-time + type: string + accountChangeIndicator: + description: 'Indicator for the length of time since the shopper''s account + was last updated. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + accountCreationDate: + description: Date when the shopper's account was created. + format: date-time + type: string + accountType: + x-addedInVersion: '50' + description: 'Indicates the type of account. For example, for a multi-account + card product. + + Allowed values: + + * notApplicable + + * credit + + * debit' + enum: + - notApplicable + - credit + - debit + type: string + addCardAttemptsDay: + description: Number of attempts the shopper tried to add a card to their + account in the last day. + format: int32 + type: integer + deliveryAddressUsageDate: + description: Date the selected delivery address was first used. + format: date-time + type: string + deliveryAddressUsageIndicator: + description: 'Indicator for the length of time since this delivery address + was first used. + + Allowed values: + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + homePhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.homePhone` instead. + description: Shopper's home phone number (including the country code). + type: string + mobilePhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.mobilePhone` instead. + description: Shopper's mobile phone number (including the country code). + type: string + passwordChangeDate: + description: Date when the shopper last changed their password. + format: date-time + type: string + passwordChangeIndicator: + description: 'Indicator when the shopper has changed their password. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + pastTransactionsDay: + description: Number of all transactions (successful and abandoned) from + this shopper in the past 24 hours. + format: int32 + type: integer + pastTransactionsYear: + description: Number of all transactions (successful and abandoned) from + this shopper in the past year. + format: int32 + type: integer + paymentAccountAge: + description: Date this payment method was added to the shopper's account. + format: date-time + type: string + paymentAccountIndicator: + description: 'Indicator for the length of time since this payment method + was added to this shopper''s account. + + Allowed values: + + * notApplicable + + * thisTransaction + + * lessThan30Days + + * from30To60Days + + * moreThan60Days' + enum: + - notApplicable + - thisTransaction + - lessThan30Days + - from30To60Days + - moreThan60Days + type: string + purchasesLast6Months: + description: Number of successful purchases in the last six months. + format: int32 + type: integer + suspiciousActivity: + description: Whether suspicious activity was recorded on this account. + type: boolean + workPhone: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. + description: Shopper's work phone number (including the country code). + type: string + AcctInfo: + properties: + chAccAgeInd: + description: "Length of time that the cardholder has had the account with\ + \ the 3DS Requestor. \nAllowed values:\n* **01** \u2014 No account\n*\ + \ **02** \u2014 Created during this transaction\n* **03** \u2014 Less\ + \ than 30 days\n* **04** \u2014 30\u201360 days\n* **05** \u2014 More\ + \ than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + chAccChange: + description: "Date that the cardholder\u2019s account with the 3DS Requestor\ + \ was last changed, including Billing or Shipping address, new payment\ + \ account, or new user(s) added. \nFormat: **YYYYMMDD**" + type: string + chAccChangeInd: + description: "Length of time since the cardholder\u2019s account information\ + \ with the 3DS Requestor was last changed, including Billing or Shipping\ + \ address, new payment account, or new user(s) added. \nAllowed values:\n\ + * **01** \u2014 Changed during this transaction\n* **02** \u2014 Less\ + \ than 30 days\n* **03** \u2014 30\u201360 days\n* **04** \u2014 More\ + \ than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + chAccPwChange: + description: "Date that cardholder\u2019s account with the 3DS Requestor\ + \ had a password change or account reset. \nFormat: **YYYYMMDD**" + type: string + chAccPwChangeInd: + description: "Indicates the length of time since the cardholder\u2019s account\ + \ with the 3DS Requestor had a password change or account reset. \nAllowed\ + \ values:\n* **01** \u2014 No change\n* **02** \u2014 Changed during this\ + \ transaction\n* **03** \u2014 Less than 30 days\n* **04** \u2014 30\u2013\ + 60 days\n* **05** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + chAccString: + description: "Date that the cardholder opened the account with the 3DS Requestor.\ + \ \nFormat: **YYYYMMDD**" + type: string + nbPurchaseAccount: + description: 'Number of purchases with this cardholder account during the + previous six months. Max length: 4 characters.' + type: string + paymentAccAge: + description: "String that the payment account was enrolled in the cardholder\u2019\ + s account with the 3DS Requestor. \nFormat: **YYYYMMDD**" + type: string + paymentAccInd: + description: "Indicates the length of time that the payment account was\ + \ enrolled in the cardholder\u2019s account with the 3DS Requestor. \n\ + Allowed values:\n* **01** \u2014 No account (guest checkout)\n* **02**\ + \ \u2014 During this transaction\n* **03** \u2014 Less than 30 days\n\ + * **04** \u2014 30\u201360 days\n* **05** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + maxLength: 2 + minLength: 2 + type: string + provisionAttemptsDay: + description: 'Number of Add Card attempts in the last 24 hours. Max length: + 3 characters.' + type: string + shipAddressUsage: + description: "String when the shipping address used for this transaction\ + \ was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**" + type: string + shipAddressUsageInd: + description: "Indicates when the shipping address used for this transaction\ + \ was first used with the 3DS Requestor. \nAllowed values:\n* **01** \u2014\ + \ This transaction\n* **02** \u2014 Less than 30 days\n* **03** \u2014\ + \ 30\u201360 days\n* **04** \u2014 More than 60 days" + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + shipNameIndicator: + description: "Indicates if the Cardholder Name on the account is identical\ + \ to the shipping Name used for this transaction. \nAllowed values:\n\ + * **01** \u2014 Account Name identical to shipping Name\n* **02** \u2014\ + \ Account Name different to shipping Name" + enum: + - '01' + - '02' + maxLength: 2 + minLength: 2 + type: string + suspiciousAccActivity: + description: "Indicates whether the 3DS Requestor has experienced suspicious\ + \ activity (including previous fraud) on the cardholder account. \nAllowed\ + \ values:\n* **01** \u2014 No suspicious activity has been observed\n\ + * **02** \u2014 Suspicious activity has been observed" + enum: + - '01' + - '02' + maxLength: 2 + minLength: 2 + type: string + txnActivityDay: + description: 'Number of transactions (successful and abandoned) for this + cardholder account with the 3DS Requestor across all payment accounts + in the previous 24 hours. Max length: 3 characters.' + maxLength: 3 + type: string + txnActivityYear: + description: 'Number of transactions (successful and abandoned) for this + cardholder account with the 3DS Requestor across all payment accounts + in the previous year. Max length: 3 characters.' + maxLength: 3 + type: string + AdditionalData3DSecure: + properties: + allow3DS2: + description: "Indicates if you are able to process 3D Secure 2 transactions\ + \ natively on your payment page. Send this parameter when you are using\ + \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ + \n > This parameter only indicates readiness to support native 3D Secure\ + \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ + \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ + \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ + \ support native 3D Secure 2 authentication. Setting this to true does\ + \ not mean always applying 3D Secure 2. Adyen still selects the version\ + \ of 3D Secure based on configuration to optimize authorisation rates\ + \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ + \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ + \ Secure 2 to your shopper regardless of your configuration.\n" + type: string + executeThreeD: + description: "Indicates if you want to perform 3D Secure authentication\ + \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ + \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ + \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ + \ 3D Secure authentication. Note that this setting results in refusals\ + \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ + \ national regulations. \n" + type: string + mpiImplementationType: + description: In case of Secure+, this field must be set to **CUPSecurePlus**. + type: string + scaExemption: + description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ + \ that you want to request for the transaction.\n\n Possible values:\n\ + * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ + \ **transactionRiskAnalysis** " + type: string + threeDSVersion: + description: "Indicates your preference for the 3D Secure version. \n> If\ + \ you use this parameter, you override the checks from Adyen's Authentication\ + \ Engine. We recommend to use this field only if you have an extensive\ + \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ + \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ + \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ + \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ + \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ + \ in the `ARes`, we will apply the fallback policy configured in your\ + \ account. For example, if the configuration is to fall back to 3D Secure\ + \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ + \ the BIN is not enrolled, you will receive an error.\n\n" + type: string + AdditionalDataAirline: + properties: + airline.agency_invoice_number: + description: 'Reference number for the invoice, issued by the agency. + + * minLength: 1 + + * maxLength: 6' + type: string + airline.agency_plan_name: + description: '2-letter agency plan identifier; alphabetical. + + * minLength: 2 + + * maxLength: 2' + type: string + airline.airline_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit + accounting code (PAX); numeric. It identifies the carrier. + + * Format: IATA 3-digit accounting code (PAX) + + * Example: KLM = 074 + + * minLength: 3 + + * maxLength: 3' + type: string + airline.airline_designator_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.boarding_fee: + description: 'Chargeable amount for boarding the plane. + + The transaction amount needs to be represented in minor units according + to the [following table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 18' + type: string + airline.computerized_reservation_system: + description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) + used to make the reservation and purchase the ticket. + + * Format: alphanumeric. + + * minLength: 4 + + * maxLength: 4' + type: string + airline.customer_reference_number: + description: 'Reference number; alphanumeric. + + * minLength: 0 + + * maxLength: 20' + type: string + airline.document_type: + description: 'Optional 2-digit code; alphanumeric. It identifies the type + of product of the transaction. The description of the code may appear + on credit card statements. + + * Format: 2-digit code + + * Example: Passenger ticket = 01 + + * minLength: 2 + + * maxLength: 2' + type: string + airline.flight_date: + description: 'Flight departure date. Local time `(HH:mm)` is optional. + + * Date format: `yyyy-MM-dd` + + * Date and time format: `yyyy-MM-dd HH:mm` + + * minLength: 10 + + * maxLength: 16' + type: string + airline.leg.carrier_code: + description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter + accounting code (PAX); alphabetical. It identifies the carrier. + + This field is required/mandatory if the airline data includes leg details. + + * Format: IATA 2-letter airline code + + * Example: KLM = KL + + * minLength: 2 + + * maxLength: 2' + type: string + airline.leg.class_of_travel: + description: '1-letter travel class identifier; alphabetical. There is no + standard; however, the following codes are used rather consistently: + + * F: first class + + * J: business class + + * Y: economy class + + * W: premium economy + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.leg.date_of_travel: + description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ + * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" + type: string + airline.leg.depart_airport: + description: 'Alphabetical identifier of the departure airport. + + This field is required if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.depart_tax: + description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). + Amount charged by a country to an individual upon their leaving. The transaction + amount needs to be represented in minor units according to the [following + table](https://docs.adyen.com/development-resources/currency-codes). + + * minLength: 1 + + * maxLength: 12' + type: string + airline.leg.destination_code: + description: 'Alphabetical identifier of the destination/arrival airport. + + This field is required/mandatory if the airline data includes leg details. + + * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter + airport code. + + * Example: Amsterdam = AMS + + * minLength: 3 + + * maxLength: 3' + type: string + airline.leg.fare_base_code: + description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); + alphanumeric. + + * minLength: 1 + + * maxLength: 7' + type: string + airline.leg.flight_number: + description: 'The flight identifier. + + * minLength: 1 + + * maxLength: 5' + type: string + airline.leg.stop_over_code: + description: '1-letter code that indicates whether the passenger is entitled + to make a stopover. Only two types of characters are allowed: + + * O: Stopover allowed + + * X: Stopover not allowed + + + Limitations: + + * minLength: 1 + + * maxLength: 1' + type: string + airline.passenger.date_of_birth: + description: 'Date of birth of the passenger. + + + Date format: `yyyy-MM-dd` + + * minLength: 10 + + * maxLength: 10' + type: string + airline.passenger.first_name: + description: 'Passenger first name/given name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.last_name: + description: 'Passenger last name/family name. + + > This field is required/mandatory if the airline data includes passenger + details or leg details.' + type: string + airline.passenger.telephone_number: + description: 'Telephone number of the passenger, including country code. + This is an alphanumeric field that can include the ''+'' and ''-'' signs. + + * minLength: 3 + + * maxLength: 30' + type: string + airline.passenger.traveller_type: + description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. + Example: ADT, SRC, CNN, INS. + + + However, several carriers use non-standard codes that can be up to 5 alphanumeric + characters. + + * minLength: 3 + + * maxLength: 6' + type: string + airline.passenger_name: + description: 'Passenger name, initials, and a title. + + * Format: last name + first name or initials + title. + + * Example: *FLYER / MARY MS*. + + * minLength: 1 + + * maxLength: 49' + type: string + airline.ticket_issue_address: + description: 'Address of the place/agency that issued the ticket. + + * minLength: 0 + + * maxLength: 16' + type: string + airline.ticket_number: + description: 'The ticket''s unique identifier. + + * minLength: 1 + + * maxLength: 150' + type: string + airline.travel_agency_code: + description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier + number for travel agencies. + + * minLength: 1 + + * maxLength: 8' + type: string + airline.travel_agency_name: + description: 'The name of the travel agency. + + * minLength: 1 + + * maxLength: 25' + type: string + required: + - airline.passenger_name + AdditionalDataCarRental: + properties: + carRental.checkOutDate: + description: 'Pick-up date. + + * Date format: `yyyyMMdd`' + type: string + carRental.customerServiceTollFreeNumber: + description: 'The customer service phone number of the car rental company. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + carRental.daysRented: + description: 'Number of days for which the car is being rented. + + * Format: Numeric + + * maxLength: 19' + type: string + carRental.fuelCharges: + description: 'Any fuel charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.insuranceCharges: + description: 'Any insurance charges associated with the rental. + + * Format: Numeric + + * maxLength: 12' + type: string + carRental.locationCity: + description: 'The city from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.locationCountry: + description: 'The country from which the car is rented. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.locationStateProvince: + description: 'The state or province from where the car is rented. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + * Y - Customer was a no show. + + * N - Not applicable.' + type: string + carRental.oneWayDropOffCharges: + description: Charge associated with not returning a vehicle to the original + rental location. + type: string + carRental.rate: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.rateIndicator: + description: 'Specifies whether the given rate is applied daily or weekly. + + * D - Daily rate. + + * W - Weekly rate.' + type: string + carRental.rentalAgreementNumber: + description: 'The rental agreement number associated with this car rental. + + * Format: Alphanumeric + + * maxLength: 9' + type: string + carRental.rentalClassId: + description: 'Daily rental rate. + + * Format: Alphanumeric + + * maxLength: 12' + type: string + carRental.renterName: + description: 'The name of the person renting the car. + + * Format: Alphanumeric + + * maxLength: 26' + type: string + carRental.returnCity: + description: 'The city where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 18' + type: string + carRental.returnCountry: + description: 'The country where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 2' + type: string + carRental.returnDate: + description: 'The last date to return the car by. + + * Date format: `yyyyMMdd`' + type: string + carRental.returnLocationId: + description: 'Agency code, phone number, or address abbreviation + + * Format: Alphanumeric + + * maxLength: 10' + type: string + carRental.returnStateProvince: + description: 'The state or province where the car must be returned. + + * Format: Alphanumeric + + * maxLength: 3' + type: string + carRental.taxExemptIndicator: + description: 'Indicates whether the goods or services were tax-exempt, or + tax was not collected. + + + Values: + + * Y - Goods or services were tax exempt + + * N - Tax was not collected' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "A" for Car rental. This should be + included in the auth message. + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataCommon: + properties: + RequestedTestErrorResponseCode: + description: "Triggers test scenarios that allow to replicate certain communication\ + \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ + \ wasn't a connection available to service the outgoing communication.\n\ + This is a transient, retriable error since no messaging could be initiated\ + \ to an issuing system (or third-party acquiring system). Therefore, the\ + \ header Transient-Error: true is returned in the response. A subsequent\ + \ request using the same idempotency key will be processed as if it was\ + \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ + \ wrong during transmission of the message or receiving the response.\n\ + This is a classified as non-transient because the message could have been\ + \ received by the issuing party and been acted upon. No transient error\ + \ header is returned. If using idempotency, the (error) response is stored\ + \ as the final result for the idempotency key. Subsequent messages with\ + \ the same idempotency key not be processed beyond returning the stored\ + \ response." + type: string + authorisationType: + description: "Flags a card payment request for either pre-authorisation\ + \ or final authorisation. For more information, refer to [Authorisation\ + \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ + \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ + \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ + \ request to be handled as a final authorisation." + type: string + customRoutingFlag: + description: 'Allows you to determine or override the acquirer account that + should be used for the transaction. + + + If you need to process a payment with an acquirer different from a default + one, you can set up a corresponding configuration on the Adyen payments + platform. Then you can pass a custom routing flag in a payment request''s + additional data to target a specific acquirer. + + + To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + industryUsage: + x-enum: + - description: An incremental charge is carried out because of a no-show + for a guaranteed reservation. + value: NoShow + - description: An incremental charge is carried out to process an additional + payment after the original services have been rendered and the respective + payment has been processed. + value: DelayedCharge + description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ + \ this field denotes why the additional payment is made.\n\nPossible values:\n\ + \n * **NoShow**: An incremental charge is carried out because of a no-show\ + \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ + \ charge is carried out to process an additional payment after the original\ + \ services have been rendered and the respective payment has been processed." + enum: + - NoShow + - DelayedCharge + type: string + networkTxReference: + description: 'Allows you to link the transaction to the original or previous + one in a subscription/card-on-file chain. This field is required for token-based + transactions where Adyen does not tokenize the card. + + + Transaction identifier from card schemes, for example, Mastercard Trace + ID or the Visa Transaction ID. + + + Submit the original transaction ID of the contract in your payment request + if you are not tokenizing card details with Adyen and are making a merchant-initiated + transaction (MIT) for subsequent charges. + + + Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` + **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction + is classified as MIT.' + type: string + overwriteBrand: + description: Boolean indicator that can be optionally used for performing + debit transactions on combo cards (for example, combo cards in Brazil). + This is not mandatory but we recommend that you set this to true if you + want to use the `selectedBrand` value to specify how to process the transaction. + type: string + subMerchantCity: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the city of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 13 characters.' + type: string + subMerchantCountry: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the three-letter + country code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Fixed length: 3 characters.' + type: string + subMerchantID: + description: 'This field contains an identifier of the actual merchant when + a transaction is submitted via a payment facilitator. The payment facilitator + must send in this unique ID. + + + A unique identifier per submerchant that is required if the transaction + is performed by a registered payment facilitator. + + * Format: alpha-numeric. + + * Fixed length: 15 characters.' + type: string + subMerchantName: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the name of + the actual merchant. + + * Format: alpha-numeric. + + * Maximum length: 22 characters.' + type: string + subMerchantPostalCode: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the postal code + of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 10 characters.' + type: string + subMerchantState: + description: 'This field is required if the transaction is performed by + a registered payment facilitator, and if applicable to the country. This + field must contain the state code of the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 3 characters.' + type: string + subMerchantStreet: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the street of + the actual merchant''s address. + + * Format: alpha-numeric. + + * Maximum length: 60 characters.' + type: string + subMerchantTaxId: + description: 'This field is required if the transaction is performed by + a registered payment facilitator. This field must contain the tax ID of + the actual merchant. + + * Format: alpha-numeric. + + * Fixed length: 11 or 14 characters.' + type: string + AdditionalDataLevel23: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + + Encoding: ASCII. + + + Max length: 25 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + enhancedSchemeData.destinationCountryCode: + description: 'Destination country code. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.destinationPostalCode: + description: 'The postal code of a destination address. + + + Encoding: ASCII. + + + Max length: 10 characters. + + + > Required for American Express.' + type: string + enhancedSchemeData.destinationStateProvinceCode: + description: 'Destination state or province code. + + + Encoding: ASCII.Max length: 3 characters.' + type: string + enhancedSchemeData.dutyAmount: + description: 'Duty amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.freightAmount: + description: 'Shipping amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].commodityCode: + description: 'Item commodity code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].description: + description: 'Item description. + + + Encoding: ASCII. + + + Max length: 26 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].discountAmount: + description: 'Discount amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].productCode: + description: 'Product code. + + + Encoding: ASCII. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].quantity: + description: 'Quantity, specified as an integer value. + + + Value must be greater than 0. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].totalAmount: + description: 'Total amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: + description: 'Item unit of measurement. + + + Encoding: ASCII. + + + Max length: 3 characters.' + type: string + enhancedSchemeData.itemDetailLine[itemNr].unitPrice: + description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). + + + Max length: 12 characters.' + type: string + enhancedSchemeData.orderDate: + description: 'Order date. + + * Format: `ddMMyy` + + + Encoding: ASCII. + + + Max length: 6 characters.' + type: string + enhancedSchemeData.shipFromPostalCode: + description: 'The postal code of a "ship-from" address. + + + Encoding: ASCII. + + + Max length: 10 characters.' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. + + + For example, 2000 means USD 20.00. + + + Max length: 12 characters. + + + > Required for Level 2 and Level 3 data.' + type: string + AdditionalDataLodging: + properties: + lodging.checkInDate: + description: 'The arrival date. + + * Date format: `yyyyMMdd`' + type: string + lodging.checkOutDate: + description: 'The departure date. + + * Date format: `yyyyMMdd`' + type: string + lodging.customerServiceTollFreeNumber: + description: 'The toll free phone number for the hotel/lodgings. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.fireSafetyActIndicator: + description: 'Identifies that the facility complies with the Hotel and Motel + Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. + + * Format: Alphabetic + + * maxLength: 1' + type: string + lodging.folioCashAdvances: + description: 'The folio cash advances. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.folioNumber: + description: "Card acceptor\u2019s internal invoice or billing ID reference\ + \ number.\n* Format: Alphanumeric\n* maxLength: 25" + type: string + lodging.foodBeverageCharges: + description: 'Any charges for food and beverages associated with the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.noShowIndicator: + description: 'Indicates if the customer was a "no-show" (neither keeps nor + cancels their booking). + + + Value should be Y or N. + + * Format: Numeric + + * maxLength: 1' + type: string + lodging.prepaidExpenses: + description: 'Prepaid expenses for the booking. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.propertyPhoneNumber: + description: 'Identifies specific lodging property location by its local + phone number. + + * Format: Alphanumeric + + * maxLength: 17' + type: string + lodging.room1.numberOfNights: + description: 'Total number of nights the room will be rented. + + * Format: Numeric + + * maxLength: 4' + type: string + lodging.room1.rate: + description: 'The rate of the room. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.room1.tax: + description: 'The total amount of tax to be paid. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalRoomTax: + description: 'Total room tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + lodging.totalTax: + description: 'Total tax amount. + + * Format: Numeric + + * maxLength: 12' + type: string + travelEntertainmentAuthData.duration: + description: 'Number of nights. This should be included in the auth message. + + * Format: Numeric + + * maxLength: 2' + type: string + travelEntertainmentAuthData.market: + description: 'Indicates what market-specific dataset will be submitted or + is being submitted. Value should be "H" for Hotel. This should be included + in the auth message. + + + * Format: Alphanumeric + + * maxLength: 1' + type: string + AdditionalDataOpenInvoice: + properties: + openinvoicedata.merchantData: + description: 'Holds different merchant data points like product, purchase, + customer, and so on. It takes data in a Base64 encoded string. + + + The `merchantData` parameter needs to be added to the `openinvoicedata` + signature at the end. + + + Since the field is optional, if it''s not included it does not impact + computing the merchant signature. + + + Applies only to Klarna. + + + You can contact Klarna for the format and structure of the string.' + type: string + openinvoicedata.numberOfLines: + description: 'The number of invoice lines included in `openinvoicedata`. + + + There needs to be at least one line, so `numberOfLines` needs to be at + least 1.' + type: string + openinvoicedataLine[itemNr].currencyCode: + description: The three-character ISO currency code. + type: string + openinvoicedataLine[itemNr].description: + description: A text description of the product the invoice line refers to. + type: string + openinvoicedataLine[itemNr].itemAmount: + description: 'The price for one item in the invoice line, represented in + minor units. + + + The due amount for the item, VAT excluded.' + type: string + openinvoicedataLine[itemNr].itemId: + description: A unique id for this item. Required for RatePay if the description + of each item is not unique. + type: string + openinvoicedataLine[itemNr].itemVatAmount: + description: The VAT due for one item in the invoice line, represented in + minor units. + type: string + openinvoicedataLine[itemNr].itemVatPercentage: + description: 'The VAT percentage for one item in the invoice line, represented + in minor units. + + + For example, 19% VAT is specified as 1900.' + type: string + openinvoicedataLine[itemNr].numberOfItems: + description: The number of units purchased of a specific product. + type: string + openinvoicedataLine[itemNr].returnShippingCompany: + description: Name of the shipping company handling the the return shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingNumber: + description: The tracking number for the return of the shipment. + type: string + openinvoicedataLine[itemNr].returnTrackingUri: + description: URI where the customer can track the return of their shipment. + type: string + openinvoicedataLine[itemNr].shippingCompany: + description: Name of the shipping company handling the delivery. + type: string + openinvoicedataLine[itemNr].shippingMethod: + description: Shipping method. + type: string + openinvoicedataLine[itemNr].trackingNumber: + description: The tracking number for the shipment. + type: string + openinvoicedataLine[itemNr].trackingUri: + description: URI where the customer can track their shipment. + type: string + AdditionalDataOpi: + properties: + opi.includeTransToken: + description: 'Optional boolean indicator. Set to **true** if you want an + ecommerce transaction to return an `opi.transToken` as additional data + in the response. + + + You can store this Oracle Payment Interface token in your Oracle Opera + database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' + type: string + AdditionalDataRatepay: + properties: + ratepay.installmentAmount: + description: Amount the customer has to pay each month. + type: string + ratepay.interestRate: + description: Interest rate of this installment. + type: string + ratepay.lastInstallmentAmount: + description: Amount of the last installment. + type: string + ratepay.paymentFirstday: + description: Calendar day of the first payment. + type: string + ratepaydata.deliveryDate: + description: Date the merchant delivered the goods to the customer. + type: string + ratepaydata.dueDate: + description: Date by which the customer must settle the payment. + type: string + ratepaydata.invoiceDate: + description: Invoice date, defined by the merchant. If not included, the + invoice date is set to the delivery date. + type: string + ratepaydata.invoiceId: + description: Identification name or number for the invoice, defined by the + merchant. + type: string + AdditionalDataRetry: + properties: + retry.chainAttemptNumber: + description: 'The number of times the transaction (not order) has been retried + between different payment service providers. For instance, the `chainAttemptNumber` + set to 2 means that this transaction has been recently tried on another + provider before being sent to Adyen. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.orderAttemptNumber: + description: 'The index of the attempt to bill a particular order, which + is identified by the `merchantOrderReference` field. For example, if a + recurring transaction fails and is retried one day later, then the order + number for these attempts would be 1 and 2, respectively. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + retry.skipRetry: + description: 'The Boolean value indicating whether Adyen should skip or + retry this transaction, if possible. + + + > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, + and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` + to facilitate linking payment attempts together.' + type: string + AdditionalDataRisk: + properties: + riskdata.[customFieldName]: + description: The data for your custom risk field. For more information, + refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). + type: string + riskdata.basket.item[itemNr].amountPerItem: + description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.basket.item[itemNr].brand: + description: Brand of the item. + type: string + riskdata.basket.item[itemNr].category: + description: Category of the item. + type: string + riskdata.basket.item[itemNr].color: + description: Color of the item. + type: string + riskdata.basket.item[itemNr].currency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.basket.item[itemNr].itemID: + description: ID of the item. + type: string + riskdata.basket.item[itemNr].manufacturer: + description: Manufacturer of the item. + type: string + riskdata.basket.item[itemNr].productTitle: + description: A text description of the product the invoice line refers to. + type: string + riskdata.basket.item[itemNr].quantity: + description: Quantity of the item purchased. + type: string + riskdata.basket.item[itemNr].receiverEmail: + description: Email associated with the given product in the basket (usually + in electronic gift cards). + type: string + riskdata.basket.item[itemNr].size: + description: Size of the item. + type: string + riskdata.basket.item[itemNr].sku: + description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' + type: string + riskdata.basket.item[itemNr].upc: + description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' + type: string + riskdata.promotions.promotion[itemNr].promotionCode: + description: Code of the promotion. + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountAmount: + description: The discount amount of the promotion, represented in [minor + units](https://docs.adyen.com/development-resources/currency-codes). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: + description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + type: string + riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: + description: 'Promotion''s percentage discount. It is represented in percentage + value and there is no need to include the ''%'' sign. + + + e.g. for a promotion discount of 30%, the value of the field should be + 30.' + type: string + riskdata.promotions.promotion[itemNr].promotionName: + description: Name of the promotion. + type: string + riskdata.riskProfileReference: + description: Reference number of the risk profile that you want to apply + to the payment. If not provided or left blank, the merchant-level account's + default risk profile will be applied to the payment. For more information, + see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). + type: string + riskdata.skipRisk: + description: If this parameter is provided with the value **true**, risk + checks for the payment request are skipped and the transaction will not + get a risk score. + type: string + AdditionalDataRiskStandalone: + properties: + PayPal.CountryCode: + description: Shopper's country of residence in the form of ISO standard + 3166 2-character country codes. + type: string + PayPal.EmailId: + description: Shopper's email. + type: string + PayPal.FirstName: + description: Shopper's first name. + type: string + PayPal.LastName: + description: Shopper's last name. + type: string + PayPal.PayerId: + description: 'Unique PayPal Customer Account identification number. Character + length and limitations: 13 single-byte alphanumeric characters.' + type: string + PayPal.Phone: + description: Shopper's phone number. + type: string + PayPal.ProtectionEligibility: + description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ + \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ + \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ + \ \u2014 Merchant is not protected under the Seller Protection Policy." + type: string + PayPal.TransactionId: + description: Unique transaction ID of the payment. + type: string + avsResultRaw: + description: 'Raw AVS result received from the acquirer, where available. + Example: D' + type: string + bin: + description: The Bank Identification Number of a credit card, which is the + first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). + type: string + cvcResultRaw: + description: 'Raw CVC result received from the acquirer, where available. + Example: 1' + type: string + riskToken: + description: Unique identifier or token for the shopper's card details. + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. Example: true' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. Example: true' + type: string + tokenDataType: + description: 'Required for PayPal payments only. The only supported value + is: **paypal**.' + type: string + AdditionalDataSubMerchant: + properties: + subMerchant.numberOfSubSellers: + description: Required for transactions performed by registered payment facilitators. + Indicates the number of sub-merchants contained in the request. For example, + **3**. + type: string + subMerchant.subSeller[subSellerNr].city: + description: 'Required for transactions performed by registered payment + facilitators. The city of the sub-merchant''s address. + + * Format: Alphanumeric + + * Maximum length: 13 characters' + type: string + subMerchant.subSeller[subSellerNr].country: + description: "Required for transactions performed by registered payment\ + \ facilitators. The three-letter country code of the sub-merchant's address.\ + \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ + * Fixed length: 3 characters" + type: string + subMerchant.subSeller[subSellerNr].id: + description: "Required for transactions performed by registered payment\ + \ facilitators. A unique identifier that you create for the sub-merchant,\ + \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ + * Maximum length: 15 characters" + type: string + subMerchant.subSeller[subSellerNr].mcc: + description: "Required for transactions performed by registered payment\ + \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ + \ \n* Format: Numeric\n* Fixed length: 4 digits" + type: string + subMerchant.subSeller[subSellerNr].name: + description: 'Required for transactions performed by registered payment + facilitators. The name of the sub-merchant. Based on scheme specifications, + this value will overwrite the shopper statement that will appear in the + card statement. + + * Format: Alphanumeric + + * Maximum length: 22 characters' + type: string + subMerchant.subSeller[subSellerNr].postalCode: + description: 'Required for transactions performed by registered payment + facilitators. The postal code of the sub-merchant''s address, without + dashes. + + * Format: Numeric + + * Fixed length: 8 digits' + type: string + subMerchant.subSeller[subSellerNr].state: + description: 'Required for transactions performed by registered payment + facilitators. The state code of the sub-merchant''s address, if applicable + to the country. + + * Format: Alphanumeric + + * Maximum length: 2 characters' + type: string + subMerchant.subSeller[subSellerNr].street: + description: 'Required for transactions performed by registered payment + facilitators. The street name and house number of the sub-merchant''s + address. + + * Format: Alphanumeric + + * Maximum length: 60 characters' + type: string + subMerchant.subSeller[subSellerNr].taxId: + description: 'Required for transactions performed by registered payment + facilitators. The tax ID of the sub-merchant. + + * Format: Numeric + + * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' + type: string + AdditionalDataTemporaryServices: + properties: + enhancedSchemeData.customerReference: + description: 'Customer code, if supplied by a customer. + + * Encoding: ASCII + + * maxLength: 25' + type: string + enhancedSchemeData.employeeName: + description: 'Name or ID associated with the individual working in a temporary + capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.jobDescription: + description: 'Description of the job or task of the individual working in + a temporary capacity. + + * maxLength: 40' + type: string + enhancedSchemeData.regularHoursRate: + description: 'Amount paid per regular hours worked, minor units. + + * maxLength: 7' + type: string + enhancedSchemeData.regularHoursWorked: + description: 'Amount of time worked during a normal operation for the task + or job. + + * maxLength: 7' + type: string + enhancedSchemeData.requestName: + description: 'Name of the individual requesting temporary services. + + * maxLength: 40' + type: string + enhancedSchemeData.tempStartDate: + description: 'Date for the beginning of the pay period. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.tempWeekEnding: + description: 'Date of the end of the billing cycle. + + * Format: ddMMyy + + * maxLength: 6' + type: string + enhancedSchemeData.totalTaxAmount: + description: 'Total tax amount, in minor units. For example, 2000 means + USD 20.00 + + * maxLength: 12' + type: string + AdditionalDataWallets: + properties: + androidpay.token: + description: The Android Pay token retrieved from the SDK. + type: string + masterpass.transactionId: + description: The Mastercard Masterpass Transaction ID retrieved from the + SDK. + type: string + payment.token: + description: The Apple Pay token retrieved from the SDK. + type: string + paywithgoogle.token: + description: The Google Pay token retrieved from the SDK. + type: string + samsungpay.token: + description: The Samsung Pay token retrieved from the SDK. + type: string + visacheckout.callId: + description: The Visa Checkout Call ID retrieved from the SDK. + type: string + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + 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 + ApplicationInfo: + properties: + adyenLibrary: + description: Adyen-developed software, such as libraries and plugins, used + to interact with the Adyen API. For example, Magento plugin, Java API + library, etc. + $ref: '#/components/schemas/CommonField' + adyenPaymentSource: + description: Adyen-developed software to get payment details. For example, + Checkout SDK, Secured Fields SDK, etc. + $ref: '#/components/schemas/CommonField' + externalPlatform: + description: Third-party developed platform used to initiate payment requests. + For example, Magento, Zuora, etc. + $ref: '#/components/schemas/ExternalPlatform' + merchantApplication: + description: Merchant developed software, such as cashier application, used + to interact with the Adyen API. + $ref: '#/components/schemas/CommonField' + merchantDevice: + description: Merchant device information. + $ref: '#/components/schemas/MerchantDevice' + shopperInteractionDevice: + description: Shopper interaction device, such as terminal, mobile device + or web browser, to initiate payment requests. + $ref: '#/components/schemas/ShopperInteractionDevice' + BankAccount: + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCity: + x-addedInVersion: '18' + description: The bank city. + type: string + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. + type: string + bankName: + description: The name of the bank. + type: string + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. + type: string + countryCode: + description: 'Country code where the bank is located. + + + A valid value is an ISO two-character country code (e.g. ''NL'').' + type: string + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + taxId: + x-addedInVersion: '18' + description: The bank account holder's tax ID. + type: string + BrowserInfo: + properties: + acceptHeader: + description: The accept header value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + colorDepth: + x-addedInVersion: '40' + description: 'The color depth of the shopper''s browser in bits per pixel. + This should be obtained by using the browser''s `screen.colorDepth` property. + Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' + format: int32 + type: integer + javaEnabled: + x-addedInVersion: '40' + description: Boolean value indicating if the shopper's browser is able to + execute Java. + type: boolean + javaScriptEnabled: + x-addedInVersion: '40' + default: true + description: Boolean value indicating if the shopper's browser is able to + execute JavaScript. A default 'true' value is assumed if the field is + not present. + type: boolean + language: + x-addedInVersion: '40' + description: The `navigator.language` value of the shopper's browser (as + defined in IETF BCP 47). + type: string + screenHeight: + x-addedInVersion: '40' + description: The total height of the shopper's device screen in pixels. + format: int32 + type: integer + screenWidth: + x-addedInVersion: '40' + description: The total width of the shopper's device screen in pixels. + format: int32 + type: integer + timeZoneOffset: + x-addedInVersion: '40' + description: Time difference between UTC time and the shopper's browser + local time, in minutes. + format: int32 + type: integer + userAgent: + description: The user agent value of the shopper's browser. + maxLength: 50 + minLength: 10 + type: string + required: + - userAgent + - acceptHeader + - javaEnabled + - colorDepth + - screenHeight + - screenWidth + - timeZoneOffset + - language + Card: + properties: + cvc: + description: "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid)\ + \ (1-20 characters). Depending on the card brand, it is known also as:\n\ + * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n>\ + \ If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce),\ + \ the CVC code is present in the encrypted data. You must never post the\ + \ card details to the server.\n> This field must be always present in\ + \ a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n\ + > When this value is returned in a response, it is always empty because\ + \ it is not stored." + maxLength: 20 + minLength: 1 + type: string + expiryMonth: + description: 'The card expiry month. + + Format: 2 digits, zero-padded for single digits. For example: + + * 03 = March + + * 11 = November' + maxLength: 2 + minLength: 1 + type: string + expiryYear: + description: 'The card expiry year. + + Format: 4 digits. For example: 2020' + maxLength: 4 + minLength: 4 + type: string + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 + type: string + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 + type: string + number: + description: 'The card number (4-19 characters). Do not use any separators. + + When this value is returned in a response, only the last 4 digits of the + card number are returned.' + maxLength: 19 + minLength: 4 + type: string + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 + type: string + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 + type: string + required: + - number + - expiryMonth + - expiryYear + - holderName + CommonField: + properties: + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + DeviceRenderOptions: + properties: + sdkInterface: + default: both + description: 'Supported SDK interface types. + + Allowed values: + + * native + + * html + + * both' + enum: + - native + - html + - both + type: string + sdkUiType: + default: + - + description: 'UI types supported for displaying specific challenges. + + Allowed values: + + * text + + * singleSelect + + * outOfBand + + * otherHtml + + * multiSelect' + items: + enum: + - multiSelect + - otherHtml + - outOfBand + - singleSelect + - text + type: string + type: array + ExternalPlatform: + properties: + integrator: + description: External platform integrator. + type: string + name: + description: Name of the field. For example, Name of External Platform. + type: string + version: + description: Version of the field. For example, Version of External Platform. + type: string + ForexQuote: + properties: + account: + description: The account name. + type: string + accountType: + description: The account type. + type: string + baseAmount: + description: The base amount. + $ref: '#/components/schemas/Amount' + basePoints: + description: The base points. + format: int32 + type: integer + buy: + description: The buy rate. + $ref: '#/components/schemas/Amount' + interbank: + description: The interbank amount. + $ref: '#/components/schemas/Amount' + reference: + description: The reference assigned to the forex quote request. + type: string + sell: + description: The sell rate. + $ref: '#/components/schemas/Amount' + signature: + description: The signature to validate the integrity. + type: string + source: + description: The source of the forex quote. + type: string + type: + description: The type of forex. + type: string + validTill: + description: The date until which the forex quote is valid. + format: date-time + type: string + required: + - validTill + - basePoints + 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 + 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: '#/components/schemas/FraudCheckResult' + type: array + required: + - accountScore + FundSource: + properties: + additionalData: + additionalProperties: + type: string + description: a map of name/value pairs for passing in additional/industry-specific + data + type: object + billingAddress: + description: the address where to send the invoice + $ref: '#/components/schemas/Address' + card: + description: a representation of a (credit or debit) card + $ref: '#/components/schemas/Card' + shopperEmail: + description: the email address of the person + type: string + shopperName: + description: the name of the person + $ref: '#/components/schemas/Name' + telephoneNumber: + description: the telephone number of the person + type: string + Installments: + properties: + plan: + x-addedInVersion: '64' + description: 'Defines the type of installment plan. If not set, defaults + to **regular**. + + + Possible values: + + * **regular** + + * **revolving**' + enum: + - regular + - revolving + type: string + value: + description: 'Defines the number of installments. Its value needs to be + greater than zero. + + + Usually, the maximum allowed number of installments is capped. For example, + it may not be possible to split a payment in more than 24 installments. + The acquirer sets this upper limit, so its value may vary.' + format: int32 + type: integer + required: + - value + Mandate: + properties: + amount: + description: The billing amount(in minor units) of the recurring transactions. + type: string + amountRule: + description: "The limitation rule of the billing amount.\n\nPossible values:\n\ + \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ + \ **exact**: The transaction amount should be the same as the `amount`.\n\ + \n" + enum: + - max + - exact + type: string + billingAttemptsRule: + description: "The rule to specify the period, within which the recurring\ + \ debit can happen, relative to the mandate recurring date.\n\nPossible\ + \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ + \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ + \n" + enum: + - 'on' + - before + - after + type: string + billingDay: + description: 'The number of the day, on which the recurring debit can happen. + Should be within the same calendar month as the mandate recurring date. + + + Possible values: 1-31 based on the `frequency`.' + type: string + endsAt: + description: End date of the billing plan, in YYYY-MM-DD format. + type: string + frequency: + description: 'The frequency with which a shopper should be charged. + + + Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, + **halfYearly**, **yearly**.' + enum: + - adhoc + - daily + - weekly + - biWeekly + - monthly + - quarterly + - halfYearly + - yearly + type: string + remarks: + description: The message shown by UPI to the shopper on the approval screen. + type: string + startsAt: + description: Start date of the billing plan, in YYYY-MM-DD format. By default, + the transaction date. + type: string + required: + - frequency + - amount + - endsAt + MerchantDevice: + properties: + os: + description: Operating system running on the merchant device. + type: string + osVersion: + description: Version of the operating system on the merchant device. + type: string + reference: + description: Merchant device reference. + type: string + MerchantRiskIndicator: + properties: + addressMatch: + description: Whether the chosen delivery address is identical to the billing + address. + type: boolean + deliveryAddressIndicator: + description: 'Indicator regarding the delivery address. + + Allowed values: + + * `shipToBillingAddress` + + * `shipToVerifiedAddress` + + * `shipToNewAddress` + + * `shipToStore` + + * `digitalGoods` + + * `goodsNotShipped` + + * `other`' + enum: + - shipToBillingAddress + - shipToVerifiedAddress + - shipToNewAddress + - shipToStore + - digitalGoods + - goodsNotShipped + - other + type: string + deliveryEmail: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `deliveryEmailAddress` instead. + description: The delivery email address (for digital goods). + type: string + deliveryEmailAddress: + x-addedInVersion: '68' + description: 'For Electronic delivery, the email address to which the merchandise + was delivered. Maximum length: 254 characters.' + maxLength: 254 + type: string + deliveryTimeframe: + description: 'The estimated delivery time for the shopper to receive the + goods. + + Allowed values: + + * `electronicDelivery` + + * `sameDayShipping` + + * `overnightShipping` + + * `twoOrMoreDaysShipping`' + enum: + - electronicDelivery + - sameDayShipping + - overnightShipping + - twoOrMoreDaysShipping + type: string + giftCardAmount: + description: For prepaid or gift card purchase, the purchase amount total + of prepaid or gift card(s). + $ref: '#/components/schemas/Amount' + giftCardCount: + description: For prepaid or gift card purchase, total count of individual + prepaid or gift cards/codes purchased. + format: int32 + type: integer + giftCardCurr: + x-addedInVersion: '68' + description: For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) + three-digit currency code of the gift card, other than those listed in + Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification. + type: string + preOrderDate: + description: For pre-order purchases, the expected date this product will + be available to the shopper. + format: date-time + type: string + preOrderPurchase: + description: Indicator for whether this transaction is for pre-ordering + a product. + type: boolean + preOrderPurchaseInd: + x-addedInVersion: '68' + description: Indicates whether Cardholder is placing an order for merchandise + with a future availability or release date. + type: string + reorderItems: + description: Indicator for whether the shopper has already purchased the + same items in the past. + type: boolean + reorderItemsInd: + x-addedInVersion: '68' + description: Indicates whether the cardholder is reordering previously purchased + merchandise. + type: string + shipIndicator: + x-addedInVersion: '68' + description: Indicates shipping method chosen for the transaction. + type: string + ModifyRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular payout request. + type: object + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + originalReference: + description: The PSP reference received in the `/submitThirdParty` response. + type: string + required: + - merchantAccount + - originalReference + ModifyResponse: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular response. + type: object + pspReference: + description: Adyen's 16-character string reference associated with the transaction. + This value is globally unique; quote it when communicating with us about + this response. + type: string + response: + description: 'The response: + + * In case of success, it is either `payout-confirm-received` or `payout-decline-received`. + + * In case of an error, an informational message is returned.' + type: string + required: + - pspReference + - response + Name: + properties: + firstName: + description: The first name. + type: string + lastName: + description: The last name. + type: string + required: + - firstName + - lastName + PayoutRequest: + properties: + accountInfo: + x-addedInVersion: '40' + description: 'Shopper account information for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/AccountInfo' + additionalAmount: + description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + request to use a non-zero value, assign this value to `additionalAmount` + (while the amount must be still set to 0 to trigger BIN or card verification). + + Required to be in the same currency as the `amount`. ' + $ref: '#/components/schemas/Amount' + additionalData: + additionalProperties: + type: string + x-anyOf: + - $ref: '#/components/schemas/AdditionalData3DSecure' + - $ref: '#/components/schemas/AdditionalDataAirline' + - $ref: '#/components/schemas/AdditionalDataCarRental' + - $ref: '#/components/schemas/AdditionalDataCommon' + - $ref: '#/components/schemas/AdditionalDataLevel23' + - $ref: '#/components/schemas/AdditionalDataLodging' + - $ref: '#/components/schemas/AdditionalDataOpenInvoice' + - $ref: '#/components/schemas/AdditionalDataOpi' + - $ref: '#/components/schemas/AdditionalDataRatepay' + - $ref: '#/components/schemas/AdditionalDataRetry' + - $ref: '#/components/schemas/AdditionalDataRisk' + - $ref: '#/components/schemas/AdditionalDataRiskStandalone' + - $ref: '#/components/schemas/AdditionalDataSubMerchant' + - $ref: '#/components/schemas/AdditionalDataTemporaryServices' + - $ref: '#/components/schemas/AdditionalDataWallets' + description: 'This field contains additional data, which may be required + for a particular payment request. + + + The `additionalData` object consists of entries, each of which includes + the key and value.' + type: object + amount: + description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). + For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) + requests, set amount to 0 (zero). + $ref: '#/components/schemas/Amount' + applicationInfo: + x-addedInVersion: '40' + description: Information about your application. For more details, see [Building + Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). + $ref: '#/components/schemas/ApplicationInfo' + bankAccount: + description: 'The details of the bank account, from which the payment should + be made. + + > Either `bankAccount` or `card` field must be provided in a payment request.' + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '4' + description: 'The address where to send the invoice. + + > The `billingAddress` object is required in the following scenarios. + Include all of the fields within this object. + + >* For 3D Secure 2 transactions in all browser-based and mobile implementations. + + >* For cross-border payouts to and from Canada.' + $ref: '#/components/schemas/Address' + browserInfo: + description: 'The shopper''s browser information. + + > For 3D Secure, the full object is required for web integrations. For + mobile app integrations, include the `userAgent` and `acceptHeader` fields + to indicate that your integration can support a redirect in case a payment + is routed to 3D Secure 1.' + $ref: '#/components/schemas/BrowserInfo' + captureDelayHours: + x-addedInVersion: '2' + description: The delay between the authorisation and scheduled auto-capture, + specified in hours. + format: int32 + type: integer + card: + description: 'A container for card data. + + > Either `bankAccount` or `card` field must be provided in a payment request.' + $ref: '#/components/schemas/Card' + dateOfBirth: + x-addedInVersion: '7' + description: 'The shopper''s date of birth. + + + Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' + format: date-time + type: string + dccQuote: + description: The forex quote as returned in the response of the forex service. + $ref: '#/components/schemas/ForexQuote' + deliveryAddress: + description: The address where the purchased goods should be delivered. + $ref: '#/components/schemas/Address' + deliveryDate: + x-addedInVersion: '8' + description: 'The date and time the purchased goods should be delivered. + + + Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD + + + Example: 2017-07-17T13:42:40.428+01:00' + format: date-time + type: string + deviceFingerprint: + x-addedInVersion: '2' + description: A string containing the shopper's device fingerprint. For more + information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + maxLength: 5000 + type: string + entityType: + x-addedInVersion: '24' + description: The type of the entity the payment is processed for. + enum: + - NaturalPerson + - CompanyName + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + fundSource: + description: The person or entity funding the money. + $ref: '#/components/schemas/FundSource' + fundingSource: + x-addedInVersion: '52' + description: The funding source that should be used when multiple sources + are available. For Brazilian combo cards, by default the funding source + is credit. To use debit, set this value to **debit**. + enum: + - debit + type: string + installments: + x-addedInVersion: '4' + description: Contains installment settings. For more information, refer + to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). + $ref: '#/components/schemas/Installments' + mandate: + description: The mandate details to initiate recurring transaction. + $ref: '#/components/schemas/Mandate' + mcc: + x-addedInVersion: '12' + description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) + (MCC) is a four-digit number, which relates to a particular market segment. + This code reflects the predominant activity that is conducted by the merchant. + type: string + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + merchantOrderReference: + x-addedInVersion: '9' + description: 'This reference allows linking multiple transactions to each + other for reporting purposes (i.e. order auth-rate). The reference should + be unique per billing cycle. + + The same merchant order reference should never be reused after the first + authorised attempt. If used, this field should be supplied for all incoming + authorisations. + + > We strongly recommend you send the `merchantOrderReference` value to + benefit from linking payment requests when authorisation retries take + place. In addition, we recommend you provide `retry.orderAttemptNumber`, + `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' + type: string + merchantRiskIndicator: + x-addedInVersion: '40' + description: 'Additional risk fields for 3D Secure 2. + + > For 3D Secure 2 transactions, we recommend that you include this object + to increase the chances of achieving a frictionless flow.' + $ref: '#/components/schemas/MerchantRiskIndicator' + metadata: + x-addedInVersion: '17' + additionalProperties: + type: string + description: 'Metadata consists of entries, each of which includes a key + and a value. + + Limits: + + * Maximum 20 key-value pairs per request. When exceeding, the "177" error + occurs: "Metadata size exceeds limit". + + * Maximum 20 characters per key. + + * Maximum 80 characters per value. ' + type: object + mpiData: + description: Authentication data produced by an MPI (Mastercard SecureCode, + Visa Secure, or Cartes Bancaires). + $ref: '#/components/schemas/ThreeDSecureData' + nationality: + x-addedInVersion: '24' + description: The two-character country code of the shopper's nationality. + maxLength: 2 + type: string + orderReference: + description: When you are doing multiple partial (gift card) payments, this + is the `pspReference` of the first payment. We use this to link the multiple + payments to each other. As your own reference for linking multiple payments, + use the `merchantOrderReference`instead. + type: string + recurring: + description: The recurring settings for the payment. Use this property when + you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments). + $ref: '#/components/schemas/Recurring' + recurringProcessingModel: + x-addedInVersion: '30' + description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ + \ \u2013 A transaction for a fixed or variable amount, which follows a\ + \ fixed schedule.\n* `CardOnFile` \u2013 With a card-on-file (CoF) transaction,\ + \ card details are stored to enable one-click or omnichannel journeys,\ + \ or simply to streamline the checkout process. Any subscription not following\ + \ a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile`\ + \ \u2013 An unscheduled card-on-file (UCoF) transaction is a transaction\ + \ that occurs on a non-fixed schedule and/or have variable amounts. For\ + \ example, automatic top-ups when a cardholder's balance drops below a\ + \ certain amount.\n" + enum: + - CardOnFile + - Subscription + - UnscheduledCardOnFile + type: string + 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 + selectedBrand: + description: 'Some payment methods require defining a value for this field + to specify how to process the transaction. + + + For the Bancontact payment method, it can be set to: + + * `maestro` (default), to be processed like a Maestro card, or + + * `bcmc`, to be processed like a Bancontact card.' + type: string + selectedRecurringDetailReference: + description: The `recurringDetailReference` you want to use for this payment. + The value `LATEST` can be used to select the most recently stored recurring + detail. + type: string + sessionId: + description: A session ID used to identify a payment session. + type: string + shopperEmail: + description: 'The shopper''s email address. We recommend that you provide + this data, as it is used in velocity fraud checks. + + > For 3D Secure 2 transactions, schemes require `shopperEmail` for all + browser-based and mobile implementations.' + type: string + shopperIP: + description: 'The shopper''s IP address. In general, we recommend that you + provide this data, as it is used in a number of risk checks (for instance, + number of payment attempts or location-based checks). + + > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based + implementations. + + This field is also mandatory for some merchants depending on your business + model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + shopperInteraction: + description: 'Specifies the sales channel, through which the shopper gives + their card details, and whether the shopper is a returning customer. + + For the web service API, Adyen assumes Ecommerce shopper interaction by + default. + + + This field has the following possible values: + + * `Ecommerce` - Online transactions where the cardholder is present (online). + For better authorisation rates, we recommend sending the card security + code (CSC) along with the request. + + * `ContAuth` - Card on file and/or subscription transactions, where the + cardholder is known to the merchant (returning customer). If the shopper + is present (online), you can supply also the CSC to improve authorisation + (one-click payment). + + * `Moto` - Mail-order and telephone-order transactions where the shopper + is in contact with the merchant via email or telephone. + + * `POS` - Point-of-sale transactions where the shopper is physically present + to make a payment using a secure payment terminal.' + enum: + - Ecommerce + - ContAuth + - Moto + - POS + type: string + shopperLocale: + x-addedInVersion: '7' + description: The combination of a language code and a country code to specify + the language to be used in the payment. + type: string + shopperName: + x-addedInVersion: '7' + description: The shopper's full name. + $ref: '#/components/schemas/Name' + shopperReference: + description: "Required for recurring payments. \nYour reference to uniquely\ + \ identify this shopper, for example user ID or account ID. Minimum length:\ + \ 3 characters.\n> Your reference must not include personally identifiable\ + \ information (PII), for example name or email address." + type: string + shopperStatement: + description: "The text to be shown on the shopper's bank statement. To enable\ + \ this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\ + \ We recommend sending a maximum of 22 characters, otherwise banks might\ + \ truncate the string." + type: string + socialSecurityNumber: + x-addedInVersion: '4' + description: The shopper's social security number. + type: string + splits: + x-addedInVersion: '37' + description: An array of objects specifying how the payment should be split + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + items: + $ref: '#/components/schemas/Split' + type: array + store: + x-addedInVersion: '23' + description: The ecommerce or point-of-sale store that is processing the + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + for Adyen for Platforms. + maxLength: 16 + minLength: 1 + type: string + telephoneNumber: + x-addedInVersion: '7' + description: The shopper's telephone number. + type: string + threeDS2RequestData: + x-addedInVersion: '40' + description: Request fields for 3D Secure 2. To check if any of the following + fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) + or [Classic integration](https://docs.adyen.com/classic-integration) documentation. + $ref: '#/components/schemas/ThreeDS2RequestData' + threeDSAuthenticationOnly: + x-addedInVersion: '50' + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + totalsGroup: + x-addedInVersion: '23' + description: The reference value to aggregate sales totals in reporting. + When not specified, the store field is used (if available). + maxLength: 16 + minLength: 1 + type: string + trustedShopper: + x-addedInVersion: '37' + description: Set to true if the payment should be routed to a trusted MID. + type: boolean + required: + - merchantAccount + - reference + - amount + PayoutResponse: + properties: + 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/ResponseAdditionalDataDeliveryAddress' + - $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** + > **Account** > **API URLs** > **Additional data settings**.' + type: object + authCode: + description: '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.' + type: string + dccAmount: + description: '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](https://support.adyen.com/hc/en-us/requests/new).' + $ref: '#/components/schemas/Amount' + dccSignature: + description: 'Cryptographic signature used to verify `dccQuote`. + + > This value only applies if you have implemented Dynamic Currency Conversion. + For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).' + type: string + fraudResult: + description: The fraud result properties of the payment. + $ref: '#/components/schemas/FraudResult' + issuerUrl: + description: 'The URL to direct the shopper to. + + > In case of SecurePlus, do not redirect a shopper to this URL.' + type: string + md: + description: The payment session. + maxLength: 20000 + type: string + paRequest: + description: '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](https://docs.adyen.com/classic-integration/3d-secure).' + type: string + pspReference: + description: Adyen's 16-character reference associated with the transaction/request. + This value is globally unique; quote it when communicating with us about + this request. + 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. + + + For more information, see [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** \u2013 The payment\ + \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ + \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ + \ \u2013 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** \u2013 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** \u2013 Indicates the\ + \ payment has been cancelled (either by the shopper or the merchant) before\ + \ processing was completed. This is a final state.\n* **ChallengeShopper**\ + \ \u2013 The issuer requires further shopper interaction before the payment\ + \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ + \ \u2013 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** \u2013 The issuer requires the shopper's device\ + \ fingerprint before the payment can be authenticated. Returned for 3D\ + \ Secure 2 transactions.\n* **Pending** \u2013 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** \u2013 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** \u2013\ + \ Indicates the payment has successfully been received by Adyen, and will\ + \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ + \ \u2013 Indicates the shopper should be redirected to an external web\ + \ page or app to complete the authorisation.\n* **Refused** \u2013 Indicates\ + \ the payment was refused. The reason is given in the `refusalReason`\ + \ field. This is a final state." + enum: + - AuthenticationFinished + - Authorised + - Cancelled + - ChallengeShopper + - Error + - IdentifyShopper + - Pending + - PresentToShopper + - Received + - RedirectShopper + - Refused + - Success + type: string + Phone: + properties: + cc: + description: "Country code. Length: 1\u20133 characters." + maxLength: 3 + minLength: 1 + type: string + subscriber: + description: 'Subscriber number. Maximum length: 15 characters.' + maxLength: 15 + type: string + Recurring: + properties: + contract: + description: "The type of recurring contract to be used.\nPossible values:\n\ + * `ONECLICK` \u2013 Payment details can be used to initiate a one-click\ + \ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\ + * `RECURRING` \u2013 Payment details can be used without the card security\ + \ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\ + * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\ + \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\ + \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)." + enum: + - ONECLICK + - RECURRING + - PAYOUT + type: string + recurringDetailName: + description: A descriptive name for this detail. + type: string + recurringExpiry: + x-addedInVersion: '40' + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time + type: string + recurringFrequency: + x-addedInVersion: '40' + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + tokenService: + x-addedInVersion: '25' + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE + type: string + 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 + 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. + + + Example: 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. + + + Example: 1011 DJ' + type: string + billingAddress.stateOrProvince: + description: 'The billing address state or province passed in the payment + request. + + + Example: NH' + type: string + billingAddress.street: + description: The billing address street passed in the payment request. + type: string + ResponseAdditionalDataCard: + properties: + cardBin: + description: 'The Bank Identification Number of a credit card, which is + the first six digits of a card number. + + + Example: 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. + + + Example: 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. + + + Example: amex' + type: string + cardSummary: + description: 'The last four digits of a card number. + + + > Returned only in case of a card payment.' + type: string + ResponseAdditionalDataCommon: + properties: + acquirerAccountCode: + description: 'The name of the Adyen acquirer account. + + + Example: PayPalSandbox_TestAcquirer + + + > Only relevant for PayPal transactions.' + type: string + acquirerCode: + description: 'The name of the acquirer processing the payment request. + + + Example: TestPmmAcquirer' + type: string + acquirerReference: + description: 'The reference number that can be used for reconciliation in + case a non-Adyen acquirer is used for settlement. + + + Example: 7C9N3FNBKT9' + type: string + alias: + description: 'The Adyen alias of the card. + + + Example: H167852639363479' + type: string + aliasType: + description: 'The type of the card alias. + + + Example: Default' + type: string + authCode: + description: '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. + + + Example: 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. + + + This 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. + + + For 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. + + + Example: D' + type: string + bic: + description: 'BIC of a bank account. + + + Example: TESTNL01 + + + > 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. + example: 1 Matches + type: string + cvcResultRaw: + description: The raw result of CVC verification. + example: M + 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. + + + Example: 02' + type: string + expiryDate: + description: 'The expiry date on the card. + + + Example: 6/2016 + + + > 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. + + + Example: 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: + + * CHARGE + + * CREDIT + + * DEBIT + + * PREPAID + + * PREPAID_RELOADABLE + + + * PREPAID_NONRELOADABLE + + * DEFFERED_DEBIT + + + > This functionality requires additional configuration on Adyen''s end. + To enable it, contact the Support Team. + + + For receiving this field in the notification, enable **Include Funding + Source** in **Notifications** > **Additional settings**.' + type: string + fundsAvailability: + description: 'Indicates availability of funds. + + + Visa: + + * "I" (fast funds are supported) + + * "N" (otherwise) + + + Mastercard: + + * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM + list) + + * "N" (otherwise) + + + > 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". + + + Possible values: + + + * 3D Secure Mandated + + * Closed Account + + * ContAuth Not Supported + + * CVC Mandated + + * Ecommerce Not Allowed + + * Crossborder Not Supported + + * Card Updated + + + * Low Authrate Bin + + * 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. + + + Example: 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. + + + > Contact Support Team to enable this field.' + type: string + merchantAdviceCode: + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. + + + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' + 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. + + + This contains either the Mastercard Trace ID or the Visa Transaction ID.' + type: string + ownerName: + description: 'The owner name of a bank account. + + + Only 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. + + + For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + + + Example: mcpro' + type: string + payoutEligible: + description: 'Indicates whether a payout is eligible or not for this card. + + + Visa: + + * "Y" + + * "N" + + + Mastercard: + + * "Y" (domestic and cross-border) + + + * "D" (only domestic) + + * "N" (no MoneySend) + + * "U" (unknown)' + type: string + realtimeAccountUpdaterStatus: + description: 'The response code from the Real Time Account Updater service. + + + Possible return values are: + + * CardChanged + + * CardExpiryChanged + + * CloseAccount + + + * 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. + + + This 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. + + + This field is unavailable if the payment is referred and is usually not + returned with ecommerce transactions. + + + Example: true' + type: string + refusalReasonRaw: + description: 'Raw refusal reason received from the acquirer, where available. + + + Example: 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. + + + Example: Ecommerce' + type: string + shopperReference: + description: 'The shopperReference passed in the payment request. + + + Example: AdyenTestShopperXX' + type: string + terminalId: + description: 'The terminal ID used in a point-of-sale payment. + + + Example: 06022622' + type: string + threeDAuthenticated: + description: 'A Boolean value indicating whether 3DS authentication was + completed on this payment. + + + Example: true' + type: string + threeDAuthenticatedResponse: + description: 'The raw 3DS authentication result from the card issuer. + + + Example: N' + type: string + threeDOffered: + description: 'A Boolean value indicating whether 3DS was offered for this + payment. + + + Example: true' + type: string + threeDOfferedResponse: + description: 'The raw enrollment result from the 3DS directory services + of the card schemes. + + + Example: Y' + type: string + threeDSVersion: + description: The 3D Secure 2 version. + type: string + visaTransactionId: + description: 'The `visaTransactionId`, has a fixed length of 15 numeric + characters. + + + > 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. + + + Example: ODgxNDc2MDg2MDExODk5MAAAAAA=' + type: string + ResponseAdditionalDataDeliveryAddress: + properties: + deliveryAddress.city: + description: The delivery address city passed in the payment request. + type: string + deliveryAddress.country: + description: 'The delivery address country passed in the payment request. + + + Example: NL' + type: string + deliveryAddress.houseNumberOrName: + description: The delivery address house number or name passed in the payment + request. + type: string + deliveryAddress.postalCode: + description: 'The delivery address postal code passed in the payment request. + + + Example: 1011 DJ' + type: string + deliveryAddress.stateOrProvince: + description: 'The delivery address state or province passed in the payment + request. + + + Example: NH' + type: string + deliveryAddress.street: + description: The delivery address street passed in the payment request. + type: string + 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: + + * PayInInstallmentsOnly + + * PayInFullOnly + + * PayInFullOrInstallments' + type: string + installments.value: + description: 'The number of installments that the payment amount should + be charged with. + + + Example: 5 + + > Only relevant for card payments in countries that support installments.' + type: string + 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 + 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 + ResponseAdditionalDataSepa: + properties: + sepadirectdebit.dateOfSignature: + description: 'The transaction signature date. + + + Format: 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: + + * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct + debit transaction. + + + * First: (FRST) Initial/first collection in a series of direct debit instructions. + + * Recurring: (RCUR) Direct debit instruction to carry out regular direct + debit transactions initiated by the creditor. + + * Final: (FNAL) Last/final collection in a series of direct debit instructions. + + + Example: OOFF' + type: string + SDKEphemPubKey: + properties: + crv: + description: The `crv` value as received from the 3D Secure 2 SDK. + type: string + kty: + description: The `kty` value as received from the 3D Secure 2 SDK. + type: string + x: + description: The `x` value as received from the 3D Secure 2 SDK. + type: string + y: + description: The `y` value as received from the 3D Secure 2 SDK. + type: string + ServiceError: + properties: + additionalData: + x-addedInVersion: '46' + additionalProperties: + type: string + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' + type: object + errorCode: + description: The error code mapped to the error message. + type: string + errorType: + description: The category of the error. + type: string + message: + description: A short explanation of the issue. + type: string + pspReference: + description: The PSP reference of the payment. + type: string + status: + description: The HTTP response status. + format: int32 + type: integer + ShopperInteractionDevice: + properties: + locale: + description: Locale on the shopper interaction device. + type: string + os: + description: Operating system running on the shopper interaction device. + type: string + osVersion: + description: Version of the operating system on the shopper interaction + device. + type: string + Split: + properties: + account: + description: 'Unique identifier of the account where the split amount should + be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. + + + ' + type: string + amount: + description: The amount of this split. + $ref: '#/components/schemas/SplitAmount' + description: + description: A description of this split. + type: string + reference: + description: 'Your reference for the split, which you can use to link the + split to other operations such as captures and refunds. + + + This is required if `type` is **MarketPlace** or **BalanceAccount**. For + the other types, we also recommend sending a reference so you can reconcile + the split and the associated payment in the transaction overview and in + the reports. If the reference is not provided, the split is reported as + part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) + in Adyen for Platforms.' + type: string + type: + description: 'The type of split. + + Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, + **MarketPlace**, **BalanceAccount**.' + enum: + - BalanceAccount + - Commission + - Default + - MarketPlace + - PaymentFee + - VAT + - Verification + type: string + required: + - amount + - type + SplitAmount: + properties: + currency: + description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + + + If this value is not provided, the currency in which the payment is made + will be used.' + maxLength: 3 + minLength: 3 + type: string + value: + description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). + format: int64 + type: integer + required: + - value + StoreDetailAndSubmitRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular request. + type: object + amount: + description: A container object for the payable amount information of the + transaction. + $ref: '#/components/schemas/Amount' + bank: + description: 'A container for bank account data. + + > This field is mandatory if `card` is not provided.' + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '18' + description: 'The billing address. + + + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' + $ref: '#/components/schemas/Address' + card: + description: 'A container for card data. + + > This field is mandatory if `bank` is not provided.' + $ref: '#/components/schemas/Card' + dateOfBirth: + x-addedInVersion: '24' + description: 'The date of birth. + + Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD + + For Paysafecard it must be the same as used when registering the Paysafecard + account. + + > This field is mandatory for natural persons.' + format: date-time + type: string + entityType: + x-addedInVersion: '24' + description: The type of the entity the payout is processed for. + enum: + - NaturalPerson + - Company + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + nationality: + x-addedInVersion: '24' + description: 'The shopper''s nationality. + + + A valid value is an ISO 2-character country code (e.g. ''NL'').' + maxLength: 2 + type: string + recurring: + description: 'A container for the type of recurring contract to be retrieved. + + + The recurring.contract must be set to `PAYOUT`' + $ref: '#/components/schemas/Recurring' + reference: + description: The merchant reference for this payment. This reference will + be used in all communication to the merchant about the status of the payout. + Although it is a good idea to make sure it is unique, this is not a requirement. + type: string + selectedBrand: + x-addedInVersion: '24' + description: 'The name of the brand to make a payout to. + + + For Paysafecard it must be set to `paysafecard`.' + type: string + shopperEmail: + description: The shopper's email address. + type: string + shopperName: + x-addedInVersion: '24' + description: 'The shopper''s name. + + + When the `entityType` is `Company`, the `shopperName.lastName` must contain + the company name.' + $ref: '#/components/schemas/Name' + shopperReference: + description: The shopper's reference for the payment transaction. + type: string + shopperStatement: + x-addedInVersion: '2' + description: The description of this payout. This description is shown on + the bank statement of the shopper (if this is supported by the chosen + payment method). + type: string + socialSecurityNumber: + x-addedInVersion: '24' + description: The shopper's social security number. + type: string + telephoneNumber: + x-addedInVersion: '52' + description: The shopper's phone number. + type: string + required: + - merchantAccount + - shopperEmail + - shopperReference + - recurring + - dateOfBirth + - nationality + - entityType + - reference + - amount + StoreDetailAndSubmitResponse: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular response. + type: object + pspReference: + description: A new reference to uniquely identify this request. + type: string + refusalReason: + description: In case of refusal, an informational message for the reason. + type: string + resultCode: + description: 'The response: + + + * In case of success is payout-submit-received. + + * In case of an error, an informational message is returned.' + type: string + required: + - pspReference + - resultCode + StoreDetailRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular request. + type: object + bank: + description: 'A container for bank account data. + + > This field is mandatory if `card` is not provided.' + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '18' + description: 'The billing address. + + + > The `billingAddress` object is required for cross-border payouts to + and from Canada. Include all of the fields within this object.' + $ref: '#/components/schemas/Address' + card: + description: 'A container for card data. + + > This field is mandatory if `bank` is not provided.' + $ref: '#/components/schemas/Card' + dateOfBirth: + x-addedInVersion: '24' + description: 'The date of birth. + + Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD + + For Paysafecard it must be the same as used when registering the Paysafecard + account. + + > This field is mandatory for natural persons.' + format: date-time + type: string + entityType: + x-addedInVersion: '24' + description: The type of the entity the payout is processed for. + enum: + - NaturalPerson + - Company + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + merchantAccount: + description: The merchant account identifier, with which you want to process + the transaction. + type: string + nationality: + x-addedInVersion: '24' + description: 'The shopper''s nationality. + + + A valid value is an ISO 2-character country code (e.g. ''NL'').' + maxLength: 2 + type: string + recurring: + description: 'A container for the type of recurring contract to be retrieved. + + + The recurring.contract must be set to `PAYOUT`' + $ref: '#/components/schemas/Recurring' + selectedBrand: + x-addedInVersion: '24' + description: 'The name of the brand to make a payout to. + + + For Paysafecard it must be set to `paysafecard`.' + type: string + shopperEmail: + description: The shopper's email address. + type: string + shopperName: + x-addedInVersion: '24' + description: 'The shopper''s name. + + + When the `entityType` is `Company`, the `shopperName.lastName` must contain + the company name.' + $ref: '#/components/schemas/Name' + shopperReference: + description: The shopper's reference for the payment transaction. + type: string + socialSecurityNumber: + x-addedInVersion: '24' + description: The shopper's social security number. + type: string + telephoneNumber: + x-addedInVersion: '52' + description: The shopper's phone number. + type: string + required: + - merchantAccount + - shopperEmail + - shopperReference + - recurring + - dateOfBirth + - nationality + - entityType + StoreDetailResponse: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular response. + type: object + pspReference: + description: A new reference to uniquely identify this request. + type: string + recurringDetailReference: + description: The token which you can use later on for submitting the payout. + type: string + resultCode: + description: The result code of the transaction. `Success` indicates that + the details were stored successfully. + type: string + required: + - pspReference + - recurringDetailReference + - resultCode + SubmitRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular request. + type: object + amount: + description: A container object for the payable amount information of the + transaction. + $ref: '#/components/schemas/Amount' + dateOfBirth: + x-addedInVersion: '24' + description: "The date of birth.\nFormat: ISO-8601; example: YYYY-MM-DD\n\ + \nFor Paysafecard it must be the same as used when registering the Paysafecard\ + \ account.\n\n> This field is mandatory for natural persons. \n> This\ + \ field is required to update the existing `dateOfBirth` that is associated\ + \ with this recurring contract." + format: date-time + type: string + entityType: + x-addedInVersion: '24' + description: 'The type of the entity the payout is processed for. + + + Allowed values: + + * NaturalPerson + + * Company + + > This field is required to update the existing `entityType` that is associated + with this recurring contract.' + enum: + - NaturalPerson + - Company + type: string + fraudOffset: + description: An integer value that is added to the normal fraud score. The + value can be either positive or negative. + format: int32 + type: integer + merchantAccount: + description: The merchant account identifier you want to process the transaction + request with. + type: string + nationality: + x-addedInVersion: '24' + description: 'The shopper''s nationality. + + + A valid value is an ISO 2-character country code (e.g. ''NL''). + + + > This field is required to update the existing nationality that is associated + with this recurring contract.' + type: string + recurring: + description: 'A container for the type of recurring contract to be retrieved. + + + The `recurring.contract` must be set to "PAYOUT".' + $ref: '#/components/schemas/Recurring' + reference: + description: The merchant reference for this payout. This reference will + be used in all communication to the merchant about the status of the payout. + Although it is a good idea to make sure it is unique, this is not a requirement. + type: string + selectedRecurringDetailReference: + description: 'This is the `recurringDetailReference` you want to use for + this payout. + + + You can use the value LATEST to select the most recently used recurring + detail.' + type: string + shopperEmail: + description: The shopper's email address. + type: string + shopperName: + x-addedInVersion: '24' + description: 'The shopper''s name. + + + In case the `entityType` is `Company`, the `shopperName.lastName` must + contain the company name. + + + > This field is required to update the existing `shopperName` associated + with a recurring contract.' + $ref: '#/components/schemas/Name' + shopperReference: + description: The shopper's reference for the payout transaction. + type: string + shopperStatement: + x-addedInVersion: '2' + description: The description of this payout. This description is shown on + the bank statement of the shopper (if this is supported by the chosen + payment method). + type: string + socialSecurityNumber: + x-addedInVersion: '24' + description: The shopper's social security number. + type: string + required: + - merchantAccount + - reference + - amount + - shopperEmail + - shopperReference + - recurring + - selectedRecurringDetailReference + SubmitResponse: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be returned + in a particular response. + type: object + pspReference: + description: A new reference to uniquely identify this request. + type: string + refusalReason: + description: In case of refusal, an informational message for the reason. + type: string + resultCode: + description: 'The response: + + * In case of success, it is `payout-submit-received`. + + * In case of an error, an informational message is returned.' + type: string + required: + - pspReference + - resultCode + ThreeDS2RequestData: + properties: + acctInfo: + x-addedInVersion: '68' + description: "Additional information about the Cardholder\u2019s account\ + \ provided by the 3DS Requestor." + $ref: '#/components/schemas/AcctInfo' + acctType: + x-addedInVersion: '68' + description: "Indicates the type of account. For example, for a multi-account\ + \ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\ + \ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit" + enum: + - '01' + - '02' + - '03' + maxLength: 2 + minLength: 2 + type: string + acquirerBIN: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The acquiring BIN enrolled for 3D Secure 2. This string should match the + value that you will use in the authorisation. Use 123456 on the Test platform. + type: string + acquirerMerchantID: + x-addedInVersion: '49' + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. + This string should match the value that you will use in the authorisation. + Use 123456 on the Test platform. + type: string + addrMatch: + x-addedInVersion: '68' + description: "Indicates whether the Cardholder Shipping Address and Cardholder\ + \ Billing Address are the same. Allowed values:\n* **Y** \u2014 Shipping\ + \ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\ + \ not match Billing Address." + enum: + - Y + - N + maxLength: 1 + minLength: 1 + type: string + authenticationOnly: + deprecated: true + x-deprecatedInVersion: '50' + x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. + default: false + description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), + and not the payment authorisation. + type: boolean + challengeIndicator: + deprecated: true + x-deprecatedInVersion: '68' + x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead. + description: 'Possibility to specify a preference for receiving a challenge + from the issuer. + + Allowed values: + + * `noPreference` + + * `requestNoChallenge` + + * `requestChallenge` + + * `requestChallengeAsMandate` + + ' + enum: + - noPreference + - requestNoChallenge + - requestChallenge + - requestChallengeAsMandate + type: string + deviceChannel: + description: 'The environment of the shopper. + + Allowed values: + + * `app` + + * `browser`' + type: string + deviceRenderOptions: + description: 'Display options for the 3D Secure 2 SDK. + + Optional and only for `deviceChannel` **app**.' + $ref: '#/components/schemas/DeviceRenderOptions' + homePhone: + x-addedInVersion: '68' + description: The home phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + mcc: + x-addedInVersion: '49' + description: Required for merchants that have been enrolled for 3D Secure + 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` + is registered at the scheme. + type: string + merchantName: + x-addedInVersion: '49' + description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). + The merchant name that the issuer presents to the shopper if they get + a challenge. We recommend to use the same value that you will use in the + authorization. Maximum length is 40 characters. + + > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). + Use this field if you are enrolled for 3D Secure 2 with us and want to + override the merchant name already configured on your account.' + type: string + messageVersion: + default: 2.1.0 + description: The `messageVersion` value indicating the 3D Secure 2 protocol + version. + type: string + mobilePhone: + x-addedInVersion: '68' + description: The mobile phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + notificationURL: + description: URL to where the issuer should send the `CRes`. Required if + you are not using components for `channel` **Web** or if you are using + classic integration `deviceChannel` **browser**. + type: string + payTokenInd: + x-addedInVersion: '68' + description: Value **true** indicates that the transaction was de-tokenised + prior to being received by the ACS. + type: boolean + paymentAuthenticationUseCase: + x-addedInVersion: '68' + description: Indicates the type of payment for which an authentication is + requested (message extension) + type: string + purchaseInstalData: + x-addedInVersion: '68' + description: "Indicates the maximum number of authorisations permitted for\ + \ instalment payments. Length: 1\u20133 characters." + maxLength: 3 + minLength: 1 + type: string + recurringExpiry: + x-addedInVersion: '68' + description: 'Date after which no further authorisations shall be performed. + Format: YYYYMMDD' + type: string + recurringFrequency: + x-addedInVersion: '68' + description: 'Indicates the minimum number of days between authorisations. + Maximum length: 4 characters.' + maxLength: 4 + type: string + sdkAppID: + description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEncData: + description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. + + Required for `deviceChannel` set to **app**.' + type: string + sdkEphemPubKey: + description: 'The `sdkEphemPubKey` value as received from the 3D Secure + 2 SDK. + + Required for `deviceChannel` set to **app**.' + $ref: '#/components/schemas/SDKEphemPubKey' + sdkMaxTimeout: + default: 60 + description: 'The maximum amount of time in minutes for the 3D Secure 2 + authentication process. + + Optional and only for `deviceChannel` set to **app**. Defaults to **60** + minutes.' + format: int32 + type: integer + sdkReferenceNumber: + description: 'The `sdkReferenceNumber` value as received from the 3D Secure + 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkTransID: + description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. + + Only for `deviceChannel` set to **app**.' + type: string + sdkVersion: + x-addedInVersion: '40' + description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ + \ set to **app**." + type: string + threeDSCompInd: + description: Completion indicator for the device fingerprinting. + type: string + threeDSRequestorAuthenticationInd: + x-addedInVersion: '68' + description: Indicates the type of Authentication request. + type: string + threeDSRequestorAuthenticationInfo: + x-addedInVersion: '68' + description: Information about how the 3DS Requestor authenticated the cardholder + before or during the transaction + $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo' + threeDSRequestorChallengeInd: + x-addedInVersion: '68' + description: Indicates whether a challenge is requested for this transaction. + type: string + threeDSRequestorID: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor identifier assigned by the Directory + Server when you enrol for 3D Secure 2. + type: string + threeDSRequestorName: + description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) + for Visa. Unique 3D Secure requestor name assigned by the Directory Server + when you enrol for 3D Secure 2. + type: string + threeDSRequestorPriorAuthenticationInfo: + x-addedInVersion: '68' + description: Information about how the 3DS Requestor authenticated the cardholder + as part of a previous 3DS transaction. + $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo' + threeDSRequestorURL: + description: URL of the (customer service) website that will be shown to + the shopper in case of technical errors during the 3D Secure 2 process. + type: string + transType: + x-addedInVersion: '68' + description: "Identifies the type of transaction being authenticated. Length:\ + \ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\ + * **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\ + \ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\ + \ Load" + enum: + - '01' + - '03' + - '10' + - '11' + - '28' + maxLength: 2 + minLength: 2 + type: string + transactionType: + x-addedInVersion: '50' + description: Identify the type of the transaction being authenticated. + enum: + - goodsOrServicePurchase + - checkAcceptance + - accountFunding + - quasiCashTransaction + - prepaidActivationAndLoad + type: string + whiteListStatus: + x-addedInVersion: '49' + description: The `whiteListStatus` value returned from a previous 3D Secure + 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. + type: string + workPhone: + x-addedInVersion: '68' + description: The work phone number provided by the Cardholder. + $ref: '#/components/schemas/Phone' + required: + - deviceChannel + ThreeDSRequestorAuthenticationInfo: + properties: + threeDSReqAuthData: + description: 'Data that documents and supports a specific authentication + process. Maximum length: 2048 bytes.' + type: string + threeDSReqAuthMethod: + description: "Mechanism used by the Cardholder to authenticate to the 3DS\ + \ Requestor. Allowed values:\n* **01** \u2014 No 3DS Requestor authentication\ + \ occurred (for example, cardholder \u201Clogged in\u201D as guest).\n\ + * **02** \u2014 Login to the cardholder account at the 3DS Requestor system\ + \ using 3DS Requestor\u2019s own credentials.\n* **03** \u2014 Login to\ + \ the cardholder account at the 3DS Requestor system using federated ID.\n\ + * **04** \u2014 Login to the cardholder account at the 3DS Requestor system\ + \ using issuer credentials.\n* **05** \u2014 Login to the cardholder account\ + \ at the 3DS Requestor system using third-party authentication.\n* **06**\ + \ \u2014 Login to the cardholder account at the 3DS Requestor system using\ + \ FIDO Authenticator." + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + - '06' + maxLength: 2 + minLength: 2 + type: string + threeDSReqAuthTimestamp: + description: 'Date and time in UTC of the cardholder authentication. Format: + YYYYMMDDHHMM' + maxLength: 12 + minLength: 12 + type: string + ThreeDSRequestorPriorAuthenticationInfo: + properties: + threeDSReqPriorAuthData: + description: 'Data that documents and supports a specific authentication + process. Maximum length: 2048 bytes.' + type: string + threeDSReqPriorAuthMethod: + description: "Mechanism used by the Cardholder to previously authenticate\ + \ to the 3DS Requestor. Allowed values:\n* **01** \u2014 Frictionless\ + \ authentication occurred by ACS.\n* **02** \u2014 Cardholder challenge\ + \ occurred by ACS.\n* **03** \u2014 AVS verified.\n* **04** \u2014 Other\ + \ issuer methods." + enum: + - '01' + - '02' + - '03' + - '04' + maxLength: 2 + minLength: 2 + type: string + threeDSReqPriorAuthTimestamp: + description: 'Date and time in UTC of the prior cardholder authentication. + Format: YYYYMMDDHHMM' + maxLength: 12 + minLength: 12 + type: string + threeDSReqPriorRef: + description: 'This data element provides additional information to the ACS + to determine the best approach for handing a request. This data element + contains an ACS Transaction ID for a prior authenticated transaction. + For example, the first recurring transaction that was authenticated with + the cardholder. Length: 30 characters.' + maxLength: 36 + minLength: 36 + type: string + ThreeDSecureData: + properties: + authenticationResponse: + description: 'In 3D Secure 1, the authentication response if the shopper + was redirected. + + + In 3D Secure 2, this is the `transStatus` from the challenge result. If + the transaction was frictionless, omit this parameter.' + enum: + - Y + - N + - U + - A + type: string + cavv: + description: The cardholder authentication value (base64 encoded, 20 bytes + in a decoded form). + format: byte + type: string + cavvAlgorithm: + description: The CAVV algorithm used. Include this only for 3D Secure 1. + 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 + directoryResponse: + description: 'In 3D Secure 1, this is the enrollment response from the 3D + directory server. + + + In 3D Secure 2, this is the `transStatus` from the `ARes`.' + enum: + - A + - C + - D + - I + - N + - R + - U + - Y + type: string + dsTransID: + x-addedInVersion: '40' + description: Supported for 3D Secure 2. The unique transaction identifier + assigned by the Directory Server (DS) to identify a single transaction. + type: string + eci: + description: The electronic commerce indicator. + type: string + riskScore: + x-addedInVersion: '67' + description: Risk score calculated by Directory Server (DS). Required for + Cartes Bancaires integrations. + type: string + threeDSVersion: + x-addedInVersion: '40' + description: The version of the 3D Secure protocol. + type: string + tokenAuthenticationVerificationValue: + x-addedInVersion: '68' + description: Network token authentication verification value (TAVV). The + network token cryptogram. + format: byte + type: string + transStatusReason: + x-addedInVersion: '67' + 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 + xid: + description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, + 20 bytes in a decoded form). + format: byte + type: string + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: + generic-400: + summary: Response code 400. Bad Request. + value: + status: 400 + errorCode: '702' + message: 'Unexpected input: I' + errorType: validation + post-confirmThirdParty-confirmThirdParty: + summary: Confirm a payout + description: Confirm a previously submitted payout + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + originalReference: '9913140798220028' + post-confirmThirdParty-confirmThirdParty-200: + summary: Example response for request 'confirmThirdParty' + value: + pspReference: 991617894325358C + response: '[payout-confirm-received]' + post-declineThirdParty-declineThirdParty: + summary: Cancel a payout + description: Cancel a previously submitted payout + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + originalReference: '9913140798220028' + post-declineThirdParty-declineThirdParty-200: + summary: Example response for request 'declineThirdParty' + value: + pspReference: 991617894325360J + response: '[payout-decline-received]' + post-payout-payout-b2c: + summary: Instant card payout (B2C) + description: Pay out to your sellers, customers, freelancers, etc + value: + amount: + value: 2500 + currency: USD + card: + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + billingAddress: + houseNumberOrName: '121' + street: Populierenlaan + city: Beverly Hills + postalCode: '90210' + stateOrProvince: CA + country: US + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: P9999999999999999 + shopperName: + firstName: John + lastName: Smith + dateOfBirth: '1990-01-01' + nationality: NL + post-payout-payout-p2p: + summary: Instant card payout (P2P) + description: Facilitate the transfer of money between two individuals + value: + amount: + value: 2500 + currency: USD + card: + number: '4111111111111111' + expiryMonth: '03' + expiryYear: '2030' + holderName: John Smith + fundSource: + additionalData: + fundingSource: DEBIT + billingAddress: + country: US + postalCode: '90210' + city: Beverly Hills + card: + expiryMonth: '03' + expiryYear: '2030' + holderName: Payer Name + number: '4400000000000008' + shopperName: + firstName: Payer + lastName: Name + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: P9999999999999999 + shopperName: + firstName: John + lastName: Smith + shopperStatement: Payer Name + dateOfBirth: '1990-01-01' + nationality: NL + post-storeDetail-storeDetail: + summary: Store payout details + description: Store payment details under the PAYOUT recurring contract + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + bank: + bankName: AbnAmro + bic: ABNANL2A + countryCode: NL + iban: NL32ABNA0515071439 + ownerName: Adyen + bankCity: Amsterdam + taxId: bankTaxId + shopperEmail: shopper@email.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperName: + firstName: Adyen + gender: MALE + lastName: Test + dateOfBirth: '1990-01-01' + entityType: Company + nationality: NL + billingAddress: + houseNumberOrName: '17' + street: Teststreet 1 + city: Amsterdam + stateOrProvince: NY + country: US + postalCode: '12345' + post-storeDetail-storeDetail-200: + summary: Example response for request 'storeDetail' + value: + pspReference: 991617894326362D + recurringDetailReference: '9916178936754752' + resultCode: Success + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty: + summary: Submit a payout and stores details + description: Submit a payout and stores its details for subsequent payouts + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: RECURRING,PAYOUT + amount: + value: 2000 + currency: EUR + bank: + bankName: Wirecard + iban: DE87123456781234567890 + countryCode: DE + ownerName: Simon Hopper + reference: Your Reference Here + shopperEmail: s.hopper@test.com + shopperIP: 61.294.12.12 + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperName: + firstName: Adyen + gender: MALE + lastName: Test + dateOfBirth: '1990-01-01' + entityType: Company + nationality: NL + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Neteller: + summary: Submit a payout to Neteller + description: Submit a payout to Neteller and stores its details for subsequent + payouts + value: + amount: + currency: EUR + value: 100 + selectedBrand: neteller + additionalData: + tokenDataType: Neteller + account: myNetellerAccount + shopperName: + firstName: Test + gender: FEMALE + lastName: Test2 + dateOfBirth: '1982-07-17' + entityType: NaturalPerson + nationality: NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: Test Payout + shopperEmail: test@company.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-PayPal: + summary: Submit a payout to PayPal + description: Submit a payout to PayPal and stores its details for subsequent + payouts + value: + amount: + currency: EUR + value: 1750 + selectedBrand: paypal + additionalData: + tokenDataType: PayPal + emailId: EmailUsedForPayPalAccount@example.com + paypal.payerId: AK5HCWWRUV2KL + shopperName: + firstName: Test + gender: FEMALE + lastName: Test2 + dateOfBirth: '1982-07-17' + entityType: NaturalPerson + nationality: NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: Test Payout + shopperEmail: test@company.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Paysafecard: + summary: Submit a payout to Paysafecard + description: Submit a payout to Paysafecard and stores its details for subsequent + payouts + value: + amount: + currency: EUR + value: 1000 + selectedBrand: paysafecard + additionalData: + emailId: EmailUsedForPaysafecardAccount@example.com + shopperName: + firstName: Test + gender: MALE + lastName: Test2 + dateOfBirth: '1982-07-17' + entityType: NaturalPerson + nationality: NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: Test Payout + shopperEmail: test@company.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperIP: 61.294.12.12 + post-storeDetailAndSubmitThirdParty-storeDetailAndSubmitThirdParty-Skrill: + summary: Submit a payout to Skrill + description: Submit a payout to Skrill and stores its details for subsequent + payouts + value: + amount: + currency: EUR + value: 100 + selectedBrand: moneybookers + additionalData: + tokenDataType: MoneyBookers + email: name@adyen.com + shopperName: + firstName: Test + gender: FEMALE + lastName: Test2 + dateOfBirth: '1982-07-17' + entityType: NaturalPerson + nationality: NL + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: Test Payout + shopperEmail: test@company.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + post-submitThirdParty-submitThirdParty: + summary: Submit a payout + description: Submit a payout using the previously stored payment details + value: + amount: + currency: EUR + value: '1000' + merchantAccount: YOUR_MERCHANT_ACCOUNT + recurring: + contract: PAYOUT + reference: PayoutPayment-0001 + shopperEmail: shopper@email.com + shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j + shopperName: + firstName: Adyen + gender: MALE + lastName: Test + dateOfBirth: '1990-01-01' + entityType: Company + nationality: NL + selectedRecurringDetailReference: LATEST diff --git a/yaml/RecurringService-v67.yaml b/yaml/RecurringService-v67.yaml new file mode 100644 index 0000000..4632e11 --- /dev/null +++ b/yaml/RecurringService-v67.yaml @@ -0,0 +1,873 @@ +openapi: 3.1.0 +servers: +- url: https://pal-test.adyen.com/pal/servlet/Recurring/v67 +info: + version: '67' + x-publicVersion: true + title: Adyen Recurring API + description: 'The Recurring APIs allow you to manage and remove your tokens or saved + payment details. Tokens should be created with validation during a payment request. + + + For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). + + ## Authentication + + To connect to the Recurring API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Recurring API supports versioning of its endpoints through a version suffix in + the endpoint URL. This suffix has the following format: "vXX", where XX is the + version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Recurring/v67/disable + + ```' + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- General +paths: + /disable: + post: + tags: + - General + summary: Disables stored payment details. + description: 'Disables stored payment details to stop charging a shopper with + this particular recurring detail ID. + + + For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).' + operationId: post-disable + x-groupName: General + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + disableARecurringContract: + $ref: '#/components/examples/post-disable-disableARecurringContract' + schema: + $ref: '#/components/schemas/DisableRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DisableResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /listRecurringDetails: + post: + tags: + - General + summary: Retrieves stored payment details for a shopper. + description: 'Lists the stored payment details for a shopper, if there are any + available. The recurring detail ID can be used with a regular authorisation + request to charge the shopper. A summary of the payment detail is returned + for presentation to the shopper. + + + For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).' + operationId: post-listRecurringDetails + x-groupName: General + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + listAllRecurringDetails: + $ref: '#/components/examples/post-listRecurringDetails-listAllRecurringDetails' + schema: + $ref: '#/components/schemas/RecurringDetailsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RecurringDetailsResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /notifyShopper: + post: + tags: + - General + summary: Notify the shopper for upcoming recurring payment + description: Trigger notification to inform the shopper about the upcoming recurring + payment. + operationId: post-notifyShopper + x-groupName: General + x-sortIndex: 0 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyShopperRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyShopperResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /scheduleAccountUpdater: + post: + tags: + - General + summary: Schedules running of the Account Updater. + description: 'When making the API call, you can submit either the credit card + information, or the recurring detail reference and the shopper reference: + + * If the card information is provided, all the sub-fields for `card` are mandatory. + + * If the recurring detail reference is provided, the fields for `shopperReference` + and `selectedRecurringDetailReference` are mandatory.' + x-addedInVersion: '4' + operationId: post-scheduleAccountUpdater + x-groupName: General + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + scheduleAccountUpdaterWithCardData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData' + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData' + schema: + $ref: '#/components/schemas/ScheduleAccountUpdaterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleAccountUpdaterResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. +components: + schemas: + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + 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 + BankAccount: + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCity: + x-addedInVersion: '18' + description: The bank city. + type: string + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. + type: string + bankName: + description: The name of the bank. + type: string + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. + type: string + countryCode: + description: 'Country code where the bank is located. + + + A valid value is an ISO two-character country code (e.g. ''NL'').' + type: string + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + taxId: + x-addedInVersion: '18' + description: The bank account holder's tax ID. + type: string + Card: + properties: + cvc: + description: "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid)\ + \ (1-20 characters). Depending on the card brand, it is known also as:\n\ + * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n>\ + \ If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce),\ + \ the CVC code is present in the encrypted data. You must never post the\ + \ card details to the server.\n> This field must be always present in\ + \ a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n\ + > When this value is returned in a response, it is always empty because\ + \ it is not stored." + maxLength: 20 + minLength: 1 + type: string + expiryMonth: + description: 'The card expiry month. + + Format: 2 digits, zero-padded for single digits. For example: + + * 03 = March + + * 11 = November' + maxLength: 2 + minLength: 1 + type: string + expiryYear: + description: 'The card expiry year. + + Format: 4 digits. For example: 2020' + maxLength: 4 + minLength: 4 + type: string + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 + type: string + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 + type: string + number: + description: 'The card number (4-19 characters). Do not use any separators. + + When this value is returned in a response, only the last 4 digits of the + card number are returned.' + maxLength: 19 + minLength: 4 + type: string + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 + type: string + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 + type: string + required: + - number + - expiryMonth + - expiryYear + - holderName + DisableRequest: + properties: + contract: + x-addedInVersion: '3' + description: 'Specify the contract if you only want to disable a specific + use. + + + This field can be set to one of the following values, or to their combination + (comma-separated): + + * ONECLICK + + * RECURRING + + * PAYOUT' + type: string + merchantAccount: + description: The merchant account identifier with which you want to process + the transaction. + type: string + recurringDetailReference: + description: 'The ID that uniquely identifies the recurring detail reference. + + + If it is not provided, the whole recurring contract of the `shopperReference` + will be disabled, which includes all recurring details.' + type: string + shopperReference: + description: 'The ID that uniquely identifies the shopper. + + + This `shopperReference` must be the same as the `shopperReference` used + in the initial payment.' + type: string + required: + - merchantAccount + - shopperReference + DisableResult: + properties: + response: + description: Depending on whether a specific recurring detail was in the + request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled]. + type: string + Name: + properties: + firstName: + description: The first name. + type: string + lastName: + description: The last name. + type: string + required: + - firstName + - lastName + NotifyShopperRequest: + properties: + amount: + description: The amount of the upcoming payment. + $ref: '#/components/schemas/Amount' + billingDate: + description: Date on which the subscription amount will be debited from + the shopper. In YYYY-MM-DD format + type: string + billingSequenceNumber: + description: Sequence of the debit. Depends on Frequency and Billing Attempts + Rule. + type: string + displayedReference: + description: Reference of Pre-debit notification that is displayed to the + shopper. Optional field. Maps to reference if missing + type: string + merchantAccount: + description: The merchant account identifier with which you want to process + the transaction. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + reference: + description: Pre-debit notification reference sent by the merchant. This + is a mandatory field + type: string + shopperReference: + description: 'The ID that uniquely identifies the shopper. + + + This `shopperReference` must be the same as the `shopperReference` used + in the initial payment.' + type: string + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + required: + - merchantAccount + - shopperReference + - amount + - reference + NotifyShopperResult: + properties: + displayedReference: + description: Reference of Pre-debit notification that is displayed to the + shopper + type: string + message: + description: A simple description of the `resultCode`. + type: string + pspReference: + description: The unique reference that is associated with the request. + type: string + reference: + description: Reference of Pre-debit notification sent in my the merchant + type: string + resultCode: + description: The code indicating the status of notification. + type: string + shopperNotificationReference: + description: The unique reference for the request sent downstream. + type: string + storedPaymentMethodId: + description: This is the recurringDetailReference returned in the response + when token was created + type: string + Recurring: + properties: + contract: + description: "The type of recurring contract to be used.\nPossible values:\n\ + * `ONECLICK` \u2013 Payment details can be used to initiate a one-click\ + \ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\ + * `RECURRING` \u2013 Payment details can be used without the card security\ + \ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\ + * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\ + \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\ + \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)." + enum: + - ONECLICK + - RECURRING + - PAYOUT + type: string + recurringDetailName: + description: A descriptive name for this detail. + type: string + recurringExpiry: + x-addedInVersion: '40' + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time + type: string + recurringFrequency: + x-addedInVersion: '40' + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + tokenService: + x-addedInVersion: '25' + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE + type: string + RecurringDetail: + properties: + additionalData: + x-addedInVersion: '5' + additionalProperties: + type: string + description: 'This field contains additional data, which may be returned + in a particular response. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + alias: + x-addedInVersion: '4' + description: 'The alias of the credit card number. + + + Applies only to recurring contracts storing credit card details' + type: string + aliasType: + x-addedInVersion: '4' + description: 'The alias type of the credit card number. + + + Applies only to recurring contracts storing credit card details.' + type: string + bank: + description: A container for bank account data. + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '4' + description: The billing address. + $ref: '#/components/schemas/Address' + card: + description: A container for card data. + $ref: '#/components/schemas/Card' + contractTypes: + x-addedInVersion: '12' + description: Types of recurring contracts. + items: + type: string + type: array + creationDate: + description: The date when the recurring details were created. + format: date-time + type: string + firstPspReference: + x-addedInVersion: '4' + description: The `pspReference` of the first recurring payment that created + the recurring detail. + type: string + name: + description: An optional descriptive name for this recurring detail. + type: string + paymentMethodVariant: + x-addedInVersion: '2' + description: The type or sub-brand of a payment method used, e.g. Visa + Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + type: string + recurringDetailReference: + description: The reference that uniquely identifies the recurring detail. + type: string + shopperName: + x-addedInVersion: '4' + description: The name of the shopper. + $ref: '#/components/schemas/Name' + socialSecurityNumber: + x-addedInVersion: '4' + description: A shopper's social security number (only in countries where + it is legal to collect). + type: string + variant: + description: "The payment method, such as \u201Cmc\", \"visa\", \"ideal\"\ + , \"paypal\"." + type: string + required: + - recurringDetailReference + - variant + RecurringDetailsRequest: + properties: + merchantAccount: + description: The merchant account identifier you want to process the (transaction) + request with. + type: string + recurring: + description: 'A container for the type of a recurring contract to be retrieved. + + + The contract value needs to match the contract value submitted in the + payment transaction used to create a recurring contract. + + However, if `ONECLICK,RECURRING` is the original contract definition in + the initial payment, then `contract` should take either `ONECLICK` or + `RECURRING`, depending on whether or not you want the shopper to enter + their card''s security code when they finalize their purchase.' + $ref: '#/components/schemas/Recurring' + shopperReference: + description: The reference you use to uniquely identify the shopper (e.g. + user ID or account ID). + type: string + required: + - merchantAccount + - shopperReference + RecurringDetailsResult: + properties: + creationDate: + description: The date when the recurring details were created. + format: date-time + type: string + details: + description: Payment details stored for recurring payments. + items: + $ref: '#/components/schemas/RecurringDetail' + type: array + lastKnownShopperEmail: + description: The most recent email for this shopper (if available). + type: string + shopperReference: + description: The reference you use to uniquely identify the shopper (e.g. + user ID or account ID). + type: string + ScheduleAccountUpdaterRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular request. + type: object + card: + description: 'A container for credit card data. + + + Optional if `shopperReference` and `selectedRecurringDetailReference` + are provided.' + $ref: '#/components/schemas/Card' + merchantAccount: + description: Account of the merchant. + type: string + reference: + description: A reference that merchants can apply for the call. + type: string + selectedRecurringDetailReference: + description: 'The selected detail recurring reference. + + + Optional if `card` is provided.' + type: string + shopperReference: + description: 'The reference of the shopper that owns the recurring contract. + + + Optional if `card` is provided.' + type: string + required: + - merchantAccount + - reference + ScheduleAccountUpdaterResult: + properties: + pspReference: + description: Adyen's 16-character unique reference associated with the transaction. + This value is globally unique; quote it when communicating with us about + this request. + type: string + result: + description: The result of scheduling an Account Updater. If scheduling + was successful, this field returns **Success**; otherwise it contains + the error message. + type: string + required: + - pspReference + - result + ServiceError: + properties: + additionalData: + x-addedInVersion: '46' + additionalProperties: + type: string + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' + type: object + errorCode: + description: The error code mapped to the error message. + type: string + errorType: + description: The category of the error. + type: string + message: + description: A short explanation of the issue. + type: string + pspReference: + description: The PSP reference of the payment. + type: string + status: + description: The HTTP response status. + format: int32 + type: integer + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: + post-disable-disableARecurringContract: + summary: Disable a recurring contract + value: + shopperReference: YOUR_UNIQUE_SHOPPER_ID + recurringDetailReference: '8314442372419167' + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-listRecurringDetails-listAllRecurringDetails: + summary: List all recurring details + value: + recurring: + contract: RECURRING + shopperReference: YOUR_UNIQUE_SHOPPER_ID + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData: + summary: Schedule AccountUpdater with card data + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: YOUR_REFERENCE + card: + expiryMonth: '03' + expiryYear: '2030' + holderName: Adyen Test + number: '4111111111111111' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData: + summary: Schedule AccountUpdater with token data + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: YOUR_REFERENCE + shopperReference: YOUR_UNIQUE_SHOPPER_ID + selectedRecurringDetailReference: '8814232895168272' diff --git a/yaml/RecurringService-v68.yaml b/yaml/RecurringService-v68.yaml new file mode 100644 index 0000000..762c381 --- /dev/null +++ b/yaml/RecurringService-v68.yaml @@ -0,0 +1,882 @@ +openapi: 3.1.0 +servers: +- url: https://pal-test.adyen.com/pal/servlet/Recurring/v68 +info: + version: '68' + x-publicVersion: true + title: Adyen Recurring API + description: 'The Recurring APIs allow you to manage and remove your tokens or saved + payment details. Tokens should be created with validation during a payment request. + + + For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). + + ## Authentication + + To connect to the Recurring API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Recurring API supports versioning of its endpoints through a version suffix in + the endpoint URL. This suffix has the following format: "vXX", where XX is the + version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable + + ```' + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- General +paths: + /disable: + post: + tags: + - General + summary: Disables stored payment details. + description: 'Disables stored payment details to stop charging a shopper with + this particular recurring detail ID. + + + For more information, refer to [Disable stored details](https://docs.adyen.com/classic-integration/recurring-payments/disable-stored-details/).' + operationId: post-disable + x-groupName: General + x-sortIndex: 2 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + disableARecurringContract: + $ref: '#/components/examples/post-disable-disableARecurringContract' + schema: + $ref: '#/components/schemas/DisableRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DisableResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /listRecurringDetails: + post: + tags: + - General + summary: Retrieves stored payment details for a shopper. + description: 'Lists the stored payment details for a shopper, if there are any + available. The recurring detail ID can be used with a regular authorisation + request to charge the shopper. A summary of the payment detail is returned + for presentation to the shopper. + + + For more information, refer to [Retrieve stored details](https://docs.adyen.com/classic-integration/recurring-payments/retrieve-stored-details/).' + operationId: post-listRecurringDetails + x-groupName: General + x-sortIndex: 1 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + listAllRecurringDetails: + $ref: '#/components/examples/post-listRecurringDetails-listAllRecurringDetails' + schema: + $ref: '#/components/schemas/RecurringDetailsRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RecurringDetailsResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /notifyShopper: + post: + tags: + - General + summary: Notify the shopper for upcoming recurring payment + description: Trigger notification to inform the shopper about the upcoming recurring + payment. + operationId: post-notifyShopper + x-groupName: General + x-sortIndex: 0 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyShopperRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyShopperResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. + /scheduleAccountUpdater: + post: + tags: + - General + summary: Schedules running of the Account Updater. + description: 'When making the API call, you can submit either the credit card + information, or the recurring detail reference and the shopper reference: + + * If the card information is provided, all the sub-fields for `card` are mandatory. + + * If the recurring detail reference is provided, the fields for `shopperReference` + and `selectedRecurringDetailReference` are mandatory.' + x-addedInVersion: '4' + operationId: post-scheduleAccountUpdater + x-groupName: General + x-sortIndex: 3 + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + examples: + scheduleAccountUpdaterWithCardData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData' + scheduleAccountUpdaterWithTokenData: + $ref: '#/components/examples/post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData' + schema: + $ref: '#/components/schemas/ScheduleAccountUpdaterRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleAccountUpdaterResult' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. +components: + schemas: + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + 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 + BankAccount: + properties: + bankAccountNumber: + description: The bank account number (without separators). + type: string + bankCity: + x-addedInVersion: '18' + description: The bank city. + type: string + bankLocationId: + description: The location id of the bank. The field value is `nil` in most + cases. + type: string + bankName: + description: The name of the bank. + type: string + bic: + description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) + (BIC) is the SWIFT address assigned to a bank. The field value is `nil` + in most cases. + type: string + countryCode: + description: 'Country code where the bank is located. + + + A valid value is an ISO two-character country code (e.g. ''NL'').' + type: string + iban: + description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) + (IBAN). + type: string + ownerName: + description: "The name of the bank account holder.\nIf you submit a name\ + \ with non-Latin characters, we automatically replace some of them with\ + \ corresponding Latin characters to meet the FATF recommendations. For\ + \ example:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ + \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ + \ accept '\xF8'.\nAfter replacement, the ownerName must have at least\ + \ three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them\ + \ must be a valid Latin character (A-Z, a-z). For example:\n* John17 -\ + \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ + > If provided details don't match the required format, the response returns\ + \ the error message: 203 'Invalid bank account holder name'." + type: string + taxId: + x-addedInVersion: '18' + description: The bank account holder's tax ID. + type: string + Card: + properties: + cvc: + description: "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid)\ + \ (1-20 characters). Depending on the card brand, it is known also as:\n\ + * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n>\ + \ If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce),\ + \ the CVC code is present in the encrypted data. You must never post the\ + \ card details to the server.\n> This field must be always present in\ + \ a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n\ + > When this value is returned in a response, it is always empty because\ + \ it is not stored." + maxLength: 20 + minLength: 1 + type: string + expiryMonth: + description: 'The card expiry month. + + Format: 2 digits, zero-padded for single digits. For example: + + * 03 = March + + * 11 = November' + maxLength: 2 + minLength: 1 + type: string + expiryYear: + description: 'The card expiry year. + + Format: 4 digits. For example: 2020' + maxLength: 4 + minLength: 4 + type: string + holderName: + description: The name of the cardholder, as printed on the card. + maxLength: 50 + minLength: 1 + type: string + issueNumber: + description: The issue number of the card (for some UK debit cards only). + maxLength: 2 + minLength: 1 + type: string + number: + description: 'The card number (4-19 characters). Do not use any separators. + + When this value is returned in a response, only the last 4 digits of the + card number are returned.' + maxLength: 19 + minLength: 4 + type: string + startMonth: + description: The month component of the start date (for some UK debit cards + only). + maxLength: 2 + minLength: 1 + type: string + startYear: + description: The year component of the start date (for some UK debit cards + only). + maxLength: 4 + minLength: 4 + type: string + required: + - number + - expiryMonth + - expiryYear + - holderName + DisableRequest: + properties: + contract: + x-addedInVersion: '3' + description: 'Specify the contract if you only want to disable a specific + use. + + + This field can be set to one of the following values, or to their combination + (comma-separated): + + * ONECLICK + + * RECURRING + + * PAYOUT' + type: string + merchantAccount: + description: The merchant account identifier with which you want to process + the transaction. + type: string + recurringDetailReference: + description: 'The ID that uniquely identifies the recurring detail reference. + + + If it is not provided, the whole recurring contract of the `shopperReference` + will be disabled, which includes all recurring details.' + type: string + shopperReference: + description: 'The ID that uniquely identifies the shopper. + + + This `shopperReference` must be the same as the `shopperReference` used + in the initial payment.' + type: string + required: + - merchantAccount + - shopperReference + DisableResult: + properties: + response: + description: Depending on whether a specific recurring detail was in the + request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled]. + type: string + Name: + properties: + firstName: + description: The first name. + type: string + lastName: + description: The last name. + type: string + required: + - firstName + - lastName + NotifyShopperRequest: + properties: + amount: + description: The amount of the upcoming payment. + $ref: '#/components/schemas/Amount' + billingDate: + description: Date on which the subscription amount will be debited from + the shopper. In YYYY-MM-DD format + type: string + billingSequenceNumber: + description: Sequence of the debit. Depends on Frequency and Billing Attempts + Rule. + type: string + displayedReference: + description: Reference of Pre-debit notification that is displayed to the + shopper. Optional field. Maps to reference if missing + type: string + merchantAccount: + description: The merchant account identifier with which you want to process + the transaction. + type: string + recurringDetailReference: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + reference: + description: Pre-debit notification reference sent by the merchant. This + is a mandatory field + type: string + shopperReference: + description: 'The ID that uniquely identifies the shopper. + + + This `shopperReference` must be the same as the `shopperReference` used + in the initial payment.' + type: string + storedPaymentMethodId: + description: This is the `recurringDetailReference` returned in the response + when you created the token. + type: string + required: + - merchantAccount + - shopperReference + - amount + - reference + NotifyShopperResult: + properties: + displayedReference: + description: Reference of Pre-debit notification that is displayed to the + shopper + type: string + message: + description: A simple description of the `resultCode`. + type: string + pspReference: + description: The unique reference that is associated with the request. + type: string + reference: + description: Reference of Pre-debit notification sent in my the merchant + type: string + resultCode: + description: The code indicating the status of notification. + type: string + shopperNotificationReference: + description: The unique reference for the request sent downstream. + type: string + storedPaymentMethodId: + description: This is the recurringDetailReference returned in the response + when token was created + type: string + Recurring: + properties: + contract: + description: "The type of recurring contract to be used.\nPossible values:\n\ + * `ONECLICK` \u2013 Payment details can be used to initiate a one-click\ + \ payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n\ + * `RECURRING` \u2013 Payment details can be used without the card security\ + \ code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n\ + * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\ + \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\ + \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts)." + enum: + - ONECLICK + - RECURRING + - PAYOUT + type: string + recurringDetailName: + description: A descriptive name for this detail. + type: string + recurringExpiry: + x-addedInVersion: '40' + description: Date after which no further authorisations shall be performed. + Only for 3D Secure 2. + format: date-time + type: string + recurringFrequency: + x-addedInVersion: '40' + description: Minimum number of days between authorisations. Only for 3D + Secure 2. + type: string + tokenService: + x-addedInVersion: '25' + description: The name of the token service. + enum: + - VISATOKENSERVICE + - MCTOKENSERVICE + type: string + RecurringDetail: + properties: + additionalData: + x-addedInVersion: '5' + additionalProperties: + type: string + description: 'This field contains additional data, which may be returned + in a particular response. + + + The additionalData object consists of entries, each of which includes + the key and value.' + type: object + alias: + x-addedInVersion: '4' + description: 'The alias of the credit card number. + + + Applies only to recurring contracts storing credit card details' + type: string + aliasType: + x-addedInVersion: '4' + description: 'The alias type of the credit card number. + + + Applies only to recurring contracts storing credit card details.' + type: string + bank: + description: A container for bank account data. + $ref: '#/components/schemas/BankAccount' + billingAddress: + x-addedInVersion: '4' + description: The billing address. + $ref: '#/components/schemas/Address' + card: + description: A container for card data. + $ref: '#/components/schemas/Card' + contractTypes: + x-addedInVersion: '12' + description: Types of recurring contracts. + items: + type: string + type: array + creationDate: + description: The date when the recurring details were created. + format: date-time + type: string + firstPspReference: + x-addedInVersion: '4' + description: The `pspReference` of the first recurring payment that created + the recurring detail. + type: string + name: + description: An optional descriptive name for this recurring detail. + type: string + networkTxReference: + x-addedInVersion: '68' + 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. + + + This contains either the Mastercard Trace ID or the Visa Transaction ID.' + type: string + paymentMethodVariant: + x-addedInVersion: '2' + description: The type or sub-brand of a payment method used, e.g. Visa + Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + type: string + recurringDetailReference: + description: The reference that uniquely identifies the recurring detail. + type: string + shopperName: + x-addedInVersion: '4' + description: The name of the shopper. + $ref: '#/components/schemas/Name' + socialSecurityNumber: + x-addedInVersion: '4' + description: A shopper's social security number (only in countries where + it is legal to collect). + type: string + variant: + description: "The payment method, such as \u201Cmc\", \"visa\", \"ideal\"\ + , \"paypal\"." + type: string + required: + - recurringDetailReference + - variant + RecurringDetailsRequest: + properties: + merchantAccount: + description: The merchant account identifier you want to process the (transaction) + request with. + type: string + recurring: + description: 'A container for the type of a recurring contract to be retrieved. + + + The contract value needs to match the contract value submitted in the + payment transaction used to create a recurring contract. + + However, if `ONECLICK,RECURRING` is the original contract definition in + the initial payment, then `contract` should take either `ONECLICK` or + `RECURRING`, depending on whether or not you want the shopper to enter + their card''s security code when they finalize their purchase.' + $ref: '#/components/schemas/Recurring' + shopperReference: + description: The reference you use to uniquely identify the shopper (e.g. + user ID or account ID). + type: string + required: + - merchantAccount + - shopperReference + RecurringDetailsResult: + properties: + creationDate: + description: The date when the recurring details were created. + format: date-time + type: string + details: + description: Payment details stored for recurring payments. + items: + $ref: '#/components/schemas/RecurringDetail' + type: array + lastKnownShopperEmail: + description: The most recent email for this shopper (if available). + type: string + shopperReference: + description: The reference you use to uniquely identify the shopper (e.g. + user ID or account ID). + type: string + ScheduleAccountUpdaterRequest: + properties: + additionalData: + additionalProperties: + type: string + description: This field contains additional data, which may be required + for a particular request. + type: object + card: + description: 'A container for credit card data. + + + Optional if `shopperReference` and `selectedRecurringDetailReference` + are provided.' + $ref: '#/components/schemas/Card' + merchantAccount: + description: Account of the merchant. + type: string + reference: + description: A reference that merchants can apply for the call. + type: string + selectedRecurringDetailReference: + description: 'The selected detail recurring reference. + + + Optional if `card` is provided.' + type: string + shopperReference: + description: 'The reference of the shopper that owns the recurring contract. + + + Optional if `card` is provided.' + type: string + required: + - merchantAccount + - reference + ScheduleAccountUpdaterResult: + properties: + pspReference: + description: Adyen's 16-character unique reference associated with the transaction. + This value is globally unique; quote it when communicating with us about + this request. + type: string + result: + description: The result of scheduling an Account Updater. If scheduling + was successful, this field returns **Success**; otherwise it contains + the error message. + type: string + required: + - pspReference + - result + ServiceError: + properties: + additionalData: + x-addedInVersion: '46' + additionalProperties: + type: string + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' + type: object + errorCode: + description: The error code mapped to the error message. + type: string + errorType: + description: The category of the error. + type: string + message: + description: A short explanation of the issue. + type: string + pspReference: + description: The PSP reference of the payment. + type: string + status: + description: The HTTP response status. + format: int32 + type: integer + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: + post-disable-disableARecurringContract: + summary: Disable a recurring contract + value: + shopperReference: YOUR_UNIQUE_SHOPPER_ID + recurringDetailReference: '8314442372419167' + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-listRecurringDetails-listAllRecurringDetails: + summary: List all recurring details + value: + recurring: + contract: RECURRING + shopperReference: YOUR_UNIQUE_SHOPPER_ID + merchantAccount: YOUR_MERCHANT_ACCOUNT + post-scheduleAccountUpdater-scheduleAccountUpdaterWithCardData: + summary: Schedule AccountUpdater with card data + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: YOUR_REFERENCE + card: + expiryMonth: '03' + expiryYear: '2030' + holderName: Adyen Test + number: '4111111111111111' + post-scheduleAccountUpdater-scheduleAccountUpdaterWithTokenData: + summary: Schedule AccountUpdater with token data + value: + merchantAccount: YOUR_MERCHANT_ACCOUNT + reference: YOUR_REFERENCE + shopperReference: YOUR_UNIQUE_SHOPPER_ID + selectedRecurringDetailReference: '8814232895168272' diff --git a/yaml/TransferService-v1.yaml b/yaml/TransferService-v1.yaml new file mode 100644 index 0000000..480a7ba --- /dev/null +++ b/yaml/TransferService-v1.yaml @@ -0,0 +1,481 @@ +openapi: 3.1.0 +servers: +- url: https://balanceplatform-api-test.adyen.com/btl/v1 +info: + version: '1' + x-publicVersion: true + title: Balance Platform Transfers API + description: "The Balance Platform Transfers API provides an endpoint that you can\ + \ use to move funds within your balance platform, or to send funds from your balance\ + \ platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments).\n\ + \nFor information on how the API is used in Adyen Issuing, refer to [Manage funds](https://docs.adyen.com/issuing/manage-funds#transfer).\n\ + \n## Authentication\nYour Adyen contact will provide your API credential and an\ + \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ + \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ + \ \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use\ + \ the username and password to connect to the API using basic authentication.\ + \ For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\"\ + :\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Balance\ + \ Platforms Transfers API, you need an additional role for your API credential.\ + \ Transfers must also be enabled for the source balance account. Your Adyen contact\ + \ will set up the roles and permissions for you.\n## Versioning\nThe Balance Platform\ + \ Transfers API supports versioning of its endpoints through a version suffix\ + \ in the endpoint URL. This suffix has the following format: \"vXX\", where XX\ + \ is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/v1\n\ + ```\n## Going live\nWhen going live, your Adyen contact will provide your API\ + \ credential for the live environment. You can then use the username and password\ + \ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v1`.\n\n\ + For more information, refer to our [Going live documentation](https://docs.adyen.com/issuing/integration-checklist#going-live)." + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- General +paths: + /transfers: + post: + tags: + - General + summary: Transfer funds. + description: 'Starts a transfer request to move funds within your balance platform, + or send funds to a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments). + Adyen sends the outcome of the transfer request through webhooks. + + + To use this endpoint, you need an additional role for your API credential + and transfers must be enabled for the source balance account. Your Adyen contact + will set these up for you.' + x-addedInVersion: '1' + operationId: post-transfers + x-groupName: General + x-sortIndex: 0 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferInfoOld' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TransferOld' + description: OK - the request has succeeded. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. +components: + schemas: + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + 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 + BankAccountInfo: + properties: + address: + description: The address of the bank account holder. + $ref: '#/components/schemas/Address' + iban: + description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) + standard. + type: string + ownerName: + description: The name of the bank account holder. + $ref: '#/components/schemas/Name' + Counterparty: + properties: + balanceAccountId: + description: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). + type: string + bankAccount: + description: The bankAccount. + $ref: '#/components/schemas/BankAccountInfo' + merchant: + $ref: '#/components/schemas/MerchantData' + transferInstrumentId: + description: Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/transferInstruments). + type: string + InternalPartyIdentification: + properties: + balanceAccountId: + description: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). + type: string + paymentInstrumentId: + description: Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}). + type: string + InvalidField: + properties: + message: + description: Description of the validation error. + type: string + name: + description: The field that has an invalid value. + type: string + value: + description: The invalid value. + type: string + required: + - name + - value + - message + Link: + properties: + href: + type: string + Links: + properties: + next: + $ref: '#/components/schemas/Link' + prev: + $ref: '#/components/schemas/Link' + MerchantData: + properties: + mcc: + description: The merchant category code. + type: string + merchantId: + description: The merchant identifier. + type: string + nameLocation: + description: Contains the merchant's name and location. + $ref: '#/components/schemas/NameLocation' + Name: + properties: + firstName: + description: The first name. + type: string + fullName: + description: The full name. + type: string + infix: + description: The infix in the name, if any. + type: string + lastName: + description: The last name. + type: string + NameLocation: + properties: + city: + description: The city where the merchant is located. + type: string + country: + description: The country where the merchant is located in [three-letter + country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format. + type: string + countryOfOrigin: + description: The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) + format, used for government-controlled merchants such as embassies. + type: string + name: + description: The name of the merchant's shop or service. + type: string + rawData: + description: The raw data. + type: string + state: + description: The state where the merchant is located. + type: string + PartyIdentification: + properties: + balanceAccountId: + description: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). + type: string + paymentInstrumentId: + description: Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}). + type: string + RestServiceError: + properties: + detail: + description: A human-readable explanation specific to this occurrence of + the problem. + type: string + errorCode: + description: A code that identifies the problem type. + type: string + errorType: + description: A URI that identifies the problem type, which points to human-readable + documentation on this problem type. + type: string + instance: + description: A unique URI that identifies the specific occurrence of the + problem. + type: string + invalidFields: + description: Detailed explanations of each validation error, when applicable. + items: + $ref: '#/components/schemas/InvalidField' + type: array + requestId: + description: A unique reference for the request, essentially same as `pspReference`. + type: string + status: + description: The HTTP status code. + format: int32 + type: integer + title: + description: A short, human-readable summary of the problem type. + type: string + required: + - errorType + - errorCode + - title + - detail + - status + Transaction: + properties: + accountHolderId: + x-addedInVersion: '1' + description: Unique identifier of the account holder. + type: string + amount: + x-addedInVersion: '1' + description: The amount. + $ref: '#/components/schemas/Amount' + balanceAccountId: + x-addedInVersion: '1' + description: Unique identifier of the balance account. + type: string + balancePlatform: + x-addedInVersion: '1' + description: Unique identifier of the balance platform. + type: string + bookingDate: + x-addedInVersion: '1' + description: The date the transaction is booked to balance. + format: date-time + type: string + counterparty: + description: The counterparty of this transaction. + $ref: '#/components/schemas/Counterparty' + createdAt: + x-addedInVersion: '1' + description: The date the transaction is created. + format: date-time + type: string + description: + x-addedInVersion: '1' + description: A human-readable description for the transaction. + type: string + id: + x-addedInVersion: '1' + description: Unique identifier of the transaction. + type: string + instructedAmount: + x-addedInVersion: '1' + description: The originally instructed amount. + $ref: '#/components/schemas/Amount' + paymentInstrumentId: + x-addedInVersion: '1' + description: Unique identifier of the payment instrument that was used for + this transaction. + type: string + reference: + x-addedInVersion: '1' + description: The reference for this transaction. + type: string + referenceForBeneficiary: + x-addedInVersion: '1' + description: The reference for beneficiary. + type: string + status: + x-addedInVersion: '1' + description: "The status of the transaction.\n\n Possible values:\n\n* **pending**:\ + \ the transaction has is still pending.* **booked**: the transaction has\ + \ been booked to balance." + enum: + - booked + - pending + type: string + transferId: + x-addedInVersion: '1' + description: Unique identifier of the related transfer. + type: string + valueDate: + x-addedInVersion: '1' + description: The date the balance of this transfer becomes available. + format: date-time + type: string + required: + - id + - transferId + - balancePlatform + - accountHolderId + - balanceAccountId + - paymentInstrumentId + - amount + - referenceForBeneficiary + - reference + - instructedAmount + - status + - createdAt + - bookingDate + - valueDate + - counterparty + TransactionSearchResponse: + properties: + _links: + $ref: '#/components/schemas/Links' + data: + items: + $ref: '#/components/schemas/Transaction' + type: array + TransferInfoOld: + properties: + amount: + x-addedInVersion: '1' + description: The amount of the transfer. + $ref: '#/components/schemas/Amount' + description: + x-addedInVersion: '1' + description: A human-readable description for the transfer. You can use + alphanumeric characters and hyphens. We recommend sending a maximum of + 140 characters, otherwise the description will be truncated in the webhooks + that you receive about the transfer. + type: string + destination: + x-addedInVersion: '1' + description: Contains information about the resource where funds will be + transferred to. + $ref: '#/components/schemas/PartyIdentification' + reference: + x-addedInVersion: '1' + description: Your unique reference for the transfer. You can use alphanumeric + characters and hyphens. Maximum length 80 characters. + type: string + source: + x-addedInVersion: '1' + description: Contains information about the resource where funds will be + taken from. + $ref: '#/components/schemas/InternalPartyIdentification' + required: + - source + - destination + - amount + TransferOld: + properties: + amount: + x-addedInVersion: '1' + description: The amount of the transfer. + $ref: '#/components/schemas/Amount' + description: + x-addedInVersion: '1' + description: A human-readable description for the transfer. You can use + alphanumeric characters and hyphens. We recommend sending a maximum of + 140 characters, otherwise the description will be truncated in the webhooks + that you receive about the transfer. + type: string + destination: + x-addedInVersion: '1' + description: Contains information about the resource where funds will be + transferred to. + $ref: '#/components/schemas/PartyIdentification' + id: + x-addedInVersion: '1' + description: Unique identifier of the transfer. + type: string + reference: + x-addedInVersion: '1' + description: Your unique reference for the transfer. You can use alphanumeric + characters and hyphens. Maximum length 80 characters. + type: string + refusalReason: + x-addedInVersion: '1' + description: Additional information about the result of the transfer request. + type: string + resultCode: + x-addedInVersion: '1' + description: "The result of the transfer request.\n\n Possible values: **Authorised**,\ + \ **Refused**." + type: string + source: + x-addedInVersion: '1' + description: Contains information about the resource where funds will be + taken from. + $ref: '#/components/schemas/InternalPartyIdentification' + required: + - source + - destination + - amount + - id + - resultCode + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: {} diff --git a/yaml/TransferService-v2.yaml b/yaml/TransferService-v2.yaml new file mode 100644 index 0000000..e11d86f --- /dev/null +++ b/yaml/TransferService-v2.yaml @@ -0,0 +1,742 @@ +openapi: 3.1.0 +servers: +- url: https://balanceplatform-api-test.adyen.com/btl/v2 +info: + version: '2' + x-publicVersion: true + title: Balance Platform Transfers API + description: "The Balance Platform Transfers API provides an endpoint that you can\ + \ use to move funds within your balance platform, or to send funds from your balance\ + \ platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments).\n\ + \nFor information on how the API is used in Adyen Issuing, refer to [Manage funds](https://docs.adyen.com/issuing/manage-funds#transfer).\n\ + \n## Authentication\nYour Adyen contact will provide your API credential and an\ + \ API key. To connect to the API, add an `X-API-Key` header with the API key as\ + \ the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\"\ + \ \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use\ + \ the username and password to connect to the API using basic authentication.\ + \ For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\"\ + :\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Balance\ + \ Platforms Transfers API, you need an additional role for your API credential.\ + \ Transfers must also be enabled for the source balance account. Your Adyen contact\ + \ will set up the roles and permissions for you.\n## Versioning\nThe Balance Platform\ + \ Transfers API supports versioning of its endpoints through a version suffix\ + \ in the endpoint URL. This suffix has the following format: \"vXX\", where XX\ + \ is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/v1\n\ + ```\n## Going live\nWhen going live, your Adyen contact will provide your API\ + \ credential for the live environment. You can then use the username and password\ + \ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v1`.\n\n\ + For more information, refer to our [Going live documentation](https://docs.adyen.com/issuing/integration-checklist#going-live)." + termsOfService: https://www.adyen.com/legal/terms-and-conditions + contact: + name: Adyen Developer Experience team + url: https://www.adyen.help/hc/en-us/community/topics + email: developer-experience@adyen.com +x-groups: +- General +- Transactions +paths: + /transactions: + get: + tags: + - Transactions + summary: Get all transactions. + description: 'Returns transactions that match the query parameters. The following + query parameters are required when making a request: + + + * One of `accountHolderId`, `balanceAccountId` or `balancePlatform` + + + * `createdUntil` + + + * `createdSince` + + + This endpoint supports cursor-based pagination. The response returns the first + page of results, and returns links to the next page when applicable. You can + use the links to page through the results. The response also returns links + to the previous page when applicable.' + x-addedInVersion: '1' + operationId: get-transactions + x-groupName: Transactions + x-sortIndex: 1 + security: + - ApiKeyAuth: [] + parameters: + - description: Unique identifier of the balance platform. + name: balancePlatform + in: query + required: false + schema: + type: string + - description: Unique identifier of the account holder. + name: accountHolderId + in: query + required: false + schema: + type: string + - description: Unique identifier of the balance account. + name: balanceAccountId + in: query + required: false + schema: + type: string + - description: The `cursor` returned in the links of the previous response. + name: cursor + in: query + required: false + schema: + type: string + - description: Required. Only include transactions that have been created on + or after this point in time. The value must be in ISO 8601 format. For example, + **2021-05-30T15:07:40Z**. + name: createdSince + in: query + required: false + schema: + format: date-time + type: string + - description: Required. Only include transactions that have been created on + or before this point in time. The value must be in ISO 8601 format. For + example, **2021-05-30T15:07:40Z**. + name: createdUntil + in: query + required: false + schema: + format: date-time + type: string + - description: The number of items returned per page, maximum of 100 items. + By default, the response returns 10 items per page. + name: limit + in: query + required: false + schema: + format: int32 + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TransactionSearchResponse' + description: OK - the request has succeeded. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /transactions/{id}: + get: + tags: + - Transactions + summary: Get a transaction. + description: Returns a specific transaction. + x-addedInVersion: '1' + operationId: get-transactions-id + x-groupName: Transactions + x-sortIndex: 2 + security: + - ApiKeyAuth: [] + parameters: + - description: Unique identifier of the transaction. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Transaction' + description: OK - the request has succeeded. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. + /transfers: + post: + tags: + - General + summary: Transfer funds. + description: 'Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), + [transfer instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/transferInstruments), + or bank accounts. Adyen sends the outcome of the transfer request through + webhooks. + + + To use this endpoint, you need an additional role for your API credential + and transfers must be enabled for the source balance account. Your Adyen contact + will set these up for you.' + x-addedInVersion: '2' + operationId: post-transfers + x-groupName: General + x-sortIndex: 0 + security: + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TransferInfo' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Transfer' + description: OK - the request has succeeded. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. +components: + schemas: + Address: + properties: + city: + description: 'The name of the city. Maximum length: 3000 characters.' + type: string + country: + description: 'The two-character country code as defined in ISO-3166-1 alpha-2. + For example, **US**. + + > If you don''t know the country or are not collecting the country from + the shopper, provide `country` as `ZZ`.' + type: string + houseNumberOrName: + description: 'The number or name of the house. Maximum length: 3000 characters.' + type: string + postalCode: + description: A maximum of five digits for an address in the US, or a maximum + of ten characters for an address in all other countries. + type: string + stateOrProvince: + description: 'State or province codes as defined in ISO 3166-2. For example, + **CA** in the US or **ON** in Canada. + + > Required for the US and Canada.' + type: string + street: + description: 'The name of the street. Maximum length: 3000 characters. + + > The house number should not be included in this field; it should be + separately provided via `houseNumberOrName`.' + type: string + required: + - street + - houseNumberOrName + - city + - postalCode + - country + 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 + Bank: + properties: + priority: + x-addedInVersion: '1' + description: "Sets the priority for the bank transfer. If you don't provide\ + \ this in the request, Adyen sets the optimal priority.\n\n Possible values:\n\ + \n * **regular**: For normal, low-value transactions.\n\n* **fast**: For\ + \ high-priority, low-value transactions.\n\n* **wire**: For high-priority,\ + \ high-value transactions.\n\n" + enum: + - fast + - regular + - wire + type: string + BankAccountInfo: + properties: + address: + description: The address of the bank account owner. + $ref: '#/components/schemas/Address' + iban: + description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) + standard. + type: string + ownerName: + description: The name of the bank account owner. + $ref: '#/components/schemas/Name' + Counterparty: + properties: + balanceAccountId: + description: Unique identifier of the recipient [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). + type: string + bankAccount: + description: Contains information about the recipient bank account. + $ref: '#/components/schemas/BankAccountInfo' + merchant: + $ref: '#/components/schemas/MerchantData' + transferInstrumentId: + description: Unique identifier of the recipient [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/transferInstruments/{id}). + type: string + CounterpartyInfo: + properties: + balanceAccountId: + description: Unique identifier of the recipient [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). + type: string + bankAccount: + description: Contains information about the recipient bank account. + $ref: '#/components/schemas/BankAccountInfo' + transferInstrumentId: + description: Unique identifier of the recipient [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/transferInstruments/{id}). + type: string + InvalidField: + properties: + message: + description: Description of the validation error. + type: string + name: + description: The field that has an invalid value. + type: string + value: + description: The invalid value. + type: string + required: + - name + - value + - message + Link: + properties: + href: + type: string + Links: + properties: + next: + description: Contains a link to the next page. + $ref: '#/components/schemas/Link' + prev: + description: Contains a link to the previous page. + $ref: '#/components/schemas/Link' + MerchantData: + properties: + mcc: + description: The merchant category code. + type: string + merchantId: + description: The merchant identifier. + type: string + nameLocation: + description: Contains the merchant's name and location. + $ref: '#/components/schemas/NameLocation' + Name: + properties: + firstName: + description: The first name. + type: string + fullName: + description: The full name. + type: string + infix: + description: The infix in the name, if any. + type: string + lastName: + description: The last name. + type: string + NameLocation: + properties: + city: + description: The city where the merchant is located. + type: string + country: + description: The country where the merchant is located in [three-letter + country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format. + type: string + countryOfOrigin: + description: The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) + format, used for government-controlled merchants such as embassies. + type: string + name: + description: The name of the merchant's shop or service. + type: string + rawData: + description: The raw data. + type: string + state: + description: The state where the merchant is located. + type: string + RestServiceError: + properties: + detail: + description: A human-readable explanation specific to this occurrence of + the problem. + type: string + errorCode: + description: A code that identifies the problem type. + type: string + errorType: + description: A URI that identifies the problem type, which points to human-readable + documentation on this problem type. + type: string + instance: + description: A unique URI that identifies the specific occurrence of the + problem. + type: string + invalidFields: + description: Detailed explanations of each validation error, when applicable. + items: + $ref: '#/components/schemas/InvalidField' + type: array + requestId: + description: A unique reference for the request, essentially same as `pspReference`. + type: string + status: + description: The HTTP status code. + format: int32 + type: integer + title: + description: A short, human-readable summary of the problem type. + type: string + required: + - errorType + - errorCode + - title + - detail + - status + Transaction: + properties: + accountHolderId: + x-addedInVersion: '1' + description: Unique identifier of the account holder. + type: string + amount: + x-addedInVersion: '1' + description: The amount. + $ref: '#/components/schemas/Amount' + balanceAccountId: + x-addedInVersion: '1' + description: Unique identifier of the balance account. + type: string + balancePlatform: + x-addedInVersion: '1' + description: Unique identifier of the balance platform. + type: string + bookingDate: + x-addedInVersion: '1' + description: The date the transaction was booked to the balance account. + format: date-time + type: string + category: + x-addedInVersion: '1' + description: "The category of the transaction indicating the type of activity.\n\ + \n Possible values:\n\n* **platformPayment**: The transaction is a payment\ + \ or payment modification made with an Adyen merchant account.\n\n* **internal**:\ + \ The transaction resulted from an internal adjustment such as a deposit\ + \ correction or invoice deduction.\n\n* **bank**: The transaction is a\ + \ bank-related activity, such as sending a payout or receiving funds.\n\ + \n* **issuedCard**: The transaction is a card-related activity, such as\ + \ using an Adyen-issued card to pay online.\n\n" + enum: + - bank + - internal + - issuedCard + - platformPayment + type: string + counterparty: + description: The recipient of the transfer. + $ref: '#/components/schemas/Counterparty' + createdAt: + x-addedInVersion: '1' + description: The date the transaction was created. + format: date-time + type: string + description: + x-addedInVersion: '1' + description: The `description` from the `/transfers` request. + type: string + id: + x-addedInVersion: '1' + description: Unique identifier of the transaction. + type: string + instructedAmount: + x-addedInVersion: '1' + description: The originally instructed amount. + $ref: '#/components/schemas/Amount' + paymentInstrumentId: + x-addedInVersion: '1' + description: Unique identifier of the payment instrument that was used for + this transaction. + type: string + reference: + x-addedInVersion: '1' + description: The reference for this transaction. + type: string + referenceForBeneficiary: + x-addedInVersion: '1' + description: The `referenceForbeneficiary` from the `/transfers` request. + type: string + status: + x-addedInVersion: '1' + description: "The status of the transaction.\n\n Possible values:\n\n* **pending**:\ + \ The transaction is still pending.\n\n* **booked**: The transaction has\ + \ been booked to the balance account.\n\n" + enum: + - booked + - pending + type: string + transferId: + x-addedInVersion: '1' + description: Unique identifier of the related transfer. + type: string + type: + x-addedInVersion: '1' + description: "The type of the transaction.\n\n Possible values: **payment**,\ + \ **capture**, **captureReversal**, **refund** **refundReversal**, **chargeback**,\ + \ **chargebackReversal**, **secondChargeback**, **atmWithdrawal**, **atmWithdrawalReversal**,\ + \ **internalTransfer**, **manualCorrection**, **invoiceDeduction**, **depositCorrection**,\ + \ **bankTransfer**, **miscCost**, **paymentCost**, **fee**" + enum: + - atmWithdrawal + - atmWithdrawalReversal + - bankTransfer + - capture + - captureReversal + - chargeback + - chargebackReversal + - depositCorrection + - fee + - internalTransfer + - invoiceDeduction + - manualCorrection + - miscCost + - payment + - paymentCost + - refund + - refundReversal + - secondChargeback + type: string + valueDate: + x-addedInVersion: '1' + description: The date the transfer amount becomes available in the balance + account. + format: date-time + type: string + required: + - id + - transferId + - balancePlatform + - accountHolderId + - balanceAccountId + - paymentInstrumentId + - amount + - referenceForBeneficiary + - reference + - instructedAmount + - status + - createdAt + - bookingDate + - valueDate + - counterparty + TransactionSearchResponse: + properties: + _links: + description: Contains links to the next and previous page whenever applicable. + $ref: '#/components/schemas/Links' + data: + description: Contains the transactions that match the query parameters. + items: + $ref: '#/components/schemas/Transaction' + type: array + Transfer: + properties: + amount: + x-addedInVersion: '1' + description: The amount of the transfer. + $ref: '#/components/schemas/Amount' + balanceAccountId: + description: Unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). + type: string + bank: + x-addedInVersion: '1' + description: Contains settings for bank transfers. If you are transferring + funds to bank accounts and you don't provide this object, Adyen applies + default settings. + $ref: '#/components/schemas/Bank' + counterparty: + description: The counterparty of this transfer. + $ref: '#/components/schemas/Counterparty' + description: + x-addedInVersion: '1' + description: A human-readable description for the transfer. You can use + alphanumeric characters and hyphens. We recommend sending a maximum of + 140 characters, otherwise the description may be truncated. + type: string + direction: + x-addedInVersion: '2' + description: 'The direction of the transfer. + + + Possible values: **incoming**, **outgoing**.' + enum: + - incoming + - outgoing + type: string + id: + x-addedInVersion: '2' + description: Unique identifier of the transfer. + type: string + paymentInstrumentId: + description: Unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}). + type: string + reason: + x-addedInVersion: '2' + description: Additional information about the status of the transfer. + enum: + - approved + - notEnoughBalance + - unknown + type: string + reference: + x-addedInVersion: '2' + description: A reference for the transfer, only used internally within your + platform. Maximum length is 80 characters. If you don't provide this in + the request, Adyen generates a unique reference. + type: string + referenceForBeneficiary: + x-addedInVersion: '2' + description: "A reference that is sent to the recipient. This reference\ + \ is also sent in all notification webhooks related to the transfer, so\ + \ you can use this to track statuses for both source and recipient of\ + \ funds.\n\n Supported characters are uppercase or lowercase letters (**A\u2013\ + Z** or **a\u2013z**) and numbers. Maximum length is 80 characters." + type: string + status: + x-addedInVersion: '2' + description: "The result of the transfer.\n\n Possible values: **authorised**,\ + \ **refused**." + enum: + - authorised + - refused + type: string + required: + - amount + - id + - counterparty + - status + TransferInfo: + properties: + amount: + x-addedInVersion: '1' + description: The amount of the transfer. + $ref: '#/components/schemas/Amount' + balanceAccountId: + description: Unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). + type: string + bank: + x-addedInVersion: '1' + description: Contains settings for bank transfers. If you are transferring + funds to bank accounts and you don't provide this object, Adyen applies + default settings. + $ref: '#/components/schemas/Bank' + counterparty: + description: The recipient of the funds transfer. This can be a balance + account, a transfer instrument, or a bank account. + $ref: '#/components/schemas/CounterpartyInfo' + description: + x-addedInVersion: '1' + description: A human-readable description for the transfer. You can use + alphanumeric characters and hyphens. We recommend sending a maximum of + 140 characters, otherwise the description may be truncated. + type: string + paymentInstrumentId: + description: Unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}). + type: string + reference: + x-addedInVersion: '2' + description: A reference for the transfer, only used internally within your + platform. Maximum length is 80 characters. If you don't provide this in + the request, Adyen generates a unique reference. + type: string + referenceForBeneficiary: + x-addedInVersion: '2' + description: "A reference that is sent to the recipient. This reference\ + \ is also sent in all notification webhooks related to the transfer, so\ + \ you can use this to track statuses for both source and recipient of\ + \ funds.\n\n Supported characters are uppercase or lowercase letters (**A\u2013\ + Z** or **a\u2013z**) and numbers. Maximum length is 80 characters." + type: string + required: + - amount + - counterparty + securitySchemes: + ApiKeyAuth: + in: header + name: X-API-Key + type: apiKey + BasicAuth: + scheme: basic + type: http + examples: {}