openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute Donations API description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\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-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```" x-timestamp: '2023-05-30T15:27:20Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi servers: - url: https://cal-test.adyen.com/cal/services/Account/v6 tags: - name: Donations paths: /donations: post: tags: - Donations summary: Adyen Start a Transaction for Donations 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).' operationId: post-donations x-sortIndex: 2 x-methodName: donations 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/DonationPaymentRequest' parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: examples: donations: $ref: '#/components/examples/post-donations-donations-200' schema: $ref: '#/components/schemas/DonationPaymentResponse' 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: 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 brand: x-addedInVersion: '70' description: Brand of the item. type: string color: x-addedInVersion: '70' description: Color of the item. type: string 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 payment methods PayPal and Ratepay. type: string manufacturer: x-addedInVersion: '70' description: Manufacturer of the item. type: string productUrl: description: Link to the purchased item. type: string quantity: description: Number of items. format: int64 type: integer receiverEmail: x-addedInVersion: '70' description: Email associated with the given product in the basket (usually in electronic gift cards). type: string size: x-addedInVersion: '70' description: Size of the item. type: string sku: x-addedInVersion: '70' description: Stock keeping unit. type: string taxAmount: description: Tax amount, in minor units. format: int64 type: integer taxPercentage: description: Tax percentage, in minor units. format: int64 type: integer upc: x-addedInVersion: '70' description: Universal Product Code. type: string type: object 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: * **01** Frictionless authentication occurred by ACS. * **02** Cardholder challenge occurred by ACS. * **03** AVS verified. * **04** 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 type: object GooglePayDonations: additionalProperties: false properties: checkoutAttemptId: x-addedInVersion: '68' description: The checkout attempt identifier. 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: - credit - debit type: string googlePayCardNetwork: description: 'The selected payment card network. ' 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. maxLength: 64 type: string type: default: googlepay description: '**googlepay**, **paywithgoogle**' enum: - googlepay type: string required: - googlePayToken title: Google Pay type: object 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: * **Eligible** Merchant is protected by PayPal''s Seller Protection Policy for Unauthorized Payments and Item Not Received. * **PartiallyEligible** Merchant is protected by PayPal''s Seller Protection Policy for Item Not Received. * **Ineligible** 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 type: object ResponseAdditionalDataNetworkTokens: properties: networkToken.available: description: Indicates whether a network token is available for the specified card. type: string networkToken.bin: description: The Bank Identification Number of a tokenized card, which is the first six digits of a card number. type: string networkToken.tokenSummary: description: The last four digits of a network token. type: string type: object 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 type: object 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 type: object AdditionalData3DSecure: properties: allow3DS2: deprecated: true x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.threeDSRequestData.nativeThreeDS` instead. 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)\nor send the `executeThreeD` parameter.\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** 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 challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen" enum: - '01' - '02' - '03' - '04' - '05' type: string executeThreeD: deprecated: true x-deprecatedInVersion: '69' x-deprecatedMessage: Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead 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** Perform 3D Secure authentication.\n* **false** 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 type: object 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 type: object CheckoutSDKAction: additionalProperties: false properties: paymentData: description: Encoded payment data. type: string paymentMethodType: description: Specifies the payment method. type: string sdkData: additionalProperties: type: string description: The data to pass to the SDK. type: object type: description: The type of the action. enum: - sdk - wechatpaySDK type: string url: description: Specifies the URL to redirect to. type: string required: - type type: object ResponseAdditionalDataDomesticError: properties: domesticRefusalReasonRaw: description: "The reason the transaction was declined, given by the local issuer. \nCurrently available for merchants in Japan." type: string domesticShopperAdvice: description: "The action the shopper should take, in a local language. \nCurrently available in Japanese, for merchants in Japan." type: string type: object 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 type: object 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 type: object 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 openinvoicedata.recipientFirstName: description: First name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna. type: string openinvoicedata.recipientLastName: description: Last name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna. 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 type: object 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 type: object 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 type: object ResponseAdditionalDataBillingAddress: properties: billingAddress.city: description: The billing address city passed in the payment request. type: string billingAddress.country: description: 'The billing address country passed in the payment request. 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 type: object 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 type: object CardDonations: additionalProperties: false properties: brand: description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' type: string checkoutAttemptId: x-addedInVersion: '68' description: The checkout attempt identifier. type: string 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: 15000 type: string encryptedExpiryMonth: description: The encrypted card expiry month. maxLength: 15000 type: string encryptedExpiryYear: description: The encrypted card expiry year. maxLength: 15000 type: string encryptedSecurityCode: description: The encrypted card verification code. maxLength: 15000 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: - credit - debit type: string holderName: description: The name of the card holder. type: string networkPaymentReference: description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment. 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. maxLength: 64 type: string threeDS2SdkVersion: description: Required for mobile integrations. 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: - bcmc - scheme - networkToken - giftcard - card type: string title: Card type: object 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: * **01** No 3DS Requestor authentication occurred (for example, cardholder logged in as guest). * **02** Login to the cardholder account at the 3DS Requestor system using 3DS Requestors own credentials. * **03** Login to the cardholder account at the 3DS Requestor system using federated ID. * **04** Login to the cardholder account at the 3DS Requestor system using issuer credentials. * **05** Login to the cardholder account at the 3DS Requestor system using third-party authentication. * **06** 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 type: object BrowserInfo: properties: acceptHeader: description: The accept header value of the shopper's browser. 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. type: string required: - userAgent - acceptHeader - javaEnabled - colorDepth - screenHeight - screenWidth - timeZoneOffset - language type: object 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 type: object ThreeDS2RequestFields: properties: acctInfo: x-addedInVersion: '68' description: Additional information about the Cardholders 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: * **01** Not applicable * **02** Credit * **03** 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: * **Y** Shipping Address matches Billing Address. * **N** 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 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: 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 platform: description: 'The platform of the shopper. Allowed values: * `iOS` * `android` * `browser`' enum: - iOS - android - browser type: string purchaseInstalData: x-addedInVersion: '68' description: 'Indicates the maximum number of authorisations permitted for instalment payments. Length: 13 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. type: string sdkEphemPubKey: description: The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK. $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. type: string sdkTransID: description: The `sdkTransID` value as received from the 3D Secure 2 SDK. 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. Possible values: * **01** No preference * **02** No challenge requested * **03** Challenge requested (3DS Requestor preference) * **04** Challenge requested (Mandate) * **05** No challenge (transactional risk analysis is already performed) * **06** Data Only' enum: - '01' - '02' - '03' - '04' - '05' - '06' 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: * **01** Goods/Service Purchase * **03** Check Acceptance * **10** Account Funding * **11** Quasi-Cash Transaction * **28** 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' type: object ResponseAdditionalDataOpi: properties: opi.transToken: description: 'Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string type: object 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 type: object AdditionalDataAirline: properties: airline.agency_invoice_number: description: 'The reference number for the invoice, issued by the agency. * Encoding: ASCII * minLength: 1 character * maxLength: 6 characters' type: string airline.agency_plan_name: description: 'The two-letter agency plan identifier. * Encoding: ASCII * minLength: 2 characters * maxLength: 2 characters' type: string airline.airline_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier. * Format: IATA 3-digit accounting code (PAX) * Example: KLM = 074 * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier. * Encoding: ASCII * Example: KLM = KL * minLength: 2 characters * maxLength: 2 characters * Must not be all spaces *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Encoding: Numeric * minLength: 1 character * maxLength: 18 characters' 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. * Encoding: ASCII * minLength: 4 characters * maxLength: 4 characters' type: string airline.customer_reference_number: description: 'The alphanumeric customer reference number. * Encoding: ASCII * maxLength: 20 characters * If you send more than 20 characters, the customer reference number is truncated * Must not be all spaces' type: string airline.document_type: description: 'A code that identifies the type of item bought. The description of the code can appear on credit card statements. * Encoding: ASCII * Example: Passenger ticket = 01 * minLength: 2 characters * maxLength: 2 characters' type: string airline.flight_date: description: 'The 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 characters * maxLength: 16 characters' type: string airline.leg.carrier_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier. This field is required if the airline data includes leg details. * Example: KLM = KL * minLength: 2 characters * maxLength: 2 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd HH:mm`.\n* Encoding: ASCII\n* minLength: 16 characters\n* maxLength: 16 characters" type: string airline.leg.depart_airport: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport. This field is required if the airline data includes leg details. * Encoding: ASCII * Example: Amsterdam = AMS * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Encoding: Numeric * minLength: 1 * maxLength: 12 *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport. This field is required if the airline data includes leg details. * Example: Amsterdam = AMS * Encoding: ASCII * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric. * minLength: 1 character * maxLength: 6 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. * minLength: 1 character * maxLength: 5 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not. * Encoding: ASCII * minLength: 1 character * maxLength: 1 character' type: string airline.passenger.date_of_birth: description: 'The passenger''s date of birth. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10' type: string airline.passenger.first_name: description: 'The passenger''s first name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII' type: string airline.passenger.last_name: description: 'The passenger''s last name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII' type: string airline.passenger.telephone_number: description: 'The passenger''s telephone number, including country code. This is an alphanumeric field that can include the ''+'' and ''-'' signs. * Encoding: ASCII * minLength: 3 characters * maxLength: 30 characters' type: string airline.passenger.traveller_type: description: 'The IATA passenger type code (PTC). * Encoding: ASCII * minLength: 3 characters * maxLength: 6 characters' type: string airline.passenger_name: description: "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. * minLength: 0 characters * maxLength: 16 characters' type: string airline.ticket_number: description: 'The ticket''s unique identifier. * minLength: 1 character * maxLength: 15 characters * Must not be all spaces *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency that issues the ticket. * Encoding: ASCII * minLength: 1 character * maxLength: 8 characters * Must not be all spaces *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. * Encoding: ASCII * minLength: 1 character * maxLength: 25 characters * Must not be all spaces *Must not be all zeros.' type: string required: - airline.passenger_name type: object CheckoutRedirectAction: additionalProperties: false properties: data: additionalProperties: type: string description: When the redirect URL must be accessed via POST, use this data to post to the redirect URL. type: object method: description: Specifies the HTTP method, for example GET or POST. type: string paymentMethodType: description: Specifies the payment method. type: string type: description: '**redirect**' enum: - redirect type: string url: description: Specifies the URL to redirect to. type: string required: - type type: object BillingAddress: properties: city: description: 'The name of the city. Maximum length: 3000 characters.' maxLength: 3000 type: string country: description: 'The two-character ISO-3166-1 alpha-2 country code. 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.' maxLength: 3000 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: 'The two-character ISO 3166-2 state or province code. 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`.' maxLength: 3000 type: string required: - street - houseNumberOrName - city - postalCode - country type: object AdditionalDataLodging: properties: lodging.checkInDate: description: 'The arrival date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.' type: string lodging.checkOutDate: description: 'The departure date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.' type: string lodging.customerServiceTollFreeNumber: description: 'The toll-free phone number for the lodging. * Format: numeric * Max length: 17 characters. * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be ''Y'' or ''N''. * Format: alphabetic * Max length: 1 character' type: string lodging.folioCashAdvances: description: 'The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters' type: string lodging.folioNumber: description: 'The card acceptors internal invoice or billing ID reference number. * Max length: 25 characters. * Must not start with a space *Must not be all zeros.' type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters' type: string lodging.noShowIndicator: description: "Indicates if the customer didn't check in for their booking.\n Possible values: \n* **Y**: the customer didn't check in \n* **N**: the customer checked in" type: string lodging.prepaidExpenses: description: 'The prepaid expenses for the booking. * Format: numeric * Max length: 12 characters' type: string lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. * Format: numeric. * Min length: 10 characters * Max length: 17 characters * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. * Format: numeric * Must be a number between 0 and 99 * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number' type: string lodging.totalRoomTax: description: 'The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number' type: string lodging.totalTax: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number' type: string travelEntertainmentAuthData.duration: description: 'The number of nights. This should be included in the auth message. * Format: numeric * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. Must be ''H'' for Hotel. This should be included in the auth message. * Format: alphanumeric * Max length: 1 character' type: string type: object CheckoutThreeDS2Action: additionalProperties: false properties: authorisationToken: description: A token needed to authorise a payment. type: string paymentData: description: Encoded payment data. type: string paymentMethodType: description: Specifies the payment method. type: string subtype: description: A subtype of the token. type: string token: description: A token to pass to the 3DS2 Component to get the fingerprint. type: string type: description: '**threeDS2**' enum: - threeDS2 type: string url: description: Specifies the URL to redirect to. type: string required: - type type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: description: 'The customer code. * Encoding: ASCII * Max length: 25 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. * Encoding: ASCII * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. * Encoding: ASCII * Max length: 10 characters * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. * Encoding: ASCII * Max length: 3 characters * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. * Encoding: ASCII * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. * Encoding: ASCII * Max length: 26 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. * Encoding: ASCII. * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. * Encoding: Numeric * Max length: 12 characters * Must not start with a space or be all spaces ' type: string enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. * Encoding: ASCII Max length: 3 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` * Encoding: ASCII * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. * Encoding: ASCII * Max length: 10 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. *Encoding: Numeric *Max length: 12 characters * Must not be all zeros.' type: string type: object 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' type: object 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 type: object AcctInfo: properties: chAccAgeInd: description: "Length of time that the cardholder has had the account with the 3DS Requestor. \nAllowed values:\n* **01** No account\n* **02** Created during this transaction\n* **03** Less than 30 days\n* **04** 3060 days\n* **05** More than 60 days" enum: - '01' - '02' - '03' - '04' - '05' maxLength: 2 minLength: 2 type: string chAccChange: description: "Date that the cardholders 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 cardholders 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** Changed during this transaction\n* **02** Less than 30 days\n* **03** 3060 days\n* **04** More than 60 days" enum: - '01' - '02' - '03' - '04' maxLength: 2 minLength: 2 type: string chAccPwChange: description: "Date that cardholders 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 cardholders account with the 3DS Requestor had a password change or account reset. \nAllowed values:\n* **01** No change\n* **02** Changed during this transaction\n* **03** Less than 30 days\n* **04** 3060 days\n* **05** 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 cardholders account with the 3DS Requestor. \nFormat: **YYYYMMDD**" type: string paymentAccInd: description: "Indicates the length of time that the payment account was enrolled in the cardholders account with the 3DS Requestor. \nAllowed values:\n* **01** No account (guest checkout)\n* **02** During this transaction\n* **03** Less than 30 days\n* **04** 3060 days\n* **05** 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** This transaction\n* **02** Less than 30 days\n* **03** 3060 days\n* **04** 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** Account Name identical to shipping Name\n* **02** 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** No suspicious activity has been observed\n* **02** 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 type: object FraudCheckResult: properties: accountScore: description: The fraud score generated by the risk check. format: int32 type: integer checkId: description: The ID of the risk check. format: int32 type: integer name: description: The name of the risk check. type: string required: - checkId - name - accountScore type: object DeliveryAddress: properties: city: description: 'The name of the city. Maximum length: 3000 characters.' maxLength: 3000 type: string country: description: 'The two-character ISO-3166-1 alpha-2 country code. 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 firstName: type: string houseNumberOrName: description: 'The number or name of the house. Maximum length: 3000 characters.' maxLength: 3000 type: string lastName: 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: 'The two-character ISO 3166-2 state or province code. 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`.' maxLength: 3000 type: string required: - street - houseNumberOrName - city - postalCode - country type: object ThreeDS2ResponseData: properties: acsChallengeMandated: type: string acsOperatorID: type: string acsReferenceNumber: type: string acsSignedContent: type: string acsTransID: type: string acsURL: type: string authenticationType: type: string cardHolderInfo: type: string cavvAlgorithm: type: string challengeIndicator: type: string dsReferenceNumber: type: string dsTransID: type: string exemptionIndicator: type: string messageVersion: type: string riskScore: type: string sdkEphemPubKey: type: string threeDSServerTransID: type: string transStatus: type: string transStatusReason: type: string type: object CheckoutDelegatedAuthenticationAction: additionalProperties: false properties: authorisationToken: description: A token needed to authorise a payment. type: string paymentData: description: Encoded payment data. type: string paymentMethodType: description: Specifies the payment method. type: string token: description: A token to pass to the delegatedAuthentication component. type: string type: description: '**delegatedAuthentication**' enum: - delegatedAuthentication type: string url: description: Specifies the URL to redirect to. type: string required: - type type: object ResponsePaymentMethod: properties: brand: description: The card brand that the shopper used to pay. Only returned if `paymentMethod.type` is **scheme**. type: string type: description: The `paymentMethod.type` value used in the request. type: string title: paymentResponse type: object 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** > **Developers** > **Additional data**. 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 type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: description: 'Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** There wasn''t a connection available to service the outgoing communication. 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. * **IOEXCEPTION_RECEIVED** Something went wrong during transmission of the message or receiving the response. 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 allowPartialAuth: description: "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team." 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). Allowed values: * **PreAuth** flags the payment request to be handled as a pre-authorisation. * **FinalAuth** 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://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: 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 manualCapture: description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction. 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 type: object 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 type: object Name: properties: firstName: description: The first name. type: string lastName: description: The last name. type: string required: - firstName - lastName type: object ResponseAdditionalDataCard: properties: cardBin: description: 'The first six digits of the card number. This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with a six-digit BIN. 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 issuerBin: description: 'The first eight digits of the card number. Only returned if the card number is 16 digits or more. This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN. Example: 52123423' type: string type: object ThreeDS2Result: properties: authenticationValue: description: The `authenticationValue` value as defined in the 3D Secure 2 specification. type: string cavvAlgorithm: x-addedInVersion: '50' description: The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations. type: string challengeCancel: x-addedInVersion: '67' description: Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata). enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. type: string eci: description: The `eci` value as defined in the 3D Secure 2 specification. type: string exemptionIndicator: x-addedInVersion: '67' description: 'Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. 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 threeDSRequestorChallengeInd: x-addedInVersion: '68' description: 'Indicates whether a challenge is requested for this transaction. Possible values: * **01** No preference * **02** No challenge requested * **03** Challenge requested (3DS Requestor preference) * **04** Challenge requested (Mandate) * **05** No challenge (transactional risk analysis is already performed) * **06** Data Only' enum: - '01' - '02' - '03' - '04' - '05' - '06' type: string threeDSServerTransID: description: The `threeDSServerTransID` value as defined in the 3D Secure 2 specification. type: string timestamp: description: The `timestamp` value of the 3D Secure 2 authentication. type: string transStatus: description: The `transStatus` value as defined in the 3D Secure 2 specification. type: string transStatusReason: description: Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values). type: string whiteListStatus: x-addedInVersion: '49' description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. type: string type: object DeviceRenderOptions: properties: sdkInterface: default: both description: 'Supported SDK interface types. Allowed values: * native * html * both' enum: - native - html - both type: string sdkUiType: 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 type: object ApplePayDonations: additionalProperties: false properties: applePayToken: description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. maxLength: 10000 type: string checkoutAttemptId: x-addedInVersion: '68' description: The checkout attempt identifier. 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: - credit - 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. maxLength: 64 type: string type: default: applepay description: '**applepay**' enum: - applepay type: string required: - applePayToken title: Apple Pay type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: description: 'The customer code, if supplied by a customer. * Encoding: ASCII * maxLength: 25' type: string enhancedSchemeData.employeeName: description: "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: description: "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). * maxLength: 7 * Must not be empty * Can be all zeros' type: string enhancedSchemeData.regularHoursWorked: description: 'The hours worked. * maxLength: 7 * Must not be empty * Can be all zeros' type: string enhancedSchemeData.requestName: description: 'The name of the person requesting temporary services. * maxLength: 40 * Must not be all zeros * Must not be all spaces' type: string enhancedSchemeData.tempStartDate: description: 'The billing period start date. * Format: ddMMyy * maxLength: 6' type: string enhancedSchemeData.tempWeekEnding: description: 'The billing period end date. * Format: ddMMyy * maxLength: 6' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). For example, 2000 means USD 20.00 * maxLength: 12' type: string 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 passCreationToken: x-addedInVersion: '68' description: A base64 encoded signature of all properties type: string paymentData: description: Encoded payment data. type: string paymentMethodType: description: Specifies the payment method. type: string reference: description: The voucher reference code. type: string shopperEmail: description: The shopper email. type: string shopperName: description: The shopper name. type: string surcharge: description: The surcharge amount. $ref: '#/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 type: object ThreeDSRequestData: properties: challengeWindowSize: x-addedInVersion: '69' description: "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen" enum: - '01' - '02' - '03' - '04' - '05' type: string dataOnly: x-addedInVersion: '69' description: Flag for data only flow. enum: - 'false' - 'true' type: string nativeThreeDS: x-addedInVersion: '69' description: 'Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be used when available. Possible values: * **preferred**: Use native 3D Secure authentication when available.' enum: - preferred type: string threeDSVersion: x-addedInVersion: '69' description: 'The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**' enum: - 2.1.0 - 2.2.0 type: string type: object ResponseAdditionalDataInstallments: properties: installmentPaymentData.installmentType: description: Type of installment. The value of `installmentType` should be **IssuerFinanced**. type: string installmentPaymentData.option[itemNr].annualPercentageRate: description: Annual interest rate. type: string installmentPaymentData.option[itemNr].firstInstallmentAmount: description: First Installment Amount in minor units. type: string installmentPaymentData.option[itemNr].installmentFee: description: Installment fee amount in minor units. type: string installmentPaymentData.option[itemNr].interestRate: description: Interest rate for the installment period. type: string installmentPaymentData.option[itemNr].maximumNumberOfInstallments: description: Maximum number of installments possible for this payment. type: string installmentPaymentData.option[itemNr].minimumNumberOfInstallments: description: Minimum number of installments possible for this payment. type: string installmentPaymentData.option[itemNr].numberOfInstallments: description: Total number of installments possible for this payment. type: string installmentPaymentData.option[itemNr].subsequentInstallmentAmount: description: Subsequent Installment Amount in minor units. type: string installmentPaymentData.option[itemNr].totalAmountDue: description: Total amount in minor units. type: string installmentPaymentData.paymentOptions: description: 'Possible values: * 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 type: object Amount: properties: currency: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). maxLength: 3 minLength: 3 type: string value: description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int64 type: integer required: - value - currency type: object PayWithGoogleDonations: additionalProperties: false properties: checkoutAttemptId: x-addedInVersion: '68' description: The checkout attempt identifier. 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: - credit - 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. maxLength: 64 type: string type: default: paywithgoogle description: '**paywithgoogle**' enum: - paywithgoogle type: string required: - googlePayToken title: Google Pay type: object CheckoutAwaitAction: additionalProperties: false properties: paymentData: description: Encoded payment data. type: string paymentMethodType: description: Specifies the payment method. type: string type: description: '**await**' enum: - await type: string url: description: Specifies the URL to redirect to. type: string required: - type type: object 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 type: object DonationPaymentResponse: properties: amount: description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' donationAccount: description: The Adyen account name of your charity. We will provide you with this account name once your chosen charity has been [onboarded](https://docs.adyen.com/online-payments/donations#onboarding). type: string id: description: Your unique resource identifier. type: string merchantAccount: description: The merchant account identifier, with which you want to process the transaction. type: string payment: description: Action to be taken for completing the payment. $ref: '#/components/schemas/PaymentResponse' reference: description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.' type: string status: description: 'The status of the donation transaction. Possible values: * **completed** * **pending** * **refused**' enum: - completed - pending - refused type: string type: object CheckoutNativeRedirectAction: additionalProperties: false properties: data: additionalProperties: type: string description: When the redirect URL must be accessed via POST, use this data to post to the redirect URL. type: object method: description: Specifies the HTTP method, for example GET or POST. type: string nativeRedirectData: description: Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult. type: string paymentMethodType: description: Specifies the payment method. type: string type: description: '**nativeRedirect**' enum: - nativeRedirect type: string url: description: Specifies the URL to redirect to. type: string required: - type type: object CheckoutQrCodeAction: additionalProperties: false properties: expiresAt: description: Expiry time of the QR code. type: string paymentData: description: Encoded payment data. type: string paymentMethodType: description: Specifies the payment method. type: string qrCodeData: description: The contents of the QR code as a UTF8 string. type: string type: description: '**qrCode**' enum: - qrCode type: string url: description: Specifies the URL to redirect to. type: string required: - type type: object Phone: properties: cc: description: 'Country code. Length: 13 characters.' maxLength: 3 minLength: 1 type: string subscriber: description: 'Subscriber number. Maximum length: 15 characters.' maxLength: 15 type: string type: object PaymentResponse: properties: action: x-addedInVersion: '49' description: Action to be taken for completing the payment. oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' - $ref: '#/components/schemas/CheckoutDelegatedAuthenticationAction' - $ref: '#/components/schemas/CheckoutNativeRedirectAction' - $ref: '#/components/schemas/CheckoutQrCodeAction' - $ref: '#/components/schemas/CheckoutRedirectAction' - $ref: '#/components/schemas/CheckoutSDKAction' - $ref: '#/components/schemas/CheckoutThreeDS2Action' - $ref: '#/components/schemas/CheckoutVoucherAction' additionalData: additionalProperties: type: string x-anyOf: - $ref: '#/components/schemas/ResponseAdditionalData3DSecure' - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress' - $ref: '#/components/schemas/ResponseAdditionalDataCard' - $ref: '#/components/schemas/ResponseAdditionalDataCommon' - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError' - $ref: '#/components/schemas/ResponseAdditionalDataInstallments' - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens' - $ref: '#/components/schemas/ResponseAdditionalDataOpi' - $ref: '#/components/schemas/ResponseAdditionalDataSepa' description: 'Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.' type: object amount: x-addedInVersion: '52' description: Authorised amount in the transaction. $ref: '#/components/schemas/Amount' donationToken: x-addedInVersion: '66' description: Donation Token containing payment details for Adyen Giving. type: string fraudResult: description: The fraud result properties of the payment. $ref: '#/components/schemas/FraudResult' merchantReference: x-addedInVersion: '49' description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. 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' paymentMethod: x-addedInVersion: '69' description: "Details about the payment method used in the transaction. \nOnly returned if `resultCode` is **Authorised**." $ref: '#/components/schemas/ResponsePaymentMethod' pspReference: description: 'Adyen''s 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > 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). Possible values: * **AuthenticationFinished** The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** The issuer requires the shopper''s device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.' enum: - AuthenticationFinished - AuthenticationNotRequired - Authorised - Cancelled - ChallengeShopper - Error - IdentifyShopper - PartiallyAuthorised - Pending - PresentToShopper - Received - RedirectShopper - Refused - Success type: string threeDS2ResponseData: x-addedInVersion: '67' description: Response of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2ResponseData' threeDS2Result: x-addedInVersion: '41' description: Result of the 3D Secure 2 authentication. $ref: '#/components/schemas/ThreeDS2Result' threeDSPaymentData: x-addedInVersion: '67' description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. type: string type: object AdditionalDataCarRental: properties: carRental.checkOutDate: description: 'The 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 * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. * Format: Numeric * maxLength: 4 * Must not be all spaces' type: string carRental.fuelCharges: description: 'Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12' type: string carRental.insuranceCharges: description: 'Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12 * Must not be all spaces *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. * Format: Alphanumeric * maxLength: 18 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. * Format: Alphanumeric * maxLength: 2' type: string carRental.locationStateProvince: description: 'The state or province where the car is rented. * Format: Alphanumeric * maxLength: 2 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. * Y - Customer did not pick up their car * N - Not applicable' type: string carRental.oneWayDropOffCharges: description: 'The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * maxLength: 12' type: string carRental.rate: description: 'The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * 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 for the car rental. * Format: Alphanumeric * maxLength: 9 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. * Format: Alphanumeric * maxLength: 4 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. * Format: Alphanumeric * maxLength: 26 * If you send more than 26 characters, the name is truncated * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. * Format: Alphanumeric * maxLength: 18 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. * Format: Alphanumeric * maxLength: 2' type: string carRental.returnDate: description: 'The last date to return the car by. * Date format: `yyyyMMdd` * maxLength: 8' type: string carRental.returnLocationId: description: 'The agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if tax was not paid on them. Values: * Y - Goods or services were tax exempt * N - Tax was not collected' type: string travelEntertainmentAuthData.duration: description: 'Number of days the car is rented for. This should be included in the auth message. * Format: Numeric * maxLength: 4' 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 type: object FraudResult: properties: accountScore: description: The total fraud score generated by the risk checks. format: int32 type: integer results: description: The result of the individual risk checks. items: $ref: '#/components/schemas/FraudCheckResult' type: array required: - accountScore type: object AuthenticationData: properties: attemptAuthentication: x-addedInVersion: '69' description: 'Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure). Possible values: * **always**: Perform 3D Secure authentication. * **never**: Don''t perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.' enum: - always - never type: string authenticationOnly: x-addedInVersion: '69' 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. Default: **false**.' type: boolean threeDSRequestData: x-addedInVersion: '69' description: Object with additional parameters for the 3D Secure authentication flow. $ref: '#/components/schemas/ThreeDSRequestData' type: object 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 type: object IdealDonations: additionalProperties: false properties: checkoutAttemptId: x-addedInVersion: '68' description: The checkout attempt identifier. type: string 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. maxLength: 64 type: string type: default: ideal description: '**ideal**' enum: - ideal type: string required: - issuer title: iDEAL type: object 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 type: object 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 type: object ResponseAdditionalData3DSecure: properties: cardHolderInfo: description: 'Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. ' type: string cavv: description: The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session, as a Base64-encoded 20-byte array. type: string cavvAlgorithm: description: The CAVV algorithm used. type: string scaExemptionRequested: description: "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string threeds2.cardEnrolled: description: Indicates whether a card is enrolled for 3D Secure 2. type: boolean type: object 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: 'The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried. For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. type: string networkTxReference: description: 'Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. 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 type: object DonationPaymentRequest: 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' authenticationData: x-addedInVersion: '69' description: Data for 3DS authentication. $ref: '#/components/schemas/AuthenticationData' billingAddress: 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/BillingAddress' 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' 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 by the client SDK for tracking user payment journey. type: string conversionId: x-addedInVersion: '49' deprecated: true x-deprecatedInVersion: '68' x-deprecatedMessage: Use `checkoutAttemptId` instead description: Conversion ID that corresponds to the Id generated by the client SDK 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: 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 deliverAt: x-addedInVersion: '70' 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 deliveryAddress: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/DeliveryAddress' deviceFingerprint: 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. Required when `donationToken` is provided. type: string donationToken: description: Donation token received in the `/payments` call. type: string 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 merchantAccount: description: The merchant account identifier, with which you want to process the transaction. 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: 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' 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: 80 type: string paymentMethod: description: The type and required details of a payment method to use. oneOf: - $ref: '#/components/schemas/ApplePayDonations' - $ref: '#/components/schemas/CardDonations' - $ref: '#/components/schemas/GooglePayDonations' - $ref: '#/components/schemas/IdealDonations' - $ref: '#/components/schemas/PayWithGoogleDonations' recurringProcessingModel: x-addedInVersion: '30' description: 'Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` 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. * `UnscheduledCardOnFile` 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. ' 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 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://www.adyen.help/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. $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." maxLength: 256 minLength: 3 type: string socialSecurityNumber: description: The shopper's social security number. type: string telephoneNumber: 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/ThreeDS2RequestFields' threeDSAuthenticationOnly: x-addedInVersion: '50' deprecated: true x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.authenticationOnly` 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 required: - paymentMethod - returnUrl - merchantAccount - reference - amount type: object examples: generic-400: summary: Response code 400. Bad request. value: status: 400 errorCode: '702' message: 'Unexpected input: ", expected: }' errorType: validation generic-422: summary: Response code 422. Unprocessable entity. value: status: 422 errorCode: '14_030' message: Return URL is missing. errorType: validation pspReference: '8816118280275544' 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 generic-500: summary: Response code 500. Internal server error. value: status: 500 errorCode: '905' message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' generic-403: summary: Response code 403. Forbidden. value: status: 403 errorCode: '901' message: Invalid Merchant Account errorType: security pspReference: 881611827877203B post-donations-donations: summary: Start a donation transaction value: amount: currency: EUR value: 1000 reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: CHARITY_ACCOUNT returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth generic-401: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security 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 recurringDetailReference: '7219687191761347' returnUrl: https://your-company.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: CHARITY_ACCOUNT shopperInteraction: ContAuth shopperReference: YOUR_SHOPPER_REFERENCE recurringProcessingModel: CardOnFile 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 headers: Idempotency-Key: description: The idempotency key used for processing the request. Present if the key was provided in the request. schema: type: string securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification