# Adyen Online payments. Take card and wallet payments, capture or cancel an authorization, refund a shopper, and send payment links. | Property | Value | | --- | --- | | Slug | `adyen_checkout` | | Definition version | `0.1.0` | | Base URL | `https://{{account.live_url_prefix}}-checkout-live.adyenpayments.com/checkout/v71` | | Auth schemes | `api_key` | | Action tools | 27 | | By class | 3 read, 21 write, 3 destructive | | Triggers | 0 | | Provider rate limit | not declared, so outbound calls are unpaced | ## Measured routing accuracy 40 golden cases replayed through the router over the whole index: measured over corpus `ea4f12ad2948` (65 toolkits, 2283 tools indexed and 13 declared uncallable), 27 cases written by hand and 13 cases from the paraphrase pass. A case counts as top-1 when its gold tool ranked first and top-8 when it reached the slate at all. | Measure | Cases | Share | | --- | --- | --- | | top-1 | 30/40 | 75.0% | | top-8 | 39/40 | 97.5% | The sweep is offline: the reranker is a deterministic identity fake that returns candidates in the order retrieval produced them, so top-1 measures retrieval order rather than a reranked slate. `just eval-live` measures the same cases through the live reranker. ## Authentication Connect an entity with `ConnectionsService.InitiateConnection`, naming this toolkit's slug. Credentials stay in the connections vault; callers hold connected-account ids only. ### `api_key` | Property | Value | | --- | --- | | Placement | `header` | | Name | `X-API-Key` | | Rendered as | `{key}` | Submit the key with `ConnectionsService` rather than putting it in a request; it is sealed at rest and never returned. ## Tools 27 action tools. The catalog-wide slug is `adyen_checkout.`, which is what `search_tools` returns and `call_tool` takes. ### `adyen_checkout.post_apple_pay_sessions` Get an Apple Pay session. You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate. Calls POST /applePay/sessions. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /applePay/sessions`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `displayName` | string | **yes** | This is the name that your shoppers will see in the Apple Pay interface. The value returned as `configuration.merchantName` field from the... | | `domainName` | string | **yes** | The domain name you provided when you added Apple Pay in your Customer Area. This must match the `window.location.hostname` of the web shop. | | `merchantIdentifier` | string | **yes** | Your merchant identifier registered with Apple Pay. Use the value of the `configuration.merchantId` field from the... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `data` | string | Base64 encoded data you need to [complete the Apple Pay merchant validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-val... | Also retrieved by: "start an apple pay merchant validation", "get the wallet handshake for our own certificate", "open a session so the pay sheet can show". ### `adyen_checkout.post_cancels` Cancel an authorised Adyen payment before capture using the pspReference in the request body rather than the URL: void a hold so it never settles. The body-reference form of the cancel operation. Calls POST /cancels. Class `destructive` (held by the mutation gate until the call's own arguments carry `"confirm": true`). No scopes beyond the connection's defaults. Calls `POST /cancels`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `enhancedSchemeData` | object | no | | | `enhancedSchemeData.airline` | object | no | | | `enhancedSchemeData.carRental` | object | no | | | `enhancedSchemeData.levelTwoThree` | object | no | | | `enhancedSchemeData.lodging` | object | no | | | `enhancedSchemeData.temporaryServices` | object | no | | | `merchantAccount` | string | **yes** | The merchant account that is used to process the payment. | | `paymentReference` | string | **yes** | The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) of the payment that you want to cancel. | | `reference` | string | no | Your reference for the cancel request. Maximum length: 80 characters. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `merchantAccount` | string | The merchant account that is used to process the payment. | | `paymentReference` | string | The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) of the payment to cancel. | | `pspReference` | string | Adyen's 16-character reference associated with the cancel request. | | `reference` | string | Your reference for the cancel request. | | `status` | string, one of received | The status of your request. This will always have the value **received**. | Also retrieved by: "void a hold using the reference in the body", "reverse an authorisation without the url id", "undo an authorised charge by body reference". ### `adyen_checkout.post_card_details` Look up an Adyen card's brand and details from its number or BIN: tell which network or scheme a card belongs to and whether it is eligible. Calls POST /cardDetails. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /cardDetails`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `cardNumber` | string | no | A minimum of the first six digits of the card number. The full card number gives the best result. You must be [fully PCI... | | `countryCode` | string | no | The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE | | `encryptedCardNumber` | string | no | The encrypted card number. | | `merchantAccount` | string | **yes** | The merchant account identifier, with which you want to process the transaction. | | `supportedBrands` | array of string | no | The card brands you support. This is the [`brands`](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods#responses-200-paymentMethods-brands) array from your... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `brands` | array of object | The list of brands identified for the card. | | `brands[].supported` | boolean | Indicates if you support the card brand. | | `brands[].type` | string | The name of the card brand. | | `fundingSource` | string | The funding source of the card, for example **DEBIT**, **CREDIT**, or **PREPAID**. | | `isCardCommercial` | boolean | Indicates if this is a commercial card or a consumer card. If **true**, it is a commercial card. If **false**, it is a consumer card. | | `issuingCountryCode` | string | The two-letter country code of the country where the card was issued. | Also retrieved by: "which brand does this card number belong to", "identify the scheme from a bin", "tell what network a card is on". ### `adyen_checkout.post_donation_campaigns` Get a list of donation campaigns. Queries the available donation campaigns for a donation based on the donation context (like merchant account, currency, and locale). Calls POST /donationCampaigns. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /donationCampaigns`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes/). | | `locale` | string | no | Locale on the shopper interaction device. | | `merchantAccount` | string | **yes** | Your merchant account identifier. | | `store` | string | no | Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-referenc... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `donationCampaigns` | array of object | List of active donation campaigns for your merchant account. | | `donationCampaigns[].amounts` | object | | | `donationCampaigns[].bannerUrl` | string | The URL for the banner of the nonprofit or campaign. | | `donationCampaigns[].campaignName` | string | The name of the donation campaign.. | | `donationCampaigns[].causeName` | string | The cause of the nonprofit. | | `donationCampaigns[].donation` | object | | | `donationCampaigns[].id` | string | The unique campaign ID of the donation campaign. | | `donationCampaigns[].logoUrl` | string | The URL for the logo of the nonprofit. | | `donationCampaigns[].nonprofitDescription` | string | The description of the nonprofit. | | `donationCampaigns[].nonprofitName` | string | The name of the nonprofit organization that receives the donation. | | `donationCampaigns[].nonprofitUrl` | string | The website URL of the nonprofit. | | `donationCampaigns[].termsAndConditionsUrl` | string | The URL of the terms and conditions page of the nonprofit and the campaign. | Also retrieved by: "which charities can a shopper give to", "available giving options for this account and currency", "list the causes offered at checkout". ### `adyen_checkout.post_donations` Add a charitable donation to an Adyen checkout: use a donation token from a payment to give a contribution to a cause on top of an order. Calls POST /donations. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /donations`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `accountInfo` | object | no | | | `accountInfo.accountAgeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days *... | | `accountInfo.accountChangeDate` | string (date-time) | no | Date when the shopper's account was last changed. | | `accountInfo.accountChangeIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.accountCreationDate` | string (date-time) | no | Date when the shopper's account was created. | | `accountInfo.accountType` | string, one of notApplicable, credit, debit | no | Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit | | `accountInfo.addCardAttemptsDay` | integer (int32) | no | Number of attempts the shopper tried to add a card to their account in the last day. | | `accountInfo.deliveryAddressUsageDate` | string (date-time) | no | Date the selected delivery address was first used. | | `accountInfo.deliveryAddressUsageIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.homePhone` | string | no | Shopper's home phone number (including the country code). | | `accountInfo.mobilePhone` | string | no | Shopper's mobile phone number (including the country code). | | `accountInfo.passwordChangeDate` | string (date-time) | no | Date when the shopper last changed their password. | | `accountInfo.passwordChangeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.pastTransactionsDay` | integer (int32) | no | Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. | | `accountInfo.pastTransactionsYear` | integer (int32) | no | Number of all transactions (successful and abandoned) from this shopper in the past year. | | `accountInfo.paymentAccountAge` | string (date-time) | no | Date this payment method was added to the shopper's account. | | `accountInfo.paymentAccountIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.purchasesLast6Months` | integer (int32) | no | Number of successful purchases in the last six months. | | `accountInfo.suspiciousActivity` | boolean | no | Whether suspicious activity was recorded on this account. | | `accountInfo.workPhone` | string | no | Shopper's work phone number (including the country code). | | `additionalData` | object | no | 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. | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `authenticationData` | object | no | | | `authenticationData.attemptAuthentication` | string, one of always, never | no | 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... | | `authenticationData.authenticationOnly` | boolean | no | Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication... Defaults to false. | | `authenticationData.threeDSRequestData` | object | no | | | `billingAddress` | object | no | | | `billingAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | **yes** | 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`. | | `billingAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | no | 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. | | `billingAddress.street` | string | **yes** | 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`. | | `browserInfo` | object | no | | | `browserInfo.acceptHeader` | string | **yes** | The accept header value of the shopper's browser. | | `browserInfo.colorDepth` | integer (int32) | **yes** | 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... | | `browserInfo.javaEnabled` | boolean | **yes** | Boolean value indicating if the shopper's browser is able to execute Java. | | `browserInfo.javaScriptEnabled` | boolean | no | 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. Defaults to true. | | `browserInfo.language` | string | **yes** | The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). | | `browserInfo.screenHeight` | integer (int32) | **yes** | The total height of the shopper's device screen in pixels. | | `browserInfo.screenWidth` | integer (int32) | **yes** | The total width of the shopper's device screen in pixels. | | `browserInfo.timeZoneOffset` | integer (int32) | **yes** | Time difference between UTC time and the shopper's browser local time, in minutes. | | `browserInfo.userAgent` | string | **yes** | The user agent value of the shopper's browser. | | `channel` | string, one of iOS, Android, Web | no | 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... | | `checkoutAttemptId` | string | no | Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. | | `conversionId` | string | no | Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. | | `countryCode` | string | no | The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE | | `dateOfBirth` | string (date-time) | no | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD | | `deliverAt` | string (date-time) | no | 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 | | `deliveryAddress` | object | no | | | `deliveryAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | **yes** | 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`. | | `deliveryAddress.firstName` | string | no | | | `deliveryAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.lastName` | string | no | | | `deliveryAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | no | 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. | | `deliveryAddress.street` | string | **yes** | 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`. | | `deviceFingerprint` | string | no | A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). | | `donationAccount` | string | no | Donation account to which the transaction is credited. | | `donationCampaignId` | string | no | The donation campaign ID received in the `/donationCampaigns` call. | | `donationOriginalPspReference` | string | no | PSP reference of the transaction from which the donation token is generated. Required when `donationToken` is provided. | | `donationToken` | string | no | Donation token received in the `/payments` call. | | `lineItems` | array of object | no | 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... | | `lineItems[].amountExcludingTax` | integer (int64) | no | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | no | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | no | Brand of the item. | | `lineItems[].color` | string | no | Color of the item. | | `lineItems[].description` | string | no | Description of the line item. | | `lineItems[].id` | string | no | ID of the line item. | | `lineItems[].imageUrl` | string | no | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | no | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | no | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | no | Marketplace seller id. | | `lineItems[].productUrl` | string | no | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | no | Number of items. | | `lineItems[].receiverEmail` | string | no | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | no | Size of the item. | | `lineItems[].sku` | string | no | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | no | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | no | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | no | Universal Product Code. | | `merchantAccount` | string | **yes** | The merchant account identifier, with which you want to process the transaction. | | `merchantRiskIndicator` | object | no | | | `merchantRiskIndicator.addressMatch` | boolean | no | Whether the chosen delivery address is identical to the billing address. | | `merchantRiskIndicator.deliveryAddressIndicator` | string, one of shipToBillingAddress, shipToVerifiedAddress, shipToNewAddress, shipToStore, digitalGoods, goodsNotShipped, other | no | Indicator regarding the delivery address. Allowed values: * `shipToBillingAddress` * `shipToVerifiedAddress` * `shipToNewAddress` * `shipToStore` * `digitalGoods` * `goodsNotShipped` * `other` | | `merchantRiskIndicator.deliveryEmail` | string | no | The delivery email address (for digital goods). | | `merchantRiskIndicator.deliveryEmailAddress` | string | no | For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters. | | `merchantRiskIndicator.deliveryTimeframe` | string, one of electronicDelivery, sameDayShipping, overnightShipping, twoOrMoreDaysShipping | no | The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping` | | `merchantRiskIndicator.giftCardAmount` | object | no | | | `merchantRiskIndicator.giftCardCount` | integer (int32) | no | For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. | | `merchantRiskIndicator.giftCardCurr` | string | no | 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... | | `merchantRiskIndicator.preOrderDate` | string (date-time) | no | For pre-order purchases, the expected date this product will be available to the shopper. | | `merchantRiskIndicator.preOrderPurchase` | boolean | no | Indicator for whether this transaction is for pre-ordering a product. | | `merchantRiskIndicator.preOrderPurchaseInd` | string | no | Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. | | `merchantRiskIndicator.reorderItems` | boolean | no | Indicator for whether the shopper has already purchased the same items in the past. | | `merchantRiskIndicator.reorderItemsInd` | string | no | Indicates whether the cardholder is reordering previously purchased merchandise. | | `merchantRiskIndicator.shipIndicator` | string | no | Indicates shipping method chosen for the transaction. | | `metadata` | object | no | 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". *... | | `mpiData` | object | no | | | `mpiData.authenticationResponse` | string, one of Y, N, U, A | no | In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter. | | `mpiData.cavv` | string (byte) | no | The cardholder authentication value (base64 encoded, 20 bytes in a decoded form). | | `mpiData.cavvAlgorithm` | string | no | The CAVV algorithm used. Include this only for 3D Secure 1. | | `mpiData.challengeCancel` | string, one of 01, 02, 03, 04, 05, 06, 07 | no | 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... | | `mpiData.directoryResponse` | string, one of A, C, D, I, N, R, U, Y | no | In 3D Secure 2, this is the `transStatus` from the `ARes`. | | `mpiData.dsTransID` | string | no | Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. | | `mpiData.eci` | string | no | The electronic commerce indicator. | | `mpiData.riskScore` | string | no | Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations. | | `mpiData.threeDSVersion` | string | no | The version of the 3D Secure protocol. | | `mpiData.tokenAuthenticationVerificationValue` | string (byte) | no | Network token authentication verification value (TAVV). The network token cryptogram. | | `mpiData.transStatusReason` | string | no | Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our... | | `mpiData.xid` | string (byte) | no | Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form). | | `origin` | string | no | > Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `donationAccount` | string | 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). | | `id` | string | Your unique resource identifier. | | `merchantAccount` | string | The merchant account identifier, with which you want to process the transaction. | | `payment` | object | | | `payment.action` | object | Action to be taken for completing the payment. | | `payment.additionalData` | object | Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. | | `payment.amount` | object | | | `payment.donationToken` | string | Donation Token containing payment details for Adyen Giving. | | `payment.fraudResult` | object | | | `payment.merchantReference` | string | The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a... | | `payment.order` | object | | | `payment.paymentMethod` | object | | | `payment.paymentValidations` | object | | | `payment.pspReference` | string | Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > For payment methods that... | | `payment.refusalReason` | string | If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the... | | `payment.refusalReasonCode` | string | Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). | | `payment.resultCode` | string, one of AuthenticationFinished, AuthenticationNotRequired, Authorised, Cancelled, ChallengeShopper, Error, IdentifyShopper, PartiallyAuthorised, Pending, PresentToShopper, Received, RedirectShopper, Refused, Success | 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... | | `payment.threeDS2ResponseData` | object | | | `payment.threeDS2Result` | object | | | `payment.threeDSPaymentData` | string | When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. | | `reference` | string | The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a... | | `status` | string, one of completed, pending, refused | The status of the donation transaction. Possible values: * **completed** * **pending** * **refused** | Also retrieved by: "add a charitable gift to this checkout", "let the shopper give to a cause", "include a contribution with the order". ### `adyen_checkout.post_forward` Forward stored payment details. Forwards the payment details you stored with Adyen to a third-party that you specify and returns the response from the third-party. Calls POST /forward. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /forward`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `amount` | object | no | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `baseUrl` | string | **yes** | The base URL of the third party API, where Adyen will send the request to forward the payment details. | | `merchantAccount` | string | **yes** | Your merchant account. | | `merchantReference` | string | no | Merchant defined payment reference. | | `options` | object | no | | | `options.accountUpdate` | boolean | no | Whether to check for a card account update (true) or not (false) | | `options.dryRun` | boolean | no | Set to **true** to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only... | | `options.networkToken` | object | no | | | `options.networkTxReferencePaths` | array | no | Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of networkTxReference in the incoming 3rd party response | | `options.tokenize` | boolean | no | Set to **true**, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization). | | `options.transactionLinkIdPaths` | array | no | Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of transactionLinkId in the incoming 3rd party response | | `paymentMethod` | object | no | | | `paymentMethod.cvc` | string | no | The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is also known as: *... | | `paymentMethod.encryptedCardNumber` | string | no | The encrypted card number. | | `paymentMethod.encryptedExpiryMonth` | string | no | The encrypted expiryMonth | | `paymentMethod.encryptedExpiryYear` | string | no | The encrypted card expiry year. | | `paymentMethod.encryptedSecurityCode` | string | no | The encrypted security code. | | `paymentMethod.expiryMonth` | string | no | The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November | | `paymentMethod.expiryYear` | string | no | The card expiry year. | | `paymentMethod.holderName` | string | no | The name of the cardholder. | | `paymentMethod.number` | string | no | The card number. Only collect raw card data if you are fully [PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). Format: Do not use separators. | | `paymentMethod.type` | string, one of scheme | no | Default payment method details. Common for scheme payment methods, and for simple payment method details. Defaults to scheme. | | `request` | object | **yes** | | | `request.body` | string | **yes** | The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use... | | `request.credentials` | string | no | Your credentials that are needed to authenticate with the third party. | | `request.headers` | object | no | The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}`... | | `request.httpMethod` | string, one of post, put, patch | **yes** | The HTTP method to use for the request Adyen makes on your behalf to the third party. | | `request.urlSuffix` | string | no | The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, **/payments**. | | `shopperReference` | string | **yes** | Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally... | | `storedPaymentMethodId` | string | no | The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `merchantReference` | string | Merchant defined payment reference. | | `pspReference` | string | Adyen's 16-character reference associated with the transaction/request. This value is globally unique. Use this reference when you communicate with us about this request. | | `response` | object | | | `response.body` | string | The body of the response Adyen received from the third party, in string format. | | `response.headers` | object | The HTTP headers of the response Adyen received from the third party. | | `response.status` | integer (int32) | The HTTP status of the response Adyen received from the third party. | | `storedPaymentMethodId` | string | The unique identifier of the token. | Also retrieved by: "send a saved card to a third party", "pass vaulted details on to another processor", "relay stored credentials outside adyen". ### `adyen_checkout.post_orders` Open an Adyen order for a partial or split payment: a basket that several payments, such as a gift card plus a card, can each pay toward until the total is covered. Calls POST /orders. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /orders`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `expiresAt` | string | no | The date when the order should expire. If not provided, the default expiry duration is 1 day. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example... | | `merchantAccount` | string | **yes** | The merchant account identifier, with which you want to process the order. | | `reference` | string | **yes** | A custom reference identifying the order. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `additionalData` | object | Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `expiresAt` | string | The date that the order will expire. | | `fraudResult` | object | | | `fraudResult.accountScore` | integer (int32) | The total fraud score generated by the risk checks. | | `fraudResult.results` | array | The result of the individual risk checks. | | `orderData` | string | The encrypted data that will be used by merchant for adding payments to the order. | | `pspReference` | string | Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. | | `reference` | string | The reference provided by merchant for creating the order. | | `refusalReason` | string | If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the... | | `remainingAmount` | object | | | `remainingAmount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `remainingAmount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `resultCode` | string, one of Success | The result of the order creation request. The value is always **Success**. | Also retrieved by: "open a basket for a split payment", "let a gift card and a card both cover it", "start a partial payment container". ### `adyen_checkout.post_orders_cancel` Cancel an order. Cancels an order. Calls POST /orders/cancel. Class `destructive` (held by the mutation gate until the call's own arguments carry `"confirm": true`). No scopes beyond the connection's defaults. Calls `POST /orders/cancel`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `merchantAccount` | string | **yes** | The merchant account identifier that orderData belongs to. | | `order` | object | **yes** | | | `order.orderData` | string | **yes** | The encrypted order data. | | `order.pspReference` | string | **yes** | The `pspReference` that belongs to the order. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `pspReference` | string | A unique reference of the cancellation request. | | `resultCode` | string, one of Received | The result of the cancellation request. Possible values: * **Received** – Indicates the cancellation has successfully been received by Adyen, and will be processed. | Also retrieved by: "stop an order", "call off an order", "back out of an order". ### `adyen_checkout.post_origin_keys` Create originKey values for domains. This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. Calls POST /originKeys. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /originKeys`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `originDomains` | array of string | **yes** | The list of origin domains, for which origin keys are requested. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `originKeys` | object | The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. | Also retrieved by: "keys that let our domains load the web components", "authorise a site to run the checkout widget", "issue browser-side identifiers per origin". ### `adyen_checkout.post_payment_links` Create an Adyen Pay by Link page: a hosted checkout URL you send a shopper so they can pay online without card entry in your own app. Use to bill someone by sending them a link. Calls POST /paymentLinks. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /paymentLinks`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `allowedPaymentMethods` | array of string | no | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `billingAddress` | object | no | | | `billingAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | **yes** | 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`. | | `billingAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | no | 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. | | `billingAddress.street` | string | **yes** | 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`. | | `blockedPaymentMethods` | array of string | no | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `captureDelayHours` | integer (int32) | no | The delay between the authorisation and scheduled auto-capture, specified in hours. | | `countryCode` | string | no | The shopper's two-letter country code. | | `dateOfBirth` | string (date) | no | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD | | `deliverAt` | string (date-time) | no | The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. | | `deliveryAddress` | object | no | | | `deliveryAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | **yes** | 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`. | | `deliveryAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | no | 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. | | `deliveryAddress.street` | string | **yes** | 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`. | | `description` | string | no | A short description visible on the payment page. Maximum length: 280 characters. | | `expiresAt` | string (date-time) | no | The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum... | | `fundOrigin` | object | no | | | `fundOrigin.billingAddress` | object | no | | | `fundOrigin.shopperEmail` | string | no | The email address of the person funding the money. | | `fundOrigin.shopperName` | object | no | | | `fundOrigin.telephoneNumber` | string | no | The phone number of the person funding the money. | | `fundOrigin.walletIdentifier` | string | no | The unique identifier of the wallet where the funds are coming from. | | `fundRecipient` | object | no | | | `fundRecipient.IBAN` | string | no | The IBAN of the bank account where the funds are being transferred to. | | `fundRecipient.billingAddress` | object | no | | | `fundRecipient.paymentMethod` | object | no | | | `fundRecipient.shopperEmail` | string | no | The email address of the shopper. | | `fundRecipient.shopperName` | object | no | | | `fundRecipient.shopperReference` | string | no | Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your... | | `fundRecipient.storedPaymentMethodId` | string | no | This is the `recurringDetailReference` returned in the response when you created the token. | | `fundRecipient.subMerchant` | object | no | | | `fundRecipient.telephoneNumber` | string | no | The telephone number of the shopper. | | `fundRecipient.walletIdentifier` | string | no | The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier. | | `fundRecipient.walletOwnerTaxId` | string | no | The tax identifier of the person receiving the funds. | | `fundRecipient.walletPurpose` | string, one of identifiedBoleto, transferDifferentWallet, transferOwnWallet, transferSameWallet, unidentifiedBoleto | no | The purpose of a digital wallet transaction. | | `installmentOptions` | object | no | A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options... | | `lineItems` | array of object | no | 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... | | `lineItems[].amountExcludingTax` | integer (int64) | no | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | no | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | no | Brand of the item. | | `lineItems[].color` | string | no | Color of the item. | | `lineItems[].description` | string | no | Description of the line item. | | `lineItems[].id` | string | no | ID of the line item. | | `lineItems[].imageUrl` | string | no | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | no | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | no | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | no | Marketplace seller id. | | `lineItems[].productUrl` | string | no | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | no | Number of items. | | `lineItems[].receiverEmail` | string | no | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | no | Size of the item. | | `lineItems[].sku` | string | no | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | no | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | no | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | no | Universal Product Code. | | `manualCapture` | boolean | no | Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). | | `mcc` | string | no | The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant... | | `merchantAccount` | string | **yes** | The merchant account identifier for which the payment link is created. | | `merchantOrderReference` | string | no | This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. | | `metadata` | object | no | Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: "Metadata size exceeds limit" * Maximum... | | `platformChargebackLogic` | object | no | | | `platformChargebackLogic.behavior` | string, one of deductFromOneBalanceAccount, deductAccordingToSplitRatio, deductFromLiableAccount | no | The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. | | `platformChargebackLogic.costAllocationAccount` | string | no | The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. | | `platformChargebackLogic.targetAccount` | string | no | The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. | | `recurringProcessingModel` | string, one of CardOnFile, Subscription, UnscheduledCardOnFile | no | Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable... | | `reference` | string | **yes** | A reference that is used to uniquely identify the payment in future communications about the payment status. | | `requiredShopperFields` | array of string | no | List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `allowedPaymentMethods` | array of string | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | | | `applicationInfo.adyenLibrary` | object | | | `applicationInfo.adyenPaymentSource` | object | | | `applicationInfo.externalPlatform` | object | | | `applicationInfo.merchantApplication` | object | | | `applicationInfo.merchantDevice` | object | | | `applicationInfo.shopperInteractionDevice` | object | | | `billingAddress` | object | | | `billingAddress.city` | string | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | 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`. | | `billingAddress.houseNumberOrName` | string | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | 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. | | `billingAddress.street` | string | 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`. | | `blockedPaymentMethods` | array of string | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `captureDelayHours` | integer (int32) | The delay between the authorisation and scheduled auto-capture, specified in hours. | | `countryCode` | string | The shopper's two-letter country code. | | `dateOfBirth` | string (date) | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD | | `deliverAt` | string (date-time) | The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. | | `deliveryAddress` | object | | | `deliveryAddress.city` | string | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | 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`. | | `deliveryAddress.houseNumberOrName` | string | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.postalCode` | string | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | 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. | | `deliveryAddress.street` | string | 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`. | | `description` | string | A short description visible on the payment page. Maximum length: 280 characters. | | `expiresAt` | string (date-time) | The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum... | | `fundOrigin` | object | | | `fundOrigin.billingAddress` | object | | | `fundOrigin.shopperEmail` | string | The email address of the person funding the money. | | `fundOrigin.shopperName` | object | | | `fundOrigin.telephoneNumber` | string | The phone number of the person funding the money. | | `fundOrigin.walletIdentifier` | string | The unique identifier of the wallet where the funds are coming from. | | `fundRecipient` | object | | | `fundRecipient.IBAN` | string | The IBAN of the bank account where the funds are being transferred to. | | `fundRecipient.billingAddress` | object | | | `fundRecipient.paymentMethod` | object | | | `fundRecipient.shopperEmail` | string | The email address of the shopper. | | `fundRecipient.shopperName` | object | | | `fundRecipient.shopperReference` | string | Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your... | | `fundRecipient.storedPaymentMethodId` | string | This is the `recurringDetailReference` returned in the response when you created the token. | | `fundRecipient.subMerchant` | object | | | `fundRecipient.telephoneNumber` | string | The telephone number of the shopper. | | `fundRecipient.walletIdentifier` | string | The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier. | | `fundRecipient.walletOwnerTaxId` | string | The tax identifier of the person receiving the funds. | | `fundRecipient.walletPurpose` | string, one of identifiedBoleto, transferDifferentWallet, transferOwnWallet, transferSameWallet, unidentifiedBoleto | The purpose of a digital wallet transaction. | | `id` | string | A unique identifier of the payment link. | | `installmentOptions` | object | A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options... | | `lineItems` | array of object | 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... | | `lineItems[].amountExcludingTax` | integer (int64) | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | Brand of the item. | | `lineItems[].color` | string | Color of the item. | | `lineItems[].description` | string | Description of the line item. | | `lineItems[].id` | string | ID of the line item. | | `lineItems[].imageUrl` | string | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | Marketplace seller id. | | `lineItems[].productUrl` | string | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | Number of items. | | `lineItems[].receiverEmail` | string | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | Size of the item. | | `lineItems[].sku` | string | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | Universal Product Code. | | `manualCapture` | boolean | Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). | | `mcc` | string | The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant... | | `merchantAccount` | string | The merchant account identifier for which the payment link is created. | | `merchantOrderReference` | string | This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. | | `metadata` | object | Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: "Metadata size exceeds limit" * Maximum... | | `platformChargebackLogic` | object | | | `platformChargebackLogic.behavior` | string, one of deductFromOneBalanceAccount, deductAccordingToSplitRatio, deductFromLiableAccount | The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. | | `platformChargebackLogic.costAllocationAccount` | string | The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. | | `platformChargebackLogic.targetAccount` | string | The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. | | `recurringProcessingModel` | string, one of CardOnFile, Subscription, UnscheduledCardOnFile | Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable... | | `reference` | string | A reference that is used to uniquely identify the payment in future communications about the payment status. | Also retrieved by: "send the buyer a page to pay on", "bill someone with a hosted link", "share a checkout url with a shopper". ### `adyen_checkout.get_payment_links_link_id` Check an Adyen payment link by its id: whether the shopper opened it and finished paying, its current status and amount. Use to see if a link you sent was paid. Calls GET /paymentLinks/{linkId}. Class `read` (reads only). No scopes beyond the connection's defaults. Calls `GET /paymentLinks/{{params.linkId}}`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `linkId` | string | **yes** | Unique identifier of the payment link. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `allowedPaymentMethods` | array of string | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | | | `applicationInfo.adyenLibrary` | object | | | `applicationInfo.adyenPaymentSource` | object | | | `applicationInfo.externalPlatform` | object | | | `applicationInfo.merchantApplication` | object | | | `applicationInfo.merchantDevice` | object | | | `applicationInfo.shopperInteractionDevice` | object | | | `billingAddress` | object | | | `billingAddress.city` | string | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | 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`. | | `billingAddress.houseNumberOrName` | string | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | 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. | | `billingAddress.street` | string | 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`. | | `blockedPaymentMethods` | array of string | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `captureDelayHours` | integer (int32) | The delay between the authorisation and scheduled auto-capture, specified in hours. | | `countryCode` | string | The shopper's two-letter country code. | | `dateOfBirth` | string (date) | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD | | `deliverAt` | string (date-time) | The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. | | `deliveryAddress` | object | | | `deliveryAddress.city` | string | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | 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`. | | `deliveryAddress.houseNumberOrName` | string | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.postalCode` | string | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | 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. | | `deliveryAddress.street` | string | 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`. | | `description` | string | A short description visible on the payment page. Maximum length: 280 characters. | | `expiresAt` | string (date-time) | The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum... | | `fundOrigin` | object | | | `fundOrigin.billingAddress` | object | | | `fundOrigin.shopperEmail` | string | The email address of the person funding the money. | | `fundOrigin.shopperName` | object | | | `fundOrigin.telephoneNumber` | string | The phone number of the person funding the money. | | `fundOrigin.walletIdentifier` | string | The unique identifier of the wallet where the funds are coming from. | | `fundRecipient` | object | | | `fundRecipient.IBAN` | string | The IBAN of the bank account where the funds are being transferred to. | | `fundRecipient.billingAddress` | object | | | `fundRecipient.paymentMethod` | object | | | `fundRecipient.shopperEmail` | string | The email address of the shopper. | | `fundRecipient.shopperName` | object | | | `fundRecipient.shopperReference` | string | Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your... | | `fundRecipient.storedPaymentMethodId` | string | This is the `recurringDetailReference` returned in the response when you created the token. | | `fundRecipient.subMerchant` | object | | | `fundRecipient.telephoneNumber` | string | The telephone number of the shopper. | | `fundRecipient.walletIdentifier` | string | The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier. | | `fundRecipient.walletOwnerTaxId` | string | The tax identifier of the person receiving the funds. | | `fundRecipient.walletPurpose` | string, one of identifiedBoleto, transferDifferentWallet, transferOwnWallet, transferSameWallet, unidentifiedBoleto | The purpose of a digital wallet transaction. | | `id` | string | A unique identifier of the payment link. | | `installmentOptions` | object | A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options... | | `lineItems` | array of object | 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... | | `lineItems[].amountExcludingTax` | integer (int64) | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | Brand of the item. | | `lineItems[].color` | string | Color of the item. | | `lineItems[].description` | string | Description of the line item. | | `lineItems[].id` | string | ID of the line item. | | `lineItems[].imageUrl` | string | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | Marketplace seller id. | | `lineItems[].productUrl` | string | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | Number of items. | | `lineItems[].receiverEmail` | string | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | Size of the item. | | `lineItems[].sku` | string | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | Universal Product Code. | | `manualCapture` | boolean | Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). | | `mcc` | string | The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant... | | `merchantAccount` | string | The merchant account identifier for which the payment link is created. | | `merchantOrderReference` | string | This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. | | `metadata` | object | Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: "Metadata size exceeds limit" * Maximum... | | `platformChargebackLogic` | object | | | `platformChargebackLogic.behavior` | string, one of deductFromOneBalanceAccount, deductAccordingToSplitRatio, deductFromLiableAccount | The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. | | `platformChargebackLogic.costAllocationAccount` | string | The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. | | `platformChargebackLogic.targetAccount` | string | The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. | | `recurringProcessingModel` | string, one of CardOnFile, Subscription, UnscheduledCardOnFile | Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable... | | `reference` | string | A reference that is used to uniquely identify the payment in future communications about the payment status. | Also retrieved by: "did the buyer pay on the link we sent", "status of the link we shared", "check if that hosted page was paid". ### `adyen_checkout.patch_payment_links_link_id` Update the status of a payment link. Updates the status of a payment link. Calls PATCH /paymentLinks/{linkId}. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `PATCH /paymentLinks/{{params.linkId}}`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `linkId` | string | **yes** | Unique identifier of the payment link. | | `status` | string, one of expired | **yes** | Status of the payment link. Possible values: * **expired** | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `allowedPaymentMethods` | array of string | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | | | `applicationInfo.adyenLibrary` | object | | | `applicationInfo.adyenPaymentSource` | object | | | `applicationInfo.externalPlatform` | object | | | `applicationInfo.merchantApplication` | object | | | `applicationInfo.merchantDevice` | object | | | `applicationInfo.shopperInteractionDevice` | object | | | `billingAddress` | object | | | `billingAddress.city` | string | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | 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`. | | `billingAddress.houseNumberOrName` | string | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | 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. | | `billingAddress.street` | string | 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`. | | `blockedPaymentMethods` | array of string | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `captureDelayHours` | integer (int32) | The delay between the authorisation and scheduled auto-capture, specified in hours. | | `countryCode` | string | The shopper's two-letter country code. | | `dateOfBirth` | string (date) | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD | | `deliverAt` | string (date-time) | The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. | | `deliveryAddress` | object | | | `deliveryAddress.city` | string | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | 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`. | | `deliveryAddress.houseNumberOrName` | string | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.postalCode` | string | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | 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. | | `deliveryAddress.street` | string | 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`. | | `description` | string | A short description visible on the payment page. Maximum length: 280 characters. | | `expiresAt` | string (date-time) | The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum... | | `fundOrigin` | object | | | `fundOrigin.billingAddress` | object | | | `fundOrigin.shopperEmail` | string | The email address of the person funding the money. | | `fundOrigin.shopperName` | object | | | `fundOrigin.telephoneNumber` | string | The phone number of the person funding the money. | | `fundOrigin.walletIdentifier` | string | The unique identifier of the wallet where the funds are coming from. | | `fundRecipient` | object | | | `fundRecipient.IBAN` | string | The IBAN of the bank account where the funds are being transferred to. | | `fundRecipient.billingAddress` | object | | | `fundRecipient.paymentMethod` | object | | | `fundRecipient.shopperEmail` | string | The email address of the shopper. | | `fundRecipient.shopperName` | object | | | `fundRecipient.shopperReference` | string | Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your... | | `fundRecipient.storedPaymentMethodId` | string | This is the `recurringDetailReference` returned in the response when you created the token. | | `fundRecipient.subMerchant` | object | | | `fundRecipient.telephoneNumber` | string | The telephone number of the shopper. | | `fundRecipient.walletIdentifier` | string | The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier. | | `fundRecipient.walletOwnerTaxId` | string | The tax identifier of the person receiving the funds. | | `fundRecipient.walletPurpose` | string, one of identifiedBoleto, transferDifferentWallet, transferOwnWallet, transferSameWallet, unidentifiedBoleto | The purpose of a digital wallet transaction. | | `id` | string | A unique identifier of the payment link. | | `installmentOptions` | object | A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options... | | `lineItems` | array of object | 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... | | `lineItems[].amountExcludingTax` | integer (int64) | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | Brand of the item. | | `lineItems[].color` | string | Color of the item. | | `lineItems[].description` | string | Description of the line item. | | `lineItems[].id` | string | ID of the line item. | | `lineItems[].imageUrl` | string | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | Marketplace seller id. | | `lineItems[].productUrl` | string | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | Number of items. | | `lineItems[].receiverEmail` | string | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | Size of the item. | | `lineItems[].sku` | string | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | Universal Product Code. | | `manualCapture` | boolean | Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). | | `mcc` | string | The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant... | | `merchantAccount` | string | The merchant account identifier for which the payment link is created. | | `merchantOrderReference` | string | This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. | | `metadata` | object | Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: "Metadata size exceeds limit" * Maximum... | | `platformChargebackLogic` | object | | | `platformChargebackLogic.behavior` | string, one of deductFromOneBalanceAccount, deductAccordingToSplitRatio, deductFromLiableAccount | The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. | | `platformChargebackLogic.costAllocationAccount` | string | The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. | | `platformChargebackLogic.targetAccount` | string | The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. | | `recurringProcessingModel` | string, one of CardOnFile, Subscription, UnscheduledCardOnFile | Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable... | | `reference` | string | A reference that is used to uniquely identify the payment in future communications about the payment status. | Also retrieved by: "expire a pay-by-link url", "mark a shared payment request as no longer usable", "change whether a link still accepts money". ### `adyen_checkout.post_payment_methods` List the Adyen payment methods available for a checkout: the cards, wallets, and local options a buyer in a given country and currency can choose from. Use to show a shopper how they can pay. Calls POST /paymentMethods. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /paymentMethods`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `additionalData` | object | no | 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. | | `allowedPaymentMethods` | array of string | no | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `amount` | object | no | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `blockedPaymentMethods` | array of string | no | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `browserInfo` | object | no | | | `browserInfo.acceptHeader` | string | **yes** | The accept header value of the shopper's browser. | | `browserInfo.colorDepth` | integer (int32) | **yes** | 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... | | `browserInfo.javaEnabled` | boolean | **yes** | Boolean value indicating if the shopper's browser is able to execute Java. | | `browserInfo.javaScriptEnabled` | boolean | no | 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. Defaults to true. | | `browserInfo.language` | string | **yes** | The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). | | `browserInfo.screenHeight` | integer (int32) | **yes** | The total height of the shopper's device screen in pixels. | | `browserInfo.screenWidth` | integer (int32) | **yes** | The total width of the shopper's device screen in pixels. | | `browserInfo.timeZoneOffset` | integer (int32) | **yes** | Time difference between UTC time and the shopper's browser local time, in minutes. | | `browserInfo.userAgent` | string | **yes** | The user agent value of the shopper's browser. | | `channel` | string, one of iOS, Android, Web | no | The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web | | `countryCode` | string | no | The shopper's country code. | | `merchantAccount` | string | **yes** | The merchant account identifier, with which you want to process the transaction. | | `order` | object | no | | | `order.orderData` | string | **yes** | The encrypted order data. | | `order.pspReference` | string | **yes** | The `pspReference` that belongs to the order. | | `shopperConversionId` | string | no | A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use... | | `shopperEmail` | string | no | The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you... | | `shopperIP` | string | no | The shopper's IP address. 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). > Required for Visa... | | `shopperLocale` | string | no | The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1... | | `shopperReference` | string | no | Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your... | | `splitCardFundingSources` | boolean | no | Boolean value indicating whether the card payment method should be split into separate debit and credit options. Defaults to false. | | `store` | string | no | Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-referenc... | | `storeFiltrationMode` | string, one of exclusive, inclusive, skipFilter | no | Specifies how payment methods should be filtered based on the `store` parameter: - **exclusive**: Only payment methods belonging to the specified `store` are returned. - **inclusive**: Payment... | | `telephoneNumber` | string | no | The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `paymentMethods` | array of object | Detailed list of payment methods required to generate payment forms. | | `paymentMethods[].apps` | array | A list of apps for this payment method. | | `paymentMethods[].brand` | string | Brand for the selected gift card. For example: plastix, hmclub. | | `paymentMethods[].brands` | array | List of possible brands. For example: visa, mc. | | `paymentMethods[].configuration` | object | The configuration of the payment method. | | `paymentMethods[].fundingSource` | string, one of credit, debit, prepaid | The funding source of the payment method. | | `paymentMethods[].group` | object | | | `paymentMethods[].inputDetails` | array | All input details to be provided to complete the payment with this payment method. | | `paymentMethods[].issuers` | array | A list of issuers for this payment method. | | `paymentMethods[].name` | string | The displayable name of this payment method. | | `paymentMethods[].promoted` | boolean | Indicates whether this payment method should be promoted or not. | | `paymentMethods[].type` | string | The unique payment method code. | | `storedPaymentMethods` | array of object | List of all stored payment methods. | | `storedPaymentMethods[].bankAccountNumber` | string | The bank account number (without separators). | | `storedPaymentMethods[].bankLocationId` | string | The location id of the bank. The field value is `nil` in most cases. | | `storedPaymentMethods[].brand` | string | The brand of the card. | | `storedPaymentMethods[].cashtag` | string | The shopper’s Cash App Pay Cashtag. | | `storedPaymentMethods[].expiryMonth` | string | The two-digit month when the card expires | | `storedPaymentMethods[].expiryYear` | string | The last two digits of the year the card expires. For example, **22** for the year 2022. | | `storedPaymentMethods[].holderName` | string | The name of the payment method holder. | | `storedPaymentMethods[].iban` | string | The IBAN of the bank account. | | `storedPaymentMethods[].id` | string | A unique identifier of this stored payment method. | | `storedPaymentMethods[].label` | string | The shopper’s issuer account label | | `storedPaymentMethods[].lastFour` | string | The last four digits of the PAN. | | `storedPaymentMethods[].name` | string | The display name of the stored payment method. | | `storedPaymentMethods[].networkTxReference` | string | 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... | | `storedPaymentMethods[].ownerName` | string | The name of the bank account holder. | | `storedPaymentMethods[].shopperEmail` | string | The shopper’s email address. | | `storedPaymentMethods[].supportedRecurringProcessingModels` | array | The supported recurring processing models for this stored payment method. | | `storedPaymentMethods[].supportedShopperInteractions` | array | The supported shopper interactions for this stored payment method. | | `storedPaymentMethods[].type` | string | The type of payment method. | Also retrieved by: "which ways can a buyer pay here", "what options does a shopper have at checkout", "show the wallets and cards for this country". ### `adyen_checkout.post_payment_methods_balance` Get the balance of a gift card. Retrieves the balance remaining on a shopper's gift card. Calls POST /paymentMethods/balance. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /paymentMethods/balance`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `accountInfo` | object | no | | | `accountInfo.accountAgeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days *... | | `accountInfo.accountChangeDate` | string (date-time) | no | Date when the shopper's account was last changed. | | `accountInfo.accountChangeIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.accountCreationDate` | string (date-time) | no | Date when the shopper's account was created. | | `accountInfo.accountType` | string, one of notApplicable, credit, debit | no | Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit | | `accountInfo.addCardAttemptsDay` | integer (int32) | no | Number of attempts the shopper tried to add a card to their account in the last day. | | `accountInfo.deliveryAddressUsageDate` | string (date-time) | no | Date the selected delivery address was first used. | | `accountInfo.deliveryAddressUsageIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.homePhone` | string | no | Shopper's home phone number (including the country code). | | `accountInfo.mobilePhone` | string | no | Shopper's mobile phone number (including the country code). | | `accountInfo.passwordChangeDate` | string (date-time) | no | Date when the shopper last changed their password. | | `accountInfo.passwordChangeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.pastTransactionsDay` | integer (int32) | no | Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. | | `accountInfo.pastTransactionsYear` | integer (int32) | no | Number of all transactions (successful and abandoned) from this shopper in the past year. | | `accountInfo.paymentAccountAge` | string (date-time) | no | Date this payment method was added to the shopper's account. | | `accountInfo.paymentAccountIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.purchasesLast6Months` | integer (int32) | no | Number of successful purchases in the last six months. | | `accountInfo.suspiciousActivity` | boolean | no | Whether suspicious activity was recorded on this account. | | `accountInfo.workPhone` | string | no | Shopper's work phone number (including the country code). | | `additionalAmount` | object | no | | | `additionalAmount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `additionalAmount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `additionalData` | object | no | 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. | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `billingAddress` | object | no | | | `billingAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | **yes** | 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`. | | `billingAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | no | 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. | | `billingAddress.street` | string | **yes** | 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`. | | `browserInfo` | object | no | | | `browserInfo.acceptHeader` | string | **yes** | The accept header value of the shopper's browser. | | `browserInfo.colorDepth` | integer (int32) | **yes** | 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... | | `browserInfo.javaEnabled` | boolean | **yes** | Boolean value indicating if the shopper's browser is able to execute Java. | | `browserInfo.javaScriptEnabled` | boolean | no | 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. Defaults to true. | | `browserInfo.language` | string | **yes** | The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). | | `browserInfo.screenHeight` | integer (int32) | **yes** | The total height of the shopper's device screen in pixels. | | `browserInfo.screenWidth` | integer (int32) | **yes** | The total width of the shopper's device screen in pixels. | | `browserInfo.timeZoneOffset` | integer (int32) | **yes** | Time difference between UTC time and the shopper's browser local time, in minutes. | | `browserInfo.userAgent` | string | **yes** | The user agent value of the shopper's browser. | | `captureDelayHours` | integer (int32) | no | The delay between the authorisation and scheduled auto-capture, specified in hours. | | `dateOfBirth` | string (date) | no | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD | | `dccQuote` | object | no | | | `dccQuote.account` | string | no | The account name. | | `dccQuote.accountType` | string | no | The account type. | | `dccQuote.baseAmount` | object | no | | | `dccQuote.basePoints` | integer (int32) | **yes** | The base points. | | `dccQuote.buy` | object | no | | | `dccQuote.interbank` | object | no | | | `dccQuote.reference` | string | no | The reference assigned to the forex quote request. | | `dccQuote.sell` | object | no | | | `dccQuote.signature` | string | no | The signature to validate the integrity. | | `dccQuote.source` | string | no | The source of the forex quote. | | `dccQuote.type` | string | no | The type of forex. | | `dccQuote.validTill` | string (date-time) | **yes** | The date until which the forex quote is valid. | | `deliveryAddress` | object | no | | | `deliveryAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | **yes** | 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`. | | `deliveryAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | no | 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. | | `deliveryAddress.street` | string | **yes** | 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`. | | `deliveryDate` | string (date-time) | no | 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 | | `deviceFingerprint` | string | no | A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). | | `fraudOffset` | integer (int32) | no | An integer value that is added to the normal fraud score. The value can be either positive or negative. | | `installments` | object | no | | | `installments.extra` | integer (int32) | no | Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later. Used for [card installments in... | | `installments.plan` | string, one of bonus, buynow_paylater, interes_refund_prctg, interest_bonus, nointeres_refund_prctg, nointerest_bonus, refund_prctg, regular, revolving, with_interest | no | The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and... | | `installments.value` | integer (int32) | **yes** | Defines the number of installments. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer... | | `localizedShopperStatement` | object | no | The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If this parameter is left empty, not provided, or not applicable (in case of... | | `mcc` | string | no | The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant... | | `merchantAccount` | string | **yes** | The merchant account identifier, with which you want to process the transaction. | | `merchantOrderReference` | string | no | This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference... | | `merchantRiskIndicator` | object | no | | | `merchantRiskIndicator.addressMatch` | boolean | no | Whether the chosen delivery address is identical to the billing address. | | `merchantRiskIndicator.deliveryAddressIndicator` | string, one of shipToBillingAddress, shipToVerifiedAddress, shipToNewAddress, shipToStore, digitalGoods, goodsNotShipped, other | no | Indicator regarding the delivery address. Allowed values: * `shipToBillingAddress` * `shipToVerifiedAddress` * `shipToNewAddress` * `shipToStore` * `digitalGoods` * `goodsNotShipped` * `other` | | `merchantRiskIndicator.deliveryEmail` | string | no | The delivery email address (for digital goods). | | `merchantRiskIndicator.deliveryEmailAddress` | string | no | For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters. | | `merchantRiskIndicator.deliveryTimeframe` | string, one of electronicDelivery, sameDayShipping, overnightShipping, twoOrMoreDaysShipping | no | The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping` | | `merchantRiskIndicator.giftCardAmount` | object | no | | | `merchantRiskIndicator.giftCardCount` | integer (int32) | no | For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. | | `merchantRiskIndicator.giftCardCurr` | string | no | 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... | | `merchantRiskIndicator.preOrderDate` | string (date-time) | no | For pre-order purchases, the expected date this product will be available to the shopper. | | `merchantRiskIndicator.preOrderPurchase` | boolean | no | Indicator for whether this transaction is for pre-ordering a product. | | `merchantRiskIndicator.preOrderPurchaseInd` | string | no | Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. | | `merchantRiskIndicator.reorderItems` | boolean | no | Indicator for whether the shopper has already purchased the same items in the past. | | `merchantRiskIndicator.reorderItemsInd` | string | no | Indicates whether the cardholder is reordering previously purchased merchandise. | | `merchantRiskIndicator.shipIndicator` | string | no | Indicates shipping method chosen for the transaction. | | `metadata` | object | no | 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". *... | | `orderReference` | string | no | When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking... | | `paymentMethod` | object | **yes** | The collection that contains the type of the payment method and its specific information. | | `recurring` | object | no | | | `recurring.contract` | string, one of ONECLICK, ONECLICK,RECURRING, RECURRING, PAYOUT, EXTERNAL | no | The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code... | | `recurring.recurringDetailName` | string | no | A descriptive name for this detail. | | `recurring.recurringExpiry` | string (date-time) | no | Date after which no further authorisations shall be performed. Only for 3D Secure 2. | | `recurring.recurringFrequency` | string | no | Minimum number of days between authorisations. Only for 3D Secure 2. | | `recurring.tokenService` | string, one of VISATOKENSERVICE, MCTOKENSERVICE, AMEXTOKENSERVICE, TOKEN_SHARING | no | The name of the token service. | | `recurringProcessingModel` | string, one of CardOnFile, Subscription, UnscheduledCardOnFile | no | 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... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `additionalData` | object | Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. | | `balance` | object | | | `balance.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `balance.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `fraudResult` | object | | | `fraudResult.accountScore` | integer (int32) | The total fraud score generated by the risk checks. | | `fraudResult.results` | array | The result of the individual risk checks. | | `pspReference` | string | Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. | | `refusalReason` | string | If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the... | | `resultCode` | string, one of Success, NotEnoughBalance, Failed | The result of the cancellation request. Possible values: * **Success** – Indicates that the balance check was successful. * **NotEnoughBalance** – Commonly indicates that the card did not have... | | `transactionLimit` | object | | | `transactionLimit.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `transactionLimit.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | Also retrieved by: "how much is left on a gift card", "remaining value on a shopper's voucher", "check funds before splitting a payment". ### `adyen_checkout.post_payments` Start an Adyen payment: charge a shopper's card or wallet for an amount in a currency, taking money for a checkout or order. Use when someone wants to bill a buyer, collect a payment, or run a transaction. Calls POST /payments. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /payments`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `accountInfo` | object | no | | | `accountInfo.accountAgeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days *... | | `accountInfo.accountChangeDate` | string (date-time) | no | Date when the shopper's account was last changed. | | `accountInfo.accountChangeIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.accountCreationDate` | string (date-time) | no | Date when the shopper's account was created. | | `accountInfo.accountType` | string, one of notApplicable, credit, debit | no | Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit | | `accountInfo.addCardAttemptsDay` | integer (int32) | no | Number of attempts the shopper tried to add a card to their account in the last day. | | `accountInfo.deliveryAddressUsageDate` | string (date-time) | no | Date the selected delivery address was first used. | | `accountInfo.deliveryAddressUsageIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.homePhone` | string | no | Shopper's home phone number (including the country code). | | `accountInfo.mobilePhone` | string | no | Shopper's mobile phone number (including the country code). | | `accountInfo.passwordChangeDate` | string (date-time) | no | Date when the shopper last changed their password. | | `accountInfo.passwordChangeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.pastTransactionsDay` | integer (int32) | no | Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. | | `accountInfo.pastTransactionsYear` | integer (int32) | no | Number of all transactions (successful and abandoned) from this shopper in the past year. | | `accountInfo.paymentAccountAge` | string (date-time) | no | Date this payment method was added to the shopper's account. | | `accountInfo.paymentAccountIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.purchasesLast6Months` | integer (int32) | no | Number of successful purchases in the last six months. | | `accountInfo.suspiciousActivity` | boolean | no | Whether suspicious activity was recorded on this account. | | `accountInfo.workPhone` | string | no | Shopper's work phone number (including the country code). | | `additionalAmount` | object | no | | | `additionalAmount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `additionalAmount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `additionalData` | object | no | 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. | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `authenticationData` | object | no | | | `authenticationData.attemptAuthentication` | string, one of always, never | no | 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... | | `authenticationData.authenticationOnly` | boolean | no | Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication... Defaults to false. | | `authenticationData.threeDSRequestData` | object | no | | | `bankAccount` | object | no | | | `bankAccount.accountType` | string, one of balance, checking, deposit, general, other, payment, savings | no | The type of the bank account. | | `bankAccount.bankAccountNumber` | string | no | The bank account number (without separators). | | `bankAccount.bankCity` | string | no | The bank city. | | `bankAccount.bankLocationId` | string | no | The location id of the bank. The field value is `nil` in most cases. | | `bankAccount.bankName` | string | no | The name of the bank. | | `bankAccount.bic` | string | no | The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases. | | `bankAccount.countryCode` | string | no | Country code where the bank is located. A valid value is an ISO two-character country code (e.g. 'NL'). | | `bankAccount.iban` | string | no | The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN). | | `bankAccount.ownerName` | string | no | The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For... | | `bankAccount.taxId` | string | no | The bank account holder's tax ID. | | `billingAddress` | object | no | | | `billingAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | **yes** | 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`. | | `billingAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | no | 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. | | `billingAddress.street` | string | **yes** | 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`. | | `browserInfo` | object | no | | | `browserInfo.acceptHeader` | string | **yes** | The accept header value of the shopper's browser. | | `browserInfo.colorDepth` | integer (int32) | **yes** | 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... | | `browserInfo.javaEnabled` | boolean | **yes** | Boolean value indicating if the shopper's browser is able to execute Java. | | `browserInfo.javaScriptEnabled` | boolean | no | 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. Defaults to true. | | `browserInfo.language` | string | **yes** | The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). | | `browserInfo.screenHeight` | integer (int32) | **yes** | The total height of the shopper's device screen in pixels. | | `browserInfo.screenWidth` | integer (int32) | **yes** | The total width of the shopper's device screen in pixels. | | `browserInfo.timeZoneOffset` | integer (int32) | **yes** | Time difference between UTC time and the shopper's browser local time, in minutes. | | `browserInfo.userAgent` | string | **yes** | The user agent value of the shopper's browser. | | `captureDelayHours` | integer (int32) | no | The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours... | | `channel` | string, one of iOS, Android, Web | no | 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... | | `checkoutAttemptId` | string | no | Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. | | `company` | object | no | | | `company.homepage` | string | no | The company website's home page. | | `company.name` | string | no | The company name. | | `company.registrationNumber` | string | no | Registration number of the company. | | `company.registryLocation` | string | no | Registry location of the company. | | `company.taxId` | string | no | Tax ID of the company. | | `company.type` | string | no | The company type. | | `conversionId` | string | no | Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. | | `countryCode` | string | no | The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE | | `dateOfBirth` | string (date-time) | no | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD | | `dccQuote` | object | no | | | `dccQuote.account` | string | no | The account name. | | `dccQuote.accountType` | string | no | The account type. | | `dccQuote.baseAmount` | object | no | | | `dccQuote.basePoints` | integer (int32) | **yes** | The base points. | | `dccQuote.buy` | object | no | | | `dccQuote.interbank` | object | no | | | `dccQuote.reference` | string | no | The reference assigned to the forex quote request. | | `dccQuote.sell` | object | no | | | `dccQuote.signature` | string | no | The signature to validate the integrity. | | `dccQuote.source` | string | no | The source of the forex quote. | | `dccQuote.type` | string | no | The type of forex. | | `dccQuote.validTill` | string (date-time) | **yes** | The date until which the forex quote is valid. | | `deliverAt` | string (date-time) | no | 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 | | `deliveryAddress` | object | no | | | `deliveryAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | **yes** | 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`. | | `deliveryAddress.firstName` | string | no | | | `deliveryAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.lastName` | string | no | | | `deliveryAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | no | 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. | | `deliveryAddress.street` | string | **yes** | 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`. | | `deliveryDate` | string (date-time) | no | 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 | | `deviceFingerprint` | string | no | A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). | | `enableOneClick` | boolean | no | When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click... | | `enablePayOut` | boolean | no | When true and `shopperReference` is provided, the payment details will be tokenized for payouts. | | `enableRecurring` | boolean | no | When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the... | | `enhancedSchemeData` | object | no | | | `enhancedSchemeData.airline` | object | no | | | `enhancedSchemeData.carRental` | object | no | | | `enhancedSchemeData.levelTwoThree` | object | no | | | `enhancedSchemeData.lodging` | object | no | | | `enhancedSchemeData.temporaryServices` | object | no | | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `action` | object | Action to be taken for completing the payment. | | `action.paymentData` | string | Encoded payment data. | | `action.paymentMethodType` | string | Specifies the payment method. | | `action.type` | string, one of await | **await** | | `action.url` | string | Specifies the URL to redirect to. | | `additionalData` | object | Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `donationToken` | string | Donation Token containing payment details for Adyen Giving. | | `fraudResult` | object | | | `fraudResult.accountScore` | integer (int32) | The total fraud score generated by the risk checks. | | `fraudResult.results` | array | The result of the individual risk checks. | | `merchantReference` | string | The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a... | | `order` | object | | | `order.amount` | object | | | `order.expiresAt` | string | The expiry date for the order. | | `order.orderData` | string | The encrypted order data. | | `order.pspReference` | string | The `pspReference` that belongs to the order. | | `order.reference` | string | The merchant reference for the order. | | `order.remainingAmount` | object | | | `paymentMethod` | object | | | `paymentMethod.brand` | string | The card brand that the shopper used to pay. Only returned if `paymentMethod.type` is **scheme**. | | `paymentMethod.type` | string | The `paymentMethod.type` value used in the request. | | `paymentValidations` | object | | | `paymentValidations.name` | object | | | `pspReference` | string | Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > For payment methods that... | | `refusalReason` | string | If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the... | | `refusalReasonCode` | string | Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). | | `resultCode` | string, one of AuthenticationFinished, AuthenticationNotRequired, Authorised, Cancelled, ChallengeShopper, Error, IdentifyShopper, PartiallyAuthorised, Pending, PresentToShopper, Received, RedirectShopper, Refused, Success | 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... | | `threeDS2ResponseData` | object | | | `threeDS2ResponseData.acsChallengeMandated` | string | | | `threeDS2ResponseData.acsOperatorID` | string | | | `threeDS2ResponseData.acsReferenceNumber` | string | | | `threeDS2ResponseData.acsSignedContent` | string | | | `threeDS2ResponseData.acsTransID` | string | | | `threeDS2ResponseData.acsURL` | string | | | `threeDS2ResponseData.authenticationType` | string | | | `threeDS2ResponseData.cardHolderInfo` | string | | | `threeDS2ResponseData.cavvAlgorithm` | string | | | `threeDS2ResponseData.challengeIndicator` | string | | | `threeDS2ResponseData.dsReferenceNumber` | string | | | `threeDS2ResponseData.dsTransID` | string | | | `threeDS2ResponseData.exemptionIndicator` | string | | | `threeDS2ResponseData.messageVersion` | string | | | `threeDS2ResponseData.riskScore` | string | | | `threeDS2ResponseData.sdkEphemPubKey` | string | | | `threeDS2ResponseData.threeDSServerTransID` | string | | | `threeDS2ResponseData.transStatus` | string | | | `threeDS2ResponseData.transStatusReason` | string | | | `threeDS2Result` | object | | | `threeDS2Result.authenticationValue` | string | The `authenticationValue` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.cavvAlgorithm` | string | The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations. | | `threeDS2Result.challengeCancel` | string, one of 01, 02, 03, 04, 05, 06, 07 | 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... | | `threeDS2Result.dsTransID` | string | The `dsTransID` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.eci` | string | The `eci` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.exemptionIndicator` | string, one of lowValue, secureCorporate, trustedBeneficiary, transactionRiskAnalysis | Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` *... | | `threeDS2Result.messageVersion` | string | The `messageVersion` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.riskScore` | string | Risk score calculated by Cartes Bancaires Directory Server (DS). | | `threeDS2Result.threeDSRequestorChallengeInd` | string, one of 01, 02, 03, 04, 05, 06 | Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor... | | `threeDS2Result.threeDSServerTransID` | string | The `threeDSServerTransID` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.timestamp` | string | The `timestamp` value of the 3D Secure 2 authentication. | | `threeDS2Result.transStatus` | string | The `transStatus` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.transStatusReason` | string | Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our... | | `threeDS2Result.whiteListStatus` | string | The `whiteListStatus` value as defined in the 3D Secure 2 specification. | | `threeDSPaymentData` | string | When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. | Also retrieved by: "charge this shopper's card", "take money for the order", "bill the buyer for the total". ### `adyen_checkout.post_payments_details` Submit details for a payment. Submits details for a payment created using `/payments`. Calls POST /payments/details. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /payments/details`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `authenticationData` | object | no | | | `authenticationData.authenticationOnly` | boolean | no | Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication... Defaults to false. | | `details` | object | **yes** | | | `details.MD` | string | no | A payment session identifier returned by the card issuer. | | `details.PaReq` | string | no | (3D) Payment Authentication Request data for the card issuer. | | `details.PaRes` | string | no | (3D) Payment Authentication Response data by the card issuer. | | `details.authorization_token` | string | no | | | `details.billingToken` | string | no | PayPal-generated token for recurring payments. | | `details.cupsecureplus.smscode` | string | no | The SMS verification code collected from the shopper. | | `details.facilitatorAccessToken` | string | no | PayPal-generated third party access token. | | `details.oneTimePasscode` | string | no | A random number sent to the mobile phone number of the shopper to verify the payment. | | `details.orderID` | string | no | PayPal-assigned ID for the order. | | `details.payerID` | string | no | PayPal-assigned ID for the payer (shopper). | | `details.payload` | string | no | Payload appended to the `returnURL` as a result of the redirect. | | `details.paymentID` | string | no | PayPal-generated ID for the payment. | | `details.paymentStatus` | string | no | Value passed from the WeChat MiniProgram `wx.requestPayment` **complete** callback. Possible values: any value starting with `requestPayment:`. | | `details.redirectResult` | string | no | The result of the redirect as appended to the `returnURL`. | | `details.resultCode` | string | no | Value you received from the WeChat Pay SDK. | | `details.returnUrlQueryString` | string | no | The query string as appended to the `returnURL` when using direct issuer links . | | `details.threeDSResult` | string | no | Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`. | | `details.threeds2.challengeResult` | string | no | Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`. | | `details.threeds2.fingerprint` | string | no | Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`. | | `details.vaultToken` | string | no | PayPalv2-generated token for recurring payments. | | `paymentData` | string | no | Encoded payment data. For [authorizing a payment after using 3D Secure 2 Authentication-only](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only/#authorise-the-paymen... | | `threeDSAuthenticationOnly` | boolean | no | Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `action` | object | Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. | | `action.authorisationToken` | string | A token needed to authorise a payment. | | `action.paymentData` | string | Encoded payment data. | | `action.paymentMethodType` | string | Specifies the payment method. | | `action.subtype` | string | A subtype of the token. | | `action.token` | string | A token to pass to the 3DS2 Component to get the fingerprint. | | `action.type` | string, one of threeDS2 | **threeDS2** | | `action.url` | string | Specifies the URL to redirect to. | | `additionalData` | object | Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `donationToken` | string | Donation Token containing payment details for Adyen Giving. | | `fraudResult` | object | | | `fraudResult.accountScore` | integer (int32) | The total fraud score generated by the risk checks. | | `fraudResult.results` | array | The result of the individual risk checks. | | `merchantReference` | string | The reference used during the /payments request. | | `order` | object | | | `order.amount` | object | | | `order.expiresAt` | string | The expiry date for the order. | | `order.orderData` | string | The encrypted order data. | | `order.pspReference` | string | The `pspReference` that belongs to the order. | | `order.reference` | string | The merchant reference for the order. | | `order.remainingAmount` | object | | | `paymentMethod` | object | | | `paymentMethod.brand` | string | The card brand that the shopper used to pay. Only returned if `paymentMethod.type` is **scheme**. | | `paymentMethod.type` | string | The `paymentMethod.type` value used in the request. | | `paymentValidations` | object | | | `paymentValidations.name` | object | | | `pspReference` | string | Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. | | `refusalReason` | string | If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the... | | `refusalReasonCode` | string | Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). | | `resultCode` | string, one of AuthenticationFinished, AuthenticationNotRequired, Authorised, Cancelled, ChallengeShopper, Error, IdentifyShopper, PartiallyAuthorised, Pending, PresentToShopper, Received, RedirectShopper, Refused, Success | 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... | | `shopperLocale` | string | The shopperLocale. | | `threeDS2ResponseData` | object | | | `threeDS2ResponseData.acsChallengeMandated` | string | | | `threeDS2ResponseData.acsOperatorID` | string | | | `threeDS2ResponseData.acsReferenceNumber` | string | | | `threeDS2ResponseData.acsSignedContent` | string | | | `threeDS2ResponseData.acsTransID` | string | | | `threeDS2ResponseData.acsURL` | string | | | `threeDS2ResponseData.authenticationType` | string | | | `threeDS2ResponseData.cardHolderInfo` | string | | | `threeDS2ResponseData.cavvAlgorithm` | string | | | `threeDS2ResponseData.challengeIndicator` | string | | | `threeDS2ResponseData.dsReferenceNumber` | string | | | `threeDS2ResponseData.dsTransID` | string | | | `threeDS2ResponseData.exemptionIndicator` | string | | | `threeDS2ResponseData.messageVersion` | string | | | `threeDS2ResponseData.riskScore` | string | | | `threeDS2ResponseData.sdkEphemPubKey` | string | | | `threeDS2ResponseData.threeDSServerTransID` | string | | | `threeDS2ResponseData.transStatus` | string | | | `threeDS2ResponseData.transStatusReason` | string | | | `threeDS2Result` | object | | | `threeDS2Result.authenticationValue` | string | The `authenticationValue` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.cavvAlgorithm` | string | The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations. | | `threeDS2Result.challengeCancel` | string, one of 01, 02, 03, 04, 05, 06, 07 | 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... | | `threeDS2Result.dsTransID` | string | The `dsTransID` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.eci` | string | The `eci` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.exemptionIndicator` | string, one of lowValue, secureCorporate, trustedBeneficiary, transactionRiskAnalysis | Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` *... | | `threeDS2Result.messageVersion` | string | The `messageVersion` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.riskScore` | string | Risk score calculated by Cartes Bancaires Directory Server (DS). | | `threeDS2Result.threeDSRequestorChallengeInd` | string, one of 01, 02, 03, 04, 05, 06 | Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor... | | `threeDS2Result.threeDSServerTransID` | string | The `threeDSServerTransID` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.timestamp` | string | The `timestamp` value of the 3D Secure 2 authentication. | | `threeDS2Result.transStatus` | string | The `transStatus` value as defined in the 3D Secure 2 specification. | | `threeDS2Result.transStatusReason` | string | Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our... | | `threeDS2Result.whiteListStatus` | string | The `whiteListStatus` value as defined in the 3D Secure 2 specification. | | `threeDSPaymentData` | string | When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. | Also retrieved by: "finish a payment after 3d secure", "send back the redirect result", "complete an authentication step the shopper did". ### `adyen_checkout.post_payments_payment_psp_reference_amount_updates` Update an authorised amount. Increases or decreases the authorised payment amount and returns a unique reference for this request. Calls POST /payments/{paymentPspReference}/amountUpdates. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /payments/{{params.paymentPspReference}}/amountUpdates`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `enhancedSchemeData` | object | no | | | `enhancedSchemeData.airline` | object | no | | | `enhancedSchemeData.carRental` | object | no | | | `enhancedSchemeData.levelTwoThree` | object | no | | | `enhancedSchemeData.lodging` | object | no | | | `enhancedSchemeData.temporaryServices` | object | no | | | `industryUsage` | string, one of delayedCharge, installment, noShow | no | The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment** | | `lineItems` | array of object | no | Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with... | | `lineItems[].amountExcludingTax` | integer (int64) | no | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | no | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | no | Brand of the item. | | `lineItems[].color` | string | no | Color of the item. | | `lineItems[].description` | string | no | Description of the line item. | | `lineItems[].id` | string | no | ID of the line item. | | `lineItems[].imageUrl` | string | no | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | no | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | no | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | no | Marketplace seller id. | | `lineItems[].productUrl` | string | no | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | no | Number of items. | | `lineItems[].receiverEmail` | string | no | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | no | Size of the item. | | `lineItems[].sku` | string | no | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | no | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | no | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | no | Universal Product Code. | | `merchantAccount` | string | **yes** | The merchant account that is used to process the payment. | | `paymentPspReference` | string | **yes** | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment. | | `reference` | string | no | Your reference for the amount update request. Maximum length: 80 characters. | | `splits` | array of object | no | An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for... | | `splits[].account` | string | no | The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms... | | `splits[].amount` | object | no | | | `splits[].description` | string | no | Your description for the split item. | | `splits[].reference` | string | no | Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms... | | `splits[].type` | string, one of AcquiringFees, AdyenCommission, AdyenFees, AdyenMarkup, BalanceAccount, Commission, Default, Interchange, MarketPlace, PaymentFee, Remainder, SchemeFee, Surcharge, Tip, TopUp, VAT | **yes** | The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `industryUsage` | string, one of delayedCharge, installment, noShow | The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment** | | `lineItems` | array of object | Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with... | | `lineItems[].amountExcludingTax` | integer (int64) | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | Brand of the item. | | `lineItems[].color` | string | Color of the item. | | `lineItems[].description` | string | Description of the line item. | | `lineItems[].id` | string | ID of the line item. | | `lineItems[].imageUrl` | string | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | Marketplace seller id. | | `lineItems[].productUrl` | string | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | Number of items. | | `lineItems[].receiverEmail` | string | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | Size of the item. | | `lineItems[].sku` | string | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | Universal Product Code. | | `merchantAccount` | string | The merchant account that is used to process the payment. | | `paymentPspReference` | string | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to update. | | `pspReference` | string | Adyen's 16-character reference associated with the amount update request. | | `reference` | string | Your reference for the amount update request. Maximum length: 80 characters. | | `splits` | array of object | An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for... | | `splits[].account` | string | The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms... | | `splits[].amount` | object | | | `splits[].description` | string | Your description for the split item. | | `splits[].reference` | string | Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms... | | `splits[].type` | string, one of AcquiringFees, AdyenCommission, AdyenFees, AdyenMarkup, BalanceAccount, Commission, Default, Interchange, MarketPlace, PaymentFee, Remainder, SchemeFee, Surcharge, Tip, TopUp, VAT | The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of... | | `status` | string, one of received | The status of your request. This will always have the value **received**. | Also retrieved by: "raise or lower an authorisation", "adjust the amount we are holding on a card", "change how much was reserved before capture". ### `adyen_checkout.post_payments_payment_psp_reference_cancels` Cancel an authorised Adyen payment before it is captured, by its pspReference from the original /payments call: void the hold so the shopper is never charged. Calls POST /payments/{paymentPspReference}/cancels. Class `destructive` (held by the mutation gate until the call's own arguments carry `"confirm": true`). No scopes beyond the connection's defaults. Calls `POST /payments/{{params.paymentPspReference}}/cancels`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `enhancedSchemeData` | object | no | | | `enhancedSchemeData.airline` | object | no | | | `enhancedSchemeData.carRental` | object | no | | | `enhancedSchemeData.levelTwoThree` | object | no | | | `enhancedSchemeData.lodging` | object | no | | | `enhancedSchemeData.temporaryServices` | object | no | | | `merchantAccount` | string | **yes** | The merchant account that is used to process the payment. | | `paymentPspReference` | string | **yes** | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you want to cancel. | | `reference` | string | no | Your reference for the cancel request. Maximum length: 80 characters. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `merchantAccount` | string | The merchant account that is used to process the payment. | | `paymentPspReference` | string | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to cancel. | | `pspReference` | string | Adyen's 16-character reference associated with the cancel request. | | `reference` | string | Your reference for the cancel request. | | `status` | string, one of received | The status of your request. This will always have the value **received**. | Also retrieved by: "call off that hold before it settles", "void the authorisation by its reference", "stop a charge we authorised earlier". ### `adyen_checkout.post_payments_payment_psp_reference_captures` Capture an authorised Adyen payment: take the funds that were held or reserved earlier so the money actually settles, by its pspReference. Use to collect on an authorisation. Calls POST /payments/{paymentPspReference}/captures. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /payments/{{params.paymentPspReference}}/captures`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `enhancedSchemeData` | object | no | | | `enhancedSchemeData.airline` | object | no | | | `enhancedSchemeData.carRental` | object | no | | | `enhancedSchemeData.levelTwoThree` | object | no | | | `enhancedSchemeData.lodging` | object | no | | | `enhancedSchemeData.temporaryServices` | object | no | | | `lineItems` | array of object | no | Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with... | | `lineItems[].amountExcludingTax` | integer (int64) | no | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | no | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | no | Brand of the item. | | `lineItems[].color` | string | no | Color of the item. | | `lineItems[].description` | string | no | Description of the line item. | | `lineItems[].id` | string | no | ID of the line item. | | `lineItems[].imageUrl` | string | no | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | no | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | no | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | no | Marketplace seller id. | | `lineItems[].productUrl` | string | no | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | no | Number of items. | | `lineItems[].receiverEmail` | string | no | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | no | Size of the item. | | `lineItems[].sku` | string | no | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | no | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | no | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | no | Universal Product Code. | | `merchantAccount` | string | **yes** | The merchant account that is used to process the payment. | | `paymentPspReference` | string | **yes** | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you want to capture. | | `platformChargebackLogic` | object | no | | | `platformChargebackLogic.behavior` | string, one of deductFromOneBalanceAccount, deductAccordingToSplitRatio, deductFromLiableAccount | no | The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. | | `platformChargebackLogic.costAllocationAccount` | string | no | The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. | | `platformChargebackLogic.targetAccount` | string | no | The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. | | `reference` | string | no | Your reference for the capture request. Maximum length: 80 characters. | | `splits` | array of object | no | An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for... | | `splits[].account` | string | no | The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms... | | `splits[].amount` | object | no | | | `splits[].description` | string | no | Your description for the split item. | | `splits[].reference` | string | no | Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms... | | `splits[].type` | string, one of AcquiringFees, AdyenCommission, AdyenFees, AdyenMarkup, BalanceAccount, Commission, Default, Interchange, MarketPlace, PaymentFee, Remainder, SchemeFee, Surcharge, Tip, TopUp, VAT | **yes** | The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of... | | `subMerchants` | array of object | no | A List of sub-merchants. | | `subMerchants[].address` | object | no | | | `subMerchants[].amount` | object | no | | | `subMerchants[].email` | string | no | Required for transactions performed by registered payment facilitators. The email associated with the sub-merchant's account. | | `subMerchants[].id` | string | no | 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. * Format: Alphanumeric... | | `subMerchants[].mcc` | string | no | Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits | | `subMerchants[].name` | string | no | 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... | | `subMerchants[].phoneNumber` | string | no | Required for transactions performed by registered payment facilitators. The phone number associated with the sub-merchant's account. | | `subMerchants[].registeredSince` | string | no | | | `subMerchants[].taxId` | string | no | 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 | | `subMerchants[].url` | string | no | Required for transactions performed by registered payment facilitators. The sub-merchant's URL on the platform, i.e. the sub-merchant's shop. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `lineItems` | array of object | Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with... | | `lineItems[].amountExcludingTax` | integer (int64) | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | Brand of the item. | | `lineItems[].color` | string | Color of the item. | | `lineItems[].description` | string | Description of the line item. | | `lineItems[].id` | string | ID of the line item. | | `lineItems[].imageUrl` | string | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | Marketplace seller id. | | `lineItems[].productUrl` | string | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | Number of items. | | `lineItems[].receiverEmail` | string | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | Size of the item. | | `lineItems[].sku` | string | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | Universal Product Code. | | `merchantAccount` | string | The merchant account that is used to process the payment. | | `paymentPspReference` | string | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to capture. | | `platformChargebackLogic` | object | | | `platformChargebackLogic.behavior` | string, one of deductFromOneBalanceAccount, deductAccordingToSplitRatio, deductFromLiableAccount | The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. | | `platformChargebackLogic.costAllocationAccount` | string | The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. | | `platformChargebackLogic.targetAccount` | string | The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. | | `pspReference` | string | Adyen's 16-character reference associated with the capture request. | | `reference` | string | Your reference for the capture request. | | `splits` | array of object | An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for... | | `splits[].account` | string | The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms... | | `splits[].amount` | object | | | `splits[].description` | string | Your description for the split item. | | `splits[].reference` | string | Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms... | | `splits[].type` | string, one of AcquiringFees, AdyenCommission, AdyenFees, AdyenMarkup, BalanceAccount, Commission, Default, Interchange, MarketPlace, PaymentFee, Remainder, SchemeFee, Surcharge, Tip, TopUp, VAT | The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of... | | `status` | string, one of received | The status of your request. This will always have the value **received**. | | `subMerchants` | array of object | List of sub-merchants. | | `subMerchants[].address` | object | | | `subMerchants[].amount` | object | | | `subMerchants[].email` | string | Required for transactions performed by registered payment facilitators. The email associated with the sub-merchant's account. | | `subMerchants[].id` | string | 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. * Format: Alphanumeric... | | `subMerchants[].mcc` | string | Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits | | `subMerchants[].name` | string | 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... | | `subMerchants[].phoneNumber` | string | Required for transactions performed by registered payment facilitators. The phone number associated with the sub-merchant's account. | | `subMerchants[].registeredSince` | string | | | `subMerchants[].taxId` | string | 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 | | `subMerchants[].url` | string | Required for transactions performed by registered payment facilitators. The sub-merchant's URL on the platform, i.e. the sub-merchant's shop. | Also retrieved by: "take the funds we held earlier", "settle the money we reserved", "collect on an earlier authorisation". ### `adyen_checkout.post_payments_payment_psp_reference_refunds` Refund an Adyen payment that was already captured: return the money to the buyer for a settled transaction, in full or in part, by its pspReference. Use to pay a customer back. Calls POST /payments/{paymentPspReference}/refunds. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /payments/{{params.paymentPspReference}}/refunds`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `capturePspReference` | string | no | This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund. | | `enhancedSchemeData` | object | no | | | `enhancedSchemeData.airline` | object | no | | | `enhancedSchemeData.carRental` | object | no | | | `enhancedSchemeData.levelTwoThree` | object | no | | | `enhancedSchemeData.lodging` | object | no | | | `enhancedSchemeData.temporaryServices` | object | no | | | `lineItems` | array of object | no | Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with... | | `lineItems[].amountExcludingTax` | integer (int64) | no | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | no | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | no | Brand of the item. | | `lineItems[].color` | string | no | Color of the item. | | `lineItems[].description` | string | no | Description of the line item. | | `lineItems[].id` | string | no | ID of the line item. | | `lineItems[].imageUrl` | string | no | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | no | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | no | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | no | Marketplace seller id. | | `lineItems[].productUrl` | string | no | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | no | Number of items. | | `lineItems[].receiverEmail` | string | no | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | no | Size of the item. | | `lineItems[].sku` | string | no | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | no | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | no | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | no | Universal Product Code. | | `merchantAccount` | string | **yes** | The merchant account that is used to process the payment. | | `merchantRefundReason` | string, one of FRAUD, CUSTOMER REQUEST, RETURN, DUPLICATE, OTHER | no | The reason for the refund request. Possible values: * **FRAUD** * **CUSTOMER REQUEST** * **RETURN** * **DUPLICATE** * **OTHER** | | `paymentPspReference` | string | **yes** | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you want to refund. | | `reference` | string | no | Your reference for the refund request. Maximum length: 80 characters. | | `splits` | array of object | no | An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for... | | `splits[].account` | string | no | The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms... | | `splits[].amount` | object | no | | | `splits[].description` | string | no | Your description for the split item. | | `splits[].reference` | string | no | Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms... | | `splits[].type` | string, one of AcquiringFees, AdyenCommission, AdyenFees, AdyenMarkup, BalanceAccount, Commission, Default, Interchange, MarketPlace, PaymentFee, Remainder, SchemeFee, Surcharge, Tip, TopUp, VAT | **yes** | The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of... | | `store` | string | no | The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `capturePspReference` | string | This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund. | | `lineItems` | array of object | Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with... | | `lineItems[].amountExcludingTax` | integer (int64) | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | Brand of the item. | | `lineItems[].color` | string | Color of the item. | | `lineItems[].description` | string | Description of the line item. | | `lineItems[].id` | string | ID of the line item. | | `lineItems[].imageUrl` | string | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | Marketplace seller id. | | `lineItems[].productUrl` | string | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | Number of items. | | `lineItems[].receiverEmail` | string | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | Size of the item. | | `lineItems[].sku` | string | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | Universal Product Code. | | `merchantAccount` | string | The merchant account that is used to process the payment. | | `merchantRefundReason` | string, one of FRAUD, CUSTOMER REQUEST, RETURN, DUPLICATE, OTHER | Your reason for the refund request. | | `paymentPspReference` | string | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to refund. | | `pspReference` | string | Adyen's 16-character reference associated with the refund request. | | `reference` | string | Your reference for the refund request. | | `splits` | array of object | An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for... | | `splits[].account` | string | The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms... | | `splits[].amount` | object | | | `splits[].description` | string | Your description for the split item. | | `splits[].reference` | string | Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms... | | `splits[].type` | string, one of AcquiringFees, AdyenCommission, AdyenFees, AdyenMarkup, BalanceAccount, Commission, Default, Interchange, MarketPlace, PaymentFee, Remainder, SchemeFee, Surcharge, Tip, TopUp, VAT | The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of... | | `status` | string, one of received | The status of your request. This will always have the value **received**. | | `store` | string | The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as... | Also retrieved by: "give the money back to the buyer", "return funds for that transaction", "pay a customer back for a settled charge". ### `adyen_checkout.post_payments_payment_psp_reference_reversals` Refund or cancel a payment. [Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Calls POST /payments/{paymentPspReference}/reversals. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /payments/{{params.paymentPspReference}}/reversals`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `enhancedSchemeData` | object | no | | | `enhancedSchemeData.airline` | object | no | | | `enhancedSchemeData.carRental` | object | no | | | `enhancedSchemeData.levelTwoThree` | object | no | | | `enhancedSchemeData.lodging` | object | no | | | `enhancedSchemeData.temporaryServices` | object | no | | | `merchantAccount` | string | **yes** | The merchant account that is used to process the payment. | | `paymentPspReference` | string | **yes** | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you want to reverse. | | `reference` | string | no | Your reference for the reversal request. Maximum length: 80 characters. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `merchantAccount` | string | The merchant account that is used to process the payment. | | `paymentPspReference` | string | The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to reverse. | | `pspReference` | string | Adyen's 16-character reference associated with the reversal request. | | `reference` | string | Your reference for the reversal request. | | `status` | string, one of received | The status of your request. This will always have the value **received**. | Also retrieved by: "give the shopper their money back", "cancel a payment that has not been captured", "reverse a charge whichever stage it is at". ### `adyen_checkout.post_paypal_update_order` Updates the order for PayPal Express Checkout. Calls POST /paypal/updateOrder. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /paypal/updateOrder`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `amount` | object | no | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `deliveryAddress` | object | no | | | `deliveryAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | **yes** | 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`. | | `deliveryAddress.firstName` | string | no | | | `deliveryAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.lastName` | string | no | | | `deliveryAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | no | 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. | | `deliveryAddress.street` | string | **yes** | 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`. | | `deliveryMethods` | array of object | no | The list of new delivery methods and the cost of each. | | `deliveryMethods[].amount` | object | no | | | `deliveryMethods[].description` | string | no | The name of the delivery method as shown to the shopper. | | `deliveryMethods[].reference` | string | no | The reference of the delivery method. | | `deliveryMethods[].selected` | boolean | no | If you display the PayPal lightbox with delivery methods, set to **true** for the delivery method that is selected. Only one delivery method can be selected at a time. | | `deliveryMethods[].type` | string, one of Shipping | no | The type of the delivery method. | | `discountAmount` | object | no | | | `discountAmount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `discountAmount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `paymentData` | string | no | The `paymentData` from the client side. This value changes every time you make a `/paypal/updateOrder` request. | | `pspReference` | string | no | The original `pspReference` from the `/payments` response. | | `sessionId` | string | no | The original `sessionId` from the `/sessions` response. | | `shippingAmount` | object | no | | | `shippingAmount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `shippingAmount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `taxTotal` | object | no | | | `taxTotal.amount` | object | no | | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `paymentData` | string | The updated paymentData. | | `status` | string, one of error, success | The status of the request. This indicates whether the order was successfully updated with PayPal. | Also retrieved by: "resend the basket to paypal after a change", "update shipping and totals in an express flow", "tell paypal the order amount moved". ### `adyen_checkout.post_sessions` Create a payment session. Creates a payment session for [Drop-in](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Drop-in), [Components](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Components), and [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Hosted+Checkout) integrations. Calls POST /sessions. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /sessions`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `accountInfo` | object | no | | | `accountInfo.accountAgeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days *... | | `accountInfo.accountChangeDate` | string (date-time) | no | Date when the shopper's account was last changed. | | `accountInfo.accountChangeIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.accountCreationDate` | string (date-time) | no | Date when the shopper's account was created. | | `accountInfo.accountType` | string, one of notApplicable, credit, debit | no | Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit | | `accountInfo.addCardAttemptsDay` | integer (int32) | no | Number of attempts the shopper tried to add a card to their account in the last day. | | `accountInfo.deliveryAddressUsageDate` | string (date-time) | no | Date the selected delivery address was first used. | | `accountInfo.deliveryAddressUsageIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.homePhone` | string | no | Shopper's home phone number (including the country code). | | `accountInfo.mobilePhone` | string | no | Shopper's mobile phone number (including the country code). | | `accountInfo.passwordChangeDate` | string (date-time) | no | Date when the shopper last changed their password. | | `accountInfo.passwordChangeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.pastTransactionsDay` | integer (int32) | no | Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. | | `accountInfo.pastTransactionsYear` | integer (int32) | no | Number of all transactions (successful and abandoned) from this shopper in the past year. | | `accountInfo.paymentAccountAge` | string (date-time) | no | Date this payment method was added to the shopper's account. | | `accountInfo.paymentAccountIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | no | Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.purchasesLast6Months` | integer (int32) | no | Number of successful purchases in the last six months. | | `accountInfo.suspiciousActivity` | boolean | no | Whether suspicious activity was recorded on this account. | | `accountInfo.workPhone` | string | no | Shopper's work phone number (including the country code). | | `additionalAmount` | object | no | | | `additionalAmount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `additionalAmount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `additionalData` | object | no | 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. | | `allowedPaymentMethods` | array of string | no | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `amount` | object | **yes** | | | `amount.currency` | string | **yes** | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | **yes** | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | no | | | `applicationInfo.adyenLibrary` | object | no | | | `applicationInfo.adyenPaymentSource` | object | no | | | `applicationInfo.externalPlatform` | object | no | | | `applicationInfo.merchantApplication` | object | no | | | `applicationInfo.merchantDevice` | object | no | | | `applicationInfo.shopperInteractionDevice` | object | no | | | `authenticationData` | object | no | | | `authenticationData.attemptAuthentication` | string, one of always, never | no | 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... | | `authenticationData.authenticationOnly` | boolean | no | Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication... Defaults to false. | | `authenticationData.threeDSRequestData` | object | no | | | `billingAddress` | object | no | | | `billingAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | **yes** | 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`. | | `billingAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | no | 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. | | `billingAddress.street` | string | **yes** | 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`. | | `blockedPaymentMethods` | array of string | no | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `captureDelayHours` | integer (int32) | no | The delay between the authorisation and scheduled auto-capture, specified in hours. | | `channel` | string, one of iOS, Android, Web | no | 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... | | `company` | object | no | | | `company.homepage` | string | no | The company website's home page. | | `company.name` | string | no | The company name. | | `company.registrationNumber` | string | no | Registration number of the company. | | `company.registryLocation` | string | no | Registry location of the company. | | `company.taxId` | string | no | Tax ID of the company. | | `company.type` | string | no | The company type. | | `countryCode` | string | no | The shopper's two-letter country code. | | `dateOfBirth` | string (date) | no | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD | | `deliverAt` | string (date-time) | no | The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. | | `deliveryAddress` | object | no | | | `deliveryAddress.city` | string | **yes** | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | **yes** | 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`. | | `deliveryAddress.firstName` | string | no | | | `deliveryAddress.houseNumberOrName` | string | **yes** | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.lastName` | string | no | | | `deliveryAddress.postalCode` | string | **yes** | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | no | 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. | | `deliveryAddress.street` | string | **yes** | 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`. | | `enableOneClick` | boolean | no | When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click... | | `enablePayOut` | boolean | no | When true and `shopperReference` is provided, the payment details will be tokenized for payouts. | | `enableRecurring` | boolean | no | When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the... | | `expiresAt` | string (date-time) | no | The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set... | | `fundOrigin` | object | no | | | `fundOrigin.billingAddress` | object | no | | | `fundOrigin.shopperEmail` | string | no | The email address of the person funding the money. | | `fundOrigin.shopperName` | object | no | | | `fundOrigin.telephoneNumber` | string | no | The phone number of the person funding the money. | | `fundOrigin.walletIdentifier` | string | no | The unique identifier of the wallet where the funds are coming from. | | `fundRecipient` | object | no | | | `fundRecipient.IBAN` | string | no | The IBAN of the bank account where the funds are being transferred to. | | `fundRecipient.billingAddress` | object | no | | | `fundRecipient.paymentMethod` | object | no | | | `fundRecipient.shopperEmail` | string | no | The email address of the shopper. | | `fundRecipient.shopperName` | object | no | | | `fundRecipient.shopperReference` | string | no | Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your... | | `fundRecipient.storedPaymentMethodId` | string | no | This is the `recurringDetailReference` returned in the response when you created the token. | | `fundRecipient.subMerchant` | object | no | | | `fundRecipient.telephoneNumber` | string | no | The telephone number of the shopper. | | `fundRecipient.walletIdentifier` | string | no | The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier. | | `fundRecipient.walletOwnerTaxId` | string | no | The tax identifier of the person receiving the funds. | | `fundRecipient.walletPurpose` | string, one of identifiedBoleto, transferDifferentWallet, transferOwnWallet, transferSameWallet, unidentifiedBoleto | no | The purpose of a digital wallet transaction. | | `installmentOptions` | object | no | A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options... | | `lineItems` | array of object | no | 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... | | `lineItems[].amountExcludingTax` | integer (int64) | no | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | no | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | no | Brand of the item. | | `lineItems[].color` | string | no | Color of the item. | | `lineItems[].description` | string | no | Description of the line item. | | `lineItems[].id` | string | no | ID of the line item. | | `lineItems[].imageUrl` | string | no | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | no | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | no | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | no | Marketplace seller id. | | `lineItems[].productUrl` | string | no | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | no | Number of items. | | `lineItems[].receiverEmail` | string | no | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | no | Size of the item. | | `lineItems[].sku` | string | no | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | no | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | no | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | no | Universal Product Code. | | `mandate` | object | no | | | `mandate.amount` | string | **yes** | The billing amount (in minor units) of the recurring transactions. | | `mandate.amountRule` | string, one of max, exact | no | The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`. | | `mandate.billingAttemptsRule` | string, one of on, before, after | no | The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a... | | `mandate.billingDay` | string | no | The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`. | | `mandate.count` | string | no | The number of transactions that can be performed within the given frequency. | | `mandate.endsAt` | string | **yes** | End date of the billing plan, in YYYY-MM-DD format. | | `mandate.frequency` | string, one of adhoc, daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly | **yes** | The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**. | | `mandate.remarks` | string | no | The message shown by UPI to the shopper on the approval screen. | | `mandate.startsAt` | string | no | Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `accountInfo` | object | | | `accountInfo.accountAgeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days *... | | `accountInfo.accountChangeDate` | string (date-time) | Date when the shopper's account was last changed. | | `accountInfo.accountChangeIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.accountCreationDate` | string (date-time) | Date when the shopper's account was created. | | `accountInfo.accountType` | string, one of notApplicable, credit, debit | Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit | | `accountInfo.addCardAttemptsDay` | integer (int32) | Number of attempts the shopper tried to add a card to their account in the last day. | | `accountInfo.deliveryAddressUsageDate` | string (date-time) | Date the selected delivery address was first used. | | `accountInfo.deliveryAddressUsageIndicator` | string, one of thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.homePhone` | string | Shopper's home phone number (including the country code). | | `accountInfo.mobilePhone` | string | Shopper's mobile phone number (including the country code). | | `accountInfo.passwordChangeDate` | string (date-time) | Date when the shopper last changed their password. | | `accountInfo.passwordChangeIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.pastTransactionsDay` | integer (int32) | Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. | | `accountInfo.pastTransactionsYear` | integer (int32) | Number of all transactions (successful and abandoned) from this shopper in the past year. | | `accountInfo.paymentAccountAge` | string (date-time) | Date this payment method was added to the shopper's account. | | `accountInfo.paymentAccountIndicator` | string, one of notApplicable, thisTransaction, lessThan30Days, from30To60Days, moreThan60Days | Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days | | `accountInfo.purchasesLast6Months` | integer (int32) | Number of successful purchases in the last six months. | | `accountInfo.suspiciousActivity` | boolean | Whether suspicious activity was recorded on this account. | | `accountInfo.workPhone` | string | Shopper's work phone number (including the country code). | | `additionalAmount` | object | | | `additionalAmount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `additionalAmount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `additionalData` | object | 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. | | `allowedPaymentMethods` | array of string | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `amount` | object | | | `amount.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. | | `amount.value` | integer (int64) | The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). | | `applicationInfo` | object | | | `applicationInfo.adyenLibrary` | object | | | `applicationInfo.adyenPaymentSource` | object | | | `applicationInfo.externalPlatform` | object | | | `applicationInfo.merchantApplication` | object | | | `applicationInfo.merchantDevice` | object | | | `applicationInfo.shopperInteractionDevice` | object | | | `authenticationData` | object | | | `authenticationData.attemptAuthentication` | string, one of always, never | 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... | | `authenticationData.authenticationOnly` | boolean | Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication... Defaults to false. | | `authenticationData.threeDSRequestData` | object | | | `billingAddress` | object | | | `billingAddress.city` | string | The name of the city. Maximum length: 3000 characters. | | `billingAddress.country` | string | 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`. | | `billingAddress.houseNumberOrName` | string | The number or name of the house. Maximum length: 3000 characters. | | `billingAddress.postalCode` | string | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `billingAddress.stateOrProvince` | string | 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. | | `billingAddress.street` | string | 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`. | | `blockedPaymentMethods` | array of string | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example... | | `captureDelayHours` | integer (int32) | The delay between the authorisation and scheduled auto-capture, specified in hours. | | `channel` | string, one of iOS, Android, Web | 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... | | `company` | object | | | `company.homepage` | string | The company website's home page. | | `company.name` | string | The company name. | | `company.registrationNumber` | string | Registration number of the company. | | `company.registryLocation` | string | Registry location of the company. | | `company.taxId` | string | Tax ID of the company. | | `company.type` | string | The company type. | | `countryCode` | string | The shopper's two-letter country code. | | `dateOfBirth` | string (date-time) | The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | | `deliverAt` | string (date-time) | The date and time when the purchased goods should be delivered. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. | | `deliveryAddress` | object | | | `deliveryAddress.city` | string | The name of the city. Maximum length: 3000 characters. | | `deliveryAddress.country` | string | 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`. | | `deliveryAddress.firstName` | string | | | `deliveryAddress.houseNumberOrName` | string | The number or name of the house. Maximum length: 3000 characters. | | `deliveryAddress.lastName` | string | | | `deliveryAddress.postalCode` | string | A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. | | `deliveryAddress.stateOrProvince` | string | 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. | | `deliveryAddress.street` | string | 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`. | | `enableOneClick` | boolean | When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click... | | `enablePayOut` | boolean | When true and `shopperReference` is provided, the payment details will be tokenized for payouts. | | `enableRecurring` | boolean | When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the... | | `expiresAt` | string (date-time) | The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set... | | `fundOrigin` | object | | | `fundOrigin.billingAddress` | object | | | `fundOrigin.shopperEmail` | string | The email address of the person funding the money. | | `fundOrigin.shopperName` | object | | | `fundOrigin.telephoneNumber` | string | The phone number of the person funding the money. | | `fundOrigin.walletIdentifier` | string | The unique identifier of the wallet where the funds are coming from. | | `fundRecipient` | object | | | `fundRecipient.IBAN` | string | The IBAN of the bank account where the funds are being transferred to. | | `fundRecipient.billingAddress` | object | | | `fundRecipient.paymentMethod` | object | | | `fundRecipient.shopperEmail` | string | The email address of the shopper. | | `fundRecipient.shopperName` | object | | | `fundRecipient.shopperReference` | string | Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your... | | `fundRecipient.storedPaymentMethodId` | string | This is the `recurringDetailReference` returned in the response when you created the token. | | `fundRecipient.subMerchant` | object | | | `fundRecipient.telephoneNumber` | string | The telephone number of the shopper. | | `fundRecipient.walletIdentifier` | string | The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier. | | `fundRecipient.walletOwnerTaxId` | string | The tax identifier of the person receiving the funds. | | `fundRecipient.walletPurpose` | string, one of identifiedBoleto, transferDifferentWallet, transferOwnWallet, transferSameWallet, unidentifiedBoleto | The purpose of a digital wallet transaction. | | `id` | string | A unique identifier of the session. | | `installmentOptions` | object | A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options... | | `lineItems` | array of object | 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... | | `lineItems[].amountExcludingTax` | integer (int64) | Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].amountIncludingTax` | integer (int64) | Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].brand` | string | Brand of the item. | | `lineItems[].color` | string | Color of the item. | | `lineItems[].description` | string | Description of the line item. | | `lineItems[].id` | string | ID of the line item. | | `lineItems[].imageUrl` | string | Link to the picture of the purchased item. | | `lineItems[].itemCategory` | string | Item category, used by the payment methods PayPal and Ratepay. | | `lineItems[].manufacturer` | string | Manufacturer of the item. | | `lineItems[].marketplaceSellerId` | string | Marketplace seller id. | | `lineItems[].productUrl` | string | Link to the purchased item. | | `lineItems[].quantity` | integer (int64) | Number of items. | | `lineItems[].receiverEmail` | string | Email associated with the given product in the basket (usually in electronic gift cards). | | `lineItems[].size` | string | Size of the item. | | `lineItems[].sku` | string | Stock keeping unit. | | `lineItems[].taxAmount` | integer (int64) | Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). | | `lineItems[].taxPercentage` | integer (int64) | Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) | | `lineItems[].upc` | string | Universal Product Code. | Also retrieved by: "open a hosted checkout for a shopper", "set up components to take a payment", "make the session drop-in needs". ### `adyen_checkout.get_sessions_session_id` Get the result of a payment session. Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path. Calls GET /sessions/{sessionId}. Class `read` (reads only). No scopes beyond the connection's defaults. Calls `GET /sessions/{{params.sessionId}}`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `sessionId` | string | **yes** | A unique identifier of the session. | | `sessionResult` | string | **yes** | The `sessionResult` value from the Drop-in or Component. | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `additionalData` | object | Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**. | | `id` | string | A unique identifier of the session. | | `payments` | array of object | A list of all authorised payments done for this session. | | `payments[].amount` | object | | | `payments[].paymentMethod` | object | | | `payments[].pspReference` | string | Adyen's 16-character reference associated with the transaction/request. This value is globally unique. Use this reference when you communicate with us about this request. | | `payments[].resultCode` | string, one of Authorised, Received, Pending | The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **Authorised** – The payment was successfully... | | `reference` | string | The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status. | | `status` | string, one of active, canceled, completed, expired, paymentPending, refused | The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper... | Also retrieved by: "did the shopper finish paying", "outcome of a checkout the drop-in ran", "status behind a sessionresult". ### `adyen_checkout.get_stored_payment_methods` List an Adyen shopper's saved payment methods: the cards and tokens kept on file for a returning buyer for one-click or recurring checkout. Use to see what a customer has stored. Calls GET /storedPaymentMethods. Class `read` (reads only). No scopes beyond the connection's defaults. Calls `GET /storedPaymentMethods`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `merchantAccount` | string | no | Your merchant account. | | `shopperReference` | string | no | Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for... | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `merchantAccount` | string | Your merchant account. | | `shopperReference` | string | Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for... | | `storedPaymentMethods` | array of object | List of all stored payment methods. | | `storedPaymentMethods[].alias` | string | The alias of the credit card number. Applies only to recurring contracts storing credit card details | | `storedPaymentMethods[].aliasType` | string | The alias type of the credit card number. Applies only to recurring contracts storing credit card details. | | `storedPaymentMethods[].brand` | string | The brand of the card. | | `storedPaymentMethods[].cardBin` | string | The bank identification number (BIN) of the card. | | `storedPaymentMethods[].expiryMonth` | string | The month the card expires. | | `storedPaymentMethods[].expiryYear` | string | The last two digits of the year the card expires. For example, **22** for the year 2022. | | `storedPaymentMethods[].externalResponseCode` | string | The response code returned by an external system (for example after a provisioning operation). | | `storedPaymentMethods[].externalTokenReference` | string | The token reference of a linked token in an external system (for example a network token reference). | | `storedPaymentMethods[].holderName` | string | The unique payment method code. | | `storedPaymentMethods[].iban` | string | The IBAN of the bank account. | | `storedPaymentMethods[].id` | string | A unique identifier of this stored payment method. | | `storedPaymentMethods[].issuerName` | string | The name of the issuer of token or card. | | `storedPaymentMethods[].lastFour` | string | The last four digits of the PAN. | | `storedPaymentMethods[].mandate` | object | | | `storedPaymentMethods[].name` | string | The display name of the stored payment method. | | `storedPaymentMethods[].networkTxReference` | string | 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... | | `storedPaymentMethods[].ownerName` | string | The name of the bank account holder. | | `storedPaymentMethods[].shopperEmail` | string | The shopper’s email address. | | `storedPaymentMethods[].shopperReference` | string | Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally... | | `storedPaymentMethods[].supportedRecurringProcessingModels` | array | Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF)... | | `storedPaymentMethods[].type` | string | The type of payment method. | Also retrieved by: "what cards do we have on file for this buyer", "the shopper's saved cards", "tokens kept for a returning customer". ### `adyen_checkout.post_stored_payment_methods` Create a token to store payment details. Creates a token to store the shopper's payment details. Calls POST /storedPaymentMethods. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /storedPaymentMethods`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `Idempotency_Key` | string | no | A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). | | `merchantAccount` | string | **yes** | The merchant account identifier, with which you want to process the transaction. | | `paymentMethod` | object | **yes** | | | `paymentMethod.brand` | string | no | Secondary brand of the card. For example: **plastix**, **hmclub**. | | `paymentMethod.cvc` | string | no | 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). | | `paymentMethod.encryptedCard` | string | no | The encrypted card. | | `paymentMethod.encryptedCardNumber` | string | no | The encrypted card number. | | `paymentMethod.encryptedExpiryMonth` | string | no | The encrypted card expiry month. | | `paymentMethod.encryptedExpiryYear` | string | no | The encrypted card expiry year. | | `paymentMethod.encryptedSecurityCode` | string | no | The encrypted card verification code. | | `paymentMethod.expiryMonth` | string | no | 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). | | `paymentMethod.expiryYear` | string | no | 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). | | `paymentMethod.holderName` | string | no | The name of the card holder. | | `paymentMethod.number` | string | no | The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). | | `paymentMethod.type` | string | no | Set to **scheme**. | | `recurringProcessingModel` | string, one of CardOnFile, Subscription, UnscheduledCardOnFile | **yes** | Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed... | | `shopperEmail` | string | no | The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. | | `shopperIP` | string | no | The IP address of a shopper. | | `shopperReference` | string | **yes** | A unique identifier for the shopper (for example, user ID or account ID). | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `alias` | string | The alias of the credit card number. Applies only to recurring contracts storing credit card details | | `aliasType` | string | The alias type of the credit card number. Applies only to recurring contracts storing credit card details. | | `brand` | string | The brand of the card. | | `cardBin` | string | The bank identification number (BIN) of the card. | | `expiryMonth` | string | The month the card expires. | | `expiryYear` | string | The last two digits of the year the card expires. For example, **22** for the year 2022. | | `externalResponseCode` | string | The response code returned by an external system (for example after a provisioning operation). | | `externalTokenReference` | string | The token reference of a linked token in an external system (for example a network token reference). | | `holderName` | string | The unique payment method code. | | `iban` | string | The IBAN of the bank account. | | `id` | string | A unique identifier of this stored payment method. | | `issuerName` | string | The name of the issuer of token or card. | | `lastFour` | string | The last four digits of the PAN. | | `mandate` | object | | | `mandate.accountIdType` | string | The type of account identifier for the masked account number. | | `mandate.amount` | string | The billing amount (in minor units) of the recurring transactions. | | `mandate.amountRule` | string, one of max, exact | The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`. | | `mandate.billingAttemptsRule` | string, one of on, before, after | The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a... | | `mandate.billingDay` | string | The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`. | | `mandate.count` | string | The number of transactions that can be performed within the given frequency. | | `mandate.currency` | string | The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). | | `mandate.endsAt` | string | End date of the billing plan, in YYYY-MM-DD format. | | `mandate.frequency` | string, one of adhoc, daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly | The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**. | | `mandate.mandateId` | string | The unique identifier of the mandate. | | `mandate.maskedAccountId` | string | The masked account number associated with the mandate. | | `mandate.minAmount` | string | For a billing plan where the payment amounts are variable, the minimum amount to charge the shopper for each recurring payment. When a shopper approves the billing plan, they can also specify a... | | `mandate.providerId` | string | The provider-specific identifier for this mandate. | | `mandate.recurringAmount` | string | For a billing plan where the payment amount is fixed, the amount the shopper will be charged for each recurring payment. | | `mandate.recurringStatement` | string | The text that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring... | | `mandate.remarks` | string | Additional remarks or notes about the mandate. | | `mandate.retryPolicy` | string, one of true, false | When set to true, you can retry for failed recurring payments. The default value is true. | | `mandate.startsAt` | string | Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. | | `mandate.status` | string | The status of the mandate. Examples : active, revoked, completed, expired | | `mandate.txVariant` | string | The transaction variant used for this mandate. | | `name` | string | The display name of the stored payment method. | | `networkTxReference` | string | 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... | | `ownerName` | string | The name of the bank account holder. | | `shopperEmail` | string | The shopper’s email address. | | `shopperReference` | string | Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally... | | `supportedRecurringProcessingModels` | array of string | Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF)... | | `type` | string | The type of payment method. | Also retrieved by: "save a card for next time", "vault the shopper's details as a token", "set up one-click for a returning customer". ### `adyen_checkout.post_validate_shopper_id` Check whether an Adyen shopper is already known: validate a shopperId to tell a returning buyer from a new one before checkout. Calls POST /validateShopperId. Class `write` (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls `POST /validateShopperId`. Arguments: | Argument | Type | Required | Notes | | --- | --- | --- | --- | | `merchantAccount` | string | **yes** | The merchant account identifier, with which you want to process the transaction. | | `paymentMethod` | object | **yes** | | | `paymentMethod.type` | string | **yes** | | | `shopperEmail` | string | no | | | `shopperIP` | string | no | | | `shopperReference` | string | no | | Result fields (the payload is trimmed to these before it reaches the model): | Field | Type | Notes | | --- | --- | --- | | `reason` | string | Reason for the result. | | `result` | string, one of VALID, INVALID, UNKNOWN, NOT_REQUIRED | | Also retrieved by: "is this buyer already known to us", "tell a returning shopper from a new one", "check a shopper is recognised".