From ffa9fed4ecf35020b35f4b87c23bd193259d7c6d Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Tue, 16 Aug 2022 16:16:31 +0000 Subject: [PATCH] spec release --- json/PayoutService-v30.json | 1110 +-------------- json/PayoutService-v40.json | 1619 +-------------------- json/PayoutService-v50.json | 1669 +--------------------- json/PayoutService-v51.json | 1669 +--------------------- json/PayoutService-v52.json | 1669 +--------------------- json/PayoutService-v64.json | 1678 +--------------------- json/PayoutService-v67.json | 1702 +--------------------- json/PayoutService-v68.json | 2083 +-------------------------- yaml/PayoutService-v30.yaml | 1612 +-------------------- yaml/PayoutService-v40.yaml | 2197 +--------------------------- yaml/PayoutService-v50.yaml | 2263 +---------------------------- yaml/PayoutService-v51.yaml | 2263 +---------------------------- yaml/PayoutService-v52.yaml | 2263 +---------------------------- yaml/PayoutService-v64.yaml | 2277 +---------------------------- yaml/PayoutService-v67.yaml | 2301 +----------------------------- yaml/PayoutService-v68.yaml | 2690 +---------------------------------- 16 files changed, 112 insertions(+), 30953 deletions(-) diff --git a/json/PayoutService-v30.json b/json/PayoutService-v30.json index 2dd1f49..26ef834 100644 --- a/json/PayoutService-v30.json +++ b/json/PayoutService-v30.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payout API", "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", - "x-timestamp" : "2022-05-03T09:24:05Z", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -40,7 +40,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Confirms a payout.", + "summary" : "Confirm a payout", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", @@ -149,7 +149,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Cancels a payout.", + "summary" : "Cancel a payout", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", @@ -258,7 +258,7 @@ "tags" : [ "Instant payouts" ], - "summary" : "Pay out directly.", + "summary" : "Make an instant card payout", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", @@ -365,7 +365,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores payout details.", + "summary" : "Store payout details", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", @@ -473,7 +473,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores details and submits a payout.", + "summary" : "Store details and submit a payout", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", @@ -589,7 +589,7 @@ "tags" : [ "Initialization" ], - "summary" : "Submits a payout.", + "summary" : "Submit a payout", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", @@ -691,906 +691,6 @@ }, "components" : { "schemas" : { - "AdditionalData3DSecure" : { - "properties" : { - "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", - "type" : "string" - }, - "executeThreeD" : { - "description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", - "type" : "string" - }, - "mpiImplementationType" : { - "description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.", - "type" : "string" - }, - "scaExemption" : { - "description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", - "type" : "string" - }, - "threeDSVersion" : { - "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", - "type" : "string" - } - } - }, - "AdditionalDataAirline" : { - "properties" : { - "airline.agency_invoice_number" : { - "description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6", - "type" : "string" - }, - "airline.agency_plan_name" : { - "description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.airline_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.airline_designator_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.boarding_fee" : { - "description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18", - "type" : "string" - }, - "airline.computerized_reservation_system" : { - "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4", - "type" : "string" - }, - "airline.customer_reference_number" : { - "description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20", - "type" : "string" - }, - "airline.document_type" : { - "description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.flight_date" : { - "description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.carrier_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.leg.class_of_travel" : { - "description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.leg.date_of_travel" : { - "description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.depart_airport" : { - "description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.depart_tax" : { - "description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12", - "type" : "string" - }, - "airline.leg.destination_code" : { - "description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.fare_base_code" : { - "description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7", - "type" : "string" - }, - "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5", - "type" : "string" - }, - "airline.leg.stop_over_code" : { - "description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.passenger.date_of_birth" : { - "description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", - "type" : "string" - }, - "airline.passenger.first_name" : { - "description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.last_name" : { - "description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.telephone_number" : { - "description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30", - "type" : "string" - }, - "airline.passenger.traveller_type" : { - "description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6", - "type" : "string" - }, - "airline.passenger_name" : { - "description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49", - "type" : "string" - }, - "airline.ticket_issue_address" : { - "description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16", - "type" : "string" - }, - "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150", - "type" : "string" - }, - "airline.travel_agency_code" : { - "description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8", - "type" : "string" - }, - "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25", - "type" : "string" - } - }, - "required" : [ - "airline.passenger_name" - ] - }, - "AdditionalDataCarRental" : { - "properties" : { - "carRental.checkOutDate" : { - "description" : "Pick-up date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19", - "type" : "string" - }, - "carRental.fuelCharges" : { - "description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.locationCity" : { - "description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.locationCountry" : { - "description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.locationStateProvince" : { - "description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.", - "type" : "string" - }, - "carRental.oneWayDropOffCharges" : { - "description" : "Charge associated with not returning a vehicle to the original rental location.", - "type" : "string" - }, - "carRental.rate" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.rateIndicator" : { - "description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.", - "type" : "string" - }, - "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9", - "type" : "string" - }, - "carRental.rentalClassId" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26", - "type" : "string" - }, - "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.returnCountry" : { - "description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.returnDate" : { - "description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.returnLocationId" : { - "description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10", - "type" : "string" - }, - "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.taxExemptIndicator" : { - "description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataCommon" : { - "properties" : { - "RequestedTestErrorResponseCode" : { - "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", - "type" : "string" - }, - "authorisationType" : { - "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", - "type" : "string" - }, - "customRoutingFlag" : { - "description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).", - "type" : "string" - }, - "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], - "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "enum" : [ - "NoShow", - "DelayedCharge" - ], - "type" : "string" - }, - "networkTxReference" : { - "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", - "type" : "string" - }, - "overwriteBrand" : { - "description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", - "type" : "string" - }, - "subMerchantCity" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", - "type" : "string" - }, - "subMerchantCountry" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", - "type" : "string" - }, - "subMerchantID" : { - "description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", - "type" : "string" - }, - "subMerchantName" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", - "type" : "string" - }, - "subMerchantPostalCode" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", - "type" : "string" - }, - "subMerchantState" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", - "type" : "string" - }, - "subMerchantStreet" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", - "type" : "string" - }, - "subMerchantTaxId" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", - "type" : "string" - } - } - }, - "AdditionalDataLevel23" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - }, - "enhancedSchemeData.destinationCountryCode" : { - "description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.", - "type" : "string" - }, - "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.dutyAmount" : { - "description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.freightAmount" : { - "description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.orderDate" : { - "description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.", - "type" : "string" - }, - "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - } - } - }, - "AdditionalDataLodging" : { - "properties" : { - "lodging.checkInDate" : { - "description" : "The arrival date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.checkOutDate" : { - "description" : "The departure date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.fireSafetyActIndicator" : { - "description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1", - "type" : "string" - }, - "lodging.folioCashAdvances" : { - "description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.folioNumber" : { - "description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25", - "type" : "string" - }, - "lodging.foodBeverageCharges" : { - "description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1", - "type" : "string" - }, - "lodging.prepaidExpenses" : { - "description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.propertyPhoneNumber" : { - "description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.room1.numberOfNights" : { - "description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4", - "type" : "string" - }, - "lodging.room1.rate" : { - "description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.room1.tax" : { - "description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalRoomTax" : { - "description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalTax" : { - "description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataOpenInvoice" : { - "properties" : { - "openinvoicedata.merchantData" : { - "description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", - "type" : "string" - }, - "openinvoicedata.numberOfLines" : { - "description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].currencyCode" : { - "description" : "The three-character ISO currency code.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].description" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemAmount" : { - "description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemId" : { - "description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatAmount" : { - "description" : "The VAT due for one item in the invoice line, represented in minor units.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatPercentage" : { - "description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].numberOfItems" : { - "description" : "The number of units purchased of a specific product.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnShippingCompany" : { - "description" : "Name of the shipping company handling the the return shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingNumber" : { - "description" : "The tracking number for the return of the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingUri" : { - "description" : "URI where the customer can track the return of their shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingCompany" : { - "description" : "Name of the shipping company handling the delivery.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingMethod" : { - "description" : "Shipping method.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingNumber" : { - "description" : "The tracking number for the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingUri" : { - "description" : "URI where the customer can track their shipment.", - "type" : "string" - } - } - }, - "AdditionalDataOpi" : { - "properties" : { - "opi.includeTransToken" : { - "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", - "type" : "string" - } - } - }, - "AdditionalDataPayout" : { - "properties" : { - "fundingNetwork" : { - "description" : "", - "type" : "string" - }, - "fundingSource" : { - "description" : "", - "enum" : [ - "CREDIT", - "DEBIT", - "PREPAID", - "DEPOSIT_ACCOUNT" - ], - "type" : "string" - }, - "fundingTransactionId" : { - "description" : "", - "type" : "string" - }, - "payoutAccountCode" : { - "description" : "", - "type" : "string" - }, - "payoutAccountHolderCode" : { - "description" : "", - "type" : "string" - }, - "payoutMarketPayUser" : { - "description" : "", - "type" : "string" - }, - "processOver" : { - "description" : "", - "enum" : [ - "MC_P2P", - "Visa_OCT", - "UnlinkedRefund" - ], - "type" : "string" - }, - "verifyOver" : { - "description" : "", - "type" : "string" - }, - "walletIdentifier" : { - "description" : "", - "type" : "string" - } - } - }, - "AdditionalDataRatepay" : { - "properties" : { - "ratepay.installmentAmount" : { - "description" : "Amount the customer has to pay each month.", - "type" : "string" - }, - "ratepay.interestRate" : { - "description" : "Interest rate of this installment.", - "type" : "string" - }, - "ratepay.lastInstallmentAmount" : { - "description" : "Amount of the last installment.", - "type" : "string" - }, - "ratepay.paymentFirstday" : { - "description" : "Calendar day of the first payment.", - "type" : "string" - }, - "ratepaydata.deliveryDate" : { - "description" : "Date the merchant delivered the goods to the customer.", - "type" : "string" - }, - "ratepaydata.dueDate" : { - "description" : "Date by which the customer must settle the payment.", - "type" : "string" - }, - "ratepaydata.invoiceDate" : { - "description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", - "type" : "string" - }, - "ratepaydata.invoiceId" : { - "description" : "Identification name or number for the invoice, defined by the merchant.", - "type" : "string" - } - } - }, - "AdditionalDataRetry" : { - "properties" : { - "retry.chainAttemptNumber" : { - "description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.orderAttemptNumber" : { - "description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.skipRetry" : { - "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - } - } - }, - "AdditionalDataRisk" : { - "properties" : { - "riskdata.[customFieldName]" : { - "description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].amountPerItem" : { - "description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].brand" : { - "description" : "Brand of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].category" : { - "description" : "Category of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].color" : { - "description" : "Color of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].currency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].itemID" : { - "description" : "ID of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].manufacturer" : { - "description" : "Manufacturer of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].productTitle" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].quantity" : { - "description" : "Quantity of the item purchased.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].receiverEmail" : { - "description" : "Email associated with the given product in the basket (usually in electronic gift cards).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].size" : { - "description" : "Size of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].sku" : { - "description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].upc" : { - "description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionCode" : { - "description" : "Code of the promotion.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : { - "description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : { - "description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionName" : { - "description" : "Name of the promotion.", - "type" : "string" - }, - "riskdata.riskProfileReference" : { - "description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", - "type" : "string" - }, - "riskdata.skipRisk" : { - "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", - "type" : "string" - } - } - }, - "AdditionalDataRiskStandalone" : { - "properties" : { - "PayPal.CountryCode" : { - "description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", - "type" : "string" - }, - "PayPal.EmailId" : { - "description" : "Shopper's email.", - "type" : "string" - }, - "PayPal.FirstName" : { - "description" : "Shopper's first name.", - "type" : "string" - }, - "PayPal.LastName" : { - "description" : "Shopper's last name.", - "type" : "string" - }, - "PayPal.PayerId" : { - "description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", - "type" : "string" - }, - "PayPal.Phone" : { - "description" : "Shopper's phone number.", - "type" : "string" - }, - "PayPal.ProtectionEligibility" : { - "description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.", - "type" : "string" - }, - "PayPal.TransactionId" : { - "description" : "Unique transaction ID of the payment.", - "type" : "string" - }, - "avsResultRaw" : { - "description" : "Raw AVS result received from the acquirer, where available. Example: D", - "type" : "string" - }, - "bin" : { - "description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", - "type" : "string" - }, - "cvcResultRaw" : { - "description" : "Raw CVC result received from the acquirer, where available. Example: 1", - "type" : "string" - }, - "riskToken" : { - "description" : "Unique identifier or token for the shopper's card details.", - "type" : "string" - }, - "threeDAuthenticated" : { - "description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", - "type" : "string" - }, - "threeDOffered" : { - "description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true", - "type" : "string" - }, - "tokenDataType" : { - "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", - "type" : "string" - } - } - }, - "AdditionalDataSubMerchant" : { - "properties" : { - "subMerchant.numberOfSubSellers" : { - "description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].city" : { - "description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].country" : { - "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].id" : { - "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].mcc" : { - "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].name" : { - "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].postalCode" : { - "description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].state" : { - "description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].street" : { - "description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].taxId" : { - "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", - "type" : "string" - } - } - }, - "AdditionalDataTemporaryServices" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", - "type" : "string" - }, - "enhancedSchemeData.employeeName" : { - "description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.jobDescription" : { - "description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.regularHoursRate" : { - "description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.regularHoursWorked" : { - "description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.requestName" : { - "description" : "Name of the individual requesting temporary services.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.tempStartDate" : { - "description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.tempWeekEnding" : { - "description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", - "type" : "string" - } - } - }, - "AdditionalDataWallets" : { - "properties" : { - "androidpay.token" : { - "description" : "The Android Pay token retrieved from the SDK.", - "type" : "string" - }, - "masterpass.transactionId" : { - "description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.", - "type" : "string" - }, - "payment.token" : { - "description" : "The Apple Pay token retrieved from the SDK.", - "type" : "string" - }, - "paywithgoogle.token" : { - "description" : "The Google Pay token retrieved from the SDK.", - "type" : "string" - }, - "samsungpay.token" : { - "description" : "The Samsung Pay token retrieved from the SDK.", - "type" : "string" - }, - "visacheckout.callId" : { - "description" : "The Visa Checkout Call ID retrieved from the SDK.", - "type" : "string" - } - } - }, "Address" : { "properties" : { "city" : { @@ -1690,26 +790,6 @@ } } }, - "BrowserInfo" : { - "properties" : { - "acceptHeader" : { - "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - }, - "userAgent" : { - "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - } - }, - "required" : [ - "userAgent", - "acceptHeader" - ] - }, "Card" : { "properties" : { "cvc" : { @@ -1768,64 +848,6 @@ "holderName" ] }, - "ForexQuote" : { - "properties" : { - "account" : { - "description" : "The account name.", - "type" : "string" - }, - "accountType" : { - "description" : "The account type.", - "type" : "string" - }, - "baseAmount" : { - "description" : "The base amount.", - "$ref" : "#/components/schemas/Amount" - }, - "basePoints" : { - "description" : "The base points.", - "format" : "int32", - "type" : "integer" - }, - "buy" : { - "description" : "The buy rate.", - "$ref" : "#/components/schemas/Amount" - }, - "interbank" : { - "description" : "The interbank amount.", - "$ref" : "#/components/schemas/Amount" - }, - "reference" : { - "description" : "The reference assigned to the forex quote request.", - "type" : "string" - }, - "sell" : { - "description" : "The sell rate.", - "$ref" : "#/components/schemas/Amount" - }, - "signature" : { - "description" : "The signature to validate the integrity.", - "type" : "string" - }, - "source" : { - "description" : "The source of the forex quote.", - "type" : "string" - }, - "type" : { - "description" : "The type of forex.", - "type" : "string" - }, - "validTill" : { - "description" : "The date until which the forex quote is valid.", - "format" : "date-time", - "type" : "string" - } - }, - "required" : [ - "validTill", - "basePoints" - ] - }, "FraudCheckResult" : { "properties" : { "accountScore" : { @@ -1899,78 +921,6 @@ } } }, - "Installments" : { - "properties" : { - "value" : { - "description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.", - "format" : "int32", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, - "Mandate" : { - "properties" : { - "amount" : { - "description" : "The billing amount (in minor units) of the recurring transactions.", - "type" : "string" - }, - "amountRule" : { - "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", - "enum" : [ - "max", - "exact" - ], - "type" : "string" - }, - "billingAttemptsRule" : { - "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", - "enum" : [ - "on", - "before", - "after" - ], - "type" : "string" - }, - "billingDay" : { - "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", - "type" : "string" - }, - "endsAt" : { - "description" : "End date of the billing plan, in YYYY-MM-DD format.", - "type" : "string" - }, - "frequency" : { - "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", - "enum" : [ - "adhoc", - "daily", - "weekly", - "biWeekly", - "monthly", - "quarterly", - "halfYearly", - "yearly" - ], - "type" : "string" - }, - "remarks" : { - "description" : "The message shown by UPI to the shopper on the approval screen.", - "type" : "string" - }, - "startsAt" : { - "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", - "type" : "string" - } - }, - "required" : [ - "frequency", - "amount", - "endsAt" - ] - }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -3044,52 +1994,6 @@ "pspReference", "resultCode" ] - }, - "ThreeDSecureData" : { - "properties" : { - "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", - "enum" : [ - "Y", - "N", - "U", - "A" - ], - "type" : "string" - }, - "cavv" : { - "description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - }, - "cavvAlgorithm" : { - "description" : "The CAVV algorithm used. Include this only for 3D Secure 1.", - "type" : "string" - }, - "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", - "enum" : [ - "A", - "C", - "D", - "I", - "N", - "R", - "U", - "Y" - ], - "type" : "string" - }, - "eci" : { - "description" : "The electronic commerce indicator.", - "type" : "string" - }, - "xid" : { - "description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - } - } } }, "securitySchemes" : { diff --git a/json/PayoutService-v40.json b/json/PayoutService-v40.json index ad79a4f..84c991f 100644 --- a/json/PayoutService-v40.json +++ b/json/PayoutService-v40.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payout API", "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", - "x-timestamp" : "2022-05-03T09:24:06Z", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -40,7 +40,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Confirms a payout.", + "summary" : "Confirm a payout", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", @@ -149,7 +149,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Cancels a payout.", + "summary" : "Cancel a payout", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", @@ -258,7 +258,7 @@ "tags" : [ "Instant payouts" ], - "summary" : "Pay out directly.", + "summary" : "Make an instant card payout", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", @@ -365,7 +365,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores payout details.", + "summary" : "Store payout details", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", @@ -473,7 +473,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores details and submits a payout.", + "summary" : "Store details and submit a payout", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", @@ -589,7 +589,7 @@ "tags" : [ "Initialization" ], - "summary" : "Submits a payout.", + "summary" : "Submit a payout", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", @@ -691,1024 +691,6 @@ }, "components" : { "schemas" : { - "AccountInfo" : { - "properties" : { - "accountAgeIndicator" : { - "description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountChangeDate" : { - "description" : "Date when the shopper's account was last changed.", - "format" : "date-time", - "type" : "string" - }, - "accountChangeIndicator" : { - "description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountCreationDate" : { - "description" : "Date when the shopper's account was created.", - "format" : "date-time", - "type" : "string" - }, - "addCardAttemptsDay" : { - "description" : "Number of attempts the shopper tried to add a card to their account in the last day.", - "format" : "int32", - "type" : "integer" - }, - "deliveryAddressUsageDate" : { - "description" : "Date the selected delivery address was first used.", - "format" : "date-time", - "type" : "string" - }, - "deliveryAddressUsageIndicator" : { - "description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "homePhone" : { - "description" : "Shopper's home phone number (including the country code).", - "type" : "string" - }, - "mobilePhone" : { - "description" : "Shopper's mobile phone number (including the country code).", - "type" : "string" - }, - "passwordChangeDate" : { - "description" : "Date when the shopper last changed their password.", - "format" : "date-time", - "type" : "string" - }, - "passwordChangeIndicator" : { - "description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "pastTransactionsDay" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.", - "format" : "int32", - "type" : "integer" - }, - "pastTransactionsYear" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.", - "format" : "int32", - "type" : "integer" - }, - "paymentAccountAge" : { - "description" : "Date this payment method was added to the shopper's account.", - "format" : "date-time", - "type" : "string" - }, - "paymentAccountIndicator" : { - "description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "purchasesLast6Months" : { - "description" : "Number of successful purchases in the last six months.", - "format" : "int32", - "type" : "integer" - }, - "suspiciousActivity" : { - "description" : "Whether suspicious activity was recorded on this account.", - "type" : "boolean" - }, - "workPhone" : { - "description" : "Shopper's work phone number (including the country code).", - "type" : "string" - } - } - }, - "AdditionalData3DSecure" : { - "properties" : { - "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", - "type" : "string" - }, - "executeThreeD" : { - "description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", - "type" : "string" - }, - "mpiImplementationType" : { - "description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.", - "type" : "string" - }, - "scaExemption" : { - "description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", - "type" : "string" - }, - "threeDSVersion" : { - "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", - "type" : "string" - } - } - }, - "AdditionalDataAirline" : { - "properties" : { - "airline.agency_invoice_number" : { - "description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6", - "type" : "string" - }, - "airline.agency_plan_name" : { - "description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.airline_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.airline_designator_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.boarding_fee" : { - "description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18", - "type" : "string" - }, - "airline.computerized_reservation_system" : { - "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4", - "type" : "string" - }, - "airline.customer_reference_number" : { - "description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20", - "type" : "string" - }, - "airline.document_type" : { - "description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.flight_date" : { - "description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.carrier_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.leg.class_of_travel" : { - "description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.leg.date_of_travel" : { - "description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.depart_airport" : { - "description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.depart_tax" : { - "description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12", - "type" : "string" - }, - "airline.leg.destination_code" : { - "description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.fare_base_code" : { - "description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7", - "type" : "string" - }, - "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5", - "type" : "string" - }, - "airline.leg.stop_over_code" : { - "description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.passenger.date_of_birth" : { - "description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", - "type" : "string" - }, - "airline.passenger.first_name" : { - "description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.last_name" : { - "description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.telephone_number" : { - "description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30", - "type" : "string" - }, - "airline.passenger.traveller_type" : { - "description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6", - "type" : "string" - }, - "airline.passenger_name" : { - "description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49", - "type" : "string" - }, - "airline.ticket_issue_address" : { - "description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16", - "type" : "string" - }, - "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150", - "type" : "string" - }, - "airline.travel_agency_code" : { - "description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8", - "type" : "string" - }, - "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25", - "type" : "string" - } - }, - "required" : [ - "airline.passenger_name" - ] - }, - "AdditionalDataCarRental" : { - "properties" : { - "carRental.checkOutDate" : { - "description" : "Pick-up date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19", - "type" : "string" - }, - "carRental.fuelCharges" : { - "description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.locationCity" : { - "description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.locationCountry" : { - "description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.locationStateProvince" : { - "description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.", - "type" : "string" - }, - "carRental.oneWayDropOffCharges" : { - "description" : "Charge associated with not returning a vehicle to the original rental location.", - "type" : "string" - }, - "carRental.rate" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.rateIndicator" : { - "description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.", - "type" : "string" - }, - "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9", - "type" : "string" - }, - "carRental.rentalClassId" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26", - "type" : "string" - }, - "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.returnCountry" : { - "description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.returnDate" : { - "description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.returnLocationId" : { - "description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10", - "type" : "string" - }, - "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.taxExemptIndicator" : { - "description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataCommon" : { - "properties" : { - "RequestedTestErrorResponseCode" : { - "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", - "type" : "string" - }, - "authorisationType" : { - "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", - "type" : "string" - }, - "customRoutingFlag" : { - "description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).", - "type" : "string" - }, - "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], - "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "enum" : [ - "NoShow", - "DelayedCharge" - ], - "type" : "string" - }, - "networkTxReference" : { - "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", - "type" : "string" - }, - "overwriteBrand" : { - "description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", - "type" : "string" - }, - "subMerchantCity" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", - "type" : "string" - }, - "subMerchantCountry" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", - "type" : "string" - }, - "subMerchantID" : { - "description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", - "type" : "string" - }, - "subMerchantName" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", - "type" : "string" - }, - "subMerchantPostalCode" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", - "type" : "string" - }, - "subMerchantState" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", - "type" : "string" - }, - "subMerchantStreet" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", - "type" : "string" - }, - "subMerchantTaxId" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", - "type" : "string" - } - } - }, - "AdditionalDataLevel23" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - }, - "enhancedSchemeData.destinationCountryCode" : { - "description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.", - "type" : "string" - }, - "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.dutyAmount" : { - "description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.freightAmount" : { - "description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.orderDate" : { - "description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.", - "type" : "string" - }, - "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - } - } - }, - "AdditionalDataLodging" : { - "properties" : { - "lodging.checkInDate" : { - "description" : "The arrival date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.checkOutDate" : { - "description" : "The departure date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.fireSafetyActIndicator" : { - "description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1", - "type" : "string" - }, - "lodging.folioCashAdvances" : { - "description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.folioNumber" : { - "description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25", - "type" : "string" - }, - "lodging.foodBeverageCharges" : { - "description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1", - "type" : "string" - }, - "lodging.prepaidExpenses" : { - "description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.propertyPhoneNumber" : { - "description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.room1.numberOfNights" : { - "description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4", - "type" : "string" - }, - "lodging.room1.rate" : { - "description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.room1.tax" : { - "description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalRoomTax" : { - "description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalTax" : { - "description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataOpenInvoice" : { - "properties" : { - "openinvoicedata.merchantData" : { - "description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", - "type" : "string" - }, - "openinvoicedata.numberOfLines" : { - "description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].currencyCode" : { - "description" : "The three-character ISO currency code.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].description" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemAmount" : { - "description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemId" : { - "description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatAmount" : { - "description" : "The VAT due for one item in the invoice line, represented in minor units.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatPercentage" : { - "description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].numberOfItems" : { - "description" : "The number of units purchased of a specific product.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnShippingCompany" : { - "description" : "Name of the shipping company handling the the return shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingNumber" : { - "description" : "The tracking number for the return of the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingUri" : { - "description" : "URI where the customer can track the return of their shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingCompany" : { - "description" : "Name of the shipping company handling the delivery.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingMethod" : { - "description" : "Shipping method.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingNumber" : { - "description" : "The tracking number for the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingUri" : { - "description" : "URI where the customer can track their shipment.", - "type" : "string" - } - } - }, - "AdditionalDataOpi" : { - "properties" : { - "opi.includeTransToken" : { - "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", - "type" : "string" - } - } - }, - "AdditionalDataPayout" : { - "properties" : { - "fundingNetwork" : { - "description" : "", - "type" : "string" - }, - "fundingSource" : { - "description" : "", - "enum" : [ - "CREDIT", - "DEBIT", - "PREPAID", - "DEPOSIT_ACCOUNT" - ], - "type" : "string" - }, - "fundingTransactionId" : { - "description" : "", - "type" : "string" - }, - "payoutAccountCode" : { - "description" : "", - "type" : "string" - }, - "payoutAccountHolderCode" : { - "description" : "", - "type" : "string" - }, - "payoutMarketPayUser" : { - "description" : "", - "type" : "string" - }, - "processOver" : { - "description" : "", - "enum" : [ - "MC_P2P", - "Visa_OCT", - "UnlinkedRefund" - ], - "type" : "string" - }, - "verifyOver" : { - "description" : "", - "type" : "string" - }, - "walletIdentifier" : { - "description" : "", - "type" : "string" - } - } - }, - "AdditionalDataRatepay" : { - "properties" : { - "ratepay.installmentAmount" : { - "description" : "Amount the customer has to pay each month.", - "type" : "string" - }, - "ratepay.interestRate" : { - "description" : "Interest rate of this installment.", - "type" : "string" - }, - "ratepay.lastInstallmentAmount" : { - "description" : "Amount of the last installment.", - "type" : "string" - }, - "ratepay.paymentFirstday" : { - "description" : "Calendar day of the first payment.", - "type" : "string" - }, - "ratepaydata.deliveryDate" : { - "description" : "Date the merchant delivered the goods to the customer.", - "type" : "string" - }, - "ratepaydata.dueDate" : { - "description" : "Date by which the customer must settle the payment.", - "type" : "string" - }, - "ratepaydata.invoiceDate" : { - "description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", - "type" : "string" - }, - "ratepaydata.invoiceId" : { - "description" : "Identification name or number for the invoice, defined by the merchant.", - "type" : "string" - } - } - }, - "AdditionalDataRetry" : { - "properties" : { - "retry.chainAttemptNumber" : { - "description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.orderAttemptNumber" : { - "description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.skipRetry" : { - "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - } - } - }, - "AdditionalDataRisk" : { - "properties" : { - "riskdata.[customFieldName]" : { - "description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].amountPerItem" : { - "description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].brand" : { - "description" : "Brand of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].category" : { - "description" : "Category of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].color" : { - "description" : "Color of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].currency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].itemID" : { - "description" : "ID of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].manufacturer" : { - "description" : "Manufacturer of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].productTitle" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].quantity" : { - "description" : "Quantity of the item purchased.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].receiverEmail" : { - "description" : "Email associated with the given product in the basket (usually in electronic gift cards).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].size" : { - "description" : "Size of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].sku" : { - "description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].upc" : { - "description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionCode" : { - "description" : "Code of the promotion.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : { - "description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : { - "description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionName" : { - "description" : "Name of the promotion.", - "type" : "string" - }, - "riskdata.riskProfileReference" : { - "description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", - "type" : "string" - }, - "riskdata.skipRisk" : { - "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", - "type" : "string" - } - } - }, - "AdditionalDataRiskStandalone" : { - "properties" : { - "PayPal.CountryCode" : { - "description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", - "type" : "string" - }, - "PayPal.EmailId" : { - "description" : "Shopper's email.", - "type" : "string" - }, - "PayPal.FirstName" : { - "description" : "Shopper's first name.", - "type" : "string" - }, - "PayPal.LastName" : { - "description" : "Shopper's last name.", - "type" : "string" - }, - "PayPal.PayerId" : { - "description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", - "type" : "string" - }, - "PayPal.Phone" : { - "description" : "Shopper's phone number.", - "type" : "string" - }, - "PayPal.ProtectionEligibility" : { - "description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.", - "type" : "string" - }, - "PayPal.TransactionId" : { - "description" : "Unique transaction ID of the payment.", - "type" : "string" - }, - "avsResultRaw" : { - "description" : "Raw AVS result received from the acquirer, where available. Example: D", - "type" : "string" - }, - "bin" : { - "description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", - "type" : "string" - }, - "cvcResultRaw" : { - "description" : "Raw CVC result received from the acquirer, where available. Example: 1", - "type" : "string" - }, - "riskToken" : { - "description" : "Unique identifier or token for the shopper's card details.", - "type" : "string" - }, - "threeDAuthenticated" : { - "description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", - "type" : "string" - }, - "threeDOffered" : { - "description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true", - "type" : "string" - }, - "tokenDataType" : { - "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", - "type" : "string" - } - } - }, - "AdditionalDataSubMerchant" : { - "properties" : { - "subMerchant.numberOfSubSellers" : { - "description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].city" : { - "description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].country" : { - "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].id" : { - "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].mcc" : { - "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].name" : { - "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].postalCode" : { - "description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].state" : { - "description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].street" : { - "description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].taxId" : { - "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", - "type" : "string" - } - } - }, - "AdditionalDataTemporaryServices" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", - "type" : "string" - }, - "enhancedSchemeData.employeeName" : { - "description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.jobDescription" : { - "description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.regularHoursRate" : { - "description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.regularHoursWorked" : { - "description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.requestName" : { - "description" : "Name of the individual requesting temporary services.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.tempStartDate" : { - "description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.tempWeekEnding" : { - "description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", - "type" : "string" - } - } - }, - "AdditionalDataWallets" : { - "properties" : { - "androidpay.token" : { - "description" : "The Android Pay token retrieved from the SDK.", - "type" : "string" - }, - "masterpass.transactionId" : { - "description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.", - "type" : "string" - }, - "payment.token" : { - "description" : "The Apple Pay token retrieved from the SDK.", - "type" : "string" - }, - "paywithgoogle.token" : { - "description" : "The Google Pay token retrieved from the SDK.", - "type" : "string" - }, - "samsungpay.token" : { - "description" : "The Samsung Pay token retrieved from the SDK.", - "type" : "string" - }, - "visacheckout.callId" : { - "description" : "The Visa Checkout Call ID retrieved from the SDK.", - "type" : "string" - } - } - }, "Address" : { "properties" : { "city" : { @@ -1766,34 +748,6 @@ "currency" ] }, - "ApplicationInfo" : { - "properties" : { - "adyenLibrary" : { - "description" : "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "adyenPaymentSource" : { - "description" : "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "externalPlatform" : { - "description" : "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.", - "$ref" : "#/components/schemas/ExternalPlatform" - }, - "merchantApplication" : { - "description" : "Merchant developed software, such as cashier application, used to interact with the Adyen API.", - "$ref" : "#/components/schemas/CommonField" - }, - "merchantDevice" : { - "description" : "Merchant device information.", - "$ref" : "#/components/schemas/MerchantDevice" - }, - "shopperInteractionDevice" : { - "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", - "$ref" : "#/components/schemas/ShopperInteractionDevice" - } - } - }, "BankAccount" : { "properties" : { "bankAccountNumber" : { @@ -1836,72 +790,6 @@ } } }, - "BrowserInfo" : { - "properties" : { - "acceptHeader" : { - "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - }, - "colorDepth" : { - "x-addedInVersion" : "40", - "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", - "format" : "int32", - "type" : "integer" - }, - "javaEnabled" : { - "x-addedInVersion" : "40", - "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", - "type" : "boolean" - }, - "javaScriptEnabled" : { - "x-addedInVersion" : "40", - "default" : true, - "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", - "type" : "boolean" - }, - "language" : { - "x-addedInVersion" : "40", - "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", - "type" : "string" - }, - "screenHeight" : { - "x-addedInVersion" : "40", - "description" : "The total height of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "screenWidth" : { - "x-addedInVersion" : "40", - "description" : "The total width of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "timeZoneOffset" : { - "x-addedInVersion" : "40", - "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", - "format" : "int32", - "type" : "integer" - }, - "userAgent" : { - "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - } - }, - "required" : [ - "userAgent", - "acceptHeader", - "javaEnabled", - "colorDepth", - "screenHeight", - "screenWidth", - "timeZoneOffset", - "language" - ] - }, "Card" : { "properties" : { "cvc" : { @@ -1960,120 +848,6 @@ "holderName" ] }, - "CommonField" : { - "properties" : { - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "DeviceRenderOptions" : { - "properties" : { - "sdkInterface" : { - "default" : "both", - "description" : "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both", - "enum" : [ - "native", - "html", - "both" - ], - "type" : "string" - }, - "sdkUiType" : { - "description" : "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect", - "items" : { - "enum" : [ - "multiSelect", - "otherHtml", - "outOfBand", - "singleSelect", - "text" - ], - "type" : "string" - }, - "type" : "array" - } - } - }, - "ExternalPlatform" : { - "properties" : { - "integrator" : { - "description" : "External platform integrator.", - "type" : "string" - }, - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "ForexQuote" : { - "properties" : { - "account" : { - "description" : "The account name.", - "type" : "string" - }, - "accountType" : { - "description" : "The account type.", - "type" : "string" - }, - "baseAmount" : { - "description" : "The base amount.", - "$ref" : "#/components/schemas/Amount" - }, - "basePoints" : { - "description" : "The base points.", - "format" : "int32", - "type" : "integer" - }, - "buy" : { - "description" : "The buy rate.", - "$ref" : "#/components/schemas/Amount" - }, - "interbank" : { - "description" : "The interbank amount.", - "$ref" : "#/components/schemas/Amount" - }, - "reference" : { - "description" : "The reference assigned to the forex quote request.", - "type" : "string" - }, - "sell" : { - "description" : "The sell rate.", - "$ref" : "#/components/schemas/Amount" - }, - "signature" : { - "description" : "The signature to validate the integrity.", - "type" : "string" - }, - "source" : { - "description" : "The source of the forex quote.", - "type" : "string" - }, - "type" : { - "description" : "The type of forex.", - "type" : "string" - }, - "validTill" : { - "description" : "The date until which the forex quote is valid.", - "format" : "date-time", - "type" : "string" - } - }, - "required" : [ - "validTill", - "basePoints" - ] - }, "FraudCheckResult" : { "properties" : { "accountScore" : { @@ -2147,151 +921,6 @@ } } }, - "Installments" : { - "properties" : { - "value" : { - "description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.", - "format" : "int32", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, - "Mandate" : { - "properties" : { - "amount" : { - "description" : "The billing amount (in minor units) of the recurring transactions.", - "type" : "string" - }, - "amountRule" : { - "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", - "enum" : [ - "max", - "exact" - ], - "type" : "string" - }, - "billingAttemptsRule" : { - "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", - "enum" : [ - "on", - "before", - "after" - ], - "type" : "string" - }, - "billingDay" : { - "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", - "type" : "string" - }, - "endsAt" : { - "description" : "End date of the billing plan, in YYYY-MM-DD format.", - "type" : "string" - }, - "frequency" : { - "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", - "enum" : [ - "adhoc", - "daily", - "weekly", - "biWeekly", - "monthly", - "quarterly", - "halfYearly", - "yearly" - ], - "type" : "string" - }, - "remarks" : { - "description" : "The message shown by UPI to the shopper on the approval screen.", - "type" : "string" - }, - "startsAt" : { - "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", - "type" : "string" - } - }, - "required" : [ - "frequency", - "amount", - "endsAt" - ] - }, - "MerchantDevice" : { - "properties" : { - "os" : { - "description" : "Operating system running on the merchant device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the merchant device.", - "type" : "string" - }, - "reference" : { - "description" : "Merchant device reference.", - "type" : "string" - } - } - }, - "MerchantRiskIndicator" : { - "properties" : { - "addressMatch" : { - "description" : "Whether the chosen delivery address is identical to the billing address.", - "type" : "boolean" - }, - "deliveryAddressIndicator" : { - "description" : "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`", - "enum" : [ - "shipToBillingAddress", - "shipToVerifiedAddress", - "shipToNewAddress", - "shipToStore", - "digitalGoods", - "goodsNotShipped", - "other" - ], - "type" : "string" - }, - "deliveryEmail" : { - "description" : "The delivery email address (for digital goods).", - "type" : "string" - }, - "deliveryTimeframe" : { - "description" : "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`", - "enum" : [ - "electronicDelivery", - "sameDayShipping", - "overnightShipping", - "twoOrMoreDaysShipping" - ], - "type" : "string" - }, - "giftCardAmount" : { - "description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).", - "$ref" : "#/components/schemas/Amount" - }, - "giftCardCount" : { - "description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.", - "format" : "int32", - "type" : "integer" - }, - "preOrderDate" : { - "description" : "For pre-order purchases, the expected date this product will be available to the shopper.", - "format" : "date-time", - "type" : "string" - }, - "preOrderPurchase" : { - "description" : "Indicator for whether this transaction is for pre-ordering a product.", - "type" : "boolean" - }, - "reorderItems" : { - "description" : "Indicator for whether the shopper has already purchased the same items in the past.", - "type" : "boolean" - } - } - }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -3007,26 +1636,6 @@ } } }, - "SDKEphemPubKey" : { - "properties" : { - "crv" : { - "description" : "The `crv` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "kty" : { - "description" : "The `kty` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "x" : { - "description" : "The `x` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "y" : { - "description" : "The `y` value as received from the 3D Secure 2 SDK.", - "type" : "string" - } - } - }, "ServiceError" : { "properties" : { "errorCode" : { @@ -3052,78 +1661,6 @@ } } }, - "ShopperInteractionDevice" : { - "properties" : { - "locale" : { - "description" : "Locale on the shopper interaction device.", - "type" : "string" - }, - "os" : { - "description" : "Operating system running on the shopper interaction device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the shopper interaction device.", - "type" : "string" - } - } - }, - "Split" : { - "properties" : { - "account" : { - "description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n", - "type" : "string" - }, - "amount" : { - "description" : "The amount of this split.", - "$ref" : "#/components/schemas/SplitAmount" - }, - "description" : { - "description" : "A description of this split.", - "type" : "string" - }, - "reference" : { - "description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.", - "type" : "string" - }, - "type" : { - "description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**.", - "enum" : [ - "BalanceAccount", - "Commission", - "Default", - "MarketPlace", - "PaymentFee", - "Remainder", - "VAT", - "Verification" - ], - "type" : "string" - } - }, - "required" : [ - "amount", - "type" - ] - }, - "SplitAmount" : { - "properties" : { - "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.", - "maxLength" : 3, - "minLength" : 3, - "type" : "string" - }, - "value" : { - "description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "format" : "int64", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, "StoreDetailAndSubmitRequest" : { "properties" : { "additionalData" : { @@ -3488,148 +2025,6 @@ "pspReference", "resultCode" ] - }, - "ThreeDS2RequestData" : { - "properties" : { - "authenticationOnly" : { - "default" : false, - "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", - "type" : "boolean" - }, - "challengeIndicator" : { - "description" : "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, - "deviceChannel" : { - "description" : "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`", - "type" : "string" - }, - "deviceRenderOptions" : { - "description" : "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.", - "$ref" : "#/components/schemas/DeviceRenderOptions" - }, - "messageVersion" : { - "default" : "2.1.0", - "description" : "The `messageVersion` value indicating the 3D Secure 2 protocol version.", - "type" : "string" - }, - "notificationURL" : { - "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", - "type" : "string" - }, - "sdkAppID" : { - "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEncData" : { - "description" : "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEphemPubKey" : { - "description" : "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "$ref" : "#/components/schemas/SDKEphemPubKey" - }, - "sdkMaxTimeout" : { - "default" : 60, - "description" : "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.", - "format" : "int32", - "type" : "integer" - }, - "sdkReferenceNumber" : { - "description" : "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkTransID" : { - "description" : "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkVersion" : { - "x-addedInVersion" : "40", - "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "threeDSCompInd" : { - "description" : "Completion indicator for the device fingerprinting.", - "type" : "string" - }, - "threeDSRequestorID" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorName" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorURL" : { - "description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.", - "type" : "string" - } - }, - "required" : [ - "deviceChannel" - ] - }, - "ThreeDSecureData" : { - "properties" : { - "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", - "enum" : [ - "Y", - "N", - "U", - "A" - ], - "type" : "string" - }, - "cavv" : { - "description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - }, - "cavvAlgorithm" : { - "description" : "The CAVV algorithm used. Include this only for 3D Secure 1.", - "type" : "string" - }, - "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", - "enum" : [ - "A", - "C", - "D", - "I", - "N", - "R", - "U", - "Y" - ], - "type" : "string" - }, - "dsTransID" : { - "x-addedInVersion" : "40", - "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", - "type" : "string" - }, - "eci" : { - "description" : "The electronic commerce indicator.", - "type" : "string" - }, - "threeDSVersion" : { - "x-addedInVersion" : "40", - "description" : "The version of the 3D Secure protocol.", - "type" : "string" - }, - "xid" : { - "description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - } - } } }, "securitySchemes" : { diff --git a/json/PayoutService-v50.json b/json/PayoutService-v50.json index 051964c..fec827d 100644 --- a/json/PayoutService-v50.json +++ b/json/PayoutService-v50.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payout API", "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", - "x-timestamp" : "2022-05-03T09:24:06Z", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -40,7 +40,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Confirms a payout.", + "summary" : "Confirm a payout", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", @@ -149,7 +149,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Cancels a payout.", + "summary" : "Cancel a payout", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", @@ -258,7 +258,7 @@ "tags" : [ "Instant payouts" ], - "summary" : "Pay out directly.", + "summary" : "Make an instant card payout", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", @@ -365,7 +365,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores payout details.", + "summary" : "Store payout details", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", @@ -473,7 +473,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores details and submits a payout.", + "summary" : "Store details and submit a payout", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", @@ -589,7 +589,7 @@ "tags" : [ "Initialization" ], - "summary" : "Submits a payout.", + "summary" : "Submit a payout", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", @@ -691,1034 +691,6 @@ }, "components" : { "schemas" : { - "AccountInfo" : { - "properties" : { - "accountAgeIndicator" : { - "description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountChangeDate" : { - "description" : "Date when the shopper's account was last changed.", - "format" : "date-time", - "type" : "string" - }, - "accountChangeIndicator" : { - "description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountCreationDate" : { - "description" : "Date when the shopper's account was created.", - "format" : "date-time", - "type" : "string" - }, - "accountType" : { - "x-addedInVersion" : "50", - "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", - "enum" : [ - "notApplicable", - "credit", - "debit" - ], - "type" : "string" - }, - "addCardAttemptsDay" : { - "description" : "Number of attempts the shopper tried to add a card to their account in the last day.", - "format" : "int32", - "type" : "integer" - }, - "deliveryAddressUsageDate" : { - "description" : "Date the selected delivery address was first used.", - "format" : "date-time", - "type" : "string" - }, - "deliveryAddressUsageIndicator" : { - "description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "homePhone" : { - "description" : "Shopper's home phone number (including the country code).", - "type" : "string" - }, - "mobilePhone" : { - "description" : "Shopper's mobile phone number (including the country code).", - "type" : "string" - }, - "passwordChangeDate" : { - "description" : "Date when the shopper last changed their password.", - "format" : "date-time", - "type" : "string" - }, - "passwordChangeIndicator" : { - "description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "pastTransactionsDay" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.", - "format" : "int32", - "type" : "integer" - }, - "pastTransactionsYear" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.", - "format" : "int32", - "type" : "integer" - }, - "paymentAccountAge" : { - "description" : "Date this payment method was added to the shopper's account.", - "format" : "date-time", - "type" : "string" - }, - "paymentAccountIndicator" : { - "description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "purchasesLast6Months" : { - "description" : "Number of successful purchases in the last six months.", - "format" : "int32", - "type" : "integer" - }, - "suspiciousActivity" : { - "description" : "Whether suspicious activity was recorded on this account.", - "type" : "boolean" - }, - "workPhone" : { - "description" : "Shopper's work phone number (including the country code).", - "type" : "string" - } - } - }, - "AdditionalData3DSecure" : { - "properties" : { - "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", - "type" : "string" - }, - "executeThreeD" : { - "description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", - "type" : "string" - }, - "mpiImplementationType" : { - "description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.", - "type" : "string" - }, - "scaExemption" : { - "description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", - "type" : "string" - }, - "threeDSVersion" : { - "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", - "type" : "string" - } - } - }, - "AdditionalDataAirline" : { - "properties" : { - "airline.agency_invoice_number" : { - "description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6", - "type" : "string" - }, - "airline.agency_plan_name" : { - "description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.airline_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.airline_designator_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.boarding_fee" : { - "description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18", - "type" : "string" - }, - "airline.computerized_reservation_system" : { - "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4", - "type" : "string" - }, - "airline.customer_reference_number" : { - "description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20", - "type" : "string" - }, - "airline.document_type" : { - "description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.flight_date" : { - "description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.carrier_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.leg.class_of_travel" : { - "description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.leg.date_of_travel" : { - "description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.depart_airport" : { - "description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.depart_tax" : { - "description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12", - "type" : "string" - }, - "airline.leg.destination_code" : { - "description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.fare_base_code" : { - "description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7", - "type" : "string" - }, - "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5", - "type" : "string" - }, - "airline.leg.stop_over_code" : { - "description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.passenger.date_of_birth" : { - "description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", - "type" : "string" - }, - "airline.passenger.first_name" : { - "description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.last_name" : { - "description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.telephone_number" : { - "description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30", - "type" : "string" - }, - "airline.passenger.traveller_type" : { - "description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6", - "type" : "string" - }, - "airline.passenger_name" : { - "description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49", - "type" : "string" - }, - "airline.ticket_issue_address" : { - "description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16", - "type" : "string" - }, - "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150", - "type" : "string" - }, - "airline.travel_agency_code" : { - "description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8", - "type" : "string" - }, - "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25", - "type" : "string" - } - }, - "required" : [ - "airline.passenger_name" - ] - }, - "AdditionalDataCarRental" : { - "properties" : { - "carRental.checkOutDate" : { - "description" : "Pick-up date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19", - "type" : "string" - }, - "carRental.fuelCharges" : { - "description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.locationCity" : { - "description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.locationCountry" : { - "description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.locationStateProvince" : { - "description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.", - "type" : "string" - }, - "carRental.oneWayDropOffCharges" : { - "description" : "Charge associated with not returning a vehicle to the original rental location.", - "type" : "string" - }, - "carRental.rate" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.rateIndicator" : { - "description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.", - "type" : "string" - }, - "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9", - "type" : "string" - }, - "carRental.rentalClassId" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26", - "type" : "string" - }, - "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.returnCountry" : { - "description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.returnDate" : { - "description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.returnLocationId" : { - "description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10", - "type" : "string" - }, - "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.taxExemptIndicator" : { - "description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataCommon" : { - "properties" : { - "RequestedTestErrorResponseCode" : { - "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", - "type" : "string" - }, - "authorisationType" : { - "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", - "type" : "string" - }, - "customRoutingFlag" : { - "description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).", - "type" : "string" - }, - "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], - "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "enum" : [ - "NoShow", - "DelayedCharge" - ], - "type" : "string" - }, - "networkTxReference" : { - "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", - "type" : "string" - }, - "overwriteBrand" : { - "description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", - "type" : "string" - }, - "subMerchantCity" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", - "type" : "string" - }, - "subMerchantCountry" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", - "type" : "string" - }, - "subMerchantID" : { - "description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", - "type" : "string" - }, - "subMerchantName" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", - "type" : "string" - }, - "subMerchantPostalCode" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", - "type" : "string" - }, - "subMerchantState" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", - "type" : "string" - }, - "subMerchantStreet" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", - "type" : "string" - }, - "subMerchantTaxId" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", - "type" : "string" - } - } - }, - "AdditionalDataLevel23" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - }, - "enhancedSchemeData.destinationCountryCode" : { - "description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.", - "type" : "string" - }, - "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.dutyAmount" : { - "description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.freightAmount" : { - "description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.orderDate" : { - "description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.", - "type" : "string" - }, - "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - } - } - }, - "AdditionalDataLodging" : { - "properties" : { - "lodging.checkInDate" : { - "description" : "The arrival date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.checkOutDate" : { - "description" : "The departure date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.fireSafetyActIndicator" : { - "description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1", - "type" : "string" - }, - "lodging.folioCashAdvances" : { - "description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.folioNumber" : { - "description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25", - "type" : "string" - }, - "lodging.foodBeverageCharges" : { - "description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1", - "type" : "string" - }, - "lodging.prepaidExpenses" : { - "description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.propertyPhoneNumber" : { - "description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.room1.numberOfNights" : { - "description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4", - "type" : "string" - }, - "lodging.room1.rate" : { - "description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.room1.tax" : { - "description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalRoomTax" : { - "description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalTax" : { - "description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataOpenInvoice" : { - "properties" : { - "openinvoicedata.merchantData" : { - "description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", - "type" : "string" - }, - "openinvoicedata.numberOfLines" : { - "description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].currencyCode" : { - "description" : "The three-character ISO currency code.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].description" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemAmount" : { - "description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemId" : { - "description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatAmount" : { - "description" : "The VAT due for one item in the invoice line, represented in minor units.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatPercentage" : { - "description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].numberOfItems" : { - "description" : "The number of units purchased of a specific product.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnShippingCompany" : { - "description" : "Name of the shipping company handling the the return shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingNumber" : { - "description" : "The tracking number for the return of the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingUri" : { - "description" : "URI where the customer can track the return of their shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingCompany" : { - "description" : "Name of the shipping company handling the delivery.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingMethod" : { - "description" : "Shipping method.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingNumber" : { - "description" : "The tracking number for the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingUri" : { - "description" : "URI where the customer can track their shipment.", - "type" : "string" - } - } - }, - "AdditionalDataOpi" : { - "properties" : { - "opi.includeTransToken" : { - "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", - "type" : "string" - } - } - }, - "AdditionalDataPayout" : { - "properties" : { - "fundingNetwork" : { - "description" : "", - "type" : "string" - }, - "fundingSource" : { - "description" : "", - "enum" : [ - "CREDIT", - "DEBIT", - "PREPAID", - "DEPOSIT_ACCOUNT" - ], - "type" : "string" - }, - "fundingTransactionId" : { - "description" : "", - "type" : "string" - }, - "payoutAccountCode" : { - "description" : "", - "type" : "string" - }, - "payoutAccountHolderCode" : { - "description" : "", - "type" : "string" - }, - "payoutMarketPayUser" : { - "description" : "", - "type" : "string" - }, - "processOver" : { - "description" : "", - "enum" : [ - "MC_P2P", - "Visa_OCT", - "UnlinkedRefund" - ], - "type" : "string" - }, - "verifyOver" : { - "description" : "", - "type" : "string" - }, - "walletIdentifier" : { - "description" : "", - "type" : "string" - } - } - }, - "AdditionalDataRatepay" : { - "properties" : { - "ratepay.installmentAmount" : { - "description" : "Amount the customer has to pay each month.", - "type" : "string" - }, - "ratepay.interestRate" : { - "description" : "Interest rate of this installment.", - "type" : "string" - }, - "ratepay.lastInstallmentAmount" : { - "description" : "Amount of the last installment.", - "type" : "string" - }, - "ratepay.paymentFirstday" : { - "description" : "Calendar day of the first payment.", - "type" : "string" - }, - "ratepaydata.deliveryDate" : { - "description" : "Date the merchant delivered the goods to the customer.", - "type" : "string" - }, - "ratepaydata.dueDate" : { - "description" : "Date by which the customer must settle the payment.", - "type" : "string" - }, - "ratepaydata.invoiceDate" : { - "description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", - "type" : "string" - }, - "ratepaydata.invoiceId" : { - "description" : "Identification name or number for the invoice, defined by the merchant.", - "type" : "string" - } - } - }, - "AdditionalDataRetry" : { - "properties" : { - "retry.chainAttemptNumber" : { - "description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.orderAttemptNumber" : { - "description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.skipRetry" : { - "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - } - } - }, - "AdditionalDataRisk" : { - "properties" : { - "riskdata.[customFieldName]" : { - "description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].amountPerItem" : { - "description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].brand" : { - "description" : "Brand of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].category" : { - "description" : "Category of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].color" : { - "description" : "Color of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].currency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].itemID" : { - "description" : "ID of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].manufacturer" : { - "description" : "Manufacturer of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].productTitle" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].quantity" : { - "description" : "Quantity of the item purchased.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].receiverEmail" : { - "description" : "Email associated with the given product in the basket (usually in electronic gift cards).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].size" : { - "description" : "Size of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].sku" : { - "description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].upc" : { - "description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionCode" : { - "description" : "Code of the promotion.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : { - "description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : { - "description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionName" : { - "description" : "Name of the promotion.", - "type" : "string" - }, - "riskdata.riskProfileReference" : { - "description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", - "type" : "string" - }, - "riskdata.skipRisk" : { - "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", - "type" : "string" - } - } - }, - "AdditionalDataRiskStandalone" : { - "properties" : { - "PayPal.CountryCode" : { - "description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", - "type" : "string" - }, - "PayPal.EmailId" : { - "description" : "Shopper's email.", - "type" : "string" - }, - "PayPal.FirstName" : { - "description" : "Shopper's first name.", - "type" : "string" - }, - "PayPal.LastName" : { - "description" : "Shopper's last name.", - "type" : "string" - }, - "PayPal.PayerId" : { - "description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", - "type" : "string" - }, - "PayPal.Phone" : { - "description" : "Shopper's phone number.", - "type" : "string" - }, - "PayPal.ProtectionEligibility" : { - "description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.", - "type" : "string" - }, - "PayPal.TransactionId" : { - "description" : "Unique transaction ID of the payment.", - "type" : "string" - }, - "avsResultRaw" : { - "description" : "Raw AVS result received from the acquirer, where available. Example: D", - "type" : "string" - }, - "bin" : { - "description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", - "type" : "string" - }, - "cvcResultRaw" : { - "description" : "Raw CVC result received from the acquirer, where available. Example: 1", - "type" : "string" - }, - "riskToken" : { - "description" : "Unique identifier or token for the shopper's card details.", - "type" : "string" - }, - "threeDAuthenticated" : { - "description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", - "type" : "string" - }, - "threeDOffered" : { - "description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true", - "type" : "string" - }, - "tokenDataType" : { - "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", - "type" : "string" - } - } - }, - "AdditionalDataSubMerchant" : { - "properties" : { - "subMerchant.numberOfSubSellers" : { - "description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].city" : { - "description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].country" : { - "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].id" : { - "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].mcc" : { - "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].name" : { - "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].postalCode" : { - "description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].state" : { - "description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].street" : { - "description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].taxId" : { - "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", - "type" : "string" - } - } - }, - "AdditionalDataTemporaryServices" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", - "type" : "string" - }, - "enhancedSchemeData.employeeName" : { - "description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.jobDescription" : { - "description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.regularHoursRate" : { - "description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.regularHoursWorked" : { - "description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.requestName" : { - "description" : "Name of the individual requesting temporary services.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.tempStartDate" : { - "description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.tempWeekEnding" : { - "description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", - "type" : "string" - } - } - }, - "AdditionalDataWallets" : { - "properties" : { - "androidpay.token" : { - "description" : "The Android Pay token retrieved from the SDK.", - "type" : "string" - }, - "masterpass.transactionId" : { - "description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.", - "type" : "string" - }, - "payment.token" : { - "description" : "The Apple Pay token retrieved from the SDK.", - "type" : "string" - }, - "paywithgoogle.token" : { - "description" : "The Google Pay token retrieved from the SDK.", - "type" : "string" - }, - "samsungpay.token" : { - "description" : "The Samsung Pay token retrieved from the SDK.", - "type" : "string" - }, - "visacheckout.callId" : { - "description" : "The Visa Checkout Call ID retrieved from the SDK.", - "type" : "string" - } - } - }, "Address" : { "properties" : { "city" : { @@ -1776,34 +748,6 @@ "currency" ] }, - "ApplicationInfo" : { - "properties" : { - "adyenLibrary" : { - "description" : "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "adyenPaymentSource" : { - "description" : "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "externalPlatform" : { - "description" : "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.", - "$ref" : "#/components/schemas/ExternalPlatform" - }, - "merchantApplication" : { - "description" : "Merchant developed software, such as cashier application, used to interact with the Adyen API.", - "$ref" : "#/components/schemas/CommonField" - }, - "merchantDevice" : { - "description" : "Merchant device information.", - "$ref" : "#/components/schemas/MerchantDevice" - }, - "shopperInteractionDevice" : { - "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", - "$ref" : "#/components/schemas/ShopperInteractionDevice" - } - } - }, "BankAccount" : { "properties" : { "bankAccountNumber" : { @@ -1846,72 +790,6 @@ } } }, - "BrowserInfo" : { - "properties" : { - "acceptHeader" : { - "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - }, - "colorDepth" : { - "x-addedInVersion" : "40", - "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", - "format" : "int32", - "type" : "integer" - }, - "javaEnabled" : { - "x-addedInVersion" : "40", - "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", - "type" : "boolean" - }, - "javaScriptEnabled" : { - "x-addedInVersion" : "40", - "default" : true, - "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", - "type" : "boolean" - }, - "language" : { - "x-addedInVersion" : "40", - "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", - "type" : "string" - }, - "screenHeight" : { - "x-addedInVersion" : "40", - "description" : "The total height of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "screenWidth" : { - "x-addedInVersion" : "40", - "description" : "The total width of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "timeZoneOffset" : { - "x-addedInVersion" : "40", - "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", - "format" : "int32", - "type" : "integer" - }, - "userAgent" : { - "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - } - }, - "required" : [ - "userAgent", - "acceptHeader", - "javaEnabled", - "colorDepth", - "screenHeight", - "screenWidth", - "timeZoneOffset", - "language" - ] - }, "Card" : { "properties" : { "cvc" : { @@ -1970,120 +848,6 @@ "holderName" ] }, - "CommonField" : { - "properties" : { - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "DeviceRenderOptions" : { - "properties" : { - "sdkInterface" : { - "default" : "both", - "description" : "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both", - "enum" : [ - "native", - "html", - "both" - ], - "type" : "string" - }, - "sdkUiType" : { - "description" : "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect", - "items" : { - "enum" : [ - "multiSelect", - "otherHtml", - "outOfBand", - "singleSelect", - "text" - ], - "type" : "string" - }, - "type" : "array" - } - } - }, - "ExternalPlatform" : { - "properties" : { - "integrator" : { - "description" : "External platform integrator.", - "type" : "string" - }, - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "ForexQuote" : { - "properties" : { - "account" : { - "description" : "The account name.", - "type" : "string" - }, - "accountType" : { - "description" : "The account type.", - "type" : "string" - }, - "baseAmount" : { - "description" : "The base amount.", - "$ref" : "#/components/schemas/Amount" - }, - "basePoints" : { - "description" : "The base points.", - "format" : "int32", - "type" : "integer" - }, - "buy" : { - "description" : "The buy rate.", - "$ref" : "#/components/schemas/Amount" - }, - "interbank" : { - "description" : "The interbank amount.", - "$ref" : "#/components/schemas/Amount" - }, - "reference" : { - "description" : "The reference assigned to the forex quote request.", - "type" : "string" - }, - "sell" : { - "description" : "The sell rate.", - "$ref" : "#/components/schemas/Amount" - }, - "signature" : { - "description" : "The signature to validate the integrity.", - "type" : "string" - }, - "source" : { - "description" : "The source of the forex quote.", - "type" : "string" - }, - "type" : { - "description" : "The type of forex.", - "type" : "string" - }, - "validTill" : { - "description" : "The date until which the forex quote is valid.", - "format" : "date-time", - "type" : "string" - } - }, - "required" : [ - "validTill", - "basePoints" - ] - }, "FraudCheckResult" : { "properties" : { "accountScore" : { @@ -2157,151 +921,6 @@ } } }, - "Installments" : { - "properties" : { - "value" : { - "description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.", - "format" : "int32", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, - "Mandate" : { - "properties" : { - "amount" : { - "description" : "The billing amount (in minor units) of the recurring transactions.", - "type" : "string" - }, - "amountRule" : { - "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", - "enum" : [ - "max", - "exact" - ], - "type" : "string" - }, - "billingAttemptsRule" : { - "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", - "enum" : [ - "on", - "before", - "after" - ], - "type" : "string" - }, - "billingDay" : { - "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", - "type" : "string" - }, - "endsAt" : { - "description" : "End date of the billing plan, in YYYY-MM-DD format.", - "type" : "string" - }, - "frequency" : { - "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", - "enum" : [ - "adhoc", - "daily", - "weekly", - "biWeekly", - "monthly", - "quarterly", - "halfYearly", - "yearly" - ], - "type" : "string" - }, - "remarks" : { - "description" : "The message shown by UPI to the shopper on the approval screen.", - "type" : "string" - }, - "startsAt" : { - "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", - "type" : "string" - } - }, - "required" : [ - "frequency", - "amount", - "endsAt" - ] - }, - "MerchantDevice" : { - "properties" : { - "os" : { - "description" : "Operating system running on the merchant device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the merchant device.", - "type" : "string" - }, - "reference" : { - "description" : "Merchant device reference.", - "type" : "string" - } - } - }, - "MerchantRiskIndicator" : { - "properties" : { - "addressMatch" : { - "description" : "Whether the chosen delivery address is identical to the billing address.", - "type" : "boolean" - }, - "deliveryAddressIndicator" : { - "description" : "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`", - "enum" : [ - "shipToBillingAddress", - "shipToVerifiedAddress", - "shipToNewAddress", - "shipToStore", - "digitalGoods", - "goodsNotShipped", - "other" - ], - "type" : "string" - }, - "deliveryEmail" : { - "description" : "The delivery email address (for digital goods).", - "type" : "string" - }, - "deliveryTimeframe" : { - "description" : "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`", - "enum" : [ - "electronicDelivery", - "sameDayShipping", - "overnightShipping", - "twoOrMoreDaysShipping" - ], - "type" : "string" - }, - "giftCardAmount" : { - "description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).", - "$ref" : "#/components/schemas/Amount" - }, - "giftCardCount" : { - "description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.", - "format" : "int32", - "type" : "integer" - }, - "preOrderDate" : { - "description" : "For pre-order purchases, the expected date this product will be available to the shopper.", - "format" : "date-time", - "type" : "string" - }, - "preOrderPurchase" : { - "description" : "Indicator for whether this transaction is for pre-ordering a product.", - "type" : "boolean" - }, - "reorderItems" : { - "description" : "Indicator for whether the shopper has already purchased the same items in the past.", - "type" : "boolean" - } - } - }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -3017,26 +1636,6 @@ } } }, - "SDKEphemPubKey" : { - "properties" : { - "crv" : { - "description" : "The `crv` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "kty" : { - "description" : "The `kty` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "x" : { - "description" : "The `x` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "y" : { - "description" : "The `y` value as received from the 3D Secure 2 SDK.", - "type" : "string" - } - } - }, "ServiceError" : { "properties" : { "additionalData" : { @@ -3070,78 +1669,6 @@ } } }, - "ShopperInteractionDevice" : { - "properties" : { - "locale" : { - "description" : "Locale on the shopper interaction device.", - "type" : "string" - }, - "os" : { - "description" : "Operating system running on the shopper interaction device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the shopper interaction device.", - "type" : "string" - } - } - }, - "Split" : { - "properties" : { - "account" : { - "description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n", - "type" : "string" - }, - "amount" : { - "description" : "The amount of this split.", - "$ref" : "#/components/schemas/SplitAmount" - }, - "description" : { - "description" : "A description of this split.", - "type" : "string" - }, - "reference" : { - "description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.", - "type" : "string" - }, - "type" : { - "description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**.", - "enum" : [ - "BalanceAccount", - "Commission", - "Default", - "MarketPlace", - "PaymentFee", - "Remainder", - "VAT", - "Verification" - ], - "type" : "string" - } - }, - "required" : [ - "amount", - "type" - ] - }, - "SplitAmount" : { - "properties" : { - "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.", - "maxLength" : 3, - "minLength" : 3, - "type" : "string" - }, - "value" : { - "description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "format" : "int64", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, "StoreDetailAndSubmitRequest" : { "properties" : { "additionalData" : { @@ -3506,188 +2033,6 @@ "pspReference", "resultCode" ] - }, - "ThreeDS2RequestData" : { - "properties" : { - "acquirerBIN" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "acquirerMerchantID" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "authenticationOnly" : { - "deprecated" : true, - "x-deprecatedInVersion" : "50", - "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", - "default" : false, - "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", - "type" : "boolean" - }, - "challengeIndicator" : { - "description" : "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, - "deviceChannel" : { - "description" : "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`", - "type" : "string" - }, - "deviceRenderOptions" : { - "description" : "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.", - "$ref" : "#/components/schemas/DeviceRenderOptions" - }, - "mcc" : { - "x-addedInVersion" : "49", - "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", - "type" : "string" - }, - "merchantName" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", - "type" : "string" - }, - "messageVersion" : { - "default" : "2.1.0", - "description" : "The `messageVersion` value indicating the 3D Secure 2 protocol version.", - "type" : "string" - }, - "notificationURL" : { - "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", - "type" : "string" - }, - "sdkAppID" : { - "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEncData" : { - "description" : "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEphemPubKey" : { - "description" : "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "$ref" : "#/components/schemas/SDKEphemPubKey" - }, - "sdkMaxTimeout" : { - "default" : 60, - "description" : "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.", - "format" : "int32", - "type" : "integer" - }, - "sdkReferenceNumber" : { - "description" : "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkTransID" : { - "description" : "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkVersion" : { - "x-addedInVersion" : "40", - "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "threeDSCompInd" : { - "description" : "Completion indicator for the device fingerprinting.", - "type" : "string" - }, - "threeDSRequestorID" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorName" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorURL" : { - "description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.", - "type" : "string" - }, - "transactionType" : { - "x-addedInVersion" : "50", - "description" : "Identify the type of the transaction being authenticated.", - "enum" : [ - "goodsOrServicePurchase", - "checkAcceptance", - "accountFunding", - "quasiCashTransaction", - "prepaidActivationAndLoad" - ], - "type" : "string" - }, - "whiteListStatus" : { - "x-addedInVersion" : "49", - "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", - "type" : "string" - } - }, - "required" : [ - "deviceChannel" - ] - }, - "ThreeDSecureData" : { - "properties" : { - "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", - "enum" : [ - "Y", - "N", - "U", - "A" - ], - "type" : "string" - }, - "cavv" : { - "description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - }, - "cavvAlgorithm" : { - "description" : "The CAVV algorithm used. Include this only for 3D Secure 1.", - "type" : "string" - }, - "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", - "enum" : [ - "A", - "C", - "D", - "I", - "N", - "R", - "U", - "Y" - ], - "type" : "string" - }, - "dsTransID" : { - "x-addedInVersion" : "40", - "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", - "type" : "string" - }, - "eci" : { - "description" : "The electronic commerce indicator.", - "type" : "string" - }, - "threeDSVersion" : { - "x-addedInVersion" : "40", - "description" : "The version of the 3D Secure protocol.", - "type" : "string" - }, - "xid" : { - "description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - } - } } }, "securitySchemes" : { diff --git a/json/PayoutService-v51.json b/json/PayoutService-v51.json index 58c0bd9..7efbaf1 100644 --- a/json/PayoutService-v51.json +++ b/json/PayoutService-v51.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payout API", "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", - "x-timestamp" : "2022-05-03T09:24:06Z", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -40,7 +40,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Confirms a payout.", + "summary" : "Confirm a payout", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", @@ -149,7 +149,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Cancels a payout.", + "summary" : "Cancel a payout", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", @@ -258,7 +258,7 @@ "tags" : [ "Instant payouts" ], - "summary" : "Pay out directly.", + "summary" : "Make an instant card payout", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", @@ -365,7 +365,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores payout details.", + "summary" : "Store payout details", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", @@ -473,7 +473,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores details and submits a payout.", + "summary" : "Store details and submit a payout", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", @@ -589,7 +589,7 @@ "tags" : [ "Initialization" ], - "summary" : "Submits a payout.", + "summary" : "Submit a payout", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", @@ -691,1034 +691,6 @@ }, "components" : { "schemas" : { - "AccountInfo" : { - "properties" : { - "accountAgeIndicator" : { - "description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountChangeDate" : { - "description" : "Date when the shopper's account was last changed.", - "format" : "date-time", - "type" : "string" - }, - "accountChangeIndicator" : { - "description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountCreationDate" : { - "description" : "Date when the shopper's account was created.", - "format" : "date-time", - "type" : "string" - }, - "accountType" : { - "x-addedInVersion" : "50", - "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", - "enum" : [ - "notApplicable", - "credit", - "debit" - ], - "type" : "string" - }, - "addCardAttemptsDay" : { - "description" : "Number of attempts the shopper tried to add a card to their account in the last day.", - "format" : "int32", - "type" : "integer" - }, - "deliveryAddressUsageDate" : { - "description" : "Date the selected delivery address was first used.", - "format" : "date-time", - "type" : "string" - }, - "deliveryAddressUsageIndicator" : { - "description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "homePhone" : { - "description" : "Shopper's home phone number (including the country code).", - "type" : "string" - }, - "mobilePhone" : { - "description" : "Shopper's mobile phone number (including the country code).", - "type" : "string" - }, - "passwordChangeDate" : { - "description" : "Date when the shopper last changed their password.", - "format" : "date-time", - "type" : "string" - }, - "passwordChangeIndicator" : { - "description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "pastTransactionsDay" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.", - "format" : "int32", - "type" : "integer" - }, - "pastTransactionsYear" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.", - "format" : "int32", - "type" : "integer" - }, - "paymentAccountAge" : { - "description" : "Date this payment method was added to the shopper's account.", - "format" : "date-time", - "type" : "string" - }, - "paymentAccountIndicator" : { - "description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "purchasesLast6Months" : { - "description" : "Number of successful purchases in the last six months.", - "format" : "int32", - "type" : "integer" - }, - "suspiciousActivity" : { - "description" : "Whether suspicious activity was recorded on this account.", - "type" : "boolean" - }, - "workPhone" : { - "description" : "Shopper's work phone number (including the country code).", - "type" : "string" - } - } - }, - "AdditionalData3DSecure" : { - "properties" : { - "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", - "type" : "string" - }, - "executeThreeD" : { - "description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", - "type" : "string" - }, - "mpiImplementationType" : { - "description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.", - "type" : "string" - }, - "scaExemption" : { - "description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", - "type" : "string" - }, - "threeDSVersion" : { - "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", - "type" : "string" - } - } - }, - "AdditionalDataAirline" : { - "properties" : { - "airline.agency_invoice_number" : { - "description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6", - "type" : "string" - }, - "airline.agency_plan_name" : { - "description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.airline_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.airline_designator_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.boarding_fee" : { - "description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18", - "type" : "string" - }, - "airline.computerized_reservation_system" : { - "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4", - "type" : "string" - }, - "airline.customer_reference_number" : { - "description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20", - "type" : "string" - }, - "airline.document_type" : { - "description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.flight_date" : { - "description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.carrier_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.leg.class_of_travel" : { - "description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.leg.date_of_travel" : { - "description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.depart_airport" : { - "description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.depart_tax" : { - "description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12", - "type" : "string" - }, - "airline.leg.destination_code" : { - "description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.fare_base_code" : { - "description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7", - "type" : "string" - }, - "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5", - "type" : "string" - }, - "airline.leg.stop_over_code" : { - "description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.passenger.date_of_birth" : { - "description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", - "type" : "string" - }, - "airline.passenger.first_name" : { - "description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.last_name" : { - "description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.telephone_number" : { - "description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30", - "type" : "string" - }, - "airline.passenger.traveller_type" : { - "description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6", - "type" : "string" - }, - "airline.passenger_name" : { - "description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49", - "type" : "string" - }, - "airline.ticket_issue_address" : { - "description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16", - "type" : "string" - }, - "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150", - "type" : "string" - }, - "airline.travel_agency_code" : { - "description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8", - "type" : "string" - }, - "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25", - "type" : "string" - } - }, - "required" : [ - "airline.passenger_name" - ] - }, - "AdditionalDataCarRental" : { - "properties" : { - "carRental.checkOutDate" : { - "description" : "Pick-up date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19", - "type" : "string" - }, - "carRental.fuelCharges" : { - "description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.locationCity" : { - "description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.locationCountry" : { - "description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.locationStateProvince" : { - "description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.", - "type" : "string" - }, - "carRental.oneWayDropOffCharges" : { - "description" : "Charge associated with not returning a vehicle to the original rental location.", - "type" : "string" - }, - "carRental.rate" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.rateIndicator" : { - "description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.", - "type" : "string" - }, - "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9", - "type" : "string" - }, - "carRental.rentalClassId" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26", - "type" : "string" - }, - "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.returnCountry" : { - "description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.returnDate" : { - "description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.returnLocationId" : { - "description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10", - "type" : "string" - }, - "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.taxExemptIndicator" : { - "description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataCommon" : { - "properties" : { - "RequestedTestErrorResponseCode" : { - "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", - "type" : "string" - }, - "authorisationType" : { - "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", - "type" : "string" - }, - "customRoutingFlag" : { - "description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).", - "type" : "string" - }, - "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], - "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "enum" : [ - "NoShow", - "DelayedCharge" - ], - "type" : "string" - }, - "networkTxReference" : { - "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", - "type" : "string" - }, - "overwriteBrand" : { - "description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", - "type" : "string" - }, - "subMerchantCity" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", - "type" : "string" - }, - "subMerchantCountry" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", - "type" : "string" - }, - "subMerchantID" : { - "description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", - "type" : "string" - }, - "subMerchantName" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", - "type" : "string" - }, - "subMerchantPostalCode" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", - "type" : "string" - }, - "subMerchantState" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", - "type" : "string" - }, - "subMerchantStreet" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", - "type" : "string" - }, - "subMerchantTaxId" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", - "type" : "string" - } - } - }, - "AdditionalDataLevel23" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - }, - "enhancedSchemeData.destinationCountryCode" : { - "description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.", - "type" : "string" - }, - "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.dutyAmount" : { - "description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.freightAmount" : { - "description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.orderDate" : { - "description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.", - "type" : "string" - }, - "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - } - } - }, - "AdditionalDataLodging" : { - "properties" : { - "lodging.checkInDate" : { - "description" : "The arrival date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.checkOutDate" : { - "description" : "The departure date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.fireSafetyActIndicator" : { - "description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1", - "type" : "string" - }, - "lodging.folioCashAdvances" : { - "description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.folioNumber" : { - "description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25", - "type" : "string" - }, - "lodging.foodBeverageCharges" : { - "description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1", - "type" : "string" - }, - "lodging.prepaidExpenses" : { - "description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.propertyPhoneNumber" : { - "description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.room1.numberOfNights" : { - "description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4", - "type" : "string" - }, - "lodging.room1.rate" : { - "description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.room1.tax" : { - "description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalRoomTax" : { - "description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalTax" : { - "description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataOpenInvoice" : { - "properties" : { - "openinvoicedata.merchantData" : { - "description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", - "type" : "string" - }, - "openinvoicedata.numberOfLines" : { - "description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].currencyCode" : { - "description" : "The three-character ISO currency code.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].description" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemAmount" : { - "description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemId" : { - "description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatAmount" : { - "description" : "The VAT due for one item in the invoice line, represented in minor units.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatPercentage" : { - "description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].numberOfItems" : { - "description" : "The number of units purchased of a specific product.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnShippingCompany" : { - "description" : "Name of the shipping company handling the the return shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingNumber" : { - "description" : "The tracking number for the return of the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingUri" : { - "description" : "URI where the customer can track the return of their shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingCompany" : { - "description" : "Name of the shipping company handling the delivery.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingMethod" : { - "description" : "Shipping method.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingNumber" : { - "description" : "The tracking number for the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingUri" : { - "description" : "URI where the customer can track their shipment.", - "type" : "string" - } - } - }, - "AdditionalDataOpi" : { - "properties" : { - "opi.includeTransToken" : { - "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", - "type" : "string" - } - } - }, - "AdditionalDataPayout" : { - "properties" : { - "fundingNetwork" : { - "description" : "", - "type" : "string" - }, - "fundingSource" : { - "description" : "", - "enum" : [ - "CREDIT", - "DEBIT", - "PREPAID", - "DEPOSIT_ACCOUNT" - ], - "type" : "string" - }, - "fundingTransactionId" : { - "description" : "", - "type" : "string" - }, - "payoutAccountCode" : { - "description" : "", - "type" : "string" - }, - "payoutAccountHolderCode" : { - "description" : "", - "type" : "string" - }, - "payoutMarketPayUser" : { - "description" : "", - "type" : "string" - }, - "processOver" : { - "description" : "", - "enum" : [ - "MC_P2P", - "Visa_OCT", - "UnlinkedRefund" - ], - "type" : "string" - }, - "verifyOver" : { - "description" : "", - "type" : "string" - }, - "walletIdentifier" : { - "description" : "", - "type" : "string" - } - } - }, - "AdditionalDataRatepay" : { - "properties" : { - "ratepay.installmentAmount" : { - "description" : "Amount the customer has to pay each month.", - "type" : "string" - }, - "ratepay.interestRate" : { - "description" : "Interest rate of this installment.", - "type" : "string" - }, - "ratepay.lastInstallmentAmount" : { - "description" : "Amount of the last installment.", - "type" : "string" - }, - "ratepay.paymentFirstday" : { - "description" : "Calendar day of the first payment.", - "type" : "string" - }, - "ratepaydata.deliveryDate" : { - "description" : "Date the merchant delivered the goods to the customer.", - "type" : "string" - }, - "ratepaydata.dueDate" : { - "description" : "Date by which the customer must settle the payment.", - "type" : "string" - }, - "ratepaydata.invoiceDate" : { - "description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", - "type" : "string" - }, - "ratepaydata.invoiceId" : { - "description" : "Identification name or number for the invoice, defined by the merchant.", - "type" : "string" - } - } - }, - "AdditionalDataRetry" : { - "properties" : { - "retry.chainAttemptNumber" : { - "description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.orderAttemptNumber" : { - "description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.skipRetry" : { - "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - } - } - }, - "AdditionalDataRisk" : { - "properties" : { - "riskdata.[customFieldName]" : { - "description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].amountPerItem" : { - "description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].brand" : { - "description" : "Brand of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].category" : { - "description" : "Category of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].color" : { - "description" : "Color of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].currency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].itemID" : { - "description" : "ID of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].manufacturer" : { - "description" : "Manufacturer of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].productTitle" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].quantity" : { - "description" : "Quantity of the item purchased.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].receiverEmail" : { - "description" : "Email associated with the given product in the basket (usually in electronic gift cards).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].size" : { - "description" : "Size of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].sku" : { - "description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].upc" : { - "description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionCode" : { - "description" : "Code of the promotion.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : { - "description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : { - "description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionName" : { - "description" : "Name of the promotion.", - "type" : "string" - }, - "riskdata.riskProfileReference" : { - "description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", - "type" : "string" - }, - "riskdata.skipRisk" : { - "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", - "type" : "string" - } - } - }, - "AdditionalDataRiskStandalone" : { - "properties" : { - "PayPal.CountryCode" : { - "description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", - "type" : "string" - }, - "PayPal.EmailId" : { - "description" : "Shopper's email.", - "type" : "string" - }, - "PayPal.FirstName" : { - "description" : "Shopper's first name.", - "type" : "string" - }, - "PayPal.LastName" : { - "description" : "Shopper's last name.", - "type" : "string" - }, - "PayPal.PayerId" : { - "description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", - "type" : "string" - }, - "PayPal.Phone" : { - "description" : "Shopper's phone number.", - "type" : "string" - }, - "PayPal.ProtectionEligibility" : { - "description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.", - "type" : "string" - }, - "PayPal.TransactionId" : { - "description" : "Unique transaction ID of the payment.", - "type" : "string" - }, - "avsResultRaw" : { - "description" : "Raw AVS result received from the acquirer, where available. Example: D", - "type" : "string" - }, - "bin" : { - "description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", - "type" : "string" - }, - "cvcResultRaw" : { - "description" : "Raw CVC result received from the acquirer, where available. Example: 1", - "type" : "string" - }, - "riskToken" : { - "description" : "Unique identifier or token for the shopper's card details.", - "type" : "string" - }, - "threeDAuthenticated" : { - "description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", - "type" : "string" - }, - "threeDOffered" : { - "description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true", - "type" : "string" - }, - "tokenDataType" : { - "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", - "type" : "string" - } - } - }, - "AdditionalDataSubMerchant" : { - "properties" : { - "subMerchant.numberOfSubSellers" : { - "description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].city" : { - "description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].country" : { - "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].id" : { - "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].mcc" : { - "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].name" : { - "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].postalCode" : { - "description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].state" : { - "description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].street" : { - "description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].taxId" : { - "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", - "type" : "string" - } - } - }, - "AdditionalDataTemporaryServices" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", - "type" : "string" - }, - "enhancedSchemeData.employeeName" : { - "description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.jobDescription" : { - "description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.regularHoursRate" : { - "description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.regularHoursWorked" : { - "description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.requestName" : { - "description" : "Name of the individual requesting temporary services.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.tempStartDate" : { - "description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.tempWeekEnding" : { - "description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", - "type" : "string" - } - } - }, - "AdditionalDataWallets" : { - "properties" : { - "androidpay.token" : { - "description" : "The Android Pay token retrieved from the SDK.", - "type" : "string" - }, - "masterpass.transactionId" : { - "description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.", - "type" : "string" - }, - "payment.token" : { - "description" : "The Apple Pay token retrieved from the SDK.", - "type" : "string" - }, - "paywithgoogle.token" : { - "description" : "The Google Pay token retrieved from the SDK.", - "type" : "string" - }, - "samsungpay.token" : { - "description" : "The Samsung Pay token retrieved from the SDK.", - "type" : "string" - }, - "visacheckout.callId" : { - "description" : "The Visa Checkout Call ID retrieved from the SDK.", - "type" : "string" - } - } - }, "Address" : { "properties" : { "city" : { @@ -1776,34 +748,6 @@ "currency" ] }, - "ApplicationInfo" : { - "properties" : { - "adyenLibrary" : { - "description" : "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "adyenPaymentSource" : { - "description" : "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "externalPlatform" : { - "description" : "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.", - "$ref" : "#/components/schemas/ExternalPlatform" - }, - "merchantApplication" : { - "description" : "Merchant developed software, such as cashier application, used to interact with the Adyen API.", - "$ref" : "#/components/schemas/CommonField" - }, - "merchantDevice" : { - "description" : "Merchant device information.", - "$ref" : "#/components/schemas/MerchantDevice" - }, - "shopperInteractionDevice" : { - "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", - "$ref" : "#/components/schemas/ShopperInteractionDevice" - } - } - }, "BankAccount" : { "properties" : { "bankAccountNumber" : { @@ -1846,72 +790,6 @@ } } }, - "BrowserInfo" : { - "properties" : { - "acceptHeader" : { - "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - }, - "colorDepth" : { - "x-addedInVersion" : "40", - "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", - "format" : "int32", - "type" : "integer" - }, - "javaEnabled" : { - "x-addedInVersion" : "40", - "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", - "type" : "boolean" - }, - "javaScriptEnabled" : { - "x-addedInVersion" : "40", - "default" : true, - "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", - "type" : "boolean" - }, - "language" : { - "x-addedInVersion" : "40", - "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", - "type" : "string" - }, - "screenHeight" : { - "x-addedInVersion" : "40", - "description" : "The total height of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "screenWidth" : { - "x-addedInVersion" : "40", - "description" : "The total width of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "timeZoneOffset" : { - "x-addedInVersion" : "40", - "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", - "format" : "int32", - "type" : "integer" - }, - "userAgent" : { - "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - } - }, - "required" : [ - "userAgent", - "acceptHeader", - "javaEnabled", - "colorDepth", - "screenHeight", - "screenWidth", - "timeZoneOffset", - "language" - ] - }, "Card" : { "properties" : { "cvc" : { @@ -1970,120 +848,6 @@ "holderName" ] }, - "CommonField" : { - "properties" : { - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "DeviceRenderOptions" : { - "properties" : { - "sdkInterface" : { - "default" : "both", - "description" : "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both", - "enum" : [ - "native", - "html", - "both" - ], - "type" : "string" - }, - "sdkUiType" : { - "description" : "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect", - "items" : { - "enum" : [ - "multiSelect", - "otherHtml", - "outOfBand", - "singleSelect", - "text" - ], - "type" : "string" - }, - "type" : "array" - } - } - }, - "ExternalPlatform" : { - "properties" : { - "integrator" : { - "description" : "External platform integrator.", - "type" : "string" - }, - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "ForexQuote" : { - "properties" : { - "account" : { - "description" : "The account name.", - "type" : "string" - }, - "accountType" : { - "description" : "The account type.", - "type" : "string" - }, - "baseAmount" : { - "description" : "The base amount.", - "$ref" : "#/components/schemas/Amount" - }, - "basePoints" : { - "description" : "The base points.", - "format" : "int32", - "type" : "integer" - }, - "buy" : { - "description" : "The buy rate.", - "$ref" : "#/components/schemas/Amount" - }, - "interbank" : { - "description" : "The interbank amount.", - "$ref" : "#/components/schemas/Amount" - }, - "reference" : { - "description" : "The reference assigned to the forex quote request.", - "type" : "string" - }, - "sell" : { - "description" : "The sell rate.", - "$ref" : "#/components/schemas/Amount" - }, - "signature" : { - "description" : "The signature to validate the integrity.", - "type" : "string" - }, - "source" : { - "description" : "The source of the forex quote.", - "type" : "string" - }, - "type" : { - "description" : "The type of forex.", - "type" : "string" - }, - "validTill" : { - "description" : "The date until which the forex quote is valid.", - "format" : "date-time", - "type" : "string" - } - }, - "required" : [ - "validTill", - "basePoints" - ] - }, "FraudCheckResult" : { "properties" : { "accountScore" : { @@ -2157,151 +921,6 @@ } } }, - "Installments" : { - "properties" : { - "value" : { - "description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.", - "format" : "int32", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, - "Mandate" : { - "properties" : { - "amount" : { - "description" : "The billing amount (in minor units) of the recurring transactions.", - "type" : "string" - }, - "amountRule" : { - "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", - "enum" : [ - "max", - "exact" - ], - "type" : "string" - }, - "billingAttemptsRule" : { - "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", - "enum" : [ - "on", - "before", - "after" - ], - "type" : "string" - }, - "billingDay" : { - "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", - "type" : "string" - }, - "endsAt" : { - "description" : "End date of the billing plan, in YYYY-MM-DD format.", - "type" : "string" - }, - "frequency" : { - "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", - "enum" : [ - "adhoc", - "daily", - "weekly", - "biWeekly", - "monthly", - "quarterly", - "halfYearly", - "yearly" - ], - "type" : "string" - }, - "remarks" : { - "description" : "The message shown by UPI to the shopper on the approval screen.", - "type" : "string" - }, - "startsAt" : { - "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", - "type" : "string" - } - }, - "required" : [ - "frequency", - "amount", - "endsAt" - ] - }, - "MerchantDevice" : { - "properties" : { - "os" : { - "description" : "Operating system running on the merchant device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the merchant device.", - "type" : "string" - }, - "reference" : { - "description" : "Merchant device reference.", - "type" : "string" - } - } - }, - "MerchantRiskIndicator" : { - "properties" : { - "addressMatch" : { - "description" : "Whether the chosen delivery address is identical to the billing address.", - "type" : "boolean" - }, - "deliveryAddressIndicator" : { - "description" : "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`", - "enum" : [ - "shipToBillingAddress", - "shipToVerifiedAddress", - "shipToNewAddress", - "shipToStore", - "digitalGoods", - "goodsNotShipped", - "other" - ], - "type" : "string" - }, - "deliveryEmail" : { - "description" : "The delivery email address (for digital goods).", - "type" : "string" - }, - "deliveryTimeframe" : { - "description" : "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`", - "enum" : [ - "electronicDelivery", - "sameDayShipping", - "overnightShipping", - "twoOrMoreDaysShipping" - ], - "type" : "string" - }, - "giftCardAmount" : { - "description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).", - "$ref" : "#/components/schemas/Amount" - }, - "giftCardCount" : { - "description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.", - "format" : "int32", - "type" : "integer" - }, - "preOrderDate" : { - "description" : "For pre-order purchases, the expected date this product will be available to the shopper.", - "format" : "date-time", - "type" : "string" - }, - "preOrderPurchase" : { - "description" : "Indicator for whether this transaction is for pre-ordering a product.", - "type" : "boolean" - }, - "reorderItems" : { - "description" : "Indicator for whether the shopper has already purchased the same items in the past.", - "type" : "boolean" - } - } - }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -3017,26 +1636,6 @@ } } }, - "SDKEphemPubKey" : { - "properties" : { - "crv" : { - "description" : "The `crv` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "kty" : { - "description" : "The `kty` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "x" : { - "description" : "The `x` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "y" : { - "description" : "The `y` value as received from the 3D Secure 2 SDK.", - "type" : "string" - } - } - }, "ServiceError" : { "properties" : { "additionalData" : { @@ -3070,78 +1669,6 @@ } } }, - "ShopperInteractionDevice" : { - "properties" : { - "locale" : { - "description" : "Locale on the shopper interaction device.", - "type" : "string" - }, - "os" : { - "description" : "Operating system running on the shopper interaction device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the shopper interaction device.", - "type" : "string" - } - } - }, - "Split" : { - "properties" : { - "account" : { - "description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n", - "type" : "string" - }, - "amount" : { - "description" : "The amount of this split.", - "$ref" : "#/components/schemas/SplitAmount" - }, - "description" : { - "description" : "A description of this split.", - "type" : "string" - }, - "reference" : { - "description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.", - "type" : "string" - }, - "type" : { - "description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**.", - "enum" : [ - "BalanceAccount", - "Commission", - "Default", - "MarketPlace", - "PaymentFee", - "Remainder", - "VAT", - "Verification" - ], - "type" : "string" - } - }, - "required" : [ - "amount", - "type" - ] - }, - "SplitAmount" : { - "properties" : { - "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.", - "maxLength" : 3, - "minLength" : 3, - "type" : "string" - }, - "value" : { - "description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "format" : "int64", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, "StoreDetailAndSubmitRequest" : { "properties" : { "additionalData" : { @@ -3506,188 +2033,6 @@ "pspReference", "resultCode" ] - }, - "ThreeDS2RequestData" : { - "properties" : { - "acquirerBIN" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "acquirerMerchantID" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "authenticationOnly" : { - "deprecated" : true, - "x-deprecatedInVersion" : "50", - "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", - "default" : false, - "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", - "type" : "boolean" - }, - "challengeIndicator" : { - "description" : "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, - "deviceChannel" : { - "description" : "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`", - "type" : "string" - }, - "deviceRenderOptions" : { - "description" : "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.", - "$ref" : "#/components/schemas/DeviceRenderOptions" - }, - "mcc" : { - "x-addedInVersion" : "49", - "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", - "type" : "string" - }, - "merchantName" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", - "type" : "string" - }, - "messageVersion" : { - "default" : "2.1.0", - "description" : "The `messageVersion` value indicating the 3D Secure 2 protocol version.", - "type" : "string" - }, - "notificationURL" : { - "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", - "type" : "string" - }, - "sdkAppID" : { - "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEncData" : { - "description" : "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEphemPubKey" : { - "description" : "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "$ref" : "#/components/schemas/SDKEphemPubKey" - }, - "sdkMaxTimeout" : { - "default" : 60, - "description" : "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.", - "format" : "int32", - "type" : "integer" - }, - "sdkReferenceNumber" : { - "description" : "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkTransID" : { - "description" : "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkVersion" : { - "x-addedInVersion" : "40", - "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "threeDSCompInd" : { - "description" : "Completion indicator for the device fingerprinting.", - "type" : "string" - }, - "threeDSRequestorID" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorName" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorURL" : { - "description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.", - "type" : "string" - }, - "transactionType" : { - "x-addedInVersion" : "50", - "description" : "Identify the type of the transaction being authenticated.", - "enum" : [ - "goodsOrServicePurchase", - "checkAcceptance", - "accountFunding", - "quasiCashTransaction", - "prepaidActivationAndLoad" - ], - "type" : "string" - }, - "whiteListStatus" : { - "x-addedInVersion" : "49", - "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", - "type" : "string" - } - }, - "required" : [ - "deviceChannel" - ] - }, - "ThreeDSecureData" : { - "properties" : { - "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", - "enum" : [ - "Y", - "N", - "U", - "A" - ], - "type" : "string" - }, - "cavv" : { - "description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - }, - "cavvAlgorithm" : { - "description" : "The CAVV algorithm used. Include this only for 3D Secure 1.", - "type" : "string" - }, - "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", - "enum" : [ - "A", - "C", - "D", - "I", - "N", - "R", - "U", - "Y" - ], - "type" : "string" - }, - "dsTransID" : { - "x-addedInVersion" : "40", - "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", - "type" : "string" - }, - "eci" : { - "description" : "The electronic commerce indicator.", - "type" : "string" - }, - "threeDSVersion" : { - "x-addedInVersion" : "40", - "description" : "The version of the 3D Secure protocol.", - "type" : "string" - }, - "xid" : { - "description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - } - } } }, "securitySchemes" : { diff --git a/json/PayoutService-v52.json b/json/PayoutService-v52.json index 6807d5e..1688475 100644 --- a/json/PayoutService-v52.json +++ b/json/PayoutService-v52.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payout API", "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", - "x-timestamp" : "2022-05-03T09:24:06Z", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -40,7 +40,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Confirms a payout.", + "summary" : "Confirm a payout", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", @@ -149,7 +149,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Cancels a payout.", + "summary" : "Cancel a payout", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", @@ -258,7 +258,7 @@ "tags" : [ "Instant payouts" ], - "summary" : "Pay out directly.", + "summary" : "Make an instant card payout", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", @@ -365,7 +365,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores payout details.", + "summary" : "Store payout details", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", @@ -473,7 +473,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores details and submits a payout.", + "summary" : "Store details and submit a payout", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", @@ -589,7 +589,7 @@ "tags" : [ "Initialization" ], - "summary" : "Submits a payout.", + "summary" : "Submit a payout", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", @@ -691,1034 +691,6 @@ }, "components" : { "schemas" : { - "AccountInfo" : { - "properties" : { - "accountAgeIndicator" : { - "description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountChangeDate" : { - "description" : "Date when the shopper's account was last changed.", - "format" : "date-time", - "type" : "string" - }, - "accountChangeIndicator" : { - "description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountCreationDate" : { - "description" : "Date when the shopper's account was created.", - "format" : "date-time", - "type" : "string" - }, - "accountType" : { - "x-addedInVersion" : "50", - "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", - "enum" : [ - "notApplicable", - "credit", - "debit" - ], - "type" : "string" - }, - "addCardAttemptsDay" : { - "description" : "Number of attempts the shopper tried to add a card to their account in the last day.", - "format" : "int32", - "type" : "integer" - }, - "deliveryAddressUsageDate" : { - "description" : "Date the selected delivery address was first used.", - "format" : "date-time", - "type" : "string" - }, - "deliveryAddressUsageIndicator" : { - "description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "homePhone" : { - "description" : "Shopper's home phone number (including the country code).", - "type" : "string" - }, - "mobilePhone" : { - "description" : "Shopper's mobile phone number (including the country code).", - "type" : "string" - }, - "passwordChangeDate" : { - "description" : "Date when the shopper last changed their password.", - "format" : "date-time", - "type" : "string" - }, - "passwordChangeIndicator" : { - "description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "pastTransactionsDay" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.", - "format" : "int32", - "type" : "integer" - }, - "pastTransactionsYear" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.", - "format" : "int32", - "type" : "integer" - }, - "paymentAccountAge" : { - "description" : "Date this payment method was added to the shopper's account.", - "format" : "date-time", - "type" : "string" - }, - "paymentAccountIndicator" : { - "description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "purchasesLast6Months" : { - "description" : "Number of successful purchases in the last six months.", - "format" : "int32", - "type" : "integer" - }, - "suspiciousActivity" : { - "description" : "Whether suspicious activity was recorded on this account.", - "type" : "boolean" - }, - "workPhone" : { - "description" : "Shopper's work phone number (including the country code).", - "type" : "string" - } - } - }, - "AdditionalData3DSecure" : { - "properties" : { - "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", - "type" : "string" - }, - "executeThreeD" : { - "description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", - "type" : "string" - }, - "mpiImplementationType" : { - "description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.", - "type" : "string" - }, - "scaExemption" : { - "description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", - "type" : "string" - }, - "threeDSVersion" : { - "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", - "type" : "string" - } - } - }, - "AdditionalDataAirline" : { - "properties" : { - "airline.agency_invoice_number" : { - "description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6", - "type" : "string" - }, - "airline.agency_plan_name" : { - "description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.airline_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.airline_designator_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.boarding_fee" : { - "description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18", - "type" : "string" - }, - "airline.computerized_reservation_system" : { - "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4", - "type" : "string" - }, - "airline.customer_reference_number" : { - "description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20", - "type" : "string" - }, - "airline.document_type" : { - "description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.flight_date" : { - "description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.carrier_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.leg.class_of_travel" : { - "description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.leg.date_of_travel" : { - "description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.depart_airport" : { - "description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.depart_tax" : { - "description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12", - "type" : "string" - }, - "airline.leg.destination_code" : { - "description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.fare_base_code" : { - "description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7", - "type" : "string" - }, - "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5", - "type" : "string" - }, - "airline.leg.stop_over_code" : { - "description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.passenger.date_of_birth" : { - "description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", - "type" : "string" - }, - "airline.passenger.first_name" : { - "description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.last_name" : { - "description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.telephone_number" : { - "description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30", - "type" : "string" - }, - "airline.passenger.traveller_type" : { - "description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6", - "type" : "string" - }, - "airline.passenger_name" : { - "description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49", - "type" : "string" - }, - "airline.ticket_issue_address" : { - "description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16", - "type" : "string" - }, - "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150", - "type" : "string" - }, - "airline.travel_agency_code" : { - "description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8", - "type" : "string" - }, - "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25", - "type" : "string" - } - }, - "required" : [ - "airline.passenger_name" - ] - }, - "AdditionalDataCarRental" : { - "properties" : { - "carRental.checkOutDate" : { - "description" : "Pick-up date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19", - "type" : "string" - }, - "carRental.fuelCharges" : { - "description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.locationCity" : { - "description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.locationCountry" : { - "description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.locationStateProvince" : { - "description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.", - "type" : "string" - }, - "carRental.oneWayDropOffCharges" : { - "description" : "Charge associated with not returning a vehicle to the original rental location.", - "type" : "string" - }, - "carRental.rate" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.rateIndicator" : { - "description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.", - "type" : "string" - }, - "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9", - "type" : "string" - }, - "carRental.rentalClassId" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26", - "type" : "string" - }, - "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.returnCountry" : { - "description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.returnDate" : { - "description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.returnLocationId" : { - "description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10", - "type" : "string" - }, - "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.taxExemptIndicator" : { - "description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataCommon" : { - "properties" : { - "RequestedTestErrorResponseCode" : { - "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", - "type" : "string" - }, - "authorisationType" : { - "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", - "type" : "string" - }, - "customRoutingFlag" : { - "description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).", - "type" : "string" - }, - "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], - "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "enum" : [ - "NoShow", - "DelayedCharge" - ], - "type" : "string" - }, - "networkTxReference" : { - "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", - "type" : "string" - }, - "overwriteBrand" : { - "description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", - "type" : "string" - }, - "subMerchantCity" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", - "type" : "string" - }, - "subMerchantCountry" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", - "type" : "string" - }, - "subMerchantID" : { - "description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", - "type" : "string" - }, - "subMerchantName" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", - "type" : "string" - }, - "subMerchantPostalCode" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", - "type" : "string" - }, - "subMerchantState" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", - "type" : "string" - }, - "subMerchantStreet" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", - "type" : "string" - }, - "subMerchantTaxId" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", - "type" : "string" - } - } - }, - "AdditionalDataLevel23" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - }, - "enhancedSchemeData.destinationCountryCode" : { - "description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.", - "type" : "string" - }, - "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.dutyAmount" : { - "description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.freightAmount" : { - "description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.orderDate" : { - "description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.", - "type" : "string" - }, - "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - } - } - }, - "AdditionalDataLodging" : { - "properties" : { - "lodging.checkInDate" : { - "description" : "The arrival date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.checkOutDate" : { - "description" : "The departure date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.fireSafetyActIndicator" : { - "description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1", - "type" : "string" - }, - "lodging.folioCashAdvances" : { - "description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.folioNumber" : { - "description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25", - "type" : "string" - }, - "lodging.foodBeverageCharges" : { - "description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1", - "type" : "string" - }, - "lodging.prepaidExpenses" : { - "description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.propertyPhoneNumber" : { - "description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.room1.numberOfNights" : { - "description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4", - "type" : "string" - }, - "lodging.room1.rate" : { - "description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.room1.tax" : { - "description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalRoomTax" : { - "description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalTax" : { - "description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataOpenInvoice" : { - "properties" : { - "openinvoicedata.merchantData" : { - "description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", - "type" : "string" - }, - "openinvoicedata.numberOfLines" : { - "description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].currencyCode" : { - "description" : "The three-character ISO currency code.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].description" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemAmount" : { - "description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemId" : { - "description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatAmount" : { - "description" : "The VAT due for one item in the invoice line, represented in minor units.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatPercentage" : { - "description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].numberOfItems" : { - "description" : "The number of units purchased of a specific product.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnShippingCompany" : { - "description" : "Name of the shipping company handling the the return shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingNumber" : { - "description" : "The tracking number for the return of the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingUri" : { - "description" : "URI where the customer can track the return of their shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingCompany" : { - "description" : "Name of the shipping company handling the delivery.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingMethod" : { - "description" : "Shipping method.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingNumber" : { - "description" : "The tracking number for the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingUri" : { - "description" : "URI where the customer can track their shipment.", - "type" : "string" - } - } - }, - "AdditionalDataOpi" : { - "properties" : { - "opi.includeTransToken" : { - "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", - "type" : "string" - } - } - }, - "AdditionalDataPayout" : { - "properties" : { - "fundingNetwork" : { - "description" : "", - "type" : "string" - }, - "fundingSource" : { - "description" : "", - "enum" : [ - "CREDIT", - "DEBIT", - "PREPAID", - "DEPOSIT_ACCOUNT" - ], - "type" : "string" - }, - "fundingTransactionId" : { - "description" : "", - "type" : "string" - }, - "payoutAccountCode" : { - "description" : "", - "type" : "string" - }, - "payoutAccountHolderCode" : { - "description" : "", - "type" : "string" - }, - "payoutMarketPayUser" : { - "description" : "", - "type" : "string" - }, - "processOver" : { - "description" : "", - "enum" : [ - "MC_P2P", - "Visa_OCT", - "UnlinkedRefund" - ], - "type" : "string" - }, - "verifyOver" : { - "description" : "", - "type" : "string" - }, - "walletIdentifier" : { - "description" : "", - "type" : "string" - } - } - }, - "AdditionalDataRatepay" : { - "properties" : { - "ratepay.installmentAmount" : { - "description" : "Amount the customer has to pay each month.", - "type" : "string" - }, - "ratepay.interestRate" : { - "description" : "Interest rate of this installment.", - "type" : "string" - }, - "ratepay.lastInstallmentAmount" : { - "description" : "Amount of the last installment.", - "type" : "string" - }, - "ratepay.paymentFirstday" : { - "description" : "Calendar day of the first payment.", - "type" : "string" - }, - "ratepaydata.deliveryDate" : { - "description" : "Date the merchant delivered the goods to the customer.", - "type" : "string" - }, - "ratepaydata.dueDate" : { - "description" : "Date by which the customer must settle the payment.", - "type" : "string" - }, - "ratepaydata.invoiceDate" : { - "description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", - "type" : "string" - }, - "ratepaydata.invoiceId" : { - "description" : "Identification name or number for the invoice, defined by the merchant.", - "type" : "string" - } - } - }, - "AdditionalDataRetry" : { - "properties" : { - "retry.chainAttemptNumber" : { - "description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.orderAttemptNumber" : { - "description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.skipRetry" : { - "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - } - } - }, - "AdditionalDataRisk" : { - "properties" : { - "riskdata.[customFieldName]" : { - "description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].amountPerItem" : { - "description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].brand" : { - "description" : "Brand of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].category" : { - "description" : "Category of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].color" : { - "description" : "Color of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].currency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].itemID" : { - "description" : "ID of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].manufacturer" : { - "description" : "Manufacturer of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].productTitle" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].quantity" : { - "description" : "Quantity of the item purchased.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].receiverEmail" : { - "description" : "Email associated with the given product in the basket (usually in electronic gift cards).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].size" : { - "description" : "Size of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].sku" : { - "description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].upc" : { - "description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionCode" : { - "description" : "Code of the promotion.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : { - "description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : { - "description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionName" : { - "description" : "Name of the promotion.", - "type" : "string" - }, - "riskdata.riskProfileReference" : { - "description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", - "type" : "string" - }, - "riskdata.skipRisk" : { - "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", - "type" : "string" - } - } - }, - "AdditionalDataRiskStandalone" : { - "properties" : { - "PayPal.CountryCode" : { - "description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", - "type" : "string" - }, - "PayPal.EmailId" : { - "description" : "Shopper's email.", - "type" : "string" - }, - "PayPal.FirstName" : { - "description" : "Shopper's first name.", - "type" : "string" - }, - "PayPal.LastName" : { - "description" : "Shopper's last name.", - "type" : "string" - }, - "PayPal.PayerId" : { - "description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", - "type" : "string" - }, - "PayPal.Phone" : { - "description" : "Shopper's phone number.", - "type" : "string" - }, - "PayPal.ProtectionEligibility" : { - "description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.", - "type" : "string" - }, - "PayPal.TransactionId" : { - "description" : "Unique transaction ID of the payment.", - "type" : "string" - }, - "avsResultRaw" : { - "description" : "Raw AVS result received from the acquirer, where available. Example: D", - "type" : "string" - }, - "bin" : { - "description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", - "type" : "string" - }, - "cvcResultRaw" : { - "description" : "Raw CVC result received from the acquirer, where available. Example: 1", - "type" : "string" - }, - "riskToken" : { - "description" : "Unique identifier or token for the shopper's card details.", - "type" : "string" - }, - "threeDAuthenticated" : { - "description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", - "type" : "string" - }, - "threeDOffered" : { - "description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true", - "type" : "string" - }, - "tokenDataType" : { - "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", - "type" : "string" - } - } - }, - "AdditionalDataSubMerchant" : { - "properties" : { - "subMerchant.numberOfSubSellers" : { - "description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].city" : { - "description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].country" : { - "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].id" : { - "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].mcc" : { - "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].name" : { - "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].postalCode" : { - "description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].state" : { - "description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].street" : { - "description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].taxId" : { - "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", - "type" : "string" - } - } - }, - "AdditionalDataTemporaryServices" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", - "type" : "string" - }, - "enhancedSchemeData.employeeName" : { - "description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.jobDescription" : { - "description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.regularHoursRate" : { - "description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.regularHoursWorked" : { - "description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.requestName" : { - "description" : "Name of the individual requesting temporary services.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.tempStartDate" : { - "description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.tempWeekEnding" : { - "description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", - "type" : "string" - } - } - }, - "AdditionalDataWallets" : { - "properties" : { - "androidpay.token" : { - "description" : "The Android Pay token retrieved from the SDK.", - "type" : "string" - }, - "masterpass.transactionId" : { - "description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.", - "type" : "string" - }, - "payment.token" : { - "description" : "The Apple Pay token retrieved from the SDK.", - "type" : "string" - }, - "paywithgoogle.token" : { - "description" : "The Google Pay token retrieved from the SDK.", - "type" : "string" - }, - "samsungpay.token" : { - "description" : "The Samsung Pay token retrieved from the SDK.", - "type" : "string" - }, - "visacheckout.callId" : { - "description" : "The Visa Checkout Call ID retrieved from the SDK.", - "type" : "string" - } - } - }, "Address" : { "properties" : { "city" : { @@ -1776,34 +748,6 @@ "currency" ] }, - "ApplicationInfo" : { - "properties" : { - "adyenLibrary" : { - "description" : "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "adyenPaymentSource" : { - "description" : "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "externalPlatform" : { - "description" : "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.", - "$ref" : "#/components/schemas/ExternalPlatform" - }, - "merchantApplication" : { - "description" : "Merchant developed software, such as cashier application, used to interact with the Adyen API.", - "$ref" : "#/components/schemas/CommonField" - }, - "merchantDevice" : { - "description" : "Merchant device information.", - "$ref" : "#/components/schemas/MerchantDevice" - }, - "shopperInteractionDevice" : { - "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", - "$ref" : "#/components/schemas/ShopperInteractionDevice" - } - } - }, "BankAccount" : { "properties" : { "bankAccountNumber" : { @@ -1846,72 +790,6 @@ } } }, - "BrowserInfo" : { - "properties" : { - "acceptHeader" : { - "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - }, - "colorDepth" : { - "x-addedInVersion" : "40", - "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", - "format" : "int32", - "type" : "integer" - }, - "javaEnabled" : { - "x-addedInVersion" : "40", - "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", - "type" : "boolean" - }, - "javaScriptEnabled" : { - "x-addedInVersion" : "40", - "default" : true, - "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", - "type" : "boolean" - }, - "language" : { - "x-addedInVersion" : "40", - "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", - "type" : "string" - }, - "screenHeight" : { - "x-addedInVersion" : "40", - "description" : "The total height of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "screenWidth" : { - "x-addedInVersion" : "40", - "description" : "The total width of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "timeZoneOffset" : { - "x-addedInVersion" : "40", - "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", - "format" : "int32", - "type" : "integer" - }, - "userAgent" : { - "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - } - }, - "required" : [ - "userAgent", - "acceptHeader", - "javaEnabled", - "colorDepth", - "screenHeight", - "screenWidth", - "timeZoneOffset", - "language" - ] - }, "Card" : { "properties" : { "cvc" : { @@ -1970,120 +848,6 @@ "holderName" ] }, - "CommonField" : { - "properties" : { - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "DeviceRenderOptions" : { - "properties" : { - "sdkInterface" : { - "default" : "both", - "description" : "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both", - "enum" : [ - "native", - "html", - "both" - ], - "type" : "string" - }, - "sdkUiType" : { - "description" : "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect", - "items" : { - "enum" : [ - "multiSelect", - "otherHtml", - "outOfBand", - "singleSelect", - "text" - ], - "type" : "string" - }, - "type" : "array" - } - } - }, - "ExternalPlatform" : { - "properties" : { - "integrator" : { - "description" : "External platform integrator.", - "type" : "string" - }, - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "ForexQuote" : { - "properties" : { - "account" : { - "description" : "The account name.", - "type" : "string" - }, - "accountType" : { - "description" : "The account type.", - "type" : "string" - }, - "baseAmount" : { - "description" : "The base amount.", - "$ref" : "#/components/schemas/Amount" - }, - "basePoints" : { - "description" : "The base points.", - "format" : "int32", - "type" : "integer" - }, - "buy" : { - "description" : "The buy rate.", - "$ref" : "#/components/schemas/Amount" - }, - "interbank" : { - "description" : "The interbank amount.", - "$ref" : "#/components/schemas/Amount" - }, - "reference" : { - "description" : "The reference assigned to the forex quote request.", - "type" : "string" - }, - "sell" : { - "description" : "The sell rate.", - "$ref" : "#/components/schemas/Amount" - }, - "signature" : { - "description" : "The signature to validate the integrity.", - "type" : "string" - }, - "source" : { - "description" : "The source of the forex quote.", - "type" : "string" - }, - "type" : { - "description" : "The type of forex.", - "type" : "string" - }, - "validTill" : { - "description" : "The date until which the forex quote is valid.", - "format" : "date-time", - "type" : "string" - } - }, - "required" : [ - "validTill", - "basePoints" - ] - }, "FraudCheckResult" : { "properties" : { "accountScore" : { @@ -2157,151 +921,6 @@ } } }, - "Installments" : { - "properties" : { - "value" : { - "description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.", - "format" : "int32", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, - "Mandate" : { - "properties" : { - "amount" : { - "description" : "The billing amount (in minor units) of the recurring transactions.", - "type" : "string" - }, - "amountRule" : { - "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", - "enum" : [ - "max", - "exact" - ], - "type" : "string" - }, - "billingAttemptsRule" : { - "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", - "enum" : [ - "on", - "before", - "after" - ], - "type" : "string" - }, - "billingDay" : { - "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", - "type" : "string" - }, - "endsAt" : { - "description" : "End date of the billing plan, in YYYY-MM-DD format.", - "type" : "string" - }, - "frequency" : { - "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", - "enum" : [ - "adhoc", - "daily", - "weekly", - "biWeekly", - "monthly", - "quarterly", - "halfYearly", - "yearly" - ], - "type" : "string" - }, - "remarks" : { - "description" : "The message shown by UPI to the shopper on the approval screen.", - "type" : "string" - }, - "startsAt" : { - "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", - "type" : "string" - } - }, - "required" : [ - "frequency", - "amount", - "endsAt" - ] - }, - "MerchantDevice" : { - "properties" : { - "os" : { - "description" : "Operating system running on the merchant device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the merchant device.", - "type" : "string" - }, - "reference" : { - "description" : "Merchant device reference.", - "type" : "string" - } - } - }, - "MerchantRiskIndicator" : { - "properties" : { - "addressMatch" : { - "description" : "Whether the chosen delivery address is identical to the billing address.", - "type" : "boolean" - }, - "deliveryAddressIndicator" : { - "description" : "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`", - "enum" : [ - "shipToBillingAddress", - "shipToVerifiedAddress", - "shipToNewAddress", - "shipToStore", - "digitalGoods", - "goodsNotShipped", - "other" - ], - "type" : "string" - }, - "deliveryEmail" : { - "description" : "The delivery email address (for digital goods).", - "type" : "string" - }, - "deliveryTimeframe" : { - "description" : "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`", - "enum" : [ - "electronicDelivery", - "sameDayShipping", - "overnightShipping", - "twoOrMoreDaysShipping" - ], - "type" : "string" - }, - "giftCardAmount" : { - "description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).", - "$ref" : "#/components/schemas/Amount" - }, - "giftCardCount" : { - "description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.", - "format" : "int32", - "type" : "integer" - }, - "preOrderDate" : { - "description" : "For pre-order purchases, the expected date this product will be available to the shopper.", - "format" : "date-time", - "type" : "string" - }, - "preOrderPurchase" : { - "description" : "Indicator for whether this transaction is for pre-ordering a product.", - "type" : "boolean" - }, - "reorderItems" : { - "description" : "Indicator for whether the shopper has already purchased the same items in the past.", - "type" : "boolean" - } - } - }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -3017,26 +1636,6 @@ } } }, - "SDKEphemPubKey" : { - "properties" : { - "crv" : { - "description" : "The `crv` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "kty" : { - "description" : "The `kty` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "x" : { - "description" : "The `x` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "y" : { - "description" : "The `y` value as received from the 3D Secure 2 SDK.", - "type" : "string" - } - } - }, "ServiceError" : { "properties" : { "additionalData" : { @@ -3070,78 +1669,6 @@ } } }, - "ShopperInteractionDevice" : { - "properties" : { - "locale" : { - "description" : "Locale on the shopper interaction device.", - "type" : "string" - }, - "os" : { - "description" : "Operating system running on the shopper interaction device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the shopper interaction device.", - "type" : "string" - } - } - }, - "Split" : { - "properties" : { - "account" : { - "description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n", - "type" : "string" - }, - "amount" : { - "description" : "The amount of this split.", - "$ref" : "#/components/schemas/SplitAmount" - }, - "description" : { - "description" : "A description of this split.", - "type" : "string" - }, - "reference" : { - "description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.", - "type" : "string" - }, - "type" : { - "description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**.", - "enum" : [ - "BalanceAccount", - "Commission", - "Default", - "MarketPlace", - "PaymentFee", - "Remainder", - "VAT", - "Verification" - ], - "type" : "string" - } - }, - "required" : [ - "amount", - "type" - ] - }, - "SplitAmount" : { - "properties" : { - "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.", - "maxLength" : 3, - "minLength" : 3, - "type" : "string" - }, - "value" : { - "description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "format" : "int64", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, "StoreDetailAndSubmitRequest" : { "properties" : { "additionalData" : { @@ -3516,188 +2043,6 @@ "pspReference", "resultCode" ] - }, - "ThreeDS2RequestData" : { - "properties" : { - "acquirerBIN" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "acquirerMerchantID" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "authenticationOnly" : { - "deprecated" : true, - "x-deprecatedInVersion" : "50", - "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", - "default" : false, - "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", - "type" : "boolean" - }, - "challengeIndicator" : { - "description" : "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, - "deviceChannel" : { - "description" : "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`", - "type" : "string" - }, - "deviceRenderOptions" : { - "description" : "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.", - "$ref" : "#/components/schemas/DeviceRenderOptions" - }, - "mcc" : { - "x-addedInVersion" : "49", - "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", - "type" : "string" - }, - "merchantName" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", - "type" : "string" - }, - "messageVersion" : { - "default" : "2.1.0", - "description" : "The `messageVersion` value indicating the 3D Secure 2 protocol version.", - "type" : "string" - }, - "notificationURL" : { - "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", - "type" : "string" - }, - "sdkAppID" : { - "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEncData" : { - "description" : "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEphemPubKey" : { - "description" : "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "$ref" : "#/components/schemas/SDKEphemPubKey" - }, - "sdkMaxTimeout" : { - "default" : 60, - "description" : "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.", - "format" : "int32", - "type" : "integer" - }, - "sdkReferenceNumber" : { - "description" : "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkTransID" : { - "description" : "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkVersion" : { - "x-addedInVersion" : "40", - "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "threeDSCompInd" : { - "description" : "Completion indicator for the device fingerprinting.", - "type" : "string" - }, - "threeDSRequestorID" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorName" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorURL" : { - "description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.", - "type" : "string" - }, - "transactionType" : { - "x-addedInVersion" : "50", - "description" : "Identify the type of the transaction being authenticated.", - "enum" : [ - "goodsOrServicePurchase", - "checkAcceptance", - "accountFunding", - "quasiCashTransaction", - "prepaidActivationAndLoad" - ], - "type" : "string" - }, - "whiteListStatus" : { - "x-addedInVersion" : "49", - "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", - "type" : "string" - } - }, - "required" : [ - "deviceChannel" - ] - }, - "ThreeDSecureData" : { - "properties" : { - "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", - "enum" : [ - "Y", - "N", - "U", - "A" - ], - "type" : "string" - }, - "cavv" : { - "description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - }, - "cavvAlgorithm" : { - "description" : "The CAVV algorithm used. Include this only for 3D Secure 1.", - "type" : "string" - }, - "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", - "enum" : [ - "A", - "C", - "D", - "I", - "N", - "R", - "U", - "Y" - ], - "type" : "string" - }, - "dsTransID" : { - "x-addedInVersion" : "40", - "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", - "type" : "string" - }, - "eci" : { - "description" : "The electronic commerce indicator.", - "type" : "string" - }, - "threeDSVersion" : { - "x-addedInVersion" : "40", - "description" : "The version of the 3D Secure protocol.", - "type" : "string" - }, - "xid" : { - "description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - } - } } }, "securitySchemes" : { diff --git a/json/PayoutService-v64.json b/json/PayoutService-v64.json index eddc023..af74c78 100644 --- a/json/PayoutService-v64.json +++ b/json/PayoutService-v64.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payout API", "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", - "x-timestamp" : "2022-05-03T09:24:06Z", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -40,7 +40,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Confirms a payout.", + "summary" : "Confirm a payout", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", @@ -149,7 +149,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Cancels a payout.", + "summary" : "Cancel a payout", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", @@ -258,7 +258,7 @@ "tags" : [ "Instant payouts" ], - "summary" : "Pay out directly.", + "summary" : "Make an instant card payout", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", @@ -365,7 +365,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores payout details.", + "summary" : "Store payout details", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", @@ -473,7 +473,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores details and submits a payout.", + "summary" : "Store details and submit a payout", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", @@ -589,7 +589,7 @@ "tags" : [ "Initialization" ], - "summary" : "Submits a payout.", + "summary" : "Submit a payout", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", @@ -691,1034 +691,6 @@ }, "components" : { "schemas" : { - "AccountInfo" : { - "properties" : { - "accountAgeIndicator" : { - "description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountChangeDate" : { - "description" : "Date when the shopper's account was last changed.", - "format" : "date-time", - "type" : "string" - }, - "accountChangeIndicator" : { - "description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountCreationDate" : { - "description" : "Date when the shopper's account was created.", - "format" : "date-time", - "type" : "string" - }, - "accountType" : { - "x-addedInVersion" : "50", - "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", - "enum" : [ - "notApplicable", - "credit", - "debit" - ], - "type" : "string" - }, - "addCardAttemptsDay" : { - "description" : "Number of attempts the shopper tried to add a card to their account in the last day.", - "format" : "int32", - "type" : "integer" - }, - "deliveryAddressUsageDate" : { - "description" : "Date the selected delivery address was first used.", - "format" : "date-time", - "type" : "string" - }, - "deliveryAddressUsageIndicator" : { - "description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "homePhone" : { - "description" : "Shopper's home phone number (including the country code).", - "type" : "string" - }, - "mobilePhone" : { - "description" : "Shopper's mobile phone number (including the country code).", - "type" : "string" - }, - "passwordChangeDate" : { - "description" : "Date when the shopper last changed their password.", - "format" : "date-time", - "type" : "string" - }, - "passwordChangeIndicator" : { - "description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "pastTransactionsDay" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.", - "format" : "int32", - "type" : "integer" - }, - "pastTransactionsYear" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.", - "format" : "int32", - "type" : "integer" - }, - "paymentAccountAge" : { - "description" : "Date this payment method was added to the shopper's account.", - "format" : "date-time", - "type" : "string" - }, - "paymentAccountIndicator" : { - "description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "purchasesLast6Months" : { - "description" : "Number of successful purchases in the last six months.", - "format" : "int32", - "type" : "integer" - }, - "suspiciousActivity" : { - "description" : "Whether suspicious activity was recorded on this account.", - "type" : "boolean" - }, - "workPhone" : { - "description" : "Shopper's work phone number (including the country code).", - "type" : "string" - } - } - }, - "AdditionalData3DSecure" : { - "properties" : { - "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", - "type" : "string" - }, - "executeThreeD" : { - "description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", - "type" : "string" - }, - "mpiImplementationType" : { - "description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.", - "type" : "string" - }, - "scaExemption" : { - "description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", - "type" : "string" - }, - "threeDSVersion" : { - "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", - "type" : "string" - } - } - }, - "AdditionalDataAirline" : { - "properties" : { - "airline.agency_invoice_number" : { - "description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6", - "type" : "string" - }, - "airline.agency_plan_name" : { - "description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.airline_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.airline_designator_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.boarding_fee" : { - "description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18", - "type" : "string" - }, - "airline.computerized_reservation_system" : { - "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4", - "type" : "string" - }, - "airline.customer_reference_number" : { - "description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20", - "type" : "string" - }, - "airline.document_type" : { - "description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.flight_date" : { - "description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.carrier_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.leg.class_of_travel" : { - "description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.leg.date_of_travel" : { - "description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.depart_airport" : { - "description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.depart_tax" : { - "description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12", - "type" : "string" - }, - "airline.leg.destination_code" : { - "description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.fare_base_code" : { - "description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7", - "type" : "string" - }, - "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5", - "type" : "string" - }, - "airline.leg.stop_over_code" : { - "description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.passenger.date_of_birth" : { - "description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", - "type" : "string" - }, - "airline.passenger.first_name" : { - "description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.last_name" : { - "description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.telephone_number" : { - "description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30", - "type" : "string" - }, - "airline.passenger.traveller_type" : { - "description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6", - "type" : "string" - }, - "airline.passenger_name" : { - "description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49", - "type" : "string" - }, - "airline.ticket_issue_address" : { - "description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16", - "type" : "string" - }, - "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150", - "type" : "string" - }, - "airline.travel_agency_code" : { - "description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8", - "type" : "string" - }, - "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25", - "type" : "string" - } - }, - "required" : [ - "airline.passenger_name" - ] - }, - "AdditionalDataCarRental" : { - "properties" : { - "carRental.checkOutDate" : { - "description" : "Pick-up date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19", - "type" : "string" - }, - "carRental.fuelCharges" : { - "description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.locationCity" : { - "description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.locationCountry" : { - "description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.locationStateProvince" : { - "description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.", - "type" : "string" - }, - "carRental.oneWayDropOffCharges" : { - "description" : "Charge associated with not returning a vehicle to the original rental location.", - "type" : "string" - }, - "carRental.rate" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.rateIndicator" : { - "description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.", - "type" : "string" - }, - "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9", - "type" : "string" - }, - "carRental.rentalClassId" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26", - "type" : "string" - }, - "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.returnCountry" : { - "description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.returnDate" : { - "description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.returnLocationId" : { - "description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10", - "type" : "string" - }, - "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.taxExemptIndicator" : { - "description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataCommon" : { - "properties" : { - "RequestedTestErrorResponseCode" : { - "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", - "type" : "string" - }, - "authorisationType" : { - "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", - "type" : "string" - }, - "customRoutingFlag" : { - "description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).", - "type" : "string" - }, - "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], - "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "enum" : [ - "NoShow", - "DelayedCharge" - ], - "type" : "string" - }, - "networkTxReference" : { - "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", - "type" : "string" - }, - "overwriteBrand" : { - "description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", - "type" : "string" - }, - "subMerchantCity" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", - "type" : "string" - }, - "subMerchantCountry" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", - "type" : "string" - }, - "subMerchantID" : { - "description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", - "type" : "string" - }, - "subMerchantName" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", - "type" : "string" - }, - "subMerchantPostalCode" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", - "type" : "string" - }, - "subMerchantState" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", - "type" : "string" - }, - "subMerchantStreet" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", - "type" : "string" - }, - "subMerchantTaxId" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", - "type" : "string" - } - } - }, - "AdditionalDataLevel23" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - }, - "enhancedSchemeData.destinationCountryCode" : { - "description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.", - "type" : "string" - }, - "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.dutyAmount" : { - "description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.freightAmount" : { - "description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.orderDate" : { - "description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.", - "type" : "string" - }, - "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - } - } - }, - "AdditionalDataLodging" : { - "properties" : { - "lodging.checkInDate" : { - "description" : "The arrival date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.checkOutDate" : { - "description" : "The departure date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.fireSafetyActIndicator" : { - "description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1", - "type" : "string" - }, - "lodging.folioCashAdvances" : { - "description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.folioNumber" : { - "description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25", - "type" : "string" - }, - "lodging.foodBeverageCharges" : { - "description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1", - "type" : "string" - }, - "lodging.prepaidExpenses" : { - "description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.propertyPhoneNumber" : { - "description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.room1.numberOfNights" : { - "description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4", - "type" : "string" - }, - "lodging.room1.rate" : { - "description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.room1.tax" : { - "description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalRoomTax" : { - "description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalTax" : { - "description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataOpenInvoice" : { - "properties" : { - "openinvoicedata.merchantData" : { - "description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", - "type" : "string" - }, - "openinvoicedata.numberOfLines" : { - "description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].currencyCode" : { - "description" : "The three-character ISO currency code.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].description" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemAmount" : { - "description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemId" : { - "description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatAmount" : { - "description" : "The VAT due for one item in the invoice line, represented in minor units.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatPercentage" : { - "description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].numberOfItems" : { - "description" : "The number of units purchased of a specific product.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnShippingCompany" : { - "description" : "Name of the shipping company handling the the return shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingNumber" : { - "description" : "The tracking number for the return of the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingUri" : { - "description" : "URI where the customer can track the return of their shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingCompany" : { - "description" : "Name of the shipping company handling the delivery.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingMethod" : { - "description" : "Shipping method.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingNumber" : { - "description" : "The tracking number for the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingUri" : { - "description" : "URI where the customer can track their shipment.", - "type" : "string" - } - } - }, - "AdditionalDataOpi" : { - "properties" : { - "opi.includeTransToken" : { - "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", - "type" : "string" - } - } - }, - "AdditionalDataPayout" : { - "properties" : { - "fundingNetwork" : { - "description" : "", - "type" : "string" - }, - "fundingSource" : { - "description" : "", - "enum" : [ - "CREDIT", - "DEBIT", - "PREPAID", - "DEPOSIT_ACCOUNT" - ], - "type" : "string" - }, - "fundingTransactionId" : { - "description" : "", - "type" : "string" - }, - "payoutAccountCode" : { - "description" : "", - "type" : "string" - }, - "payoutAccountHolderCode" : { - "description" : "", - "type" : "string" - }, - "payoutMarketPayUser" : { - "description" : "", - "type" : "string" - }, - "processOver" : { - "description" : "", - "enum" : [ - "MC_P2P", - "Visa_OCT", - "UnlinkedRefund" - ], - "type" : "string" - }, - "verifyOver" : { - "description" : "", - "type" : "string" - }, - "walletIdentifier" : { - "description" : "", - "type" : "string" - } - } - }, - "AdditionalDataRatepay" : { - "properties" : { - "ratepay.installmentAmount" : { - "description" : "Amount the customer has to pay each month.", - "type" : "string" - }, - "ratepay.interestRate" : { - "description" : "Interest rate of this installment.", - "type" : "string" - }, - "ratepay.lastInstallmentAmount" : { - "description" : "Amount of the last installment.", - "type" : "string" - }, - "ratepay.paymentFirstday" : { - "description" : "Calendar day of the first payment.", - "type" : "string" - }, - "ratepaydata.deliveryDate" : { - "description" : "Date the merchant delivered the goods to the customer.", - "type" : "string" - }, - "ratepaydata.dueDate" : { - "description" : "Date by which the customer must settle the payment.", - "type" : "string" - }, - "ratepaydata.invoiceDate" : { - "description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", - "type" : "string" - }, - "ratepaydata.invoiceId" : { - "description" : "Identification name or number for the invoice, defined by the merchant.", - "type" : "string" - } - } - }, - "AdditionalDataRetry" : { - "properties" : { - "retry.chainAttemptNumber" : { - "description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.orderAttemptNumber" : { - "description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.skipRetry" : { - "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - } - } - }, - "AdditionalDataRisk" : { - "properties" : { - "riskdata.[customFieldName]" : { - "description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].amountPerItem" : { - "description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].brand" : { - "description" : "Brand of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].category" : { - "description" : "Category of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].color" : { - "description" : "Color of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].currency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].itemID" : { - "description" : "ID of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].manufacturer" : { - "description" : "Manufacturer of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].productTitle" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].quantity" : { - "description" : "Quantity of the item purchased.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].receiverEmail" : { - "description" : "Email associated with the given product in the basket (usually in electronic gift cards).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].size" : { - "description" : "Size of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].sku" : { - "description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].upc" : { - "description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionCode" : { - "description" : "Code of the promotion.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : { - "description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : { - "description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionName" : { - "description" : "Name of the promotion.", - "type" : "string" - }, - "riskdata.riskProfileReference" : { - "description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", - "type" : "string" - }, - "riskdata.skipRisk" : { - "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", - "type" : "string" - } - } - }, - "AdditionalDataRiskStandalone" : { - "properties" : { - "PayPal.CountryCode" : { - "description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", - "type" : "string" - }, - "PayPal.EmailId" : { - "description" : "Shopper's email.", - "type" : "string" - }, - "PayPal.FirstName" : { - "description" : "Shopper's first name.", - "type" : "string" - }, - "PayPal.LastName" : { - "description" : "Shopper's last name.", - "type" : "string" - }, - "PayPal.PayerId" : { - "description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", - "type" : "string" - }, - "PayPal.Phone" : { - "description" : "Shopper's phone number.", - "type" : "string" - }, - "PayPal.ProtectionEligibility" : { - "description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.", - "type" : "string" - }, - "PayPal.TransactionId" : { - "description" : "Unique transaction ID of the payment.", - "type" : "string" - }, - "avsResultRaw" : { - "description" : "Raw AVS result received from the acquirer, where available. Example: D", - "type" : "string" - }, - "bin" : { - "description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", - "type" : "string" - }, - "cvcResultRaw" : { - "description" : "Raw CVC result received from the acquirer, where available. Example: 1", - "type" : "string" - }, - "riskToken" : { - "description" : "Unique identifier or token for the shopper's card details.", - "type" : "string" - }, - "threeDAuthenticated" : { - "description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", - "type" : "string" - }, - "threeDOffered" : { - "description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true", - "type" : "string" - }, - "tokenDataType" : { - "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", - "type" : "string" - } - } - }, - "AdditionalDataSubMerchant" : { - "properties" : { - "subMerchant.numberOfSubSellers" : { - "description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].city" : { - "description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].country" : { - "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].id" : { - "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].mcc" : { - "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].name" : { - "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].postalCode" : { - "description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].state" : { - "description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].street" : { - "description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].taxId" : { - "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", - "type" : "string" - } - } - }, - "AdditionalDataTemporaryServices" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", - "type" : "string" - }, - "enhancedSchemeData.employeeName" : { - "description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.jobDescription" : { - "description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.regularHoursRate" : { - "description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.regularHoursWorked" : { - "description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.requestName" : { - "description" : "Name of the individual requesting temporary services.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.tempStartDate" : { - "description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.tempWeekEnding" : { - "description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", - "type" : "string" - } - } - }, - "AdditionalDataWallets" : { - "properties" : { - "androidpay.token" : { - "description" : "The Android Pay token retrieved from the SDK.", - "type" : "string" - }, - "masterpass.transactionId" : { - "description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.", - "type" : "string" - }, - "payment.token" : { - "description" : "The Apple Pay token retrieved from the SDK.", - "type" : "string" - }, - "paywithgoogle.token" : { - "description" : "The Google Pay token retrieved from the SDK.", - "type" : "string" - }, - "samsungpay.token" : { - "description" : "The Samsung Pay token retrieved from the SDK.", - "type" : "string" - }, - "visacheckout.callId" : { - "description" : "The Visa Checkout Call ID retrieved from the SDK.", - "type" : "string" - } - } - }, "Address" : { "properties" : { "city" : { @@ -1776,34 +748,6 @@ "currency" ] }, - "ApplicationInfo" : { - "properties" : { - "adyenLibrary" : { - "description" : "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "adyenPaymentSource" : { - "description" : "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "externalPlatform" : { - "description" : "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.", - "$ref" : "#/components/schemas/ExternalPlatform" - }, - "merchantApplication" : { - "description" : "Merchant developed software, such as cashier application, used to interact with the Adyen API.", - "$ref" : "#/components/schemas/CommonField" - }, - "merchantDevice" : { - "description" : "Merchant device information.", - "$ref" : "#/components/schemas/MerchantDevice" - }, - "shopperInteractionDevice" : { - "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", - "$ref" : "#/components/schemas/ShopperInteractionDevice" - } - } - }, "BankAccount" : { "properties" : { "bankAccountNumber" : { @@ -1846,72 +790,6 @@ } } }, - "BrowserInfo" : { - "properties" : { - "acceptHeader" : { - "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - }, - "colorDepth" : { - "x-addedInVersion" : "40", - "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", - "format" : "int32", - "type" : "integer" - }, - "javaEnabled" : { - "x-addedInVersion" : "40", - "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", - "type" : "boolean" - }, - "javaScriptEnabled" : { - "x-addedInVersion" : "40", - "default" : true, - "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", - "type" : "boolean" - }, - "language" : { - "x-addedInVersion" : "40", - "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", - "type" : "string" - }, - "screenHeight" : { - "x-addedInVersion" : "40", - "description" : "The total height of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "screenWidth" : { - "x-addedInVersion" : "40", - "description" : "The total width of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "timeZoneOffset" : { - "x-addedInVersion" : "40", - "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", - "format" : "int32", - "type" : "integer" - }, - "userAgent" : { - "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - } - }, - "required" : [ - "userAgent", - "acceptHeader", - "javaEnabled", - "colorDepth", - "screenHeight", - "screenWidth", - "timeZoneOffset", - "language" - ] - }, "Card" : { "properties" : { "cvc" : { @@ -1970,120 +848,6 @@ "holderName" ] }, - "CommonField" : { - "properties" : { - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "DeviceRenderOptions" : { - "properties" : { - "sdkInterface" : { - "default" : "both", - "description" : "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both", - "enum" : [ - "native", - "html", - "both" - ], - "type" : "string" - }, - "sdkUiType" : { - "description" : "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect", - "items" : { - "enum" : [ - "multiSelect", - "otherHtml", - "outOfBand", - "singleSelect", - "text" - ], - "type" : "string" - }, - "type" : "array" - } - } - }, - "ExternalPlatform" : { - "properties" : { - "integrator" : { - "description" : "External platform integrator.", - "type" : "string" - }, - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "ForexQuote" : { - "properties" : { - "account" : { - "description" : "The account name.", - "type" : "string" - }, - "accountType" : { - "description" : "The account type.", - "type" : "string" - }, - "baseAmount" : { - "description" : "The base amount.", - "$ref" : "#/components/schemas/Amount" - }, - "basePoints" : { - "description" : "The base points.", - "format" : "int32", - "type" : "integer" - }, - "buy" : { - "description" : "The buy rate.", - "$ref" : "#/components/schemas/Amount" - }, - "interbank" : { - "description" : "The interbank amount.", - "$ref" : "#/components/schemas/Amount" - }, - "reference" : { - "description" : "The reference assigned to the forex quote request.", - "type" : "string" - }, - "sell" : { - "description" : "The sell rate.", - "$ref" : "#/components/schemas/Amount" - }, - "signature" : { - "description" : "The signature to validate the integrity.", - "type" : "string" - }, - "source" : { - "description" : "The source of the forex quote.", - "type" : "string" - }, - "type" : { - "description" : "The type of forex.", - "type" : "string" - }, - "validTill" : { - "description" : "The date until which the forex quote is valid.", - "format" : "date-time", - "type" : "string" - } - }, - "required" : [ - "validTill", - "basePoints" - ] - }, "FraudCheckResult" : { "properties" : { "accountScore" : { @@ -2157,160 +921,6 @@ } } }, - "Installments" : { - "properties" : { - "plan" : { - "x-addedInVersion" : "64", - "description" : "The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values:\n* **regular**\n* **revolving**\n", - "enum" : [ - "regular", - "revolving" - ], - "type" : "string" - }, - "value" : { - "description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.", - "format" : "int32", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, - "Mandate" : { - "properties" : { - "amount" : { - "description" : "The billing amount (in minor units) of the recurring transactions.", - "type" : "string" - }, - "amountRule" : { - "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", - "enum" : [ - "max", - "exact" - ], - "type" : "string" - }, - "billingAttemptsRule" : { - "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", - "enum" : [ - "on", - "before", - "after" - ], - "type" : "string" - }, - "billingDay" : { - "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", - "type" : "string" - }, - "endsAt" : { - "description" : "End date of the billing plan, in YYYY-MM-DD format.", - "type" : "string" - }, - "frequency" : { - "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", - "enum" : [ - "adhoc", - "daily", - "weekly", - "biWeekly", - "monthly", - "quarterly", - "halfYearly", - "yearly" - ], - "type" : "string" - }, - "remarks" : { - "description" : "The message shown by UPI to the shopper on the approval screen.", - "type" : "string" - }, - "startsAt" : { - "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", - "type" : "string" - } - }, - "required" : [ - "frequency", - "amount", - "endsAt" - ] - }, - "MerchantDevice" : { - "properties" : { - "os" : { - "description" : "Operating system running on the merchant device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the merchant device.", - "type" : "string" - }, - "reference" : { - "description" : "Merchant device reference.", - "type" : "string" - } - } - }, - "MerchantRiskIndicator" : { - "properties" : { - "addressMatch" : { - "description" : "Whether the chosen delivery address is identical to the billing address.", - "type" : "boolean" - }, - "deliveryAddressIndicator" : { - "description" : "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`", - "enum" : [ - "shipToBillingAddress", - "shipToVerifiedAddress", - "shipToNewAddress", - "shipToStore", - "digitalGoods", - "goodsNotShipped", - "other" - ], - "type" : "string" - }, - "deliveryEmail" : { - "description" : "The delivery email address (for digital goods).", - "type" : "string" - }, - "deliveryTimeframe" : { - "description" : "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`", - "enum" : [ - "electronicDelivery", - "sameDayShipping", - "overnightShipping", - "twoOrMoreDaysShipping" - ], - "type" : "string" - }, - "giftCardAmount" : { - "description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).", - "$ref" : "#/components/schemas/Amount" - }, - "giftCardCount" : { - "description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.", - "format" : "int32", - "type" : "integer" - }, - "preOrderDate" : { - "description" : "For pre-order purchases, the expected date this product will be available to the shopper.", - "format" : "date-time", - "type" : "string" - }, - "preOrderPurchase" : { - "description" : "Indicator for whether this transaction is for pre-ordering a product.", - "type" : "boolean" - }, - "reorderItems" : { - "description" : "Indicator for whether the shopper has already purchased the same items in the past.", - "type" : "boolean" - } - } - }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -3026,26 +1636,6 @@ } } }, - "SDKEphemPubKey" : { - "properties" : { - "crv" : { - "description" : "The `crv` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "kty" : { - "description" : "The `kty` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "x" : { - "description" : "The `x` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "y" : { - "description" : "The `y` value as received from the 3D Secure 2 SDK.", - "type" : "string" - } - } - }, "ServiceError" : { "properties" : { "additionalData" : { @@ -3079,78 +1669,6 @@ } } }, - "ShopperInteractionDevice" : { - "properties" : { - "locale" : { - "description" : "Locale on the shopper interaction device.", - "type" : "string" - }, - "os" : { - "description" : "Operating system running on the shopper interaction device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the shopper interaction device.", - "type" : "string" - } - } - }, - "Split" : { - "properties" : { - "account" : { - "description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n", - "type" : "string" - }, - "amount" : { - "description" : "The amount of this split.", - "$ref" : "#/components/schemas/SplitAmount" - }, - "description" : { - "description" : "A description of this split.", - "type" : "string" - }, - "reference" : { - "description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.", - "type" : "string" - }, - "type" : { - "description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**.", - "enum" : [ - "BalanceAccount", - "Commission", - "Default", - "MarketPlace", - "PaymentFee", - "Remainder", - "VAT", - "Verification" - ], - "type" : "string" - } - }, - "required" : [ - "amount", - "type" - ] - }, - "SplitAmount" : { - "properties" : { - "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.", - "maxLength" : 3, - "minLength" : 3, - "type" : "string" - }, - "value" : { - "description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "format" : "int64", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, "StoreDetailAndSubmitRequest" : { "properties" : { "additionalData" : { @@ -3525,188 +2043,6 @@ "pspReference", "resultCode" ] - }, - "ThreeDS2RequestData" : { - "properties" : { - "acquirerBIN" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "acquirerMerchantID" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "authenticationOnly" : { - "deprecated" : true, - "x-deprecatedInVersion" : "50", - "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", - "default" : false, - "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", - "type" : "boolean" - }, - "challengeIndicator" : { - "description" : "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, - "deviceChannel" : { - "description" : "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`", - "type" : "string" - }, - "deviceRenderOptions" : { - "description" : "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.", - "$ref" : "#/components/schemas/DeviceRenderOptions" - }, - "mcc" : { - "x-addedInVersion" : "49", - "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", - "type" : "string" - }, - "merchantName" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", - "type" : "string" - }, - "messageVersion" : { - "default" : "2.1.0", - "description" : "The `messageVersion` value indicating the 3D Secure 2 protocol version.", - "type" : "string" - }, - "notificationURL" : { - "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", - "type" : "string" - }, - "sdkAppID" : { - "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEncData" : { - "description" : "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEphemPubKey" : { - "description" : "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "$ref" : "#/components/schemas/SDKEphemPubKey" - }, - "sdkMaxTimeout" : { - "default" : 60, - "description" : "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.", - "format" : "int32", - "type" : "integer" - }, - "sdkReferenceNumber" : { - "description" : "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkTransID" : { - "description" : "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkVersion" : { - "x-addedInVersion" : "40", - "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "threeDSCompInd" : { - "description" : "Completion indicator for the device fingerprinting.", - "type" : "string" - }, - "threeDSRequestorID" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorName" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorURL" : { - "description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.", - "type" : "string" - }, - "transactionType" : { - "x-addedInVersion" : "50", - "description" : "Identify the type of the transaction being authenticated.", - "enum" : [ - "goodsOrServicePurchase", - "checkAcceptance", - "accountFunding", - "quasiCashTransaction", - "prepaidActivationAndLoad" - ], - "type" : "string" - }, - "whiteListStatus" : { - "x-addedInVersion" : "49", - "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", - "type" : "string" - } - }, - "required" : [ - "deviceChannel" - ] - }, - "ThreeDSecureData" : { - "properties" : { - "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", - "enum" : [ - "Y", - "N", - "U", - "A" - ], - "type" : "string" - }, - "cavv" : { - "description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - }, - "cavvAlgorithm" : { - "description" : "The CAVV algorithm used. Include this only for 3D Secure 1.", - "type" : "string" - }, - "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", - "enum" : [ - "A", - "C", - "D", - "I", - "N", - "R", - "U", - "Y" - ], - "type" : "string" - }, - "dsTransID" : { - "x-addedInVersion" : "40", - "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", - "type" : "string" - }, - "eci" : { - "description" : "The electronic commerce indicator.", - "type" : "string" - }, - "threeDSVersion" : { - "x-addedInVersion" : "40", - "description" : "The version of the 3D Secure protocol.", - "type" : "string" - }, - "xid" : { - "description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - } - } } }, "securitySchemes" : { diff --git a/json/PayoutService-v67.json b/json/PayoutService-v67.json index 45d49e9..9be6877 100644 --- a/json/PayoutService-v67.json +++ b/json/PayoutService-v67.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payout API", "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", - "x-timestamp" : "2022-05-03T09:24:06Z", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -40,7 +40,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Confirms a payout.", + "summary" : "Confirm a payout", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", @@ -149,7 +149,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Cancels a payout.", + "summary" : "Cancel a payout", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", @@ -258,7 +258,7 @@ "tags" : [ "Instant payouts" ], - "summary" : "Pay out directly.", + "summary" : "Make an instant card payout", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", @@ -365,7 +365,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores payout details.", + "summary" : "Store payout details", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", @@ -473,7 +473,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores details and submits a payout.", + "summary" : "Store details and submit a payout", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", @@ -589,7 +589,7 @@ "tags" : [ "Initialization" ], - "summary" : "Submits a payout.", + "summary" : "Submit a payout", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", @@ -691,1034 +691,6 @@ }, "components" : { "schemas" : { - "AccountInfo" : { - "properties" : { - "accountAgeIndicator" : { - "description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountChangeDate" : { - "description" : "Date when the shopper's account was last changed.", - "format" : "date-time", - "type" : "string" - }, - "accountChangeIndicator" : { - "description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountCreationDate" : { - "description" : "Date when the shopper's account was created.", - "format" : "date-time", - "type" : "string" - }, - "accountType" : { - "x-addedInVersion" : "50", - "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", - "enum" : [ - "notApplicable", - "credit", - "debit" - ], - "type" : "string" - }, - "addCardAttemptsDay" : { - "description" : "Number of attempts the shopper tried to add a card to their account in the last day.", - "format" : "int32", - "type" : "integer" - }, - "deliveryAddressUsageDate" : { - "description" : "Date the selected delivery address was first used.", - "format" : "date-time", - "type" : "string" - }, - "deliveryAddressUsageIndicator" : { - "description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "homePhone" : { - "description" : "Shopper's home phone number (including the country code).", - "type" : "string" - }, - "mobilePhone" : { - "description" : "Shopper's mobile phone number (including the country code).", - "type" : "string" - }, - "passwordChangeDate" : { - "description" : "Date when the shopper last changed their password.", - "format" : "date-time", - "type" : "string" - }, - "passwordChangeIndicator" : { - "description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "pastTransactionsDay" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.", - "format" : "int32", - "type" : "integer" - }, - "pastTransactionsYear" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.", - "format" : "int32", - "type" : "integer" - }, - "paymentAccountAge" : { - "description" : "Date this payment method was added to the shopper's account.", - "format" : "date-time", - "type" : "string" - }, - "paymentAccountIndicator" : { - "description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "purchasesLast6Months" : { - "description" : "Number of successful purchases in the last six months.", - "format" : "int32", - "type" : "integer" - }, - "suspiciousActivity" : { - "description" : "Whether suspicious activity was recorded on this account.", - "type" : "boolean" - }, - "workPhone" : { - "description" : "Shopper's work phone number (including the country code).", - "type" : "string" - } - } - }, - "AdditionalData3DSecure" : { - "properties" : { - "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", - "type" : "string" - }, - "executeThreeD" : { - "description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", - "type" : "string" - }, - "mpiImplementationType" : { - "description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.", - "type" : "string" - }, - "scaExemption" : { - "description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", - "type" : "string" - }, - "threeDSVersion" : { - "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", - "type" : "string" - } - } - }, - "AdditionalDataAirline" : { - "properties" : { - "airline.agency_invoice_number" : { - "description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6", - "type" : "string" - }, - "airline.agency_plan_name" : { - "description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.airline_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.airline_designator_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.boarding_fee" : { - "description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18", - "type" : "string" - }, - "airline.computerized_reservation_system" : { - "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4", - "type" : "string" - }, - "airline.customer_reference_number" : { - "description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20", - "type" : "string" - }, - "airline.document_type" : { - "description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.flight_date" : { - "description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.carrier_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.leg.class_of_travel" : { - "description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.leg.date_of_travel" : { - "description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.depart_airport" : { - "description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.depart_tax" : { - "description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12", - "type" : "string" - }, - "airline.leg.destination_code" : { - "description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.fare_base_code" : { - "description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7", - "type" : "string" - }, - "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5", - "type" : "string" - }, - "airline.leg.stop_over_code" : { - "description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.passenger.date_of_birth" : { - "description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", - "type" : "string" - }, - "airline.passenger.first_name" : { - "description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.last_name" : { - "description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.telephone_number" : { - "description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30", - "type" : "string" - }, - "airline.passenger.traveller_type" : { - "description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6", - "type" : "string" - }, - "airline.passenger_name" : { - "description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49", - "type" : "string" - }, - "airline.ticket_issue_address" : { - "description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16", - "type" : "string" - }, - "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150", - "type" : "string" - }, - "airline.travel_agency_code" : { - "description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8", - "type" : "string" - }, - "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25", - "type" : "string" - } - }, - "required" : [ - "airline.passenger_name" - ] - }, - "AdditionalDataCarRental" : { - "properties" : { - "carRental.checkOutDate" : { - "description" : "Pick-up date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19", - "type" : "string" - }, - "carRental.fuelCharges" : { - "description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.locationCity" : { - "description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.locationCountry" : { - "description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.locationStateProvince" : { - "description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.", - "type" : "string" - }, - "carRental.oneWayDropOffCharges" : { - "description" : "Charge associated with not returning a vehicle to the original rental location.", - "type" : "string" - }, - "carRental.rate" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.rateIndicator" : { - "description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.", - "type" : "string" - }, - "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9", - "type" : "string" - }, - "carRental.rentalClassId" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26", - "type" : "string" - }, - "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.returnCountry" : { - "description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.returnDate" : { - "description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.returnLocationId" : { - "description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10", - "type" : "string" - }, - "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.taxExemptIndicator" : { - "description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataCommon" : { - "properties" : { - "RequestedTestErrorResponseCode" : { - "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", - "type" : "string" - }, - "authorisationType" : { - "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", - "type" : "string" - }, - "customRoutingFlag" : { - "description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).", - "type" : "string" - }, - "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], - "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "enum" : [ - "NoShow", - "DelayedCharge" - ], - "type" : "string" - }, - "networkTxReference" : { - "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", - "type" : "string" - }, - "overwriteBrand" : { - "description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", - "type" : "string" - }, - "subMerchantCity" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", - "type" : "string" - }, - "subMerchantCountry" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", - "type" : "string" - }, - "subMerchantID" : { - "description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", - "type" : "string" - }, - "subMerchantName" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", - "type" : "string" - }, - "subMerchantPostalCode" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", - "type" : "string" - }, - "subMerchantState" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", - "type" : "string" - }, - "subMerchantStreet" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", - "type" : "string" - }, - "subMerchantTaxId" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", - "type" : "string" - } - } - }, - "AdditionalDataLevel23" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - }, - "enhancedSchemeData.destinationCountryCode" : { - "description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.", - "type" : "string" - }, - "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.dutyAmount" : { - "description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.freightAmount" : { - "description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.orderDate" : { - "description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.", - "type" : "string" - }, - "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - } - } - }, - "AdditionalDataLodging" : { - "properties" : { - "lodging.checkInDate" : { - "description" : "The arrival date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.checkOutDate" : { - "description" : "The departure date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.fireSafetyActIndicator" : { - "description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1", - "type" : "string" - }, - "lodging.folioCashAdvances" : { - "description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.folioNumber" : { - "description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25", - "type" : "string" - }, - "lodging.foodBeverageCharges" : { - "description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1", - "type" : "string" - }, - "lodging.prepaidExpenses" : { - "description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.propertyPhoneNumber" : { - "description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.room1.numberOfNights" : { - "description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4", - "type" : "string" - }, - "lodging.room1.rate" : { - "description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.room1.tax" : { - "description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalRoomTax" : { - "description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalTax" : { - "description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataOpenInvoice" : { - "properties" : { - "openinvoicedata.merchantData" : { - "description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", - "type" : "string" - }, - "openinvoicedata.numberOfLines" : { - "description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].currencyCode" : { - "description" : "The three-character ISO currency code.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].description" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemAmount" : { - "description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemId" : { - "description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatAmount" : { - "description" : "The VAT due for one item in the invoice line, represented in minor units.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatPercentage" : { - "description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].numberOfItems" : { - "description" : "The number of units purchased of a specific product.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnShippingCompany" : { - "description" : "Name of the shipping company handling the the return shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingNumber" : { - "description" : "The tracking number for the return of the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingUri" : { - "description" : "URI where the customer can track the return of their shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingCompany" : { - "description" : "Name of the shipping company handling the delivery.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingMethod" : { - "description" : "Shipping method.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingNumber" : { - "description" : "The tracking number for the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingUri" : { - "description" : "URI where the customer can track their shipment.", - "type" : "string" - } - } - }, - "AdditionalDataOpi" : { - "properties" : { - "opi.includeTransToken" : { - "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", - "type" : "string" - } - } - }, - "AdditionalDataPayout" : { - "properties" : { - "fundingNetwork" : { - "description" : "", - "type" : "string" - }, - "fundingSource" : { - "description" : "", - "enum" : [ - "CREDIT", - "DEBIT", - "PREPAID", - "DEPOSIT_ACCOUNT" - ], - "type" : "string" - }, - "fundingTransactionId" : { - "description" : "", - "type" : "string" - }, - "payoutAccountCode" : { - "description" : "", - "type" : "string" - }, - "payoutAccountHolderCode" : { - "description" : "", - "type" : "string" - }, - "payoutMarketPayUser" : { - "description" : "", - "type" : "string" - }, - "processOver" : { - "description" : "", - "enum" : [ - "MC_P2P", - "Visa_OCT", - "UnlinkedRefund" - ], - "type" : "string" - }, - "verifyOver" : { - "description" : "", - "type" : "string" - }, - "walletIdentifier" : { - "description" : "", - "type" : "string" - } - } - }, - "AdditionalDataRatepay" : { - "properties" : { - "ratepay.installmentAmount" : { - "description" : "Amount the customer has to pay each month.", - "type" : "string" - }, - "ratepay.interestRate" : { - "description" : "Interest rate of this installment.", - "type" : "string" - }, - "ratepay.lastInstallmentAmount" : { - "description" : "Amount of the last installment.", - "type" : "string" - }, - "ratepay.paymentFirstday" : { - "description" : "Calendar day of the first payment.", - "type" : "string" - }, - "ratepaydata.deliveryDate" : { - "description" : "Date the merchant delivered the goods to the customer.", - "type" : "string" - }, - "ratepaydata.dueDate" : { - "description" : "Date by which the customer must settle the payment.", - "type" : "string" - }, - "ratepaydata.invoiceDate" : { - "description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", - "type" : "string" - }, - "ratepaydata.invoiceId" : { - "description" : "Identification name or number for the invoice, defined by the merchant.", - "type" : "string" - } - } - }, - "AdditionalDataRetry" : { - "properties" : { - "retry.chainAttemptNumber" : { - "description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.orderAttemptNumber" : { - "description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.skipRetry" : { - "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - } - } - }, - "AdditionalDataRisk" : { - "properties" : { - "riskdata.[customFieldName]" : { - "description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].amountPerItem" : { - "description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].brand" : { - "description" : "Brand of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].category" : { - "description" : "Category of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].color" : { - "description" : "Color of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].currency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].itemID" : { - "description" : "ID of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].manufacturer" : { - "description" : "Manufacturer of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].productTitle" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].quantity" : { - "description" : "Quantity of the item purchased.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].receiverEmail" : { - "description" : "Email associated with the given product in the basket (usually in electronic gift cards).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].size" : { - "description" : "Size of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].sku" : { - "description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].upc" : { - "description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionCode" : { - "description" : "Code of the promotion.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : { - "description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : { - "description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionName" : { - "description" : "Name of the promotion.", - "type" : "string" - }, - "riskdata.riskProfileReference" : { - "description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", - "type" : "string" - }, - "riskdata.skipRisk" : { - "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", - "type" : "string" - } - } - }, - "AdditionalDataRiskStandalone" : { - "properties" : { - "PayPal.CountryCode" : { - "description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", - "type" : "string" - }, - "PayPal.EmailId" : { - "description" : "Shopper's email.", - "type" : "string" - }, - "PayPal.FirstName" : { - "description" : "Shopper's first name.", - "type" : "string" - }, - "PayPal.LastName" : { - "description" : "Shopper's last name.", - "type" : "string" - }, - "PayPal.PayerId" : { - "description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", - "type" : "string" - }, - "PayPal.Phone" : { - "description" : "Shopper's phone number.", - "type" : "string" - }, - "PayPal.ProtectionEligibility" : { - "description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.", - "type" : "string" - }, - "PayPal.TransactionId" : { - "description" : "Unique transaction ID of the payment.", - "type" : "string" - }, - "avsResultRaw" : { - "description" : "Raw AVS result received from the acquirer, where available. Example: D", - "type" : "string" - }, - "bin" : { - "description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", - "type" : "string" - }, - "cvcResultRaw" : { - "description" : "Raw CVC result received from the acquirer, where available. Example: 1", - "type" : "string" - }, - "riskToken" : { - "description" : "Unique identifier or token for the shopper's card details.", - "type" : "string" - }, - "threeDAuthenticated" : { - "description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", - "type" : "string" - }, - "threeDOffered" : { - "description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true", - "type" : "string" - }, - "tokenDataType" : { - "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", - "type" : "string" - } - } - }, - "AdditionalDataSubMerchant" : { - "properties" : { - "subMerchant.numberOfSubSellers" : { - "description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].city" : { - "description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].country" : { - "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].id" : { - "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].mcc" : { - "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].name" : { - "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].postalCode" : { - "description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].state" : { - "description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].street" : { - "description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].taxId" : { - "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", - "type" : "string" - } - } - }, - "AdditionalDataTemporaryServices" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", - "type" : "string" - }, - "enhancedSchemeData.employeeName" : { - "description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.jobDescription" : { - "description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.regularHoursRate" : { - "description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.regularHoursWorked" : { - "description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.requestName" : { - "description" : "Name of the individual requesting temporary services.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.tempStartDate" : { - "description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.tempWeekEnding" : { - "description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", - "type" : "string" - } - } - }, - "AdditionalDataWallets" : { - "properties" : { - "androidpay.token" : { - "description" : "The Android Pay token retrieved from the SDK.", - "type" : "string" - }, - "masterpass.transactionId" : { - "description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.", - "type" : "string" - }, - "payment.token" : { - "description" : "The Apple Pay token retrieved from the SDK.", - "type" : "string" - }, - "paywithgoogle.token" : { - "description" : "The Google Pay token retrieved from the SDK.", - "type" : "string" - }, - "samsungpay.token" : { - "description" : "The Samsung Pay token retrieved from the SDK.", - "type" : "string" - }, - "visacheckout.callId" : { - "description" : "The Visa Checkout Call ID retrieved from the SDK.", - "type" : "string" - } - } - }, "Address" : { "properties" : { "city" : { @@ -1776,34 +748,6 @@ "currency" ] }, - "ApplicationInfo" : { - "properties" : { - "adyenLibrary" : { - "description" : "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "adyenPaymentSource" : { - "description" : "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "externalPlatform" : { - "description" : "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.", - "$ref" : "#/components/schemas/ExternalPlatform" - }, - "merchantApplication" : { - "description" : "Merchant developed software, such as cashier application, used to interact with the Adyen API.", - "$ref" : "#/components/schemas/CommonField" - }, - "merchantDevice" : { - "description" : "Merchant device information.", - "$ref" : "#/components/schemas/MerchantDevice" - }, - "shopperInteractionDevice" : { - "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", - "$ref" : "#/components/schemas/ShopperInteractionDevice" - } - } - }, "BankAccount" : { "properties" : { "bankAccountNumber" : { @@ -1846,72 +790,6 @@ } } }, - "BrowserInfo" : { - "properties" : { - "acceptHeader" : { - "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - }, - "colorDepth" : { - "x-addedInVersion" : "40", - "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", - "format" : "int32", - "type" : "integer" - }, - "javaEnabled" : { - "x-addedInVersion" : "40", - "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", - "type" : "boolean" - }, - "javaScriptEnabled" : { - "x-addedInVersion" : "40", - "default" : true, - "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", - "type" : "boolean" - }, - "language" : { - "x-addedInVersion" : "40", - "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", - "type" : "string" - }, - "screenHeight" : { - "x-addedInVersion" : "40", - "description" : "The total height of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "screenWidth" : { - "x-addedInVersion" : "40", - "description" : "The total width of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "timeZoneOffset" : { - "x-addedInVersion" : "40", - "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", - "format" : "int32", - "type" : "integer" - }, - "userAgent" : { - "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - } - }, - "required" : [ - "userAgent", - "acceptHeader", - "javaEnabled", - "colorDepth", - "screenHeight", - "screenWidth", - "timeZoneOffset", - "language" - ] - }, "Card" : { "properties" : { "cvc" : { @@ -1970,120 +848,6 @@ "holderName" ] }, - "CommonField" : { - "properties" : { - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "DeviceRenderOptions" : { - "properties" : { - "sdkInterface" : { - "default" : "both", - "description" : "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both", - "enum" : [ - "native", - "html", - "both" - ], - "type" : "string" - }, - "sdkUiType" : { - "description" : "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect", - "items" : { - "enum" : [ - "multiSelect", - "otherHtml", - "outOfBand", - "singleSelect", - "text" - ], - "type" : "string" - }, - "type" : "array" - } - } - }, - "ExternalPlatform" : { - "properties" : { - "integrator" : { - "description" : "External platform integrator.", - "type" : "string" - }, - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "ForexQuote" : { - "properties" : { - "account" : { - "description" : "The account name.", - "type" : "string" - }, - "accountType" : { - "description" : "The account type.", - "type" : "string" - }, - "baseAmount" : { - "description" : "The base amount.", - "$ref" : "#/components/schemas/Amount" - }, - "basePoints" : { - "description" : "The base points.", - "format" : "int32", - "type" : "integer" - }, - "buy" : { - "description" : "The buy rate.", - "$ref" : "#/components/schemas/Amount" - }, - "interbank" : { - "description" : "The interbank amount.", - "$ref" : "#/components/schemas/Amount" - }, - "reference" : { - "description" : "The reference assigned to the forex quote request.", - "type" : "string" - }, - "sell" : { - "description" : "The sell rate.", - "$ref" : "#/components/schemas/Amount" - }, - "signature" : { - "description" : "The signature to validate the integrity.", - "type" : "string" - }, - "source" : { - "description" : "The source of the forex quote.", - "type" : "string" - }, - "type" : { - "description" : "The type of forex.", - "type" : "string" - }, - "validTill" : { - "description" : "The date until which the forex quote is valid.", - "format" : "date-time", - "type" : "string" - } - }, - "required" : [ - "validTill", - "basePoints" - ] - }, "FraudCheckResult" : { "properties" : { "accountScore" : { @@ -2157,160 +921,6 @@ } } }, - "Installments" : { - "properties" : { - "plan" : { - "x-addedInVersion" : "64", - "description" : "The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values:\n* **regular**\n* **revolving**\n", - "enum" : [ - "regular", - "revolving" - ], - "type" : "string" - }, - "value" : { - "description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.", - "format" : "int32", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, - "Mandate" : { - "properties" : { - "amount" : { - "description" : "The billing amount (in minor units) of the recurring transactions.", - "type" : "string" - }, - "amountRule" : { - "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", - "enum" : [ - "max", - "exact" - ], - "type" : "string" - }, - "billingAttemptsRule" : { - "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", - "enum" : [ - "on", - "before", - "after" - ], - "type" : "string" - }, - "billingDay" : { - "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", - "type" : "string" - }, - "endsAt" : { - "description" : "End date of the billing plan, in YYYY-MM-DD format.", - "type" : "string" - }, - "frequency" : { - "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", - "enum" : [ - "adhoc", - "daily", - "weekly", - "biWeekly", - "monthly", - "quarterly", - "halfYearly", - "yearly" - ], - "type" : "string" - }, - "remarks" : { - "description" : "The message shown by UPI to the shopper on the approval screen.", - "type" : "string" - }, - "startsAt" : { - "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", - "type" : "string" - } - }, - "required" : [ - "frequency", - "amount", - "endsAt" - ] - }, - "MerchantDevice" : { - "properties" : { - "os" : { - "description" : "Operating system running on the merchant device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the merchant device.", - "type" : "string" - }, - "reference" : { - "description" : "Merchant device reference.", - "type" : "string" - } - } - }, - "MerchantRiskIndicator" : { - "properties" : { - "addressMatch" : { - "description" : "Whether the chosen delivery address is identical to the billing address.", - "type" : "boolean" - }, - "deliveryAddressIndicator" : { - "description" : "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`", - "enum" : [ - "shipToBillingAddress", - "shipToVerifiedAddress", - "shipToNewAddress", - "shipToStore", - "digitalGoods", - "goodsNotShipped", - "other" - ], - "type" : "string" - }, - "deliveryEmail" : { - "description" : "The delivery email address (for digital goods).", - "type" : "string" - }, - "deliveryTimeframe" : { - "description" : "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`", - "enum" : [ - "electronicDelivery", - "sameDayShipping", - "overnightShipping", - "twoOrMoreDaysShipping" - ], - "type" : "string" - }, - "giftCardAmount" : { - "description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).", - "$ref" : "#/components/schemas/Amount" - }, - "giftCardCount" : { - "description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.", - "format" : "int32", - "type" : "integer" - }, - "preOrderDate" : { - "description" : "For pre-order purchases, the expected date this product will be available to the shopper.", - "format" : "date-time", - "type" : "string" - }, - "preOrderPurchase" : { - "description" : "Indicator for whether this transaction is for pre-ordering a product.", - "type" : "boolean" - }, - "reorderItems" : { - "description" : "Indicator for whether the shopper has already purchased the same items in the past.", - "type" : "boolean" - } - } - }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -3018,26 +1628,6 @@ } } }, - "SDKEphemPubKey" : { - "properties" : { - "crv" : { - "description" : "The `crv` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "kty" : { - "description" : "The `kty` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "x" : { - "description" : "The `x` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "y" : { - "description" : "The `y` value as received from the 3D Secure 2 SDK.", - "type" : "string" - } - } - }, "ServiceError" : { "properties" : { "additionalData" : { @@ -3071,78 +1661,6 @@ } } }, - "ShopperInteractionDevice" : { - "properties" : { - "locale" : { - "description" : "Locale on the shopper interaction device.", - "type" : "string" - }, - "os" : { - "description" : "Operating system running on the shopper interaction device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the shopper interaction device.", - "type" : "string" - } - } - }, - "Split" : { - "properties" : { - "account" : { - "description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n", - "type" : "string" - }, - "amount" : { - "description" : "The amount of this split.", - "$ref" : "#/components/schemas/SplitAmount" - }, - "description" : { - "description" : "A description of this split.", - "type" : "string" - }, - "reference" : { - "description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.", - "type" : "string" - }, - "type" : { - "description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**.", - "enum" : [ - "BalanceAccount", - "Commission", - "Default", - "MarketPlace", - "PaymentFee", - "Remainder", - "VAT", - "Verification" - ], - "type" : "string" - } - }, - "required" : [ - "amount", - "type" - ] - }, - "SplitAmount" : { - "properties" : { - "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.", - "maxLength" : 3, - "minLength" : 3, - "type" : "string" - }, - "value" : { - "description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "format" : "int64", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, "StoreDetailAndSubmitRequest" : { "properties" : { "additionalData" : { @@ -3517,212 +2035,6 @@ "pspReference", "resultCode" ] - }, - "ThreeDS2RequestData" : { - "properties" : { - "acquirerBIN" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "acquirerMerchantID" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "authenticationOnly" : { - "deprecated" : true, - "x-deprecatedInVersion" : "50", - "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", - "default" : false, - "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", - "type" : "boolean" - }, - "challengeIndicator" : { - "description" : "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, - "deviceChannel" : { - "description" : "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`", - "type" : "string" - }, - "deviceRenderOptions" : { - "description" : "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.", - "$ref" : "#/components/schemas/DeviceRenderOptions" - }, - "mcc" : { - "x-addedInVersion" : "49", - "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", - "type" : "string" - }, - "merchantName" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", - "type" : "string" - }, - "messageVersion" : { - "default" : "2.1.0", - "description" : "The `messageVersion` value indicating the 3D Secure 2 protocol version.", - "type" : "string" - }, - "notificationURL" : { - "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", - "type" : "string" - }, - "sdkAppID" : { - "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEncData" : { - "description" : "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEphemPubKey" : { - "description" : "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "$ref" : "#/components/schemas/SDKEphemPubKey" - }, - "sdkMaxTimeout" : { - "default" : 60, - "description" : "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.", - "format" : "int32", - "type" : "integer" - }, - "sdkReferenceNumber" : { - "description" : "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkTransID" : { - "description" : "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkVersion" : { - "x-addedInVersion" : "40", - "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "threeDSCompInd" : { - "description" : "Completion indicator for the device fingerprinting.", - "type" : "string" - }, - "threeDSRequestorID" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorName" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorURL" : { - "description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.", - "type" : "string" - }, - "transactionType" : { - "x-addedInVersion" : "50", - "description" : "Identify the type of the transaction being authenticated.", - "enum" : [ - "goodsOrServicePurchase", - "checkAcceptance", - "accountFunding", - "quasiCashTransaction", - "prepaidActivationAndLoad" - ], - "type" : "string" - }, - "whiteListStatus" : { - "x-addedInVersion" : "49", - "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", - "type" : "string" - } - }, - "required" : [ - "deviceChannel" - ] - }, - "ThreeDSecureData" : { - "properties" : { - "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", - "enum" : [ - "Y", - "N", - "U", - "A" - ], - "type" : "string" - }, - "cavv" : { - "description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - }, - "cavvAlgorithm" : { - "description" : "The CAVV algorithm used. Include this only for 3D Secure 1.", - "type" : "string" - }, - "challengeCancel" : { - "x-addedInVersion" : "67", - "description" : "Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).", - "enum" : [ - "01", - "02", - "03", - "04", - "05", - "06", - "07" - ], - "type" : "string" - }, - "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", - "enum" : [ - "A", - "C", - "D", - "I", - "N", - "R", - "U", - "Y" - ], - "type" : "string" - }, - "dsTransID" : { - "x-addedInVersion" : "40", - "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", - "type" : "string" - }, - "eci" : { - "description" : "The electronic commerce indicator.", - "type" : "string" - }, - "riskScore" : { - "x-addedInVersion" : "67", - "description" : "Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.", - "type" : "string" - }, - "threeDSVersion" : { - "x-addedInVersion" : "40", - "description" : "The version of the 3D Secure protocol.", - "type" : "string" - }, - "transStatusReason" : { - "x-addedInVersion" : "67", - "description" : "Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).", - "type" : "string" - }, - "xid" : { - "description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - } - } } }, "securitySchemes" : { diff --git a/json/PayoutService-v68.json b/json/PayoutService-v68.json index b854222..c5993d5 100644 --- a/json/PayoutService-v68.json +++ b/json/PayoutService-v68.json @@ -10,7 +10,7 @@ "x-publicVersion" : true, "title" : "Adyen Payout API", "description" : "A set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n\nBoth of these API credentials must be authenticated with [basic authentication](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).The following example shows how to authenticate your request when submitting a payout:\n\n```\ncurl\n-U \"storePayout@Company.[YourCompany]\":\"YourBasicAuthenticationPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n", - "x-timestamp" : "2022-05-03T09:24:06Z", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -40,7 +40,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Confirms a payout.", + "summary" : "Confirm a payout", "description" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", @@ -149,7 +149,7 @@ "tags" : [ "Reviewing" ], - "summary" : "Cancels a payout.", + "summary" : "Cancel a payout", "description" : "Cancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", @@ -258,7 +258,7 @@ "tags" : [ "Instant payouts" ], - "summary" : "Pay out directly.", + "summary" : "Make an instant card payout", "description" : "With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", @@ -365,7 +365,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores payout details.", + "summary" : "Store payout details", "description" : "Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-groupName" : "Initialization", @@ -473,7 +473,7 @@ "tags" : [ "Initialization" ], - "summary" : "Stores details and submits a payout.", + "summary" : "Store details and submit a payout", "description" : "Submits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", @@ -589,7 +589,7 @@ "tags" : [ "Initialization" ], - "summary" : "Submits a payout.", + "summary" : "Submit a payout", "description" : "Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", @@ -691,1168 +691,6 @@ }, "components" : { "schemas" : { - "AccountInfo" : { - "properties" : { - "accountAgeIndicator" : { - "description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountChangeDate" : { - "description" : "Date when the shopper's account was last changed.", - "format" : "date-time", - "type" : "string" - }, - "accountChangeIndicator" : { - "description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "accountCreationDate" : { - "description" : "Date when the shopper's account was created.", - "format" : "date-time", - "type" : "string" - }, - "accountType" : { - "x-addedInVersion" : "50", - "description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit", - "enum" : [ - "notApplicable", - "credit", - "debit" - ], - "type" : "string" - }, - "addCardAttemptsDay" : { - "description" : "Number of attempts the shopper tried to add a card to their account in the last day.", - "format" : "int32", - "type" : "integer" - }, - "deliveryAddressUsageDate" : { - "description" : "Date the selected delivery address was first used.", - "format" : "date-time", - "type" : "string" - }, - "deliveryAddressUsageIndicator" : { - "description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "homePhone" : { - "deprecated" : true, - "x-deprecatedInVersion" : "68", - "x-deprecatedMessage" : "Use `ThreeDS2RequestData.homePhone` instead.", - "description" : "Shopper's home phone number (including the country code).", - "type" : "string" - }, - "mobilePhone" : { - "deprecated" : true, - "x-deprecatedInVersion" : "68", - "x-deprecatedMessage" : "Use `ThreeDS2RequestData.mobilePhone` instead.", - "description" : "Shopper's mobile phone number (including the country code).", - "type" : "string" - }, - "passwordChangeDate" : { - "description" : "Date when the shopper last changed their password.", - "format" : "date-time", - "type" : "string" - }, - "passwordChangeIndicator" : { - "description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "pastTransactionsDay" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.", - "format" : "int32", - "type" : "integer" - }, - "pastTransactionsYear" : { - "description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.", - "format" : "int32", - "type" : "integer" - }, - "paymentAccountAge" : { - "description" : "Date this payment method was added to the shopper's account.", - "format" : "date-time", - "type" : "string" - }, - "paymentAccountIndicator" : { - "description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days", - "enum" : [ - "notApplicable", - "thisTransaction", - "lessThan30Days", - "from30To60Days", - "moreThan60Days" - ], - "type" : "string" - }, - "purchasesLast6Months" : { - "description" : "Number of successful purchases in the last six months.", - "format" : "int32", - "type" : "integer" - }, - "suspiciousActivity" : { - "description" : "Whether suspicious activity was recorded on this account.", - "type" : "boolean" - }, - "workPhone" : { - "deprecated" : true, - "x-deprecatedInVersion" : "68", - "x-deprecatedMessage" : "Use `ThreeDS2RequestData.workPhone` instead.", - "description" : "Shopper's work phone number (including the country code).", - "type" : "string" - } - } - }, - "AcctInfo" : { - "properties" : { - "chAccAgeInd" : { - "description" : "Length of time that the cardholder has had the account with the 3DS Requestor. \nAllowed values:\n* **01** — No account\n* **02** — Created during this transaction\n* **03** — Less than 30 days\n* **04** — 30–60 days\n* **05** — More than 60 days", - "enum" : [ - "01", - "02", - "03", - "04", - "05" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "chAccChange" : { - "description" : "Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nFormat: **YYYYMMDD**", - "type" : "string" - }, - "chAccChangeInd" : { - "description" : "Length of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nAllowed values:\n* **01** — Changed during this transaction\n* **02** — Less than 30 days\n* **03** — 30–60 days\n* **04** — More than 60 days", - "enum" : [ - "01", - "02", - "03", - "04" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "chAccPwChange" : { - "description" : "Date that cardholder’s account with the 3DS Requestor had a password change or account reset. \nFormat: **YYYYMMDD**", - "type" : "string" - }, - "chAccPwChangeInd" : { - "description" : "Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset. \nAllowed values:\n* **01** — No change\n* **02** — Changed during this transaction\n* **03** — Less than 30 days\n* **04** — 30–60 days\n* **05** — More than 60 days", - "enum" : [ - "01", - "02", - "03", - "04", - "05" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "chAccString" : { - "description" : "Date that the cardholder opened the account with the 3DS Requestor. \nFormat: **YYYYMMDD**", - "type" : "string" - }, - "nbPurchaseAccount" : { - "description" : "Number of purchases with this cardholder account during the previous six months. Max length: 4 characters.", - "type" : "string" - }, - "paymentAccAge" : { - "description" : "String that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. \nFormat: **YYYYMMDD**", - "type" : "string" - }, - "paymentAccInd" : { - "description" : "Indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. \nAllowed values:\n* **01** — No account (guest checkout)\n* **02** — During this transaction\n* **03** — Less than 30 days\n* **04** — 30–60 days\n* **05** — More than 60 days", - "enum" : [ - "01", - "02", - "03", - "04", - "05" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "provisionAttemptsDay" : { - "description" : "Number of Add Card attempts in the last 24 hours. Max length: 3 characters.", - "type" : "string" - }, - "shipAddressUsage" : { - "description" : "String when the shipping address used for this transaction was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**", - "type" : "string" - }, - "shipAddressUsageInd" : { - "description" : "Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. \nAllowed values:\n* **01** — This transaction\n* **02** — Less than 30 days\n* **03** — 30–60 days\n* **04** — More than 60 days", - "enum" : [ - "01", - "02", - "03", - "04" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "shipNameIndicator" : { - "description" : "Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. \nAllowed values:\n* **01** — Account Name identical to shipping Name\n* **02** — Account Name different to shipping Name", - "enum" : [ - "01", - "02" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "suspiciousAccActivity" : { - "description" : "Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. \nAllowed values:\n* **01** — No suspicious activity has been observed\n* **02** — Suspicious activity has been observed", - "enum" : [ - "01", - "02" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "txnActivityDay" : { - "description" : "Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. Max length: 3 characters.", - "maxLength" : 3, - "type" : "string" - }, - "txnActivityYear" : { - "description" : "Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. Max length: 3 characters.", - "maxLength" : 3, - "type" : "string" - } - } - }, - "AdditionalData3DSecure" : { - "properties" : { - "allow3DS2" : { - "description" : "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n", - "type" : "string" - }, - "executeThreeD" : { - "description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n", - "type" : "string" - }, - "mpiImplementationType" : { - "description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.", - "type" : "string" - }, - "scaExemption" : { - "description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ", - "type" : "string" - }, - "threeDSVersion" : { - "description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n", - "type" : "string" - } - } - }, - "AdditionalDataAirline" : { - "properties" : { - "airline.agency_invoice_number" : { - "description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6", - "type" : "string" - }, - "airline.agency_plan_name" : { - "description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.airline_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.airline_designator_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.boarding_fee" : { - "description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18", - "type" : "string" - }, - "airline.computerized_reservation_system" : { - "description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4", - "type" : "string" - }, - "airline.customer_reference_number" : { - "description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20", - "type" : "string" - }, - "airline.document_type" : { - "description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.flight_date" : { - "description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.carrier_code" : { - "description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2", - "type" : "string" - }, - "airline.leg.class_of_travel" : { - "description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.leg.date_of_travel" : { - "description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16", - "type" : "string" - }, - "airline.leg.depart_airport" : { - "description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.depart_tax" : { - "description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12", - "type" : "string" - }, - "airline.leg.destination_code" : { - "description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3", - "type" : "string" - }, - "airline.leg.fare_base_code" : { - "description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7", - "type" : "string" - }, - "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5", - "type" : "string" - }, - "airline.leg.stop_over_code" : { - "description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1", - "type" : "string" - }, - "airline.passenger.date_of_birth" : { - "description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10", - "type" : "string" - }, - "airline.passenger.first_name" : { - "description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.last_name" : { - "description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.", - "type" : "string" - }, - "airline.passenger.telephone_number" : { - "description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30", - "type" : "string" - }, - "airline.passenger.traveller_type" : { - "description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6", - "type" : "string" - }, - "airline.passenger_name" : { - "description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49", - "type" : "string" - }, - "airline.ticket_issue_address" : { - "description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16", - "type" : "string" - }, - "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150", - "type" : "string" - }, - "airline.travel_agency_code" : { - "description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8", - "type" : "string" - }, - "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25", - "type" : "string" - } - }, - "required" : [ - "airline.passenger_name" - ] - }, - "AdditionalDataCarRental" : { - "properties" : { - "carRental.checkOutDate" : { - "description" : "Pick-up date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19", - "type" : "string" - }, - "carRental.fuelCharges" : { - "description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.locationCity" : { - "description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.locationCountry" : { - "description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.locationStateProvince" : { - "description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.", - "type" : "string" - }, - "carRental.oneWayDropOffCharges" : { - "description" : "Charge associated with not returning a vehicle to the original rental location.", - "type" : "string" - }, - "carRental.rate" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.rateIndicator" : { - "description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.", - "type" : "string" - }, - "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9", - "type" : "string" - }, - "carRental.rentalClassId" : { - "description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12", - "type" : "string" - }, - "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26", - "type" : "string" - }, - "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18", - "type" : "string" - }, - "carRental.returnCountry" : { - "description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2", - "type" : "string" - }, - "carRental.returnDate" : { - "description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "carRental.returnLocationId" : { - "description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10", - "type" : "string" - }, - "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3", - "type" : "string" - }, - "carRental.taxExemptIndicator" : { - "description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataCommon" : { - "properties" : { - "RequestedTestErrorResponseCode" : { - "description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.\n* **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.", - "type" : "string" - }, - "authorisationType" : { - "description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.", - "type" : "string" - }, - "customRoutingFlag" : { - "description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).", - "type" : "string" - }, - "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], - "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "enum" : [ - "NoShow", - "DelayedCharge" - ], - "type" : "string" - }, - "networkTxReference" : { - "description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.", - "type" : "string" - }, - "overwriteBrand" : { - "description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.", - "type" : "string" - }, - "subMerchantCity" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.", - "type" : "string" - }, - "subMerchantCountry" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.", - "type" : "string" - }, - "subMerchantID" : { - "description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.", - "type" : "string" - }, - "subMerchantName" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.", - "type" : "string" - }, - "subMerchantPostalCode" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.", - "type" : "string" - }, - "subMerchantState" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.", - "type" : "string" - }, - "subMerchantStreet" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.", - "type" : "string" - }, - "subMerchantTaxId" : { - "description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.", - "type" : "string" - } - } - }, - "AdditionalDataLevel23" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - }, - "enhancedSchemeData.destinationCountryCode" : { - "description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.", - "type" : "string" - }, - "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.dutyAmount" : { - "description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.freightAmount" : { - "description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.", - "type" : "string" - }, - "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.", - "type" : "string" - }, - "enhancedSchemeData.orderDate" : { - "description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.", - "type" : "string" - }, - "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.", - "type" : "string" - } - } - }, - "AdditionalDataLodging" : { - "properties" : { - "lodging.checkInDate" : { - "description" : "The arrival date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.checkOutDate" : { - "description" : "The departure date.\n* Date format: `yyyyMMdd`", - "type" : "string" - }, - "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.fireSafetyActIndicator" : { - "description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1", - "type" : "string" - }, - "lodging.folioCashAdvances" : { - "description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.folioNumber" : { - "description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25", - "type" : "string" - }, - "lodging.foodBeverageCharges" : { - "description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.noShowIndicator" : { - "description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1", - "type" : "string" - }, - "lodging.prepaidExpenses" : { - "description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.propertyPhoneNumber" : { - "description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17", - "type" : "string" - }, - "lodging.room1.numberOfNights" : { - "description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4", - "type" : "string" - }, - "lodging.room1.rate" : { - "description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.room1.tax" : { - "description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalRoomTax" : { - "description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "lodging.totalTax" : { - "description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12", - "type" : "string" - }, - "travelEntertainmentAuthData.duration" : { - "description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", - "type" : "string" - }, - "travelEntertainmentAuthData.market" : { - "description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1", - "type" : "string" - } - } - }, - "AdditionalDataOpenInvoice" : { - "properties" : { - "openinvoicedata.merchantData" : { - "description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.", - "type" : "string" - }, - "openinvoicedata.numberOfLines" : { - "description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].currencyCode" : { - "description" : "The three-character ISO currency code.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].description" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemAmount" : { - "description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemId" : { - "description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatAmount" : { - "description" : "The VAT due for one item in the invoice line, represented in minor units.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].itemVatPercentage" : { - "description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].numberOfItems" : { - "description" : "The number of units purchased of a specific product.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnShippingCompany" : { - "description" : "Name of the shipping company handling the the return shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingNumber" : { - "description" : "The tracking number for the return of the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].returnTrackingUri" : { - "description" : "URI where the customer can track the return of their shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingCompany" : { - "description" : "Name of the shipping company handling the delivery.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].shippingMethod" : { - "description" : "Shipping method.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingNumber" : { - "description" : "The tracking number for the shipment.", - "type" : "string" - }, - "openinvoicedataLine[itemNr].trackingUri" : { - "description" : "URI where the customer can track their shipment.", - "type" : "string" - } - } - }, - "AdditionalDataOpi" : { - "properties" : { - "opi.includeTransToken" : { - "description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).", - "type" : "string" - } - } - }, - "AdditionalDataPayout" : { - "properties" : { - "fundingNetwork" : { - "description" : "", - "type" : "string" - }, - "fundingSource" : { - "description" : "", - "enum" : [ - "CREDIT", - "DEBIT", - "PREPAID", - "DEPOSIT_ACCOUNT" - ], - "type" : "string" - }, - "fundingTransactionId" : { - "description" : "", - "type" : "string" - }, - "payoutAccountCode" : { - "description" : "", - "type" : "string" - }, - "payoutAccountHolderCode" : { - "description" : "", - "type" : "string" - }, - "payoutMarketPayUser" : { - "description" : "", - "type" : "string" - }, - "processOver" : { - "description" : "", - "enum" : [ - "MC_P2P", - "Visa_OCT", - "UnlinkedRefund" - ], - "type" : "string" - }, - "verifyOver" : { - "description" : "", - "type" : "string" - }, - "walletIdentifier" : { - "description" : "", - "type" : "string" - } - } - }, - "AdditionalDataRatepay" : { - "properties" : { - "ratepay.installmentAmount" : { - "description" : "Amount the customer has to pay each month.", - "type" : "string" - }, - "ratepay.interestRate" : { - "description" : "Interest rate of this installment.", - "type" : "string" - }, - "ratepay.lastInstallmentAmount" : { - "description" : "Amount of the last installment.", - "type" : "string" - }, - "ratepay.paymentFirstday" : { - "description" : "Calendar day of the first payment.", - "type" : "string" - }, - "ratepaydata.deliveryDate" : { - "description" : "Date the merchant delivered the goods to the customer.", - "type" : "string" - }, - "ratepaydata.dueDate" : { - "description" : "Date by which the customer must settle the payment.", - "type" : "string" - }, - "ratepaydata.invoiceDate" : { - "description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.", - "type" : "string" - }, - "ratepaydata.invoiceId" : { - "description" : "Identification name or number for the invoice, defined by the merchant.", - "type" : "string" - } - } - }, - "AdditionalDataRetry" : { - "properties" : { - "retry.chainAttemptNumber" : { - "description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.orderAttemptNumber" : { - "description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - }, - "retry.skipRetry" : { - "description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.", - "type" : "string" - } - } - }, - "AdditionalDataRisk" : { - "properties" : { - "riskdata.[customFieldName]" : { - "description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].amountPerItem" : { - "description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].brand" : { - "description" : "Brand of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].category" : { - "description" : "Category of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].color" : { - "description" : "Color of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].currency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].itemID" : { - "description" : "ID of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].manufacturer" : { - "description" : "Manufacturer of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].productTitle" : { - "description" : "A text description of the product the invoice line refers to.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].quantity" : { - "description" : "Quantity of the item purchased.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].receiverEmail" : { - "description" : "Email associated with the given product in the basket (usually in electronic gift cards).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].size" : { - "description" : "Size of the item.", - "type" : "string" - }, - "riskdata.basket.item[itemNr].sku" : { - "description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).", - "type" : "string" - }, - "riskdata.basket.item[itemNr].upc" : { - "description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionCode" : { - "description" : "Code of the promotion.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : { - "description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : { - "description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : { - "description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.", - "type" : "string" - }, - "riskdata.promotions.promotion[itemNr].promotionName" : { - "description" : "Name of the promotion.", - "type" : "string" - }, - "riskdata.riskProfileReference" : { - "description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).", - "type" : "string" - }, - "riskdata.skipRisk" : { - "description" : "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.", - "type" : "string" - } - } - }, - "AdditionalDataRiskStandalone" : { - "properties" : { - "PayPal.CountryCode" : { - "description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.", - "type" : "string" - }, - "PayPal.EmailId" : { - "description" : "Shopper's email.", - "type" : "string" - }, - "PayPal.FirstName" : { - "description" : "Shopper's first name.", - "type" : "string" - }, - "PayPal.LastName" : { - "description" : "Shopper's last name.", - "type" : "string" - }, - "PayPal.PayerId" : { - "description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.", - "type" : "string" - }, - "PayPal.Phone" : { - "description" : "Shopper's phone number.", - "type" : "string" - }, - "PayPal.ProtectionEligibility" : { - "description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.", - "type" : "string" - }, - "PayPal.TransactionId" : { - "description" : "Unique transaction ID of the payment.", - "type" : "string" - }, - "avsResultRaw" : { - "description" : "Raw AVS result received from the acquirer, where available. Example: D", - "type" : "string" - }, - "bin" : { - "description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).", - "type" : "string" - }, - "cvcResultRaw" : { - "description" : "Raw CVC result received from the acquirer, where available. Example: 1", - "type" : "string" - }, - "riskToken" : { - "description" : "Unique identifier or token for the shopper's card details.", - "type" : "string" - }, - "threeDAuthenticated" : { - "description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true", - "type" : "string" - }, - "threeDOffered" : { - "description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true", - "type" : "string" - }, - "tokenDataType" : { - "description" : "Required for PayPal payments only. The only supported value is: **paypal**.", - "type" : "string" - } - } - }, - "AdditionalDataSubMerchant" : { - "properties" : { - "subMerchant.numberOfSubSellers" : { - "description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].city" : { - "description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].country" : { - "description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].id" : { - "description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].mcc" : { - "description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].name" : { - "description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].postalCode" : { - "description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].state" : { - "description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].street" : { - "description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters", - "type" : "string" - }, - "subMerchant.subSeller[subSellerNr].taxId" : { - "description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ", - "type" : "string" - } - } - }, - "AdditionalDataTemporaryServices" : { - "properties" : { - "enhancedSchemeData.customerReference" : { - "description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25", - "type" : "string" - }, - "enhancedSchemeData.employeeName" : { - "description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.jobDescription" : { - "description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.regularHoursRate" : { - "description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.regularHoursWorked" : { - "description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7", - "type" : "string" - }, - "enhancedSchemeData.requestName" : { - "description" : "Name of the individual requesting temporary services.\n* maxLength: 40", - "type" : "string" - }, - "enhancedSchemeData.tempStartDate" : { - "description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.tempWeekEnding" : { - "description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6", - "type" : "string" - }, - "enhancedSchemeData.totalTaxAmount" : { - "description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12", - "type" : "string" - } - } - }, - "AdditionalDataWallets" : { - "properties" : { - "androidpay.token" : { - "description" : "The Android Pay token retrieved from the SDK.", - "type" : "string" - }, - "masterpass.transactionId" : { - "description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.", - "type" : "string" - }, - "payment.token" : { - "description" : "The Apple Pay token retrieved from the SDK.", - "type" : "string" - }, - "paywithgoogle.token" : { - "description" : "The Google Pay token retrieved from the SDK.", - "type" : "string" - }, - "samsungpay.token" : { - "description" : "The Samsung Pay token retrieved from the SDK.", - "type" : "string" - }, - "visacheckout.callId" : { - "description" : "The Visa Checkout Call ID retrieved from the SDK.", - "type" : "string" - } - } - }, "Address" : { "properties" : { "city" : { @@ -1910,34 +748,6 @@ "currency" ] }, - "ApplicationInfo" : { - "properties" : { - "adyenLibrary" : { - "description" : "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "adyenPaymentSource" : { - "description" : "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.", - "$ref" : "#/components/schemas/CommonField" - }, - "externalPlatform" : { - "description" : "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.", - "$ref" : "#/components/schemas/ExternalPlatform" - }, - "merchantApplication" : { - "description" : "Merchant developed software, such as cashier application, used to interact with the Adyen API.", - "$ref" : "#/components/schemas/CommonField" - }, - "merchantDevice" : { - "description" : "Merchant device information.", - "$ref" : "#/components/schemas/MerchantDevice" - }, - "shopperInteractionDevice" : { - "description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.", - "$ref" : "#/components/schemas/ShopperInteractionDevice" - } - } - }, "BankAccount" : { "properties" : { "bankAccountNumber" : { @@ -1980,72 +790,6 @@ } } }, - "BrowserInfo" : { - "properties" : { - "acceptHeader" : { - "description" : "The accept header value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - }, - "colorDepth" : { - "x-addedInVersion" : "40", - "description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.", - "format" : "int32", - "type" : "integer" - }, - "javaEnabled" : { - "x-addedInVersion" : "40", - "description" : "Boolean value indicating if the shopper's browser is able to execute Java.", - "type" : "boolean" - }, - "javaScriptEnabled" : { - "x-addedInVersion" : "40", - "default" : true, - "description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.", - "type" : "boolean" - }, - "language" : { - "x-addedInVersion" : "40", - "description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).", - "type" : "string" - }, - "screenHeight" : { - "x-addedInVersion" : "40", - "description" : "The total height of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "screenWidth" : { - "x-addedInVersion" : "40", - "description" : "The total width of the shopper's device screen in pixels.", - "format" : "int32", - "type" : "integer" - }, - "timeZoneOffset" : { - "x-addedInVersion" : "40", - "description" : "Time difference between UTC time and the shopper's browser local time, in minutes.", - "format" : "int32", - "type" : "integer" - }, - "userAgent" : { - "description" : "The user agent value of the shopper's browser.", - "maxLength" : 50, - "minLength" : 10, - "type" : "string" - } - }, - "required" : [ - "userAgent", - "acceptHeader", - "javaEnabled", - "colorDepth", - "screenHeight", - "screenWidth", - "timeZoneOffset", - "language" - ] - }, "Card" : { "properties" : { "cvc" : { @@ -2104,120 +848,6 @@ "holderName" ] }, - "CommonField" : { - "properties" : { - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "DeviceRenderOptions" : { - "properties" : { - "sdkInterface" : { - "default" : "both", - "description" : "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both", - "enum" : [ - "native", - "html", - "both" - ], - "type" : "string" - }, - "sdkUiType" : { - "description" : "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect", - "items" : { - "enum" : [ - "multiSelect", - "otherHtml", - "outOfBand", - "singleSelect", - "text" - ], - "type" : "string" - }, - "type" : "array" - } - } - }, - "ExternalPlatform" : { - "properties" : { - "integrator" : { - "description" : "External platform integrator.", - "type" : "string" - }, - "name" : { - "description" : "Name of the field. For example, Name of External Platform.", - "type" : "string" - }, - "version" : { - "description" : "Version of the field. For example, Version of External Platform.", - "type" : "string" - } - } - }, - "ForexQuote" : { - "properties" : { - "account" : { - "description" : "The account name.", - "type" : "string" - }, - "accountType" : { - "description" : "The account type.", - "type" : "string" - }, - "baseAmount" : { - "description" : "The base amount.", - "$ref" : "#/components/schemas/Amount" - }, - "basePoints" : { - "description" : "The base points.", - "format" : "int32", - "type" : "integer" - }, - "buy" : { - "description" : "The buy rate.", - "$ref" : "#/components/schemas/Amount" - }, - "interbank" : { - "description" : "The interbank amount.", - "$ref" : "#/components/schemas/Amount" - }, - "reference" : { - "description" : "The reference assigned to the forex quote request.", - "type" : "string" - }, - "sell" : { - "description" : "The sell rate.", - "$ref" : "#/components/schemas/Amount" - }, - "signature" : { - "description" : "The signature to validate the integrity.", - "type" : "string" - }, - "source" : { - "description" : "The source of the forex quote.", - "type" : "string" - }, - "type" : { - "description" : "The type of forex.", - "type" : "string" - }, - "validTill" : { - "description" : "The date until which the forex quote is valid.", - "format" : "date-time", - "type" : "string" - } - }, - "required" : [ - "validTill", - "basePoints" - ] - }, "FraudCheckResult" : { "properties" : { "accountScore" : { @@ -2291,189 +921,6 @@ } } }, - "Installments" : { - "properties" : { - "plan" : { - "x-addedInVersion" : "64", - "description" : "The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values:\n* **regular**\n* **revolving**\n", - "enum" : [ - "regular", - "revolving" - ], - "type" : "string" - }, - "value" : { - "description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.", - "format" : "int32", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, - "Mandate" : { - "properties" : { - "amount" : { - "description" : "The billing amount (in minor units) of the recurring transactions.", - "type" : "string" - }, - "amountRule" : { - "description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n", - "enum" : [ - "max", - "exact" - ], - "type" : "string" - }, - "billingAttemptsRule" : { - "description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n", - "enum" : [ - "on", - "before", - "after" - ], - "type" : "string" - }, - "billingDay" : { - "description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.", - "type" : "string" - }, - "endsAt" : { - "description" : "End date of the billing plan, in YYYY-MM-DD format.", - "type" : "string" - }, - "frequency" : { - "description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.", - "enum" : [ - "adhoc", - "daily", - "weekly", - "biWeekly", - "monthly", - "quarterly", - "halfYearly", - "yearly" - ], - "type" : "string" - }, - "remarks" : { - "description" : "The message shown by UPI to the shopper on the approval screen.", - "type" : "string" - }, - "startsAt" : { - "description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.", - "type" : "string" - } - }, - "required" : [ - "frequency", - "amount", - "endsAt" - ] - }, - "MerchantDevice" : { - "properties" : { - "os" : { - "description" : "Operating system running on the merchant device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the merchant device.", - "type" : "string" - }, - "reference" : { - "description" : "Merchant device reference.", - "type" : "string" - } - } - }, - "MerchantRiskIndicator" : { - "properties" : { - "addressMatch" : { - "description" : "Whether the chosen delivery address is identical to the billing address.", - "type" : "boolean" - }, - "deliveryAddressIndicator" : { - "description" : "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`", - "enum" : [ - "shipToBillingAddress", - "shipToVerifiedAddress", - "shipToNewAddress", - "shipToStore", - "digitalGoods", - "goodsNotShipped", - "other" - ], - "type" : "string" - }, - "deliveryEmail" : { - "deprecated" : true, - "x-deprecatedInVersion" : "68", - "x-deprecatedMessage" : "Use `deliveryEmailAddress` instead.", - "description" : "The delivery email address (for digital goods).", - "type" : "string" - }, - "deliveryEmailAddress" : { - "x-addedInVersion" : "68", - "description" : "For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters.", - "maxLength" : 254, - "type" : "string" - }, - "deliveryTimeframe" : { - "description" : "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`", - "enum" : [ - "electronicDelivery", - "sameDayShipping", - "overnightShipping", - "twoOrMoreDaysShipping" - ], - "type" : "string" - }, - "giftCardAmount" : { - "description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).", - "$ref" : "#/components/schemas/Amount" - }, - "giftCardCount" : { - "description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.", - "format" : "int32", - "type" : "integer" - }, - "giftCardCurr" : { - "x-addedInVersion" : "68", - "description" : "For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) three-digit currency code of the gift card, other than those listed in Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification.", - "type" : "string" - }, - "preOrderDate" : { - "description" : "For pre-order purchases, the expected date this product will be available to the shopper.", - "format" : "date-time", - "type" : "string" - }, - "preOrderPurchase" : { - "description" : "Indicator for whether this transaction is for pre-ordering a product.", - "type" : "boolean" - }, - "preOrderPurchaseInd" : { - "x-addedInVersion" : "68", - "description" : "Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.", - "type" : "string" - }, - "reorderItems" : { - "description" : "Indicator for whether the shopper has already purchased the same items in the past.", - "type" : "boolean" - }, - "reorderItemsInd" : { - "x-addedInVersion" : "68", - "description" : "Indicates whether the cardholder is reordering previously purchased merchandise.", - "type" : "string" - }, - "shipIndicator" : { - "x-addedInVersion" : "68", - "description" : "Indicates shipping method chosen for the transaction.", - "type" : "string" - } - } - }, "ModifyRequest" : { "properties" : { "additionalData" : { @@ -2703,21 +1150,6 @@ } } }, - "Phone" : { - "properties" : { - "cc" : { - "description" : "Country code. Length: 1–3 characters.", - "maxLength" : 3, - "minLength" : 1, - "type" : "string" - }, - "subscriber" : { - "description" : "Subscriber number. Maximum length: 15 characters.", - "maxLength" : 15, - "type" : "string" - } - } - }, "Recurring" : { "properties" : { "contract" : { @@ -3196,26 +1628,6 @@ } } }, - "SDKEphemPubKey" : { - "properties" : { - "crv" : { - "description" : "The `crv` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "kty" : { - "description" : "The `kty` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "x" : { - "description" : "The `x` value as received from the 3D Secure 2 SDK.", - "type" : "string" - }, - "y" : { - "description" : "The `y` value as received from the 3D Secure 2 SDK.", - "type" : "string" - } - } - }, "ServiceError" : { "properties" : { "additionalData" : { @@ -3249,78 +1661,6 @@ } } }, - "ShopperInteractionDevice" : { - "properties" : { - "locale" : { - "description" : "Locale on the shopper interaction device.", - "type" : "string" - }, - "os" : { - "description" : "Operating system running on the shopper interaction device.", - "type" : "string" - }, - "osVersion" : { - "description" : "Version of the operating system on the shopper interaction device.", - "type" : "string" - } - } - }, - "Split" : { - "properties" : { - "account" : { - "description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n", - "type" : "string" - }, - "amount" : { - "description" : "The amount of this split.", - "$ref" : "#/components/schemas/SplitAmount" - }, - "description" : { - "description" : "A description of this split.", - "type" : "string" - }, - "reference" : { - "description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.", - "type" : "string" - }, - "type" : { - "description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**, **Remainder**.", - "enum" : [ - "BalanceAccount", - "Commission", - "Default", - "MarketPlace", - "PaymentFee", - "Remainder", - "VAT", - "Verification" - ], - "type" : "string" - } - }, - "required" : [ - "amount", - "type" - ] - }, - "SplitAmount" : { - "properties" : { - "currency" : { - "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.", - "maxLength" : 3, - "minLength" : 3, - "type" : "string" - }, - "value" : { - "description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).", - "format" : "int64", - "type" : "integer" - } - }, - "required" : [ - "value" - ] - }, "StoreDetailAndSubmitRequest" : { "properties" : { "additionalData" : { @@ -3695,415 +2035,6 @@ "pspReference", "resultCode" ] - }, - "ThreeDS2RequestData" : { - "properties" : { - "acctInfo" : { - "x-addedInVersion" : "68", - "description" : "Additional information about the Cardholder’s account provided by the 3DS Requestor.", - "$ref" : "#/components/schemas/AcctInfo" - }, - "acctType" : { - "x-addedInVersion" : "68", - "description" : "Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values:\n* **01** — Not applicable\n* **02** — Credit\n* **03** — Debit", - "enum" : [ - "01", - "02", - "03" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "acquirerBIN" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "acquirerMerchantID" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.", - "type" : "string" - }, - "addrMatch" : { - "x-addedInVersion" : "68", - "description" : "Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values:\n* **Y** — Shipping Address matches Billing Address.\n* **N** — Shipping Address does not match Billing Address.", - "enum" : [ - "Y", - "N" - ], - "maxLength" : 1, - "minLength" : 1, - "type" : "string" - }, - "authenticationOnly" : { - "deprecated" : true, - "x-deprecatedInVersion" : "50", - "x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.", - "default" : false, - "description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.", - "type" : "boolean" - }, - "challengeIndicator" : { - "deprecated" : true, - "x-deprecatedInVersion" : "68", - "x-deprecatedMessage" : "Use `threeDSRequestorChallengeInd` instead.", - "description" : "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, - "deviceChannel" : { - "description" : "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`", - "type" : "string" - }, - "deviceRenderOptions" : { - "description" : "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.", - "$ref" : "#/components/schemas/DeviceRenderOptions" - }, - "homePhone" : { - "x-addedInVersion" : "68", - "description" : "The home phone number provided by the Cardholder.", - "$ref" : "#/components/schemas/Phone" - }, - "mcc" : { - "x-addedInVersion" : "49", - "description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.", - "type" : "string" - }, - "merchantName" : { - "x-addedInVersion" : "49", - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.", - "type" : "string" - }, - "messageVersion" : { - "default" : "2.1.0", - "description" : "The `messageVersion` value indicating the 3D Secure 2 protocol version.", - "type" : "string" - }, - "mobilePhone" : { - "x-addedInVersion" : "68", - "description" : "The mobile phone number provided by the Cardholder.", - "$ref" : "#/components/schemas/Phone" - }, - "notificationURL" : { - "description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.", - "type" : "string" - }, - "payTokenInd" : { - "x-addedInVersion" : "68", - "description" : "Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS.", - "type" : "boolean" - }, - "paymentAuthenticationUseCase" : { - "x-addedInVersion" : "68", - "description" : "Indicates the type of payment for which an authentication is requested (message extension)", - "type" : "string" - }, - "purchaseInstalData" : { - "x-addedInVersion" : "68", - "description" : "Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters.", - "maxLength" : 3, - "minLength" : 1, - "type" : "string" - }, - "recurringExpiry" : { - "x-addedInVersion" : "68", - "description" : "Date after which no further authorisations shall be performed. Format: YYYYMMDD", - "type" : "string" - }, - "recurringFrequency" : { - "x-addedInVersion" : "68", - "description" : "Indicates the minimum number of days between authorisations. Maximum length: 4 characters.", - "maxLength" : 4, - "type" : "string" - }, - "sdkAppID" : { - "description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEncData" : { - "description" : "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkEphemPubKey" : { - "description" : "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.", - "$ref" : "#/components/schemas/SDKEphemPubKey" - }, - "sdkMaxTimeout" : { - "default" : 60, - "description" : "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.", - "format" : "int32", - "type" : "integer" - }, - "sdkReferenceNumber" : { - "description" : "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkTransID" : { - "description" : "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "sdkVersion" : { - "x-addedInVersion" : "40", - "description" : "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**.", - "type" : "string" - }, - "threeDSCompInd" : { - "description" : "Completion indicator for the device fingerprinting.", - "type" : "string" - }, - "threeDSRequestorAuthenticationInd" : { - "x-addedInVersion" : "68", - "description" : "Indicates the type of Authentication request.", - "type" : "string" - }, - "threeDSRequestorAuthenticationInfo" : { - "x-addedInVersion" : "68", - "description" : "Information about how the 3DS Requestor authenticated the cardholder before or during the transaction", - "$ref" : "#/components/schemas/ThreeDSRequestorAuthenticationInfo" - }, - "threeDSRequestorChallengeInd" : { - "x-addedInVersion" : "68", - "x-enum" : [ - { - "description" : "No preference", - "value" : "01" - }, - { - "description" : "No challenge requested", - "value" : "02" - }, - { - "description" : "Challenge requested (3DS Requestor preference)", - "value" : "03" - }, - { - "description" : "Challenge requested (Mandate)", - "value" : "04" - }, - { - "description" : "No challenge (transactional risk analysis is already performed)", - "value" : "05" - } - ], - "description" : "Indicates whether a challenge is requested for this transaction. Possible values:\n* **01** — No preference\n* **02** — No challenge requested\n* **03** — Challenge requested (3DS Requestor preference)\n* **04** — Challenge requested (Mandate)\n* **05** — No challenge (transactional risk analysis is already performed)", - "enum" : [ - "01", - "02", - "03", - "04", - "05" - ], - "type" : "string" - }, - "threeDSRequestorID" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorName" : { - "description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.", - "type" : "string" - }, - "threeDSRequestorPriorAuthenticationInfo" : { - "x-addedInVersion" : "68", - "description" : "Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.", - "$ref" : "#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo" - }, - "threeDSRequestorURL" : { - "description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.", - "type" : "string" - }, - "transType" : { - "x-addedInVersion" : "68", - "description" : "Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values:\n* **01** — Goods/Service Purchase\n* **03** — Check Acceptance\n* **10** — Account Funding\n* **11** — Quasi-Cash Transaction\n* **28** — Prepaid Activation and Load", - "enum" : [ - "01", - "03", - "10", - "11", - "28" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "transactionType" : { - "x-addedInVersion" : "50", - "description" : "Identify the type of the transaction being authenticated.", - "enum" : [ - "goodsOrServicePurchase", - "checkAcceptance", - "accountFunding", - "quasiCashTransaction", - "prepaidActivationAndLoad" - ], - "type" : "string" - }, - "whiteListStatus" : { - "x-addedInVersion" : "49", - "description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.", - "type" : "string" - }, - "workPhone" : { - "x-addedInVersion" : "68", - "description" : "The work phone number provided by the Cardholder.", - "$ref" : "#/components/schemas/Phone" - } - }, - "required" : [ - "deviceChannel" - ] - }, - "ThreeDSRequestorAuthenticationInfo" : { - "properties" : { - "threeDSReqAuthData" : { - "description" : "Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.", - "type" : "string" - }, - "threeDSReqAuthMethod" : { - "description" : "Mechanism used by the Cardholder to authenticate to the 3DS Requestor. Allowed values:\n* **01** — No 3DS Requestor authentication occurred (for example, cardholder “logged in” as guest).\n* **02** — Login to the cardholder account at the 3DS Requestor system using 3DS Requestor’s own credentials.\n* **03** — Login to the cardholder account at the 3DS Requestor system using federated ID.\n* **04** — Login to the cardholder account at the 3DS Requestor system using issuer credentials.\n* **05** — Login to the cardholder account at the 3DS Requestor system using third-party authentication.\n* **06** — Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator.", - "enum" : [ - "01", - "02", - "03", - "04", - "05", - "06" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "threeDSReqAuthTimestamp" : { - "description" : "Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM", - "maxLength" : 12, - "minLength" : 12, - "type" : "string" - } - } - }, - "ThreeDSRequestorPriorAuthenticationInfo" : { - "properties" : { - "threeDSReqPriorAuthData" : { - "description" : "Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.", - "type" : "string" - }, - "threeDSReqPriorAuthMethod" : { - "description" : "Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Allowed values:\n* **01** — Frictionless authentication occurred by ACS.\n* **02** — Cardholder challenge occurred by ACS.\n* **03** — AVS verified.\n* **04** — Other issuer methods.", - "enum" : [ - "01", - "02", - "03", - "04" - ], - "maxLength" : 2, - "minLength" : 2, - "type" : "string" - }, - "threeDSReqPriorAuthTimestamp" : { - "description" : "Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM", - "maxLength" : 12, - "minLength" : 12, - "type" : "string" - }, - "threeDSReqPriorRef" : { - "description" : "This data element provides additional information to the ACS to determine the best approach for handing a request. This data element contains an ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder. Length: 30 characters.", - "maxLength" : 36, - "minLength" : 36, - "type" : "string" - } - } - }, - "ThreeDSecureData" : { - "properties" : { - "authenticationResponse" : { - "description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.", - "enum" : [ - "Y", - "N", - "U", - "A" - ], - "type" : "string" - }, - "cavv" : { - "description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - }, - "cavvAlgorithm" : { - "description" : "The CAVV algorithm used. Include this only for 3D Secure 1.", - "type" : "string" - }, - "challengeCancel" : { - "x-addedInVersion" : "67", - "description" : "Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).", - "enum" : [ - "01", - "02", - "03", - "04", - "05", - "06", - "07" - ], - "type" : "string" - }, - "directoryResponse" : { - "description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.", - "enum" : [ - "A", - "C", - "D", - "I", - "N", - "R", - "U", - "Y" - ], - "type" : "string" - }, - "dsTransID" : { - "x-addedInVersion" : "40", - "description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.", - "type" : "string" - }, - "eci" : { - "description" : "The electronic commerce indicator.", - "type" : "string" - }, - "riskScore" : { - "x-addedInVersion" : "67", - "description" : "Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.", - "type" : "string" - }, - "threeDSVersion" : { - "x-addedInVersion" : "40", - "description" : "The version of the 3D Secure protocol.", - "type" : "string" - }, - "tokenAuthenticationVerificationValue" : { - "x-addedInVersion" : "68", - "description" : "Network token authentication verification value (TAVV). The network token cryptogram.", - "format" : "byte", - "type" : "string" - }, - "transStatusReason" : { - "x-addedInVersion" : "67", - "description" : "Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).", - "type" : "string" - }, - "xid" : { - "description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).", - "format" : "byte", - "type" : "string" - } - } } }, "securitySchemes" : { diff --git a/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml index f3ebe78..9ef3610 100644 --- a/yaml/PayoutService-v30.yaml +++ b/yaml/PayoutService-v30.yaml @@ -40,7 +40,7 @@ info: ' - x-timestamp: '2022-05-03T09:24:05Z' + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -59,7 +59,7 @@ paths: post: tags: - Reviewing - summary: Confirms a payout. + summary: Confirm a payout description: 'Confirms a previously submitted payout. @@ -126,7 +126,7 @@ paths: post: tags: - Reviewing - summary: Cancels a payout. + summary: Cancel a payout description: 'Cancels a previously submitted payout. @@ -193,7 +193,7 @@ paths: post: tags: - Instant payouts - summary: Pay out directly. + summary: Make an instant card payout description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card @@ -259,7 +259,7 @@ paths: post: tags: - Initialization - summary: Stores payout details. + summary: Store payout details description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call. @@ -324,7 +324,7 @@ paths: post: tags: - Initialization - summary: Stores details and submits a payout. + summary: Store details and submit a payout description: 'Submits a payout and stores its details for subsequent payouts. @@ -397,7 +397,7 @@ paths: post: tags: - Initialization - summary: Submits a payout. + summary: Submit a payout description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -461,1423 +461,6 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: - AdditionalData3DSecure: - properties: - allow3DS2: - description: "Indicates if you are able to process 3D Secure 2 transactions\ - \ natively on your payment page. Send this parameter when you are using\ - \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ - \n > This parameter only indicates readiness to support native 3D Secure\ - \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ - \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ - \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ - \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" - type: string - executeThreeD: - description: "Indicates if you want to perform 3D Secure authentication\ - \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ - \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ - \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ - \ 3D Secure authentication. Note that this setting results in refusals\ - \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ - \ national regulations. \n" - type: string - mpiImplementationType: - description: In case of Secure+, this field must be set to **CUPSecurePlus**. - type: string - scaExemption: - description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction.\n\n Possible values:\n\ - * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ - \ **transactionRiskAnalysis** " - type: string - threeDSVersion: - description: "Indicates your preference for the 3D Secure version. \n> If\ - \ you use this parameter, you override the checks from Adyen's Authentication\ - \ Engine. We recommend to use this field only if you have an extensive\ - \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ - \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ - \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ - \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ - \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ - \ in the `ARes`, we will apply the fallback policy configured in your\ - \ account. For example, if the configuration is to fall back to 3D Secure\ - \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ - \ the BIN is not enrolled, you will receive an error.\n\n" - type: string - AdditionalDataAirline: - properties: - airline.agency_invoice_number: - description: 'Reference number for the invoice, issued by the agency. - - * minLength: 1 - - * maxLength: 6' - type: string - airline.agency_plan_name: - description: '2-letter agency plan identifier; alphabetical. - - * minLength: 2 - - * maxLength: 2' - type: string - airline.airline_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit - accounting code (PAX); numeric. It identifies the carrier. - - * Format: IATA 3-digit accounting code (PAX) - - * Example: KLM = 074 - - * minLength: 3 - - * maxLength: 3' - type: string - airline.airline_designator_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.boarding_fee: - description: 'Chargeable amount for boarding the plane. - - The transaction amount needs to be represented in minor units according - to the [following table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 18' - type: string - airline.computerized_reservation_system: - description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) - used to make the reservation and purchase the ticket. - - * Format: alphanumeric. - - * minLength: 4 - - * maxLength: 4' - type: string - airline.customer_reference_number: - description: 'Reference number; alphanumeric. - - * minLength: 0 - - * maxLength: 20' - type: string - airline.document_type: - description: 'Optional 2-digit code; alphanumeric. It identifies the type - of product of the transaction. The description of the code may appear - on credit card statements. - - * Format: 2-digit code - - * Example: Passenger ticket = 01 - - * minLength: 2 - - * maxLength: 2' - type: string - airline.flight_date: - description: 'Flight departure date. Local time `(HH:mm)` is optional. - - * Date format: `yyyy-MM-dd` - - * Date and time format: `yyyy-MM-dd HH:mm` - - * minLength: 10 - - * maxLength: 16' - type: string - airline.leg.carrier_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - This field is required/mandatory if the airline data includes leg details. - - * Format: IATA 2-letter airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.leg.class_of_travel: - description: '1-letter travel class identifier; alphabetical. There is no - standard; however, the following codes are used rather consistently: - - * F: first class - - * J: business class - - * Y: economy class - - * W: premium economy - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_airport: - description: 'Alphabetical identifier of the departure airport. - - This field is required if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.depart_tax: - description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). - Amount charged by a country to an individual upon their leaving. The transaction - amount needs to be represented in minor units according to the [following - table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 12' - type: string - airline.leg.destination_code: - description: 'Alphabetical identifier of the destination/arrival airport. - - This field is required/mandatory if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.fare_base_code: - description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); - alphanumeric. - - * minLength: 1 - - * maxLength: 7' - type: string - airline.leg.flight_number: - description: 'The flight identifier. - - * minLength: 1 - - * maxLength: 5' - type: string - airline.leg.stop_over_code: - description: '1-letter code that indicates whether the passenger is entitled - to make a stopover. Only two types of characters are allowed: - - * O: Stopover allowed - - * X: Stopover not allowed - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.passenger.date_of_birth: - description: 'Date of birth of the passenger. - - - Date format: `yyyy-MM-dd` - - * minLength: 10 - - * maxLength: 10' - type: string - airline.passenger.first_name: - description: 'Passenger first name/given name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.last_name: - description: 'Passenger last name/family name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.telephone_number: - description: 'Telephone number of the passenger, including country code. - This is an alphanumeric field that can include the ''+'' and ''-'' signs. - - * minLength: 3 - - * maxLength: 30' - type: string - airline.passenger.traveller_type: - description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. - Example: ADT, SRC, CNN, INS. - - - However, several carriers use non-standard codes that can be up to 5 alphanumeric - characters. - - * minLength: 3 - - * maxLength: 6' - type: string - airline.passenger_name: - description: 'Passenger name, initials, and a title. - - * Format: last name + first name or initials + title. - - * Example: *FLYER / MARY MS*. - - * minLength: 1 - - * maxLength: 49' - type: string - airline.ticket_issue_address: - description: 'Address of the place/agency that issued the ticket. - - * minLength: 0 - - * maxLength: 16' - type: string - airline.ticket_number: - description: 'The ticket''s unique identifier. - - * minLength: 1 - - * maxLength: 150' - type: string - airline.travel_agency_code: - description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier - number for travel agencies. - - * minLength: 1 - - * maxLength: 8' - type: string - airline.travel_agency_name: - description: 'The name of the travel agency. - - * minLength: 1 - - * maxLength: 25' - type: string - required: - - airline.passenger_name - AdditionalDataCarRental: - properties: - carRental.checkOutDate: - description: 'Pick-up date. - - * Date format: `yyyyMMdd`' - type: string - carRental.customerServiceTollFreeNumber: - description: 'The customer service phone number of the car rental company. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - carRental.daysRented: - description: 'Number of days for which the car is being rented. - - * Format: Numeric - - * maxLength: 19' - type: string - carRental.fuelCharges: - description: 'Any fuel charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.insuranceCharges: - description: 'Any insurance charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.locationCity: - description: 'The city from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.locationCountry: - description: 'The country from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.locationStateProvince: - description: 'The state or province from where the car is rented. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - * Y - Customer was a no show. - - * N - Not applicable.' - type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. - type: string - carRental.rate: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.rateIndicator: - description: 'Specifies whether the given rate is applied daily or weekly. - - * D - Daily rate. - - * W - Weekly rate.' - type: string - carRental.rentalAgreementNumber: - description: 'The rental agreement number associated with this car rental. - - * Format: Alphanumeric - - * maxLength: 9' - type: string - carRental.rentalClassId: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.renterName: - description: 'The name of the person renting the car. - - * Format: Alphanumeric - - * maxLength: 26' - type: string - carRental.returnCity: - description: 'The city where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.returnCountry: - description: 'The country where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.returnDate: - description: 'The last date to return the car by. - - * Date format: `yyyyMMdd`' - type: string - carRental.returnLocationId: - description: 'Agency code, phone number, or address abbreviation - - * Format: Alphanumeric - - * maxLength: 10' - type: string - carRental.returnStateProvince: - description: 'The state or province where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.taxExemptIndicator: - description: 'Indicates whether the goods or services were tax-exempt, or - tax was not collected. - - - Values: - - * Y - Goods or services were tax exempt - - * N - Tax was not collected' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "A" for Car rental. This should be - included in the auth message. - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataCommon: - properties: - RequestedTestErrorResponseCode: - description: "Triggers test scenarios that allow to replicate certain communication\ - \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ - \ wasn't a connection available to service the outgoing communication.\n\ - This is a transient, retriable error since no messaging could be initiated\ - \ to an issuing system (or third-party acquiring system). Therefore, the\ - \ header Transient-Error: true is returned in the response. A subsequent\ - \ request using the same idempotency key will be processed as if it was\ - \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ - \ wrong during transmission of the message or receiving the response.\n\ - This is a classified as non-transient because the message could have been\ - \ received by the issuing party and been acted upon. No transient error\ - \ header is returned. If using idempotency, the (error) response is stored\ - \ as the final result for the idempotency key. Subsequent messages with\ - \ the same idempotency key not be processed beyond returning the stored\ - \ response." - type: string - authorisationType: - description: "Flags a card payment request for either pre-authorisation\ - \ or final authorisation. For more information, refer to [Authorisation\ - \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ - \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ - \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ - \ request to be handled as a final authorisation." - type: string - customRoutingFlag: - description: 'Allows you to determine or override the acquirer account that - should be used for the transaction. - - - If you need to process a payment with an acquirer different from a default - one, you can set up a corresponding configuration on the Adyen payments - platform. Then you can pass a custom routing flag in a payment request''s - additional data to target a specific acquirer. - - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' - type: string - industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge - description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ - \ this field denotes why the additional payment is made.\n\nPossible values:\n\ - \n * **NoShow**: An incremental charge is carried out because of a no-show\ - \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ - \ charge is carried out to process an additional payment after the original\ - \ services have been rendered and the respective payment has been processed." - enum: - - NoShow - - DelayedCharge - type: string - networkTxReference: - description: 'Allows you to link the transaction to the original or previous - one in a subscription/card-on-file chain. This field is required for token-based - transactions where Adyen does not tokenize the card. - - - Transaction identifier from card schemes, for example, Mastercard Trace - ID or the Visa Transaction ID. - - - Submit the original transaction ID of the contract in your payment request - if you are not tokenizing card details with Adyen and are making a merchant-initiated - transaction (MIT) for subsequent charges. - - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` - **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction - is classified as MIT.' - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - subMerchantCity: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the city of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 13 characters.' - type: string - subMerchantCountry: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the three-letter - country code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Fixed length: 3 characters.' - type: string - subMerchantID: - description: 'This field contains an identifier of the actual merchant when - a transaction is submitted via a payment facilitator. The payment facilitator - must send in this unique ID. - - - A unique identifier per submerchant that is required if the transaction - is performed by a registered payment facilitator. - - * Format: alpha-numeric. - - * Fixed length: 15 characters.' - type: string - subMerchantName: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the name of - the actual merchant. - - * Format: alpha-numeric. - - * Maximum length: 22 characters.' - type: string - subMerchantPostalCode: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the postal code - of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 10 characters.' - type: string - subMerchantState: - description: 'This field is required if the transaction is performed by - a registered payment facilitator, and if applicable to the country. This - field must contain the state code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 3 characters.' - type: string - subMerchantStreet: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the street of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 60 characters.' - type: string - subMerchantTaxId: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the tax ID of - the actual merchant. - - * Format: alpha-numeric. - - * Fixed length: 11 or 14 characters.' - type: string - AdditionalDataLevel23: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - - Encoding: ASCII. - - - Max length: 25 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - enhancedSchemeData.destinationCountryCode: - description: 'Destination country code. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.destinationPostalCode: - description: 'The postal code of a destination address. - - - Encoding: ASCII. - - - Max length: 10 characters. - - - > Required for American Express.' - type: string - enhancedSchemeData.destinationStateProvinceCode: - description: 'Destination state or province code. - - - Encoding: ASCII.Max length: 3 characters.' - type: string - enhancedSchemeData.dutyAmount: - description: 'Duty amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.freightAmount: - description: 'Shipping amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].commodityCode: - description: 'Item commodity code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].description: - description: 'Item description. - - - Encoding: ASCII. - - - Max length: 26 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: - description: 'Discount amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].productCode: - description: 'Product code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].quantity: - description: 'Quantity, specified as an integer value. - - - Value must be greater than 0. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: - description: 'Total amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: - description: 'Item unit of measurement. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitPrice: - description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - - - Max length: 12 characters.' - type: string - enhancedSchemeData.orderDate: - description: 'Order date. - - * Format: `ddMMyy` - - - Encoding: ASCII. - - - Max length: 6 characters.' - type: string - enhancedSchemeData.shipFromPostalCode: - description: 'The postal code of a "ship-from" address. - - - Encoding: ASCII. - - - Max length: 10 characters.' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - AdditionalDataLodging: - properties: - lodging.checkInDate: - description: 'The arrival date. - - * Date format: `yyyyMMdd`' - type: string - lodging.checkOutDate: - description: 'The departure date. - - * Date format: `yyyyMMdd`' - type: string - lodging.customerServiceTollFreeNumber: - description: 'The toll free phone number for the hotel/lodgings. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.fireSafetyActIndicator: - description: 'Identifies that the facility complies with the Hotel and Motel - Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. - - * Format: Alphabetic - - * maxLength: 1' - type: string - lodging.folioCashAdvances: - description: 'The folio cash advances. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.folioNumber: - description: "Card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Format: Alphanumeric\n* maxLength: 25" - type: string - lodging.foodBeverageCharges: - description: 'Any charges for food and beverages associated with the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - - Value should be Y or N. - - * Format: Numeric - - * maxLength: 1' - type: string - lodging.prepaidExpenses: - description: 'Prepaid expenses for the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.propertyPhoneNumber: - description: 'Identifies specific lodging property location by its local - phone number. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.room1.numberOfNights: - description: 'Total number of nights the room will be rented. - - * Format: Numeric - - * maxLength: 4' - type: string - lodging.room1.rate: - description: 'The rate of the room. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.room1.tax: - description: 'The total amount of tax to be paid. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalRoomTax: - description: 'Total room tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalTax: - description: 'Total tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "H" for Hotel. This should be included - in the auth message. - - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.merchantData: - description: 'Holds different merchant data points like product, purchase, - customer, and so on. It takes data in a Base64 encoded string. - - - The `merchantData` parameter needs to be added to the `openinvoicedata` - signature at the end. - - - Since the field is optional, if it''s not included it does not impact - computing the merchant signature. - - - Applies only to Klarna. - - - You can contact Klarna for the format and structure of the string.' - type: string - openinvoicedata.numberOfLines: - description: 'The number of invoice lines included in `openinvoicedata`. - - - There needs to be at least one line, so `numberOfLines` needs to be at - least 1.' - type: string - openinvoicedataLine[itemNr].currencyCode: - description: The three-character ISO currency code. - type: string - openinvoicedataLine[itemNr].description: - description: A text description of the product the invoice line refers to. - type: string - openinvoicedataLine[itemNr].itemAmount: - description: 'The price for one item in the invoice line, represented in - minor units. - - - The due amount for the item, VAT excluded.' - type: string - openinvoicedataLine[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. - type: string - openinvoicedataLine[itemNr].itemVatAmount: - description: The VAT due for one item in the invoice line, represented in - minor units. - type: string - openinvoicedataLine[itemNr].itemVatPercentage: - description: 'The VAT percentage for one item in the invoice line, represented - in minor units. - - - For example, 19% VAT is specified as 1900.' - type: string - openinvoicedataLine[itemNr].numberOfItems: - description: The number of units purchased of a specific product. - type: string - openinvoicedataLine[itemNr].returnShippingCompany: - description: Name of the shipping company handling the the return shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingNumber: - description: The tracking number for the return of the shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingUri: - description: URI where the customer can track the return of their shipment. - type: string - openinvoicedataLine[itemNr].shippingCompany: - description: Name of the shipping company handling the delivery. - type: string - openinvoicedataLine[itemNr].shippingMethod: - description: Shipping method. - type: string - openinvoicedataLine[itemNr].trackingNumber: - description: The tracking number for the shipment. - type: string - openinvoicedataLine[itemNr].trackingUri: - description: URI where the customer can track their shipment. - type: string - AdditionalDataOpi: - properties: - opi.includeTransToken: - description: 'Optional boolean indicator. Set to **true** if you want an - ecommerce transaction to return an `opi.transToken` as additional data - in the response. - - - You can store this Oracle Payment Interface token in your Oracle Opera - database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' - type: string - AdditionalDataPayout: - properties: - fundingNetwork: - description: '' - type: string - fundingSource: - description: '' - enum: - - CREDIT - - DEBIT - - PREPAID - - DEPOSIT_ACCOUNT - type: string - fundingTransactionId: - description: '' - type: string - payoutAccountCode: - description: '' - type: string - payoutAccountHolderCode: - description: '' - type: string - payoutMarketPayUser: - description: '' - type: string - processOver: - description: '' - enum: - - MC_P2P - - Visa_OCT - - UnlinkedRefund - type: string - verifyOver: - description: '' - type: string - walletIdentifier: - description: '' - type: string - AdditionalDataRatepay: - properties: - ratepay.installmentAmount: - description: Amount the customer has to pay each month. - type: string - ratepay.interestRate: - description: Interest rate of this installment. - type: string - ratepay.lastInstallmentAmount: - description: Amount of the last installment. - type: string - ratepay.paymentFirstday: - description: Calendar day of the first payment. - type: string - ratepaydata.deliveryDate: - description: Date the merchant delivered the goods to the customer. - type: string - ratepaydata.dueDate: - description: Date by which the customer must settle the payment. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. - type: string - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - AdditionalDataRetry: - properties: - retry.chainAttemptNumber: - description: 'The number of times the transaction (not order) has been retried - between different payment service providers. For instance, the `chainAttemptNumber` - set to 2 means that this transaction has been recently tried on another - provider before being sent to Adyen. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.orderAttemptNumber: - description: 'The index of the attempt to bill a particular order, which - is identified by the `merchantOrderReference` field. For example, if a - recurring transaction fails and is retried one day later, then the order - number for these attempts would be 1 and 2, respectively. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.skipRetry: - description: 'The Boolean value indicating whether Adyen should skip or - retry this transaction, if possible. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - AdditionalDataRisk: - properties: - riskdata.[customFieldName]: - description: The data for your custom risk field. For more information, - refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). - type: string - riskdata.basket.item[itemNr].amountPerItem: - description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.basket.item[itemNr].brand: - description: Brand of the item. - type: string - riskdata.basket.item[itemNr].category: - description: Category of the item. - type: string - riskdata.basket.item[itemNr].color: - description: Color of the item. - type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string - riskdata.basket.item[itemNr].quantity: - description: Quantity of the item purchased. - type: string - riskdata.basket.item[itemNr].receiverEmail: - description: Email associated with the given product in the basket (usually - in electronic gift cards). - type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.promotions.promotion[itemNr].promotionCode: - description: Code of the promotion. - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountAmount: - description: The discount amount of the promotion, represented in [minor - units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: - description: 'Promotion''s percentage discount. It is represented in percentage - value and there is no need to include the ''%'' sign. - - - e.g. for a promotion discount of 30%, the value of the field should be - 30.' - type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string - riskdata.riskProfileReference: - description: Reference number of the risk profile that you want to apply - to the payment. If not provided or left blank, the merchant-level account's - default risk profile will be applied to the payment. For more information, - see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). - type: string - riskdata.skipRisk: - description: If this parameter is provided with the value **true**, risk - checks for the payment request are skipped and the transaction will not - get a risk score. - type: string - AdditionalDataRiskStandalone: - properties: - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.ProtectionEligibility: - description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ - \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ - \ \u2014 Merchant is not protected under the Seller Protection Policy." - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - avsResultRaw: - description: 'Raw AVS result received from the acquirer, where available. - Example: D' - type: string - bin: - description: The Bank Identification Number of a credit card, which is the - first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). - type: string - cvcResultRaw: - description: 'Raw CVC result received from the acquirer, where available. - Example: 1' - type: string - riskToken: - description: Unique identifier or token for the shopper's card details. - type: string - threeDAuthenticated: - description: 'A Boolean value indicating whether 3DS authentication was - completed on this payment. Example: true' - type: string - threeDOffered: - description: 'A Boolean value indicating whether 3DS was offered for this - payment. Example: true' - type: string - tokenDataType: - description: 'Required for PayPal payments only. The only supported value - is: **paypal**.' - type: string - AdditionalDataSubMerchant: - properties: - subMerchant.numberOfSubSellers: - description: Required for transactions performed by registered payment facilitators. - Indicates the number of sub-merchants contained in the request. For example, - **3**. - type: string - subMerchant.subSeller[subSellerNr].city: - description: 'Required for transactions performed by registered payment - facilitators. The city of the sub-merchant''s address. - - * Format: Alphanumeric - - * Maximum length: 13 characters' - type: string - subMerchant.subSeller[subSellerNr].country: - description: "Required for transactions performed by registered payment\ - \ facilitators. The three-letter country code of the sub-merchant's address.\ - \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ - * Fixed length: 3 characters" - type: string - subMerchant.subSeller[subSellerNr].id: - description: "Required for transactions performed by registered payment\ - \ facilitators. A unique identifier that you create for the sub-merchant,\ - \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ - * Maximum length: 15 characters" - type: string - subMerchant.subSeller[subSellerNr].mcc: - description: "Required for transactions performed by registered payment\ - \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ - \ \n* Format: Numeric\n* Fixed length: 4 digits" - type: string - subMerchant.subSeller[subSellerNr].name: - description: 'Required for transactions performed by registered payment - facilitators. The name of the sub-merchant. Based on scheme specifications, - this value will overwrite the shopper statement that will appear in the - card statement. - - * Format: Alphanumeric - - * Maximum length: 22 characters' - type: string - subMerchant.subSeller[subSellerNr].postalCode: - description: 'Required for transactions performed by registered payment - facilitators. The postal code of the sub-merchant''s address, without - dashes. - - * Format: Numeric - - * Fixed length: 8 digits' - type: string - subMerchant.subSeller[subSellerNr].state: - description: 'Required for transactions performed by registered payment - facilitators. The state code of the sub-merchant''s address, if applicable - to the country. - - * Format: Alphanumeric - - * Maximum length: 2 characters' - type: string - subMerchant.subSeller[subSellerNr].street: - description: 'Required for transactions performed by registered payment - facilitators. The street name and house number of the sub-merchant''s - address. - - * Format: Alphanumeric - - * Maximum length: 60 characters' - type: string - subMerchant.subSeller[subSellerNr].taxId: - description: 'Required for transactions performed by registered payment - facilitators. The tax ID of the sub-merchant. - - * Format: Numeric - - * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' - type: string - AdditionalDataTemporaryServices: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - * Encoding: ASCII - - * maxLength: 25' - type: string - enhancedSchemeData.employeeName: - description: 'Name or ID associated with the individual working in a temporary - capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.jobDescription: - description: 'Description of the job or task of the individual working in - a temporary capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.regularHoursRate: - description: 'Amount paid per regular hours worked, minor units. - - * maxLength: 7' - type: string - enhancedSchemeData.regularHoursWorked: - description: 'Amount of time worked during a normal operation for the task - or job. - - * maxLength: 7' - type: string - enhancedSchemeData.requestName: - description: 'Name of the individual requesting temporary services. - - * maxLength: 40' - type: string - enhancedSchemeData.tempStartDate: - description: 'Date for the beginning of the pay period. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.tempWeekEnding: - description: 'Date of the end of the billing cycle. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. For example, 2000 means - USD 20.00 - - * maxLength: 12' - type: string - AdditionalDataWallets: - properties: - androidpay.token: - description: The Android Pay token retrieved from the SDK. - type: string - masterpass.transactionId: - description: The Mastercard Masterpass Transaction ID retrieved from the - SDK. - type: string - payment.token: - description: The Apple Pay token retrieved from the SDK. - type: string - paywithgoogle.token: - description: The Google Pay token retrieved from the SDK. - type: string - samsungpay.token: - description: The Samsung Pay token retrieved from the SDK. - type: string - visacheckout.callId: - description: The Visa Checkout Call ID retrieved from the SDK. - type: string Address: properties: city: @@ -1980,21 +563,6 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string - BrowserInfo: - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - userAgent - - acceptHeader Card: properties: cvc: @@ -2063,49 +631,6 @@ components: - expiryMonth - expiryYear - holderName - ForexQuote: - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - description: The base amount. - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - description: The buy rate. - $ref: '#/components/schemas/Amount' - interbank: - description: The interbank amount. - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - description: The sell rate. - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - validTill - - basePoints FraudCheckResult: properties: accountScore: @@ -2163,82 +688,6 @@ components: telephoneNumber: description: Phone number of the person type: string - Installments: - properties: - value: - description: 'Defines the number of installments. Its value needs to be - greater than zero. - - - Usually, the maximum allowed number of installments is capped. For example, - it may not be possible to split a payment in more than 24 installments. - The acquirer sets this upper limit, so its value may vary.' - format: int32 - type: integer - required: - - value - Mandate: - properties: - amount: - description: The billing amount (in minor units) of the recurring transactions. - type: string - amountRule: - description: "The limitation rule of the billing amount.\n\nPossible values:\n\ - \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ - \ **exact**: The transaction amount should be the same as the `amount`.\n\ - \n" - enum: - - max - - exact - type: string - billingAttemptsRule: - description: "The rule to specify the period, within which the recurring\ - \ debit can happen, relative to the mandate recurring date.\n\nPossible\ - \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ - \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ - \n" - enum: - - 'on' - - before - - after - type: string - billingDay: - description: 'The number of the day, on which the recurring debit can happen. - Should be within the same calendar month as the mandate recurring date. - - - Possible values: 1-31 based on the `frequency`.' - type: string - endsAt: - description: End date of the billing plan, in YYYY-MM-DD format. - type: string - frequency: - description: 'The frequency with which a shopper should be charged. - - - Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, - **halfYearly**, **yearly**.' - enum: - - adhoc - - daily - - weekly - - biWeekly - - monthly - - quarterly - - halfYearly - - yearly - type: string - remarks: - description: The message shown by UPI to the shopper on the approval screen. - type: string - startsAt: - description: Start date of the billing plan, in YYYY-MM-DD format. By default, - the transaction date. - type: string - required: - - frequency - - amount - - endsAt ModifyRequest: properties: additionalData: @@ -3625,53 +2074,6 @@ components: required: - pspReference - resultCode - ThreeDSecureData: - properties: - authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. - - - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' - enum: - - Y - - N - - U - - A - type: string - cavv: - description: The cardholder authentication value (base64 encoded, 20 bytes - in a decoded form). - format: byte - type: string - cavvAlgorithm: - description: The CAVV algorithm used. Include this only for 3D Secure 1. - type: string - directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. - - - In 3D Secure 2, this is the `transStatus` from the `ARes`.' - enum: - - A - - C - - D - - I - - N - - R - - U - - Y - type: string - eci: - description: The electronic commerce indicator. - type: string - xid: - description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, - 20 bytes in a decoded form). - format: byte - type: string securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml index d17ca4b..695eaa4 100644 --- a/yaml/PayoutService-v40.yaml +++ b/yaml/PayoutService-v40.yaml @@ -40,7 +40,7 @@ info: ' - x-timestamp: '2022-05-03T09:24:06Z' + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -59,7 +59,7 @@ paths: post: tags: - Reviewing - summary: Confirms a payout. + summary: Confirm a payout description: 'Confirms a previously submitted payout. @@ -126,7 +126,7 @@ paths: post: tags: - Reviewing - summary: Cancels a payout. + summary: Cancel a payout description: 'Cancels a previously submitted payout. @@ -193,7 +193,7 @@ paths: post: tags: - Instant payouts - summary: Pay out directly. + summary: Make an instant card payout description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card @@ -259,7 +259,7 @@ paths: post: tags: - Initialization - summary: Stores payout details. + summary: Store payout details description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call. @@ -324,7 +324,7 @@ paths: post: tags: - Initialization - summary: Stores details and submits a payout. + summary: Store details and submit a payout description: 'Submits a payout and stores its details for subsequent payouts. @@ -397,7 +397,7 @@ paths: post: tags: - Initialization - summary: Submits a payout. + summary: Submit a payout description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -461,1579 +461,6 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: - AccountInfo: - properties: - accountAgeIndicator: - description: 'Indicator for the length of time since this shopper account - was created in the merchant''s environment. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountChangeDate: - description: Date when the shopper's account was last changed. - format: date-time - type: string - accountChangeIndicator: - description: 'Indicator for the length of time since the shopper''s account - was last updated. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountCreationDate: - description: Date when the shopper's account was created. - format: date-time - type: string - addCardAttemptsDay: - description: Number of attempts the shopper tried to add a card to their - account in the last day. - format: int32 - type: integer - deliveryAddressUsageDate: - description: Date the selected delivery address was first used. - format: date-time - type: string - deliveryAddressUsageIndicator: - description: 'Indicator for the length of time since this delivery address - was first used. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - homePhone: - description: Shopper's home phone number (including the country code). - type: string - mobilePhone: - description: Shopper's mobile phone number (including the country code). - type: string - passwordChangeDate: - description: Date when the shopper last changed their password. - format: date-time - type: string - passwordChangeIndicator: - description: 'Indicator when the shopper has changed their password. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - pastTransactionsDay: - description: Number of all transactions (successful and abandoned) from - this shopper in the past 24 hours. - format: int32 - type: integer - pastTransactionsYear: - description: Number of all transactions (successful and abandoned) from - this shopper in the past year. - format: int32 - type: integer - paymentAccountAge: - description: Date this payment method was added to the shopper's account. - format: date-time - type: string - paymentAccountIndicator: - description: 'Indicator for the length of time since this payment method - was added to this shopper''s account. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - purchasesLast6Months: - description: Number of successful purchases in the last six months. - format: int32 - type: integer - suspiciousActivity: - description: Whether suspicious activity was recorded on this account. - type: boolean - workPhone: - description: Shopper's work phone number (including the country code). - type: string - AdditionalData3DSecure: - properties: - allow3DS2: - description: "Indicates if you are able to process 3D Secure 2 transactions\ - \ natively on your payment page. Send this parameter when you are using\ - \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ - \n > This parameter only indicates readiness to support native 3D Secure\ - \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ - \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ - \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ - \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" - type: string - executeThreeD: - description: "Indicates if you want to perform 3D Secure authentication\ - \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ - \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ - \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ - \ 3D Secure authentication. Note that this setting results in refusals\ - \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ - \ national regulations. \n" - type: string - mpiImplementationType: - description: In case of Secure+, this field must be set to **CUPSecurePlus**. - type: string - scaExemption: - description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction.\n\n Possible values:\n\ - * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ - \ **transactionRiskAnalysis** " - type: string - threeDSVersion: - description: "Indicates your preference for the 3D Secure version. \n> If\ - \ you use this parameter, you override the checks from Adyen's Authentication\ - \ Engine. We recommend to use this field only if you have an extensive\ - \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ - \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ - \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ - \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ - \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ - \ in the `ARes`, we will apply the fallback policy configured in your\ - \ account. For example, if the configuration is to fall back to 3D Secure\ - \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ - \ the BIN is not enrolled, you will receive an error.\n\n" - type: string - AdditionalDataAirline: - properties: - airline.agency_invoice_number: - description: 'Reference number for the invoice, issued by the agency. - - * minLength: 1 - - * maxLength: 6' - type: string - airline.agency_plan_name: - description: '2-letter agency plan identifier; alphabetical. - - * minLength: 2 - - * maxLength: 2' - type: string - airline.airline_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit - accounting code (PAX); numeric. It identifies the carrier. - - * Format: IATA 3-digit accounting code (PAX) - - * Example: KLM = 074 - - * minLength: 3 - - * maxLength: 3' - type: string - airline.airline_designator_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.boarding_fee: - description: 'Chargeable amount for boarding the plane. - - The transaction amount needs to be represented in minor units according - to the [following table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 18' - type: string - airline.computerized_reservation_system: - description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) - used to make the reservation and purchase the ticket. - - * Format: alphanumeric. - - * minLength: 4 - - * maxLength: 4' - type: string - airline.customer_reference_number: - description: 'Reference number; alphanumeric. - - * minLength: 0 - - * maxLength: 20' - type: string - airline.document_type: - description: 'Optional 2-digit code; alphanumeric. It identifies the type - of product of the transaction. The description of the code may appear - on credit card statements. - - * Format: 2-digit code - - * Example: Passenger ticket = 01 - - * minLength: 2 - - * maxLength: 2' - type: string - airline.flight_date: - description: 'Flight departure date. Local time `(HH:mm)` is optional. - - * Date format: `yyyy-MM-dd` - - * Date and time format: `yyyy-MM-dd HH:mm` - - * minLength: 10 - - * maxLength: 16' - type: string - airline.leg.carrier_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - This field is required/mandatory if the airline data includes leg details. - - * Format: IATA 2-letter airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.leg.class_of_travel: - description: '1-letter travel class identifier; alphabetical. There is no - standard; however, the following codes are used rather consistently: - - * F: first class - - * J: business class - - * Y: economy class - - * W: premium economy - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_airport: - description: 'Alphabetical identifier of the departure airport. - - This field is required if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.depart_tax: - description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). - Amount charged by a country to an individual upon their leaving. The transaction - amount needs to be represented in minor units according to the [following - table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 12' - type: string - airline.leg.destination_code: - description: 'Alphabetical identifier of the destination/arrival airport. - - This field is required/mandatory if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.fare_base_code: - description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); - alphanumeric. - - * minLength: 1 - - * maxLength: 7' - type: string - airline.leg.flight_number: - description: 'The flight identifier. - - * minLength: 1 - - * maxLength: 5' - type: string - airline.leg.stop_over_code: - description: '1-letter code that indicates whether the passenger is entitled - to make a stopover. Only two types of characters are allowed: - - * O: Stopover allowed - - * X: Stopover not allowed - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.passenger.date_of_birth: - description: 'Date of birth of the passenger. - - - Date format: `yyyy-MM-dd` - - * minLength: 10 - - * maxLength: 10' - type: string - airline.passenger.first_name: - description: 'Passenger first name/given name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.last_name: - description: 'Passenger last name/family name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.telephone_number: - description: 'Telephone number of the passenger, including country code. - This is an alphanumeric field that can include the ''+'' and ''-'' signs. - - * minLength: 3 - - * maxLength: 30' - type: string - airline.passenger.traveller_type: - description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. - Example: ADT, SRC, CNN, INS. - - - However, several carriers use non-standard codes that can be up to 5 alphanumeric - characters. - - * minLength: 3 - - * maxLength: 6' - type: string - airline.passenger_name: - description: 'Passenger name, initials, and a title. - - * Format: last name + first name or initials + title. - - * Example: *FLYER / MARY MS*. - - * minLength: 1 - - * maxLength: 49' - type: string - airline.ticket_issue_address: - description: 'Address of the place/agency that issued the ticket. - - * minLength: 0 - - * maxLength: 16' - type: string - airline.ticket_number: - description: 'The ticket''s unique identifier. - - * minLength: 1 - - * maxLength: 150' - type: string - airline.travel_agency_code: - description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier - number for travel agencies. - - * minLength: 1 - - * maxLength: 8' - type: string - airline.travel_agency_name: - description: 'The name of the travel agency. - - * minLength: 1 - - * maxLength: 25' - type: string - required: - - airline.passenger_name - AdditionalDataCarRental: - properties: - carRental.checkOutDate: - description: 'Pick-up date. - - * Date format: `yyyyMMdd`' - type: string - carRental.customerServiceTollFreeNumber: - description: 'The customer service phone number of the car rental company. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - carRental.daysRented: - description: 'Number of days for which the car is being rented. - - * Format: Numeric - - * maxLength: 19' - type: string - carRental.fuelCharges: - description: 'Any fuel charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.insuranceCharges: - description: 'Any insurance charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.locationCity: - description: 'The city from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.locationCountry: - description: 'The country from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.locationStateProvince: - description: 'The state or province from where the car is rented. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - * Y - Customer was a no show. - - * N - Not applicable.' - type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. - type: string - carRental.rate: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.rateIndicator: - description: 'Specifies whether the given rate is applied daily or weekly. - - * D - Daily rate. - - * W - Weekly rate.' - type: string - carRental.rentalAgreementNumber: - description: 'The rental agreement number associated with this car rental. - - * Format: Alphanumeric - - * maxLength: 9' - type: string - carRental.rentalClassId: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.renterName: - description: 'The name of the person renting the car. - - * Format: Alphanumeric - - * maxLength: 26' - type: string - carRental.returnCity: - description: 'The city where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.returnCountry: - description: 'The country where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.returnDate: - description: 'The last date to return the car by. - - * Date format: `yyyyMMdd`' - type: string - carRental.returnLocationId: - description: 'Agency code, phone number, or address abbreviation - - * Format: Alphanumeric - - * maxLength: 10' - type: string - carRental.returnStateProvince: - description: 'The state or province where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.taxExemptIndicator: - description: 'Indicates whether the goods or services were tax-exempt, or - tax was not collected. - - - Values: - - * Y - Goods or services were tax exempt - - * N - Tax was not collected' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "A" for Car rental. This should be - included in the auth message. - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataCommon: - properties: - RequestedTestErrorResponseCode: - description: "Triggers test scenarios that allow to replicate certain communication\ - \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ - \ wasn't a connection available to service the outgoing communication.\n\ - This is a transient, retriable error since no messaging could be initiated\ - \ to an issuing system (or third-party acquiring system). Therefore, the\ - \ header Transient-Error: true is returned in the response. A subsequent\ - \ request using the same idempotency key will be processed as if it was\ - \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ - \ wrong during transmission of the message or receiving the response.\n\ - This is a classified as non-transient because the message could have been\ - \ received by the issuing party and been acted upon. No transient error\ - \ header is returned. If using idempotency, the (error) response is stored\ - \ as the final result for the idempotency key. Subsequent messages with\ - \ the same idempotency key not be processed beyond returning the stored\ - \ response." - type: string - authorisationType: - description: "Flags a card payment request for either pre-authorisation\ - \ or final authorisation. For more information, refer to [Authorisation\ - \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ - \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ - \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ - \ request to be handled as a final authorisation." - type: string - customRoutingFlag: - description: 'Allows you to determine or override the acquirer account that - should be used for the transaction. - - - If you need to process a payment with an acquirer different from a default - one, you can set up a corresponding configuration on the Adyen payments - platform. Then you can pass a custom routing flag in a payment request''s - additional data to target a specific acquirer. - - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' - type: string - industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge - description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ - \ this field denotes why the additional payment is made.\n\nPossible values:\n\ - \n * **NoShow**: An incremental charge is carried out because of a no-show\ - \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ - \ charge is carried out to process an additional payment after the original\ - \ services have been rendered and the respective payment has been processed." - enum: - - NoShow - - DelayedCharge - type: string - networkTxReference: - description: 'Allows you to link the transaction to the original or previous - one in a subscription/card-on-file chain. This field is required for token-based - transactions where Adyen does not tokenize the card. - - - Transaction identifier from card schemes, for example, Mastercard Trace - ID or the Visa Transaction ID. - - - Submit the original transaction ID of the contract in your payment request - if you are not tokenizing card details with Adyen and are making a merchant-initiated - transaction (MIT) for subsequent charges. - - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` - **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction - is classified as MIT.' - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - subMerchantCity: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the city of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 13 characters.' - type: string - subMerchantCountry: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the three-letter - country code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Fixed length: 3 characters.' - type: string - subMerchantID: - description: 'This field contains an identifier of the actual merchant when - a transaction is submitted via a payment facilitator. The payment facilitator - must send in this unique ID. - - - A unique identifier per submerchant that is required if the transaction - is performed by a registered payment facilitator. - - * Format: alpha-numeric. - - * Fixed length: 15 characters.' - type: string - subMerchantName: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the name of - the actual merchant. - - * Format: alpha-numeric. - - * Maximum length: 22 characters.' - type: string - subMerchantPostalCode: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the postal code - of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 10 characters.' - type: string - subMerchantState: - description: 'This field is required if the transaction is performed by - a registered payment facilitator, and if applicable to the country. This - field must contain the state code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 3 characters.' - type: string - subMerchantStreet: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the street of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 60 characters.' - type: string - subMerchantTaxId: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the tax ID of - the actual merchant. - - * Format: alpha-numeric. - - * Fixed length: 11 or 14 characters.' - type: string - AdditionalDataLevel23: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - - Encoding: ASCII. - - - Max length: 25 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - enhancedSchemeData.destinationCountryCode: - description: 'Destination country code. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.destinationPostalCode: - description: 'The postal code of a destination address. - - - Encoding: ASCII. - - - Max length: 10 characters. - - - > Required for American Express.' - type: string - enhancedSchemeData.destinationStateProvinceCode: - description: 'Destination state or province code. - - - Encoding: ASCII.Max length: 3 characters.' - type: string - enhancedSchemeData.dutyAmount: - description: 'Duty amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.freightAmount: - description: 'Shipping amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].commodityCode: - description: 'Item commodity code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].description: - description: 'Item description. - - - Encoding: ASCII. - - - Max length: 26 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: - description: 'Discount amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].productCode: - description: 'Product code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].quantity: - description: 'Quantity, specified as an integer value. - - - Value must be greater than 0. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: - description: 'Total amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: - description: 'Item unit of measurement. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitPrice: - description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - - - Max length: 12 characters.' - type: string - enhancedSchemeData.orderDate: - description: 'Order date. - - * Format: `ddMMyy` - - - Encoding: ASCII. - - - Max length: 6 characters.' - type: string - enhancedSchemeData.shipFromPostalCode: - description: 'The postal code of a "ship-from" address. - - - Encoding: ASCII. - - - Max length: 10 characters.' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - AdditionalDataLodging: - properties: - lodging.checkInDate: - description: 'The arrival date. - - * Date format: `yyyyMMdd`' - type: string - lodging.checkOutDate: - description: 'The departure date. - - * Date format: `yyyyMMdd`' - type: string - lodging.customerServiceTollFreeNumber: - description: 'The toll free phone number for the hotel/lodgings. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.fireSafetyActIndicator: - description: 'Identifies that the facility complies with the Hotel and Motel - Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. - - * Format: Alphabetic - - * maxLength: 1' - type: string - lodging.folioCashAdvances: - description: 'The folio cash advances. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.folioNumber: - description: "Card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Format: Alphanumeric\n* maxLength: 25" - type: string - lodging.foodBeverageCharges: - description: 'Any charges for food and beverages associated with the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - - Value should be Y or N. - - * Format: Numeric - - * maxLength: 1' - type: string - lodging.prepaidExpenses: - description: 'Prepaid expenses for the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.propertyPhoneNumber: - description: 'Identifies specific lodging property location by its local - phone number. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.room1.numberOfNights: - description: 'Total number of nights the room will be rented. - - * Format: Numeric - - * maxLength: 4' - type: string - lodging.room1.rate: - description: 'The rate of the room. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.room1.tax: - description: 'The total amount of tax to be paid. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalRoomTax: - description: 'Total room tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalTax: - description: 'Total tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "H" for Hotel. This should be included - in the auth message. - - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.merchantData: - description: 'Holds different merchant data points like product, purchase, - customer, and so on. It takes data in a Base64 encoded string. - - - The `merchantData` parameter needs to be added to the `openinvoicedata` - signature at the end. - - - Since the field is optional, if it''s not included it does not impact - computing the merchant signature. - - - Applies only to Klarna. - - - You can contact Klarna for the format and structure of the string.' - type: string - openinvoicedata.numberOfLines: - description: 'The number of invoice lines included in `openinvoicedata`. - - - There needs to be at least one line, so `numberOfLines` needs to be at - least 1.' - type: string - openinvoicedataLine[itemNr].currencyCode: - description: The three-character ISO currency code. - type: string - openinvoicedataLine[itemNr].description: - description: A text description of the product the invoice line refers to. - type: string - openinvoicedataLine[itemNr].itemAmount: - description: 'The price for one item in the invoice line, represented in - minor units. - - - The due amount for the item, VAT excluded.' - type: string - openinvoicedataLine[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. - type: string - openinvoicedataLine[itemNr].itemVatAmount: - description: The VAT due for one item in the invoice line, represented in - minor units. - type: string - openinvoicedataLine[itemNr].itemVatPercentage: - description: 'The VAT percentage for one item in the invoice line, represented - in minor units. - - - For example, 19% VAT is specified as 1900.' - type: string - openinvoicedataLine[itemNr].numberOfItems: - description: The number of units purchased of a specific product. - type: string - openinvoicedataLine[itemNr].returnShippingCompany: - description: Name of the shipping company handling the the return shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingNumber: - description: The tracking number for the return of the shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingUri: - description: URI where the customer can track the return of their shipment. - type: string - openinvoicedataLine[itemNr].shippingCompany: - description: Name of the shipping company handling the delivery. - type: string - openinvoicedataLine[itemNr].shippingMethod: - description: Shipping method. - type: string - openinvoicedataLine[itemNr].trackingNumber: - description: The tracking number for the shipment. - type: string - openinvoicedataLine[itemNr].trackingUri: - description: URI where the customer can track their shipment. - type: string - AdditionalDataOpi: - properties: - opi.includeTransToken: - description: 'Optional boolean indicator. Set to **true** if you want an - ecommerce transaction to return an `opi.transToken` as additional data - in the response. - - - You can store this Oracle Payment Interface token in your Oracle Opera - database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' - type: string - AdditionalDataPayout: - properties: - fundingNetwork: - description: '' - type: string - fundingSource: - description: '' - enum: - - CREDIT - - DEBIT - - PREPAID - - DEPOSIT_ACCOUNT - type: string - fundingTransactionId: - description: '' - type: string - payoutAccountCode: - description: '' - type: string - payoutAccountHolderCode: - description: '' - type: string - payoutMarketPayUser: - description: '' - type: string - processOver: - description: '' - enum: - - MC_P2P - - Visa_OCT - - UnlinkedRefund - type: string - verifyOver: - description: '' - type: string - walletIdentifier: - description: '' - type: string - AdditionalDataRatepay: - properties: - ratepay.installmentAmount: - description: Amount the customer has to pay each month. - type: string - ratepay.interestRate: - description: Interest rate of this installment. - type: string - ratepay.lastInstallmentAmount: - description: Amount of the last installment. - type: string - ratepay.paymentFirstday: - description: Calendar day of the first payment. - type: string - ratepaydata.deliveryDate: - description: Date the merchant delivered the goods to the customer. - type: string - ratepaydata.dueDate: - description: Date by which the customer must settle the payment. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. - type: string - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - AdditionalDataRetry: - properties: - retry.chainAttemptNumber: - description: 'The number of times the transaction (not order) has been retried - between different payment service providers. For instance, the `chainAttemptNumber` - set to 2 means that this transaction has been recently tried on another - provider before being sent to Adyen. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.orderAttemptNumber: - description: 'The index of the attempt to bill a particular order, which - is identified by the `merchantOrderReference` field. For example, if a - recurring transaction fails and is retried one day later, then the order - number for these attempts would be 1 and 2, respectively. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.skipRetry: - description: 'The Boolean value indicating whether Adyen should skip or - retry this transaction, if possible. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - AdditionalDataRisk: - properties: - riskdata.[customFieldName]: - description: The data for your custom risk field. For more information, - refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). - type: string - riskdata.basket.item[itemNr].amountPerItem: - description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.basket.item[itemNr].brand: - description: Brand of the item. - type: string - riskdata.basket.item[itemNr].category: - description: Category of the item. - type: string - riskdata.basket.item[itemNr].color: - description: Color of the item. - type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string - riskdata.basket.item[itemNr].quantity: - description: Quantity of the item purchased. - type: string - riskdata.basket.item[itemNr].receiverEmail: - description: Email associated with the given product in the basket (usually - in electronic gift cards). - type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.promotions.promotion[itemNr].promotionCode: - description: Code of the promotion. - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountAmount: - description: The discount amount of the promotion, represented in [minor - units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: - description: 'Promotion''s percentage discount. It is represented in percentage - value and there is no need to include the ''%'' sign. - - - e.g. for a promotion discount of 30%, the value of the field should be - 30.' - type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string - riskdata.riskProfileReference: - description: Reference number of the risk profile that you want to apply - to the payment. If not provided or left blank, the merchant-level account's - default risk profile will be applied to the payment. For more information, - see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). - type: string - riskdata.skipRisk: - description: If this parameter is provided with the value **true**, risk - checks for the payment request are skipped and the transaction will not - get a risk score. - type: string - AdditionalDataRiskStandalone: - properties: - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.ProtectionEligibility: - description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ - \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ - \ \u2014 Merchant is not protected under the Seller Protection Policy." - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - avsResultRaw: - description: 'Raw AVS result received from the acquirer, where available. - Example: D' - type: string - bin: - description: The Bank Identification Number of a credit card, which is the - first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). - type: string - cvcResultRaw: - description: 'Raw CVC result received from the acquirer, where available. - Example: 1' - type: string - riskToken: - description: Unique identifier or token for the shopper's card details. - type: string - threeDAuthenticated: - description: 'A Boolean value indicating whether 3DS authentication was - completed on this payment. Example: true' - type: string - threeDOffered: - description: 'A Boolean value indicating whether 3DS was offered for this - payment. Example: true' - type: string - tokenDataType: - description: 'Required for PayPal payments only. The only supported value - is: **paypal**.' - type: string - AdditionalDataSubMerchant: - properties: - subMerchant.numberOfSubSellers: - description: Required for transactions performed by registered payment facilitators. - Indicates the number of sub-merchants contained in the request. For example, - **3**. - type: string - subMerchant.subSeller[subSellerNr].city: - description: 'Required for transactions performed by registered payment - facilitators. The city of the sub-merchant''s address. - - * Format: Alphanumeric - - * Maximum length: 13 characters' - type: string - subMerchant.subSeller[subSellerNr].country: - description: "Required for transactions performed by registered payment\ - \ facilitators. The three-letter country code of the sub-merchant's address.\ - \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ - * Fixed length: 3 characters" - type: string - subMerchant.subSeller[subSellerNr].id: - description: "Required for transactions performed by registered payment\ - \ facilitators. A unique identifier that you create for the sub-merchant,\ - \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ - * Maximum length: 15 characters" - type: string - subMerchant.subSeller[subSellerNr].mcc: - description: "Required for transactions performed by registered payment\ - \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ - \ \n* Format: Numeric\n* Fixed length: 4 digits" - type: string - subMerchant.subSeller[subSellerNr].name: - description: 'Required for transactions performed by registered payment - facilitators. The name of the sub-merchant. Based on scheme specifications, - this value will overwrite the shopper statement that will appear in the - card statement. - - * Format: Alphanumeric - - * Maximum length: 22 characters' - type: string - subMerchant.subSeller[subSellerNr].postalCode: - description: 'Required for transactions performed by registered payment - facilitators. The postal code of the sub-merchant''s address, without - dashes. - - * Format: Numeric - - * Fixed length: 8 digits' - type: string - subMerchant.subSeller[subSellerNr].state: - description: 'Required for transactions performed by registered payment - facilitators. The state code of the sub-merchant''s address, if applicable - to the country. - - * Format: Alphanumeric - - * Maximum length: 2 characters' - type: string - subMerchant.subSeller[subSellerNr].street: - description: 'Required for transactions performed by registered payment - facilitators. The street name and house number of the sub-merchant''s - address. - - * Format: Alphanumeric - - * Maximum length: 60 characters' - type: string - subMerchant.subSeller[subSellerNr].taxId: - description: 'Required for transactions performed by registered payment - facilitators. The tax ID of the sub-merchant. - - * Format: Numeric - - * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' - type: string - AdditionalDataTemporaryServices: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - * Encoding: ASCII - - * maxLength: 25' - type: string - enhancedSchemeData.employeeName: - description: 'Name or ID associated with the individual working in a temporary - capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.jobDescription: - description: 'Description of the job or task of the individual working in - a temporary capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.regularHoursRate: - description: 'Amount paid per regular hours worked, minor units. - - * maxLength: 7' - type: string - enhancedSchemeData.regularHoursWorked: - description: 'Amount of time worked during a normal operation for the task - or job. - - * maxLength: 7' - type: string - enhancedSchemeData.requestName: - description: 'Name of the individual requesting temporary services. - - * maxLength: 40' - type: string - enhancedSchemeData.tempStartDate: - description: 'Date for the beginning of the pay period. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.tempWeekEnding: - description: 'Date of the end of the billing cycle. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. For example, 2000 means - USD 20.00 - - * maxLength: 12' - type: string - AdditionalDataWallets: - properties: - androidpay.token: - description: The Android Pay token retrieved from the SDK. - type: string - masterpass.transactionId: - description: The Mastercard Masterpass Transaction ID retrieved from the - SDK. - type: string - payment.token: - description: The Apple Pay token retrieved from the SDK. - type: string - paywithgoogle.token: - description: The Google Pay token retrieved from the SDK. - type: string - samsungpay.token: - description: The Samsung Pay token retrieved from the SDK. - type: string - visacheckout.callId: - description: The Visa Checkout Call ID retrieved from the SDK. - type: string Address: properties: city: @@ -2088,32 +515,6 @@ components: required: - value - currency - ApplicationInfo: - properties: - adyenLibrary: - description: Adyen-developed software, such as libraries and plugins, used - to interact with the Adyen API. For example, Magento plugin, Java API - library, etc. - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - description: Adyen-developed software to get payment details. For example, - Checkout SDK, Secured Fields SDK, etc. - $ref: '#/components/schemas/CommonField' - externalPlatform: - description: Third-party developed platform used to initiate payment requests. - For example, Magento, Zuora, etc. - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - description: Merchant developed software, such as cashier application, used - to interact with the Adyen API. - $ref: '#/components/schemas/CommonField' - merchantDevice: - description: Merchant device information. - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - description: Shopper interaction device, such as terminal, mobile device - or web browser, to initiate payment requests. - $ref: '#/components/schemas/ShopperInteractionDevice' BankAccount: properties: bankAccountNumber: @@ -2162,67 +563,6 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string - BrowserInfo: - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - colorDepth: - x-addedInVersion: '40' - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - x-addedInVersion: '40' - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - x-addedInVersion: '40' - default: true - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - x-addedInVersion: '40' - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). - type: string - screenHeight: - x-addedInVersion: '40' - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - x-addedInVersion: '40' - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - x-addedInVersion: '40' - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - userAgent - - acceptHeader - - javaEnabled - - colorDepth - - screenHeight - - screenWidth - - timeZoneOffset - - language Card: properties: cvc: @@ -2291,109 +631,6 @@ components: - expiryMonth - expiryYear - holderName - CommonField: - properties: - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - DeviceRenderOptions: - properties: - sdkInterface: - default: both - description: 'Supported SDK interface types. - - Allowed values: - - * native - - * html - - * both' - enum: - - native - - html - - both - type: string - sdkUiType: - description: 'UI types supported for displaying specific challenges. - - Allowed values: - - * text - - * singleSelect - - * outOfBand - - * otherHtml - - * multiSelect' - items: - enum: - - multiSelect - - otherHtml - - outOfBand - - singleSelect - - text - type: string - type: array - ExternalPlatform: - properties: - integrator: - description: External platform integrator. - type: string - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - ForexQuote: - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - description: The base amount. - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - description: The buy rate. - $ref: '#/components/schemas/Amount' - interbank: - description: The interbank amount. - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - description: The sell rate. - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - validTill - - basePoints FraudCheckResult: properties: accountScore: @@ -2451,170 +688,6 @@ components: telephoneNumber: description: Phone number of the person type: string - Installments: - properties: - value: - description: 'Defines the number of installments. Its value needs to be - greater than zero. - - - Usually, the maximum allowed number of installments is capped. For example, - it may not be possible to split a payment in more than 24 installments. - The acquirer sets this upper limit, so its value may vary.' - format: int32 - type: integer - required: - - value - Mandate: - properties: - amount: - description: The billing amount (in minor units) of the recurring transactions. - type: string - amountRule: - description: "The limitation rule of the billing amount.\n\nPossible values:\n\ - \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ - \ **exact**: The transaction amount should be the same as the `amount`.\n\ - \n" - enum: - - max - - exact - type: string - billingAttemptsRule: - description: "The rule to specify the period, within which the recurring\ - \ debit can happen, relative to the mandate recurring date.\n\nPossible\ - \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ - \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ - \n" - enum: - - 'on' - - before - - after - type: string - billingDay: - description: 'The number of the day, on which the recurring debit can happen. - Should be within the same calendar month as the mandate recurring date. - - - Possible values: 1-31 based on the `frequency`.' - type: string - endsAt: - description: End date of the billing plan, in YYYY-MM-DD format. - type: string - frequency: - description: 'The frequency with which a shopper should be charged. - - - Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, - **halfYearly**, **yearly**.' - enum: - - adhoc - - daily - - weekly - - biWeekly - - monthly - - quarterly - - halfYearly - - yearly - type: string - remarks: - description: The message shown by UPI to the shopper on the approval screen. - type: string - startsAt: - description: Start date of the billing plan, in YYYY-MM-DD format. By default, - the transaction date. - type: string - required: - - frequency - - amount - - endsAt - MerchantDevice: - properties: - os: - description: Operating system running on the merchant device. - type: string - osVersion: - description: Version of the operating system on the merchant device. - type: string - reference: - description: Merchant device reference. - type: string - MerchantRiskIndicator: - properties: - addressMatch: - description: Whether the chosen delivery address is identical to the billing - address. - type: boolean - deliveryAddressIndicator: - description: 'Indicator regarding the delivery address. - - Allowed values: - - * `shipToBillingAddress` - - * `shipToVerifiedAddress` - - * `shipToNewAddress` - - * `shipToStore` - - * `digitalGoods` - - * `goodsNotShipped` - - * `other`' - enum: - - shipToBillingAddress - - shipToVerifiedAddress - - shipToNewAddress - - shipToStore - - digitalGoods - - goodsNotShipped - - other - type: string - deliveryEmail: - description: The delivery email address (for digital goods). - type: string - deliveryTimeframe: - description: 'The estimated delivery time for the shopper to receive the - goods. - - Allowed values: - - * `electronicDelivery` - - * `sameDayShipping` - - * `overnightShipping` - - * `twoOrMoreDaysShipping`' - enum: - - electronicDelivery - - sameDayShipping - - overnightShipping - - twoOrMoreDaysShipping - type: string - giftCardAmount: - description: For prepaid or gift card purchase, the purchase amount total - of prepaid or gift card(s). - $ref: '#/components/schemas/Amount' - giftCardCount: - description: For prepaid or gift card purchase, total count of individual - prepaid or gift cards/codes purchased. - format: int32 - type: integer - preOrderDate: - description: For pre-order purchases, the expected date this product will - be available to the shopper. - format: date-time - type: string - preOrderPurchase: - description: Indicator for whether this transaction is for pre-ordering - a product. - type: boolean - reorderItems: - description: Indicator for whether the shopper has already purchased the - same items in the past. - type: boolean ModifyRequest: properties: additionalData: @@ -3607,20 +1680,6 @@ components: Example: OOFF' type: string - SDKEphemPubKey: - properties: - crv: - description: The `crv` value as received from the 3D Secure 2 SDK. - type: string - kty: - description: The `kty` value as received from the 3D Secure 2 SDK. - type: string - x: - description: The `x` value as received from the 3D Secure 2 SDK. - type: string - y: - description: The `y` value as received from the 3D Secure 2 SDK. - type: string ServiceError: properties: errorCode: @@ -3639,80 +1698,6 @@ components: description: The HTTP response status. format: int32 type: integer - ShopperInteractionDevice: - properties: - locale: - description: Locale on the shopper interaction device. - type: string - os: - description: Operating system running on the shopper interaction device. - type: string - osVersion: - description: Version of the operating system on the shopper interaction - device. - type: string - Split: - properties: - account: - description: 'Unique identifier of the account where the split amount should - be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. - - - ' - type: string - amount: - description: The amount of this split. - $ref: '#/components/schemas/SplitAmount' - description: - description: A description of this split. - type: string - reference: - description: 'Your reference for the split, which you can use to link the - split to other operations such as captures and refunds. - - - This is required if `type` is **MarketPlace** or **BalanceAccount**. For - the other types, we also recommend sending a reference so you can reconcile - the split and the associated payment in the transaction overview and in - the reports. If the reference is not provided, the split is reported as - part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) - in Adyen for Platforms.' - type: string - type: - description: 'The type of split. - - Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, - **MarketPlace**, **BalanceAccount**, **Remainder**.' - enum: - - BalanceAccount - - Commission - - Default - - MarketPlace - - PaymentFee - - Remainder - - VAT - - Verification - type: string - required: - - amount - - type - SplitAmount: - properties: - currency: - description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - - - If this value is not provided, the currency in which the payment is made - will be used.' - maxLength: 3 - minLength: 3 - type: string - value: - description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). - format: int64 - type: integer - required: - - value StoreDetailAndSubmitRequest: properties: additionalData: @@ -4116,174 +2101,6 @@ components: required: - pspReference - resultCode - ThreeDS2RequestData: - properties: - authenticationOnly: - default: false - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - challengeIndicator: - description: 'Possibility to specify a preference for receiving a challenge - from the issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string - deviceChannel: - description: 'The environment of the shopper. - - Allowed values: - - * `app` - - * `browser`' - type: string - deviceRenderOptions: - description: 'Display options for the 3D Secure 2 SDK. - - Optional and only for `deviceChannel` **app**.' - $ref: '#/components/schemas/DeviceRenderOptions' - messageVersion: - default: 2.1.0 - description: The `messageVersion` value indicating the 3D Secure 2 protocol - version. - type: string - notificationURL: - description: URL to where the issuer should send the `CRes`. Required if - you are not using components for `channel` **Web** or if you are using - classic integration `deviceChannel` **browser**. - type: string - sdkAppID: - description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEncData: - description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEphemPubKey: - description: 'The `sdkEphemPubKey` value as received from the 3D Secure - 2 SDK. - - Required for `deviceChannel` set to **app**.' - $ref: '#/components/schemas/SDKEphemPubKey' - sdkMaxTimeout: - default: 60 - description: 'The maximum amount of time in minutes for the 3D Secure 2 - authentication process. - - Optional and only for `deviceChannel` set to **app**. Defaults to **60** - minutes.' - format: int32 - type: integer - sdkReferenceNumber: - description: 'The `sdkReferenceNumber` value as received from the 3D Secure - 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkTransID: - description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkVersion: - x-addedInVersion: '40' - description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ - \ set to **app**." - type: string - threeDSCompInd: - description: Completion indicator for the device fingerprinting. - type: string - threeDSRequestorID: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor identifier assigned by the Directory - Server when you enrol for 3D Secure 2. - type: string - threeDSRequestorName: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor name assigned by the Directory Server - when you enrol for 3D Secure 2. - type: string - threeDSRequestorURL: - description: URL of the (customer service) website that will be shown to - the shopper in case of technical errors during the 3D Secure 2 process. - type: string - required: - - deviceChannel - ThreeDSecureData: - properties: - authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. - - - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' - enum: - - Y - - N - - U - - A - type: string - cavv: - description: The cardholder authentication value (base64 encoded, 20 bytes - in a decoded form). - format: byte - type: string - cavvAlgorithm: - description: The CAVV algorithm used. Include this only for 3D Secure 1. - type: string - directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. - - - In 3D Secure 2, this is the `transStatus` from the `ARes`.' - enum: - - A - - C - - D - - I - - N - - R - - U - - Y - type: string - dsTransID: - x-addedInVersion: '40' - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the Directory Server (DS) to identify a single transaction. - type: string - eci: - description: The electronic commerce indicator. - type: string - threeDSVersion: - x-addedInVersion: '40' - description: The version of the 3D Secure protocol. - type: string - xid: - description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, - 20 bytes in a decoded form). - format: byte - type: string securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml index a4bd3b8..5a491e1 100644 --- a/yaml/PayoutService-v50.yaml +++ b/yaml/PayoutService-v50.yaml @@ -40,7 +40,7 @@ info: ' - x-timestamp: '2022-05-03T09:24:06Z' + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -59,7 +59,7 @@ paths: post: tags: - Reviewing - summary: Confirms a payout. + summary: Confirm a payout description: 'Confirms a previously submitted payout. @@ -126,7 +126,7 @@ paths: post: tags: - Reviewing - summary: Cancels a payout. + summary: Cancel a payout description: 'Cancels a previously submitted payout. @@ -193,7 +193,7 @@ paths: post: tags: - Instant payouts - summary: Pay out directly. + summary: Make an instant card payout description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card @@ -259,7 +259,7 @@ paths: post: tags: - Initialization - summary: Stores payout details. + summary: Store payout details description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call. @@ -324,7 +324,7 @@ paths: post: tags: - Initialization - summary: Stores details and submits a payout. + summary: Store details and submit a payout description: 'Submits a payout and stores its details for subsequent payouts. @@ -397,7 +397,7 @@ paths: post: tags: - Initialization - summary: Submits a payout. + summary: Submit a payout description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -461,1596 +461,6 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: - AccountInfo: - properties: - accountAgeIndicator: - description: 'Indicator for the length of time since this shopper account - was created in the merchant''s environment. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountChangeDate: - description: Date when the shopper's account was last changed. - format: date-time - type: string - accountChangeIndicator: - description: 'Indicator for the length of time since the shopper''s account - was last updated. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountCreationDate: - description: Date when the shopper's account was created. - format: date-time - type: string - accountType: - x-addedInVersion: '50' - description: 'Indicates the type of account. For example, for a multi-account - card product. - - Allowed values: - - * notApplicable - - * credit - - * debit' - enum: - - notApplicable - - credit - - debit - type: string - addCardAttemptsDay: - description: Number of attempts the shopper tried to add a card to their - account in the last day. - format: int32 - type: integer - deliveryAddressUsageDate: - description: Date the selected delivery address was first used. - format: date-time - type: string - deliveryAddressUsageIndicator: - description: 'Indicator for the length of time since this delivery address - was first used. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - homePhone: - description: Shopper's home phone number (including the country code). - type: string - mobilePhone: - description: Shopper's mobile phone number (including the country code). - type: string - passwordChangeDate: - description: Date when the shopper last changed their password. - format: date-time - type: string - passwordChangeIndicator: - description: 'Indicator when the shopper has changed their password. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - pastTransactionsDay: - description: Number of all transactions (successful and abandoned) from - this shopper in the past 24 hours. - format: int32 - type: integer - pastTransactionsYear: - description: Number of all transactions (successful and abandoned) from - this shopper in the past year. - format: int32 - type: integer - paymentAccountAge: - description: Date this payment method was added to the shopper's account. - format: date-time - type: string - paymentAccountIndicator: - description: 'Indicator for the length of time since this payment method - was added to this shopper''s account. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - purchasesLast6Months: - description: Number of successful purchases in the last six months. - format: int32 - type: integer - suspiciousActivity: - description: Whether suspicious activity was recorded on this account. - type: boolean - workPhone: - description: Shopper's work phone number (including the country code). - type: string - AdditionalData3DSecure: - properties: - allow3DS2: - description: "Indicates if you are able to process 3D Secure 2 transactions\ - \ natively on your payment page. Send this parameter when you are using\ - \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ - \n > This parameter only indicates readiness to support native 3D Secure\ - \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ - \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ - \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ - \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" - type: string - executeThreeD: - description: "Indicates if you want to perform 3D Secure authentication\ - \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ - \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ - \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ - \ 3D Secure authentication. Note that this setting results in refusals\ - \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ - \ national regulations. \n" - type: string - mpiImplementationType: - description: In case of Secure+, this field must be set to **CUPSecurePlus**. - type: string - scaExemption: - description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction.\n\n Possible values:\n\ - * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ - \ **transactionRiskAnalysis** " - type: string - threeDSVersion: - description: "Indicates your preference for the 3D Secure version. \n> If\ - \ you use this parameter, you override the checks from Adyen's Authentication\ - \ Engine. We recommend to use this field only if you have an extensive\ - \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ - \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ - \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ - \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ - \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ - \ in the `ARes`, we will apply the fallback policy configured in your\ - \ account. For example, if the configuration is to fall back to 3D Secure\ - \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ - \ the BIN is not enrolled, you will receive an error.\n\n" - type: string - AdditionalDataAirline: - properties: - airline.agency_invoice_number: - description: 'Reference number for the invoice, issued by the agency. - - * minLength: 1 - - * maxLength: 6' - type: string - airline.agency_plan_name: - description: '2-letter agency plan identifier; alphabetical. - - * minLength: 2 - - * maxLength: 2' - type: string - airline.airline_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit - accounting code (PAX); numeric. It identifies the carrier. - - * Format: IATA 3-digit accounting code (PAX) - - * Example: KLM = 074 - - * minLength: 3 - - * maxLength: 3' - type: string - airline.airline_designator_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.boarding_fee: - description: 'Chargeable amount for boarding the plane. - - The transaction amount needs to be represented in minor units according - to the [following table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 18' - type: string - airline.computerized_reservation_system: - description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) - used to make the reservation and purchase the ticket. - - * Format: alphanumeric. - - * minLength: 4 - - * maxLength: 4' - type: string - airline.customer_reference_number: - description: 'Reference number; alphanumeric. - - * minLength: 0 - - * maxLength: 20' - type: string - airline.document_type: - description: 'Optional 2-digit code; alphanumeric. It identifies the type - of product of the transaction. The description of the code may appear - on credit card statements. - - * Format: 2-digit code - - * Example: Passenger ticket = 01 - - * minLength: 2 - - * maxLength: 2' - type: string - airline.flight_date: - description: 'Flight departure date. Local time `(HH:mm)` is optional. - - * Date format: `yyyy-MM-dd` - - * Date and time format: `yyyy-MM-dd HH:mm` - - * minLength: 10 - - * maxLength: 16' - type: string - airline.leg.carrier_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - This field is required/mandatory if the airline data includes leg details. - - * Format: IATA 2-letter airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.leg.class_of_travel: - description: '1-letter travel class identifier; alphabetical. There is no - standard; however, the following codes are used rather consistently: - - * F: first class - - * J: business class - - * Y: economy class - - * W: premium economy - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_airport: - description: 'Alphabetical identifier of the departure airport. - - This field is required if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.depart_tax: - description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). - Amount charged by a country to an individual upon their leaving. The transaction - amount needs to be represented in minor units according to the [following - table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 12' - type: string - airline.leg.destination_code: - description: 'Alphabetical identifier of the destination/arrival airport. - - This field is required/mandatory if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.fare_base_code: - description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); - alphanumeric. - - * minLength: 1 - - * maxLength: 7' - type: string - airline.leg.flight_number: - description: 'The flight identifier. - - * minLength: 1 - - * maxLength: 5' - type: string - airline.leg.stop_over_code: - description: '1-letter code that indicates whether the passenger is entitled - to make a stopover. Only two types of characters are allowed: - - * O: Stopover allowed - - * X: Stopover not allowed - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.passenger.date_of_birth: - description: 'Date of birth of the passenger. - - - Date format: `yyyy-MM-dd` - - * minLength: 10 - - * maxLength: 10' - type: string - airline.passenger.first_name: - description: 'Passenger first name/given name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.last_name: - description: 'Passenger last name/family name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.telephone_number: - description: 'Telephone number of the passenger, including country code. - This is an alphanumeric field that can include the ''+'' and ''-'' signs. - - * minLength: 3 - - * maxLength: 30' - type: string - airline.passenger.traveller_type: - description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. - Example: ADT, SRC, CNN, INS. - - - However, several carriers use non-standard codes that can be up to 5 alphanumeric - characters. - - * minLength: 3 - - * maxLength: 6' - type: string - airline.passenger_name: - description: 'Passenger name, initials, and a title. - - * Format: last name + first name or initials + title. - - * Example: *FLYER / MARY MS*. - - * minLength: 1 - - * maxLength: 49' - type: string - airline.ticket_issue_address: - description: 'Address of the place/agency that issued the ticket. - - * minLength: 0 - - * maxLength: 16' - type: string - airline.ticket_number: - description: 'The ticket''s unique identifier. - - * minLength: 1 - - * maxLength: 150' - type: string - airline.travel_agency_code: - description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier - number for travel agencies. - - * minLength: 1 - - * maxLength: 8' - type: string - airline.travel_agency_name: - description: 'The name of the travel agency. - - * minLength: 1 - - * maxLength: 25' - type: string - required: - - airline.passenger_name - AdditionalDataCarRental: - properties: - carRental.checkOutDate: - description: 'Pick-up date. - - * Date format: `yyyyMMdd`' - type: string - carRental.customerServiceTollFreeNumber: - description: 'The customer service phone number of the car rental company. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - carRental.daysRented: - description: 'Number of days for which the car is being rented. - - * Format: Numeric - - * maxLength: 19' - type: string - carRental.fuelCharges: - description: 'Any fuel charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.insuranceCharges: - description: 'Any insurance charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.locationCity: - description: 'The city from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.locationCountry: - description: 'The country from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.locationStateProvince: - description: 'The state or province from where the car is rented. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - * Y - Customer was a no show. - - * N - Not applicable.' - type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. - type: string - carRental.rate: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.rateIndicator: - description: 'Specifies whether the given rate is applied daily or weekly. - - * D - Daily rate. - - * W - Weekly rate.' - type: string - carRental.rentalAgreementNumber: - description: 'The rental agreement number associated with this car rental. - - * Format: Alphanumeric - - * maxLength: 9' - type: string - carRental.rentalClassId: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.renterName: - description: 'The name of the person renting the car. - - * Format: Alphanumeric - - * maxLength: 26' - type: string - carRental.returnCity: - description: 'The city where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.returnCountry: - description: 'The country where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.returnDate: - description: 'The last date to return the car by. - - * Date format: `yyyyMMdd`' - type: string - carRental.returnLocationId: - description: 'Agency code, phone number, or address abbreviation - - * Format: Alphanumeric - - * maxLength: 10' - type: string - carRental.returnStateProvince: - description: 'The state or province where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.taxExemptIndicator: - description: 'Indicates whether the goods or services were tax-exempt, or - tax was not collected. - - - Values: - - * Y - Goods or services were tax exempt - - * N - Tax was not collected' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "A" for Car rental. This should be - included in the auth message. - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataCommon: - properties: - RequestedTestErrorResponseCode: - description: "Triggers test scenarios that allow to replicate certain communication\ - \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ - \ wasn't a connection available to service the outgoing communication.\n\ - This is a transient, retriable error since no messaging could be initiated\ - \ to an issuing system (or third-party acquiring system). Therefore, the\ - \ header Transient-Error: true is returned in the response. A subsequent\ - \ request using the same idempotency key will be processed as if it was\ - \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ - \ wrong during transmission of the message or receiving the response.\n\ - This is a classified as non-transient because the message could have been\ - \ received by the issuing party and been acted upon. No transient error\ - \ header is returned. If using idempotency, the (error) response is stored\ - \ as the final result for the idempotency key. Subsequent messages with\ - \ the same idempotency key not be processed beyond returning the stored\ - \ response." - type: string - authorisationType: - description: "Flags a card payment request for either pre-authorisation\ - \ or final authorisation. For more information, refer to [Authorisation\ - \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ - \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ - \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ - \ request to be handled as a final authorisation." - type: string - customRoutingFlag: - description: 'Allows you to determine or override the acquirer account that - should be used for the transaction. - - - If you need to process a payment with an acquirer different from a default - one, you can set up a corresponding configuration on the Adyen payments - platform. Then you can pass a custom routing flag in a payment request''s - additional data to target a specific acquirer. - - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' - type: string - industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge - description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ - \ this field denotes why the additional payment is made.\n\nPossible values:\n\ - \n * **NoShow**: An incremental charge is carried out because of a no-show\ - \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ - \ charge is carried out to process an additional payment after the original\ - \ services have been rendered and the respective payment has been processed." - enum: - - NoShow - - DelayedCharge - type: string - networkTxReference: - description: 'Allows you to link the transaction to the original or previous - one in a subscription/card-on-file chain. This field is required for token-based - transactions where Adyen does not tokenize the card. - - - Transaction identifier from card schemes, for example, Mastercard Trace - ID or the Visa Transaction ID. - - - Submit the original transaction ID of the contract in your payment request - if you are not tokenizing card details with Adyen and are making a merchant-initiated - transaction (MIT) for subsequent charges. - - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` - **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction - is classified as MIT.' - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - subMerchantCity: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the city of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 13 characters.' - type: string - subMerchantCountry: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the three-letter - country code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Fixed length: 3 characters.' - type: string - subMerchantID: - description: 'This field contains an identifier of the actual merchant when - a transaction is submitted via a payment facilitator. The payment facilitator - must send in this unique ID. - - - A unique identifier per submerchant that is required if the transaction - is performed by a registered payment facilitator. - - * Format: alpha-numeric. - - * Fixed length: 15 characters.' - type: string - subMerchantName: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the name of - the actual merchant. - - * Format: alpha-numeric. - - * Maximum length: 22 characters.' - type: string - subMerchantPostalCode: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the postal code - of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 10 characters.' - type: string - subMerchantState: - description: 'This field is required if the transaction is performed by - a registered payment facilitator, and if applicable to the country. This - field must contain the state code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 3 characters.' - type: string - subMerchantStreet: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the street of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 60 characters.' - type: string - subMerchantTaxId: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the tax ID of - the actual merchant. - - * Format: alpha-numeric. - - * Fixed length: 11 or 14 characters.' - type: string - AdditionalDataLevel23: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - - Encoding: ASCII. - - - Max length: 25 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - enhancedSchemeData.destinationCountryCode: - description: 'Destination country code. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.destinationPostalCode: - description: 'The postal code of a destination address. - - - Encoding: ASCII. - - - Max length: 10 characters. - - - > Required for American Express.' - type: string - enhancedSchemeData.destinationStateProvinceCode: - description: 'Destination state or province code. - - - Encoding: ASCII.Max length: 3 characters.' - type: string - enhancedSchemeData.dutyAmount: - description: 'Duty amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.freightAmount: - description: 'Shipping amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].commodityCode: - description: 'Item commodity code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].description: - description: 'Item description. - - - Encoding: ASCII. - - - Max length: 26 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: - description: 'Discount amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].productCode: - description: 'Product code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].quantity: - description: 'Quantity, specified as an integer value. - - - Value must be greater than 0. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: - description: 'Total amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: - description: 'Item unit of measurement. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitPrice: - description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - - - Max length: 12 characters.' - type: string - enhancedSchemeData.orderDate: - description: 'Order date. - - * Format: `ddMMyy` - - - Encoding: ASCII. - - - Max length: 6 characters.' - type: string - enhancedSchemeData.shipFromPostalCode: - description: 'The postal code of a "ship-from" address. - - - Encoding: ASCII. - - - Max length: 10 characters.' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - AdditionalDataLodging: - properties: - lodging.checkInDate: - description: 'The arrival date. - - * Date format: `yyyyMMdd`' - type: string - lodging.checkOutDate: - description: 'The departure date. - - * Date format: `yyyyMMdd`' - type: string - lodging.customerServiceTollFreeNumber: - description: 'The toll free phone number for the hotel/lodgings. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.fireSafetyActIndicator: - description: 'Identifies that the facility complies with the Hotel and Motel - Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. - - * Format: Alphabetic - - * maxLength: 1' - type: string - lodging.folioCashAdvances: - description: 'The folio cash advances. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.folioNumber: - description: "Card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Format: Alphanumeric\n* maxLength: 25" - type: string - lodging.foodBeverageCharges: - description: 'Any charges for food and beverages associated with the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - - Value should be Y or N. - - * Format: Numeric - - * maxLength: 1' - type: string - lodging.prepaidExpenses: - description: 'Prepaid expenses for the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.propertyPhoneNumber: - description: 'Identifies specific lodging property location by its local - phone number. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.room1.numberOfNights: - description: 'Total number of nights the room will be rented. - - * Format: Numeric - - * maxLength: 4' - type: string - lodging.room1.rate: - description: 'The rate of the room. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.room1.tax: - description: 'The total amount of tax to be paid. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalRoomTax: - description: 'Total room tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalTax: - description: 'Total tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "H" for Hotel. This should be included - in the auth message. - - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.merchantData: - description: 'Holds different merchant data points like product, purchase, - customer, and so on. It takes data in a Base64 encoded string. - - - The `merchantData` parameter needs to be added to the `openinvoicedata` - signature at the end. - - - Since the field is optional, if it''s not included it does not impact - computing the merchant signature. - - - Applies only to Klarna. - - - You can contact Klarna for the format and structure of the string.' - type: string - openinvoicedata.numberOfLines: - description: 'The number of invoice lines included in `openinvoicedata`. - - - There needs to be at least one line, so `numberOfLines` needs to be at - least 1.' - type: string - openinvoicedataLine[itemNr].currencyCode: - description: The three-character ISO currency code. - type: string - openinvoicedataLine[itemNr].description: - description: A text description of the product the invoice line refers to. - type: string - openinvoicedataLine[itemNr].itemAmount: - description: 'The price for one item in the invoice line, represented in - minor units. - - - The due amount for the item, VAT excluded.' - type: string - openinvoicedataLine[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. - type: string - openinvoicedataLine[itemNr].itemVatAmount: - description: The VAT due for one item in the invoice line, represented in - minor units. - type: string - openinvoicedataLine[itemNr].itemVatPercentage: - description: 'The VAT percentage for one item in the invoice line, represented - in minor units. - - - For example, 19% VAT is specified as 1900.' - type: string - openinvoicedataLine[itemNr].numberOfItems: - description: The number of units purchased of a specific product. - type: string - openinvoicedataLine[itemNr].returnShippingCompany: - description: Name of the shipping company handling the the return shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingNumber: - description: The tracking number for the return of the shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingUri: - description: URI where the customer can track the return of their shipment. - type: string - openinvoicedataLine[itemNr].shippingCompany: - description: Name of the shipping company handling the delivery. - type: string - openinvoicedataLine[itemNr].shippingMethod: - description: Shipping method. - type: string - openinvoicedataLine[itemNr].trackingNumber: - description: The tracking number for the shipment. - type: string - openinvoicedataLine[itemNr].trackingUri: - description: URI where the customer can track their shipment. - type: string - AdditionalDataOpi: - properties: - opi.includeTransToken: - description: 'Optional boolean indicator. Set to **true** if you want an - ecommerce transaction to return an `opi.transToken` as additional data - in the response. - - - You can store this Oracle Payment Interface token in your Oracle Opera - database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' - type: string - AdditionalDataPayout: - properties: - fundingNetwork: - description: '' - type: string - fundingSource: - description: '' - enum: - - CREDIT - - DEBIT - - PREPAID - - DEPOSIT_ACCOUNT - type: string - fundingTransactionId: - description: '' - type: string - payoutAccountCode: - description: '' - type: string - payoutAccountHolderCode: - description: '' - type: string - payoutMarketPayUser: - description: '' - type: string - processOver: - description: '' - enum: - - MC_P2P - - Visa_OCT - - UnlinkedRefund - type: string - verifyOver: - description: '' - type: string - walletIdentifier: - description: '' - type: string - AdditionalDataRatepay: - properties: - ratepay.installmentAmount: - description: Amount the customer has to pay each month. - type: string - ratepay.interestRate: - description: Interest rate of this installment. - type: string - ratepay.lastInstallmentAmount: - description: Amount of the last installment. - type: string - ratepay.paymentFirstday: - description: Calendar day of the first payment. - type: string - ratepaydata.deliveryDate: - description: Date the merchant delivered the goods to the customer. - type: string - ratepaydata.dueDate: - description: Date by which the customer must settle the payment. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. - type: string - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - AdditionalDataRetry: - properties: - retry.chainAttemptNumber: - description: 'The number of times the transaction (not order) has been retried - between different payment service providers. For instance, the `chainAttemptNumber` - set to 2 means that this transaction has been recently tried on another - provider before being sent to Adyen. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.orderAttemptNumber: - description: 'The index of the attempt to bill a particular order, which - is identified by the `merchantOrderReference` field. For example, if a - recurring transaction fails and is retried one day later, then the order - number for these attempts would be 1 and 2, respectively. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.skipRetry: - description: 'The Boolean value indicating whether Adyen should skip or - retry this transaction, if possible. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - AdditionalDataRisk: - properties: - riskdata.[customFieldName]: - description: The data for your custom risk field. For more information, - refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). - type: string - riskdata.basket.item[itemNr].amountPerItem: - description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.basket.item[itemNr].brand: - description: Brand of the item. - type: string - riskdata.basket.item[itemNr].category: - description: Category of the item. - type: string - riskdata.basket.item[itemNr].color: - description: Color of the item. - type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string - riskdata.basket.item[itemNr].quantity: - description: Quantity of the item purchased. - type: string - riskdata.basket.item[itemNr].receiverEmail: - description: Email associated with the given product in the basket (usually - in electronic gift cards). - type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.promotions.promotion[itemNr].promotionCode: - description: Code of the promotion. - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountAmount: - description: The discount amount of the promotion, represented in [minor - units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: - description: 'Promotion''s percentage discount. It is represented in percentage - value and there is no need to include the ''%'' sign. - - - e.g. for a promotion discount of 30%, the value of the field should be - 30.' - type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string - riskdata.riskProfileReference: - description: Reference number of the risk profile that you want to apply - to the payment. If not provided or left blank, the merchant-level account's - default risk profile will be applied to the payment. For more information, - see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). - type: string - riskdata.skipRisk: - description: If this parameter is provided with the value **true**, risk - checks for the payment request are skipped and the transaction will not - get a risk score. - type: string - AdditionalDataRiskStandalone: - properties: - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.ProtectionEligibility: - description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ - \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ - \ \u2014 Merchant is not protected under the Seller Protection Policy." - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - avsResultRaw: - description: 'Raw AVS result received from the acquirer, where available. - Example: D' - type: string - bin: - description: The Bank Identification Number of a credit card, which is the - first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). - type: string - cvcResultRaw: - description: 'Raw CVC result received from the acquirer, where available. - Example: 1' - type: string - riskToken: - description: Unique identifier or token for the shopper's card details. - type: string - threeDAuthenticated: - description: 'A Boolean value indicating whether 3DS authentication was - completed on this payment. Example: true' - type: string - threeDOffered: - description: 'A Boolean value indicating whether 3DS was offered for this - payment. Example: true' - type: string - tokenDataType: - description: 'Required for PayPal payments only. The only supported value - is: **paypal**.' - type: string - AdditionalDataSubMerchant: - properties: - subMerchant.numberOfSubSellers: - description: Required for transactions performed by registered payment facilitators. - Indicates the number of sub-merchants contained in the request. For example, - **3**. - type: string - subMerchant.subSeller[subSellerNr].city: - description: 'Required for transactions performed by registered payment - facilitators. The city of the sub-merchant''s address. - - * Format: Alphanumeric - - * Maximum length: 13 characters' - type: string - subMerchant.subSeller[subSellerNr].country: - description: "Required for transactions performed by registered payment\ - \ facilitators. The three-letter country code of the sub-merchant's address.\ - \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ - * Fixed length: 3 characters" - type: string - subMerchant.subSeller[subSellerNr].id: - description: "Required for transactions performed by registered payment\ - \ facilitators. A unique identifier that you create for the sub-merchant,\ - \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ - * Maximum length: 15 characters" - type: string - subMerchant.subSeller[subSellerNr].mcc: - description: "Required for transactions performed by registered payment\ - \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ - \ \n* Format: Numeric\n* Fixed length: 4 digits" - type: string - subMerchant.subSeller[subSellerNr].name: - description: 'Required for transactions performed by registered payment - facilitators. The name of the sub-merchant. Based on scheme specifications, - this value will overwrite the shopper statement that will appear in the - card statement. - - * Format: Alphanumeric - - * Maximum length: 22 characters' - type: string - subMerchant.subSeller[subSellerNr].postalCode: - description: 'Required for transactions performed by registered payment - facilitators. The postal code of the sub-merchant''s address, without - dashes. - - * Format: Numeric - - * Fixed length: 8 digits' - type: string - subMerchant.subSeller[subSellerNr].state: - description: 'Required for transactions performed by registered payment - facilitators. The state code of the sub-merchant''s address, if applicable - to the country. - - * Format: Alphanumeric - - * Maximum length: 2 characters' - type: string - subMerchant.subSeller[subSellerNr].street: - description: 'Required for transactions performed by registered payment - facilitators. The street name and house number of the sub-merchant''s - address. - - * Format: Alphanumeric - - * Maximum length: 60 characters' - type: string - subMerchant.subSeller[subSellerNr].taxId: - description: 'Required for transactions performed by registered payment - facilitators. The tax ID of the sub-merchant. - - * Format: Numeric - - * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' - type: string - AdditionalDataTemporaryServices: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - * Encoding: ASCII - - * maxLength: 25' - type: string - enhancedSchemeData.employeeName: - description: 'Name or ID associated with the individual working in a temporary - capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.jobDescription: - description: 'Description of the job or task of the individual working in - a temporary capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.regularHoursRate: - description: 'Amount paid per regular hours worked, minor units. - - * maxLength: 7' - type: string - enhancedSchemeData.regularHoursWorked: - description: 'Amount of time worked during a normal operation for the task - or job. - - * maxLength: 7' - type: string - enhancedSchemeData.requestName: - description: 'Name of the individual requesting temporary services. - - * maxLength: 40' - type: string - enhancedSchemeData.tempStartDate: - description: 'Date for the beginning of the pay period. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.tempWeekEnding: - description: 'Date of the end of the billing cycle. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. For example, 2000 means - USD 20.00 - - * maxLength: 12' - type: string - AdditionalDataWallets: - properties: - androidpay.token: - description: The Android Pay token retrieved from the SDK. - type: string - masterpass.transactionId: - description: The Mastercard Masterpass Transaction ID retrieved from the - SDK. - type: string - payment.token: - description: The Apple Pay token retrieved from the SDK. - type: string - paywithgoogle.token: - description: The Google Pay token retrieved from the SDK. - type: string - samsungpay.token: - description: The Samsung Pay token retrieved from the SDK. - type: string - visacheckout.callId: - description: The Visa Checkout Call ID retrieved from the SDK. - type: string Address: properties: city: @@ -2105,32 +515,6 @@ components: required: - value - currency - ApplicationInfo: - properties: - adyenLibrary: - description: Adyen-developed software, such as libraries and plugins, used - to interact with the Adyen API. For example, Magento plugin, Java API - library, etc. - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - description: Adyen-developed software to get payment details. For example, - Checkout SDK, Secured Fields SDK, etc. - $ref: '#/components/schemas/CommonField' - externalPlatform: - description: Third-party developed platform used to initiate payment requests. - For example, Magento, Zuora, etc. - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - description: Merchant developed software, such as cashier application, used - to interact with the Adyen API. - $ref: '#/components/schemas/CommonField' - merchantDevice: - description: Merchant device information. - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - description: Shopper interaction device, such as terminal, mobile device - or web browser, to initiate payment requests. - $ref: '#/components/schemas/ShopperInteractionDevice' BankAccount: properties: bankAccountNumber: @@ -2179,67 +563,6 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string - BrowserInfo: - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - colorDepth: - x-addedInVersion: '40' - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - x-addedInVersion: '40' - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - x-addedInVersion: '40' - default: true - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - x-addedInVersion: '40' - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). - type: string - screenHeight: - x-addedInVersion: '40' - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - x-addedInVersion: '40' - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - x-addedInVersion: '40' - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - userAgent - - acceptHeader - - javaEnabled - - colorDepth - - screenHeight - - screenWidth - - timeZoneOffset - - language Card: properties: cvc: @@ -2308,109 +631,6 @@ components: - expiryMonth - expiryYear - holderName - CommonField: - properties: - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - DeviceRenderOptions: - properties: - sdkInterface: - default: both - description: 'Supported SDK interface types. - - Allowed values: - - * native - - * html - - * both' - enum: - - native - - html - - both - type: string - sdkUiType: - description: 'UI types supported for displaying specific challenges. - - Allowed values: - - * text - - * singleSelect - - * outOfBand - - * otherHtml - - * multiSelect' - items: - enum: - - multiSelect - - otherHtml - - outOfBand - - singleSelect - - text - type: string - type: array - ExternalPlatform: - properties: - integrator: - description: External platform integrator. - type: string - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - ForexQuote: - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - description: The base amount. - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - description: The buy rate. - $ref: '#/components/schemas/Amount' - interbank: - description: The interbank amount. - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - description: The sell rate. - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - validTill - - basePoints FraudCheckResult: properties: accountScore: @@ -2468,170 +688,6 @@ components: telephoneNumber: description: Phone number of the person type: string - Installments: - properties: - value: - description: 'Defines the number of installments. Its value needs to be - greater than zero. - - - Usually, the maximum allowed number of installments is capped. For example, - it may not be possible to split a payment in more than 24 installments. - The acquirer sets this upper limit, so its value may vary.' - format: int32 - type: integer - required: - - value - Mandate: - properties: - amount: - description: The billing amount (in minor units) of the recurring transactions. - type: string - amountRule: - description: "The limitation rule of the billing amount.\n\nPossible values:\n\ - \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ - \ **exact**: The transaction amount should be the same as the `amount`.\n\ - \n" - enum: - - max - - exact - type: string - billingAttemptsRule: - description: "The rule to specify the period, within which the recurring\ - \ debit can happen, relative to the mandate recurring date.\n\nPossible\ - \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ - \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ - \n" - enum: - - 'on' - - before - - after - type: string - billingDay: - description: 'The number of the day, on which the recurring debit can happen. - Should be within the same calendar month as the mandate recurring date. - - - Possible values: 1-31 based on the `frequency`.' - type: string - endsAt: - description: End date of the billing plan, in YYYY-MM-DD format. - type: string - frequency: - description: 'The frequency with which a shopper should be charged. - - - Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, - **halfYearly**, **yearly**.' - enum: - - adhoc - - daily - - weekly - - biWeekly - - monthly - - quarterly - - halfYearly - - yearly - type: string - remarks: - description: The message shown by UPI to the shopper on the approval screen. - type: string - startsAt: - description: Start date of the billing plan, in YYYY-MM-DD format. By default, - the transaction date. - type: string - required: - - frequency - - amount - - endsAt - MerchantDevice: - properties: - os: - description: Operating system running on the merchant device. - type: string - osVersion: - description: Version of the operating system on the merchant device. - type: string - reference: - description: Merchant device reference. - type: string - MerchantRiskIndicator: - properties: - addressMatch: - description: Whether the chosen delivery address is identical to the billing - address. - type: boolean - deliveryAddressIndicator: - description: 'Indicator regarding the delivery address. - - Allowed values: - - * `shipToBillingAddress` - - * `shipToVerifiedAddress` - - * `shipToNewAddress` - - * `shipToStore` - - * `digitalGoods` - - * `goodsNotShipped` - - * `other`' - enum: - - shipToBillingAddress - - shipToVerifiedAddress - - shipToNewAddress - - shipToStore - - digitalGoods - - goodsNotShipped - - other - type: string - deliveryEmail: - description: The delivery email address (for digital goods). - type: string - deliveryTimeframe: - description: 'The estimated delivery time for the shopper to receive the - goods. - - Allowed values: - - * `electronicDelivery` - - * `sameDayShipping` - - * `overnightShipping` - - * `twoOrMoreDaysShipping`' - enum: - - electronicDelivery - - sameDayShipping - - overnightShipping - - twoOrMoreDaysShipping - type: string - giftCardAmount: - description: For prepaid or gift card purchase, the purchase amount total - of prepaid or gift card(s). - $ref: '#/components/schemas/Amount' - giftCardCount: - description: For prepaid or gift card purchase, total count of individual - prepaid or gift cards/codes purchased. - format: int32 - type: integer - preOrderDate: - description: For pre-order purchases, the expected date this product will - be available to the shopper. - format: date-time - type: string - preOrderPurchase: - description: Indicator for whether this transaction is for pre-ordering - a product. - type: boolean - reorderItems: - description: Indicator for whether the shopper has already purchased the - same items in the past. - type: boolean ModifyRequest: properties: additionalData: @@ -3624,20 +1680,6 @@ components: Example: OOFF' type: string - SDKEphemPubKey: - properties: - crv: - description: The `crv` value as received from the 3D Secure 2 SDK. - type: string - kty: - description: The `kty` value as received from the 3D Secure 2 SDK. - type: string - x: - description: The `x` value as received from the 3D Secure 2 SDK. - type: string - y: - description: The `y` value as received from the 3D Secure 2 SDK. - type: string ServiceError: properties: additionalData: @@ -3664,80 +1706,6 @@ components: description: The HTTP response status. format: int32 type: integer - ShopperInteractionDevice: - properties: - locale: - description: Locale on the shopper interaction device. - type: string - os: - description: Operating system running on the shopper interaction device. - type: string - osVersion: - description: Version of the operating system on the shopper interaction - device. - type: string - Split: - properties: - account: - description: 'Unique identifier of the account where the split amount should - be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. - - - ' - type: string - amount: - description: The amount of this split. - $ref: '#/components/schemas/SplitAmount' - description: - description: A description of this split. - type: string - reference: - description: 'Your reference for the split, which you can use to link the - split to other operations such as captures and refunds. - - - This is required if `type` is **MarketPlace** or **BalanceAccount**. For - the other types, we also recommend sending a reference so you can reconcile - the split and the associated payment in the transaction overview and in - the reports. If the reference is not provided, the split is reported as - part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) - in Adyen for Platforms.' - type: string - type: - description: 'The type of split. - - Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, - **MarketPlace**, **BalanceAccount**, **Remainder**.' - enum: - - BalanceAccount - - Commission - - Default - - MarketPlace - - PaymentFee - - Remainder - - VAT - - Verification - type: string - required: - - amount - - type - SplitAmount: - properties: - currency: - description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - - - If this value is not provided, the currency in which the payment is made - will be used.' - maxLength: 3 - minLength: 3 - type: string - value: - description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). - format: int64 - type: integer - required: - - value StoreDetailAndSubmitRequest: properties: additionalData: @@ -4141,223 +2109,6 @@ components: required: - pspReference - resultCode - ThreeDS2RequestData: - properties: - acquirerBIN: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The acquiring BIN enrolled for 3D Secure 2. This string should match the - value that you will use in the authorisation. Use 123456 on the Test platform. - type: string - acquirerMerchantID: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. - This string should match the value that you will use in the authorisation. - Use 123456 on the Test platform. - type: string - authenticationOnly: - deprecated: true - x-deprecatedInVersion: '50' - x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. - default: false - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - challengeIndicator: - description: 'Possibility to specify a preference for receiving a challenge - from the issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string - deviceChannel: - description: 'The environment of the shopper. - - Allowed values: - - * `app` - - * `browser`' - type: string - deviceRenderOptions: - description: 'Display options for the 3D Secure 2 SDK. - - Optional and only for `deviceChannel` **app**.' - $ref: '#/components/schemas/DeviceRenderOptions' - mcc: - x-addedInVersion: '49' - description: Required for merchants that have been enrolled for 3D Secure - 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` - is registered at the scheme. - type: string - merchantName: - x-addedInVersion: '49' - description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchant name that the issuer presents to the shopper if they get - a challenge. We recommend to use the same value that you will use in the - authorization. Maximum length is 40 characters. - - > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). - Use this field if you are enrolled for 3D Secure 2 with us and want to - override the merchant name already configured on your account.' - type: string - messageVersion: - default: 2.1.0 - description: The `messageVersion` value indicating the 3D Secure 2 protocol - version. - type: string - notificationURL: - description: URL to where the issuer should send the `CRes`. Required if - you are not using components for `channel` **Web** or if you are using - classic integration `deviceChannel` **browser**. - type: string - sdkAppID: - description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEncData: - description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEphemPubKey: - description: 'The `sdkEphemPubKey` value as received from the 3D Secure - 2 SDK. - - Required for `deviceChannel` set to **app**.' - $ref: '#/components/schemas/SDKEphemPubKey' - sdkMaxTimeout: - default: 60 - description: 'The maximum amount of time in minutes for the 3D Secure 2 - authentication process. - - Optional and only for `deviceChannel` set to **app**. Defaults to **60** - minutes.' - format: int32 - type: integer - sdkReferenceNumber: - description: 'The `sdkReferenceNumber` value as received from the 3D Secure - 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkTransID: - description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkVersion: - x-addedInVersion: '40' - description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ - \ set to **app**." - type: string - threeDSCompInd: - description: Completion indicator for the device fingerprinting. - type: string - threeDSRequestorID: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor identifier assigned by the Directory - Server when you enrol for 3D Secure 2. - type: string - threeDSRequestorName: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor name assigned by the Directory Server - when you enrol for 3D Secure 2. - type: string - threeDSRequestorURL: - description: URL of the (customer service) website that will be shown to - the shopper in case of technical errors during the 3D Secure 2 process. - type: string - transactionType: - x-addedInVersion: '50' - description: Identify the type of the transaction being authenticated. - enum: - - goodsOrServicePurchase - - checkAcceptance - - accountFunding - - quasiCashTransaction - - prepaidActivationAndLoad - type: string - whiteListStatus: - x-addedInVersion: '49' - description: The `whiteListStatus` value returned from a previous 3D Secure - 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. - type: string - required: - - deviceChannel - ThreeDSecureData: - properties: - authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. - - - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' - enum: - - Y - - N - - U - - A - type: string - cavv: - description: The cardholder authentication value (base64 encoded, 20 bytes - in a decoded form). - format: byte - type: string - cavvAlgorithm: - description: The CAVV algorithm used. Include this only for 3D Secure 1. - type: string - directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. - - - In 3D Secure 2, this is the `transStatus` from the `ARes`.' - enum: - - A - - C - - D - - I - - N - - R - - U - - Y - type: string - dsTransID: - x-addedInVersion: '40' - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the Directory Server (DS) to identify a single transaction. - type: string - eci: - description: The electronic commerce indicator. - type: string - threeDSVersion: - x-addedInVersion: '40' - description: The version of the 3D Secure protocol. - type: string - xid: - description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, - 20 bytes in a decoded form). - format: byte - type: string securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml index 0bbc6d7..2fd8ad8 100644 --- a/yaml/PayoutService-v51.yaml +++ b/yaml/PayoutService-v51.yaml @@ -40,7 +40,7 @@ info: ' - x-timestamp: '2022-05-03T09:24:06Z' + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -59,7 +59,7 @@ paths: post: tags: - Reviewing - summary: Confirms a payout. + summary: Confirm a payout description: 'Confirms a previously submitted payout. @@ -126,7 +126,7 @@ paths: post: tags: - Reviewing - summary: Cancels a payout. + summary: Cancel a payout description: 'Cancels a previously submitted payout. @@ -193,7 +193,7 @@ paths: post: tags: - Instant payouts - summary: Pay out directly. + summary: Make an instant card payout description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card @@ -259,7 +259,7 @@ paths: post: tags: - Initialization - summary: Stores payout details. + summary: Store payout details description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call. @@ -324,7 +324,7 @@ paths: post: tags: - Initialization - summary: Stores details and submits a payout. + summary: Store details and submit a payout description: 'Submits a payout and stores its details for subsequent payouts. @@ -397,7 +397,7 @@ paths: post: tags: - Initialization - summary: Submits a payout. + summary: Submit a payout description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -461,1596 +461,6 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: - AccountInfo: - properties: - accountAgeIndicator: - description: 'Indicator for the length of time since this shopper account - was created in the merchant''s environment. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountChangeDate: - description: Date when the shopper's account was last changed. - format: date-time - type: string - accountChangeIndicator: - description: 'Indicator for the length of time since the shopper''s account - was last updated. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountCreationDate: - description: Date when the shopper's account was created. - format: date-time - type: string - accountType: - x-addedInVersion: '50' - description: 'Indicates the type of account. For example, for a multi-account - card product. - - Allowed values: - - * notApplicable - - * credit - - * debit' - enum: - - notApplicable - - credit - - debit - type: string - addCardAttemptsDay: - description: Number of attempts the shopper tried to add a card to their - account in the last day. - format: int32 - type: integer - deliveryAddressUsageDate: - description: Date the selected delivery address was first used. - format: date-time - type: string - deliveryAddressUsageIndicator: - description: 'Indicator for the length of time since this delivery address - was first used. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - homePhone: - description: Shopper's home phone number (including the country code). - type: string - mobilePhone: - description: Shopper's mobile phone number (including the country code). - type: string - passwordChangeDate: - description: Date when the shopper last changed their password. - format: date-time - type: string - passwordChangeIndicator: - description: 'Indicator when the shopper has changed their password. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - pastTransactionsDay: - description: Number of all transactions (successful and abandoned) from - this shopper in the past 24 hours. - format: int32 - type: integer - pastTransactionsYear: - description: Number of all transactions (successful and abandoned) from - this shopper in the past year. - format: int32 - type: integer - paymentAccountAge: - description: Date this payment method was added to the shopper's account. - format: date-time - type: string - paymentAccountIndicator: - description: 'Indicator for the length of time since this payment method - was added to this shopper''s account. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - purchasesLast6Months: - description: Number of successful purchases in the last six months. - format: int32 - type: integer - suspiciousActivity: - description: Whether suspicious activity was recorded on this account. - type: boolean - workPhone: - description: Shopper's work phone number (including the country code). - type: string - AdditionalData3DSecure: - properties: - allow3DS2: - description: "Indicates if you are able to process 3D Secure 2 transactions\ - \ natively on your payment page. Send this parameter when you are using\ - \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ - \n > This parameter only indicates readiness to support native 3D Secure\ - \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ - \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ - \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ - \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" - type: string - executeThreeD: - description: "Indicates if you want to perform 3D Secure authentication\ - \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ - \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ - \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ - \ 3D Secure authentication. Note that this setting results in refusals\ - \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ - \ national regulations. \n" - type: string - mpiImplementationType: - description: In case of Secure+, this field must be set to **CUPSecurePlus**. - type: string - scaExemption: - description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction.\n\n Possible values:\n\ - * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ - \ **transactionRiskAnalysis** " - type: string - threeDSVersion: - description: "Indicates your preference for the 3D Secure version. \n> If\ - \ you use this parameter, you override the checks from Adyen's Authentication\ - \ Engine. We recommend to use this field only if you have an extensive\ - \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ - \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ - \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ - \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ - \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ - \ in the `ARes`, we will apply the fallback policy configured in your\ - \ account. For example, if the configuration is to fall back to 3D Secure\ - \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ - \ the BIN is not enrolled, you will receive an error.\n\n" - type: string - AdditionalDataAirline: - properties: - airline.agency_invoice_number: - description: 'Reference number for the invoice, issued by the agency. - - * minLength: 1 - - * maxLength: 6' - type: string - airline.agency_plan_name: - description: '2-letter agency plan identifier; alphabetical. - - * minLength: 2 - - * maxLength: 2' - type: string - airline.airline_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit - accounting code (PAX); numeric. It identifies the carrier. - - * Format: IATA 3-digit accounting code (PAX) - - * Example: KLM = 074 - - * minLength: 3 - - * maxLength: 3' - type: string - airline.airline_designator_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.boarding_fee: - description: 'Chargeable amount for boarding the plane. - - The transaction amount needs to be represented in minor units according - to the [following table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 18' - type: string - airline.computerized_reservation_system: - description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) - used to make the reservation and purchase the ticket. - - * Format: alphanumeric. - - * minLength: 4 - - * maxLength: 4' - type: string - airline.customer_reference_number: - description: 'Reference number; alphanumeric. - - * minLength: 0 - - * maxLength: 20' - type: string - airline.document_type: - description: 'Optional 2-digit code; alphanumeric. It identifies the type - of product of the transaction. The description of the code may appear - on credit card statements. - - * Format: 2-digit code - - * Example: Passenger ticket = 01 - - * minLength: 2 - - * maxLength: 2' - type: string - airline.flight_date: - description: 'Flight departure date. Local time `(HH:mm)` is optional. - - * Date format: `yyyy-MM-dd` - - * Date and time format: `yyyy-MM-dd HH:mm` - - * minLength: 10 - - * maxLength: 16' - type: string - airline.leg.carrier_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - This field is required/mandatory if the airline data includes leg details. - - * Format: IATA 2-letter airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.leg.class_of_travel: - description: '1-letter travel class identifier; alphabetical. There is no - standard; however, the following codes are used rather consistently: - - * F: first class - - * J: business class - - * Y: economy class - - * W: premium economy - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_airport: - description: 'Alphabetical identifier of the departure airport. - - This field is required if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.depart_tax: - description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). - Amount charged by a country to an individual upon their leaving. The transaction - amount needs to be represented in minor units according to the [following - table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 12' - type: string - airline.leg.destination_code: - description: 'Alphabetical identifier of the destination/arrival airport. - - This field is required/mandatory if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.fare_base_code: - description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); - alphanumeric. - - * minLength: 1 - - * maxLength: 7' - type: string - airline.leg.flight_number: - description: 'The flight identifier. - - * minLength: 1 - - * maxLength: 5' - type: string - airline.leg.stop_over_code: - description: '1-letter code that indicates whether the passenger is entitled - to make a stopover. Only two types of characters are allowed: - - * O: Stopover allowed - - * X: Stopover not allowed - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.passenger.date_of_birth: - description: 'Date of birth of the passenger. - - - Date format: `yyyy-MM-dd` - - * minLength: 10 - - * maxLength: 10' - type: string - airline.passenger.first_name: - description: 'Passenger first name/given name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.last_name: - description: 'Passenger last name/family name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.telephone_number: - description: 'Telephone number of the passenger, including country code. - This is an alphanumeric field that can include the ''+'' and ''-'' signs. - - * minLength: 3 - - * maxLength: 30' - type: string - airline.passenger.traveller_type: - description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. - Example: ADT, SRC, CNN, INS. - - - However, several carriers use non-standard codes that can be up to 5 alphanumeric - characters. - - * minLength: 3 - - * maxLength: 6' - type: string - airline.passenger_name: - description: 'Passenger name, initials, and a title. - - * Format: last name + first name or initials + title. - - * Example: *FLYER / MARY MS*. - - * minLength: 1 - - * maxLength: 49' - type: string - airline.ticket_issue_address: - description: 'Address of the place/agency that issued the ticket. - - * minLength: 0 - - * maxLength: 16' - type: string - airline.ticket_number: - description: 'The ticket''s unique identifier. - - * minLength: 1 - - * maxLength: 150' - type: string - airline.travel_agency_code: - description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier - number for travel agencies. - - * minLength: 1 - - * maxLength: 8' - type: string - airline.travel_agency_name: - description: 'The name of the travel agency. - - * minLength: 1 - - * maxLength: 25' - type: string - required: - - airline.passenger_name - AdditionalDataCarRental: - properties: - carRental.checkOutDate: - description: 'Pick-up date. - - * Date format: `yyyyMMdd`' - type: string - carRental.customerServiceTollFreeNumber: - description: 'The customer service phone number of the car rental company. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - carRental.daysRented: - description: 'Number of days for which the car is being rented. - - * Format: Numeric - - * maxLength: 19' - type: string - carRental.fuelCharges: - description: 'Any fuel charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.insuranceCharges: - description: 'Any insurance charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.locationCity: - description: 'The city from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.locationCountry: - description: 'The country from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.locationStateProvince: - description: 'The state or province from where the car is rented. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - * Y - Customer was a no show. - - * N - Not applicable.' - type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. - type: string - carRental.rate: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.rateIndicator: - description: 'Specifies whether the given rate is applied daily or weekly. - - * D - Daily rate. - - * W - Weekly rate.' - type: string - carRental.rentalAgreementNumber: - description: 'The rental agreement number associated with this car rental. - - * Format: Alphanumeric - - * maxLength: 9' - type: string - carRental.rentalClassId: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.renterName: - description: 'The name of the person renting the car. - - * Format: Alphanumeric - - * maxLength: 26' - type: string - carRental.returnCity: - description: 'The city where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.returnCountry: - description: 'The country where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.returnDate: - description: 'The last date to return the car by. - - * Date format: `yyyyMMdd`' - type: string - carRental.returnLocationId: - description: 'Agency code, phone number, or address abbreviation - - * Format: Alphanumeric - - * maxLength: 10' - type: string - carRental.returnStateProvince: - description: 'The state or province where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.taxExemptIndicator: - description: 'Indicates whether the goods or services were tax-exempt, or - tax was not collected. - - - Values: - - * Y - Goods or services were tax exempt - - * N - Tax was not collected' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "A" for Car rental. This should be - included in the auth message. - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataCommon: - properties: - RequestedTestErrorResponseCode: - description: "Triggers test scenarios that allow to replicate certain communication\ - \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ - \ wasn't a connection available to service the outgoing communication.\n\ - This is a transient, retriable error since no messaging could be initiated\ - \ to an issuing system (or third-party acquiring system). Therefore, the\ - \ header Transient-Error: true is returned in the response. A subsequent\ - \ request using the same idempotency key will be processed as if it was\ - \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ - \ wrong during transmission of the message or receiving the response.\n\ - This is a classified as non-transient because the message could have been\ - \ received by the issuing party and been acted upon. No transient error\ - \ header is returned. If using idempotency, the (error) response is stored\ - \ as the final result for the idempotency key. Subsequent messages with\ - \ the same idempotency key not be processed beyond returning the stored\ - \ response." - type: string - authorisationType: - description: "Flags a card payment request for either pre-authorisation\ - \ or final authorisation. For more information, refer to [Authorisation\ - \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ - \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ - \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ - \ request to be handled as a final authorisation." - type: string - customRoutingFlag: - description: 'Allows you to determine or override the acquirer account that - should be used for the transaction. - - - If you need to process a payment with an acquirer different from a default - one, you can set up a corresponding configuration on the Adyen payments - platform. Then you can pass a custom routing flag in a payment request''s - additional data to target a specific acquirer. - - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' - type: string - industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge - description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ - \ this field denotes why the additional payment is made.\n\nPossible values:\n\ - \n * **NoShow**: An incremental charge is carried out because of a no-show\ - \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ - \ charge is carried out to process an additional payment after the original\ - \ services have been rendered and the respective payment has been processed." - enum: - - NoShow - - DelayedCharge - type: string - networkTxReference: - description: 'Allows you to link the transaction to the original or previous - one in a subscription/card-on-file chain. This field is required for token-based - transactions where Adyen does not tokenize the card. - - - Transaction identifier from card schemes, for example, Mastercard Trace - ID or the Visa Transaction ID. - - - Submit the original transaction ID of the contract in your payment request - if you are not tokenizing card details with Adyen and are making a merchant-initiated - transaction (MIT) for subsequent charges. - - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` - **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction - is classified as MIT.' - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - subMerchantCity: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the city of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 13 characters.' - type: string - subMerchantCountry: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the three-letter - country code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Fixed length: 3 characters.' - type: string - subMerchantID: - description: 'This field contains an identifier of the actual merchant when - a transaction is submitted via a payment facilitator. The payment facilitator - must send in this unique ID. - - - A unique identifier per submerchant that is required if the transaction - is performed by a registered payment facilitator. - - * Format: alpha-numeric. - - * Fixed length: 15 characters.' - type: string - subMerchantName: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the name of - the actual merchant. - - * Format: alpha-numeric. - - * Maximum length: 22 characters.' - type: string - subMerchantPostalCode: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the postal code - of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 10 characters.' - type: string - subMerchantState: - description: 'This field is required if the transaction is performed by - a registered payment facilitator, and if applicable to the country. This - field must contain the state code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 3 characters.' - type: string - subMerchantStreet: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the street of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 60 characters.' - type: string - subMerchantTaxId: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the tax ID of - the actual merchant. - - * Format: alpha-numeric. - - * Fixed length: 11 or 14 characters.' - type: string - AdditionalDataLevel23: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - - Encoding: ASCII. - - - Max length: 25 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - enhancedSchemeData.destinationCountryCode: - description: 'Destination country code. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.destinationPostalCode: - description: 'The postal code of a destination address. - - - Encoding: ASCII. - - - Max length: 10 characters. - - - > Required for American Express.' - type: string - enhancedSchemeData.destinationStateProvinceCode: - description: 'Destination state or province code. - - - Encoding: ASCII.Max length: 3 characters.' - type: string - enhancedSchemeData.dutyAmount: - description: 'Duty amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.freightAmount: - description: 'Shipping amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].commodityCode: - description: 'Item commodity code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].description: - description: 'Item description. - - - Encoding: ASCII. - - - Max length: 26 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: - description: 'Discount amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].productCode: - description: 'Product code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].quantity: - description: 'Quantity, specified as an integer value. - - - Value must be greater than 0. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: - description: 'Total amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: - description: 'Item unit of measurement. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitPrice: - description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - - - Max length: 12 characters.' - type: string - enhancedSchemeData.orderDate: - description: 'Order date. - - * Format: `ddMMyy` - - - Encoding: ASCII. - - - Max length: 6 characters.' - type: string - enhancedSchemeData.shipFromPostalCode: - description: 'The postal code of a "ship-from" address. - - - Encoding: ASCII. - - - Max length: 10 characters.' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - AdditionalDataLodging: - properties: - lodging.checkInDate: - description: 'The arrival date. - - * Date format: `yyyyMMdd`' - type: string - lodging.checkOutDate: - description: 'The departure date. - - * Date format: `yyyyMMdd`' - type: string - lodging.customerServiceTollFreeNumber: - description: 'The toll free phone number for the hotel/lodgings. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.fireSafetyActIndicator: - description: 'Identifies that the facility complies with the Hotel and Motel - Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. - - * Format: Alphabetic - - * maxLength: 1' - type: string - lodging.folioCashAdvances: - description: 'The folio cash advances. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.folioNumber: - description: "Card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Format: Alphanumeric\n* maxLength: 25" - type: string - lodging.foodBeverageCharges: - description: 'Any charges for food and beverages associated with the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - - Value should be Y or N. - - * Format: Numeric - - * maxLength: 1' - type: string - lodging.prepaidExpenses: - description: 'Prepaid expenses for the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.propertyPhoneNumber: - description: 'Identifies specific lodging property location by its local - phone number. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.room1.numberOfNights: - description: 'Total number of nights the room will be rented. - - * Format: Numeric - - * maxLength: 4' - type: string - lodging.room1.rate: - description: 'The rate of the room. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.room1.tax: - description: 'The total amount of tax to be paid. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalRoomTax: - description: 'Total room tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalTax: - description: 'Total tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "H" for Hotel. This should be included - in the auth message. - - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.merchantData: - description: 'Holds different merchant data points like product, purchase, - customer, and so on. It takes data in a Base64 encoded string. - - - The `merchantData` parameter needs to be added to the `openinvoicedata` - signature at the end. - - - Since the field is optional, if it''s not included it does not impact - computing the merchant signature. - - - Applies only to Klarna. - - - You can contact Klarna for the format and structure of the string.' - type: string - openinvoicedata.numberOfLines: - description: 'The number of invoice lines included in `openinvoicedata`. - - - There needs to be at least one line, so `numberOfLines` needs to be at - least 1.' - type: string - openinvoicedataLine[itemNr].currencyCode: - description: The three-character ISO currency code. - type: string - openinvoicedataLine[itemNr].description: - description: A text description of the product the invoice line refers to. - type: string - openinvoicedataLine[itemNr].itemAmount: - description: 'The price for one item in the invoice line, represented in - minor units. - - - The due amount for the item, VAT excluded.' - type: string - openinvoicedataLine[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. - type: string - openinvoicedataLine[itemNr].itemVatAmount: - description: The VAT due for one item in the invoice line, represented in - minor units. - type: string - openinvoicedataLine[itemNr].itemVatPercentage: - description: 'The VAT percentage for one item in the invoice line, represented - in minor units. - - - For example, 19% VAT is specified as 1900.' - type: string - openinvoicedataLine[itemNr].numberOfItems: - description: The number of units purchased of a specific product. - type: string - openinvoicedataLine[itemNr].returnShippingCompany: - description: Name of the shipping company handling the the return shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingNumber: - description: The tracking number for the return of the shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingUri: - description: URI where the customer can track the return of their shipment. - type: string - openinvoicedataLine[itemNr].shippingCompany: - description: Name of the shipping company handling the delivery. - type: string - openinvoicedataLine[itemNr].shippingMethod: - description: Shipping method. - type: string - openinvoicedataLine[itemNr].trackingNumber: - description: The tracking number for the shipment. - type: string - openinvoicedataLine[itemNr].trackingUri: - description: URI where the customer can track their shipment. - type: string - AdditionalDataOpi: - properties: - opi.includeTransToken: - description: 'Optional boolean indicator. Set to **true** if you want an - ecommerce transaction to return an `opi.transToken` as additional data - in the response. - - - You can store this Oracle Payment Interface token in your Oracle Opera - database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' - type: string - AdditionalDataPayout: - properties: - fundingNetwork: - description: '' - type: string - fundingSource: - description: '' - enum: - - CREDIT - - DEBIT - - PREPAID - - DEPOSIT_ACCOUNT - type: string - fundingTransactionId: - description: '' - type: string - payoutAccountCode: - description: '' - type: string - payoutAccountHolderCode: - description: '' - type: string - payoutMarketPayUser: - description: '' - type: string - processOver: - description: '' - enum: - - MC_P2P - - Visa_OCT - - UnlinkedRefund - type: string - verifyOver: - description: '' - type: string - walletIdentifier: - description: '' - type: string - AdditionalDataRatepay: - properties: - ratepay.installmentAmount: - description: Amount the customer has to pay each month. - type: string - ratepay.interestRate: - description: Interest rate of this installment. - type: string - ratepay.lastInstallmentAmount: - description: Amount of the last installment. - type: string - ratepay.paymentFirstday: - description: Calendar day of the first payment. - type: string - ratepaydata.deliveryDate: - description: Date the merchant delivered the goods to the customer. - type: string - ratepaydata.dueDate: - description: Date by which the customer must settle the payment. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. - type: string - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - AdditionalDataRetry: - properties: - retry.chainAttemptNumber: - description: 'The number of times the transaction (not order) has been retried - between different payment service providers. For instance, the `chainAttemptNumber` - set to 2 means that this transaction has been recently tried on another - provider before being sent to Adyen. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.orderAttemptNumber: - description: 'The index of the attempt to bill a particular order, which - is identified by the `merchantOrderReference` field. For example, if a - recurring transaction fails and is retried one day later, then the order - number for these attempts would be 1 and 2, respectively. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.skipRetry: - description: 'The Boolean value indicating whether Adyen should skip or - retry this transaction, if possible. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - AdditionalDataRisk: - properties: - riskdata.[customFieldName]: - description: The data for your custom risk field. For more information, - refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). - type: string - riskdata.basket.item[itemNr].amountPerItem: - description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.basket.item[itemNr].brand: - description: Brand of the item. - type: string - riskdata.basket.item[itemNr].category: - description: Category of the item. - type: string - riskdata.basket.item[itemNr].color: - description: Color of the item. - type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string - riskdata.basket.item[itemNr].quantity: - description: Quantity of the item purchased. - type: string - riskdata.basket.item[itemNr].receiverEmail: - description: Email associated with the given product in the basket (usually - in electronic gift cards). - type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.promotions.promotion[itemNr].promotionCode: - description: Code of the promotion. - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountAmount: - description: The discount amount of the promotion, represented in [minor - units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: - description: 'Promotion''s percentage discount. It is represented in percentage - value and there is no need to include the ''%'' sign. - - - e.g. for a promotion discount of 30%, the value of the field should be - 30.' - type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string - riskdata.riskProfileReference: - description: Reference number of the risk profile that you want to apply - to the payment. If not provided or left blank, the merchant-level account's - default risk profile will be applied to the payment. For more information, - see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). - type: string - riskdata.skipRisk: - description: If this parameter is provided with the value **true**, risk - checks for the payment request are skipped and the transaction will not - get a risk score. - type: string - AdditionalDataRiskStandalone: - properties: - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.ProtectionEligibility: - description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ - \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ - \ \u2014 Merchant is not protected under the Seller Protection Policy." - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - avsResultRaw: - description: 'Raw AVS result received from the acquirer, where available. - Example: D' - type: string - bin: - description: The Bank Identification Number of a credit card, which is the - first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). - type: string - cvcResultRaw: - description: 'Raw CVC result received from the acquirer, where available. - Example: 1' - type: string - riskToken: - description: Unique identifier or token for the shopper's card details. - type: string - threeDAuthenticated: - description: 'A Boolean value indicating whether 3DS authentication was - completed on this payment. Example: true' - type: string - threeDOffered: - description: 'A Boolean value indicating whether 3DS was offered for this - payment. Example: true' - type: string - tokenDataType: - description: 'Required for PayPal payments only. The only supported value - is: **paypal**.' - type: string - AdditionalDataSubMerchant: - properties: - subMerchant.numberOfSubSellers: - description: Required for transactions performed by registered payment facilitators. - Indicates the number of sub-merchants contained in the request. For example, - **3**. - type: string - subMerchant.subSeller[subSellerNr].city: - description: 'Required for transactions performed by registered payment - facilitators. The city of the sub-merchant''s address. - - * Format: Alphanumeric - - * Maximum length: 13 characters' - type: string - subMerchant.subSeller[subSellerNr].country: - description: "Required for transactions performed by registered payment\ - \ facilitators. The three-letter country code of the sub-merchant's address.\ - \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ - * Fixed length: 3 characters" - type: string - subMerchant.subSeller[subSellerNr].id: - description: "Required for transactions performed by registered payment\ - \ facilitators. A unique identifier that you create for the sub-merchant,\ - \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ - * Maximum length: 15 characters" - type: string - subMerchant.subSeller[subSellerNr].mcc: - description: "Required for transactions performed by registered payment\ - \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ - \ \n* Format: Numeric\n* Fixed length: 4 digits" - type: string - subMerchant.subSeller[subSellerNr].name: - description: 'Required for transactions performed by registered payment - facilitators. The name of the sub-merchant. Based on scheme specifications, - this value will overwrite the shopper statement that will appear in the - card statement. - - * Format: Alphanumeric - - * Maximum length: 22 characters' - type: string - subMerchant.subSeller[subSellerNr].postalCode: - description: 'Required for transactions performed by registered payment - facilitators. The postal code of the sub-merchant''s address, without - dashes. - - * Format: Numeric - - * Fixed length: 8 digits' - type: string - subMerchant.subSeller[subSellerNr].state: - description: 'Required for transactions performed by registered payment - facilitators. The state code of the sub-merchant''s address, if applicable - to the country. - - * Format: Alphanumeric - - * Maximum length: 2 characters' - type: string - subMerchant.subSeller[subSellerNr].street: - description: 'Required for transactions performed by registered payment - facilitators. The street name and house number of the sub-merchant''s - address. - - * Format: Alphanumeric - - * Maximum length: 60 characters' - type: string - subMerchant.subSeller[subSellerNr].taxId: - description: 'Required for transactions performed by registered payment - facilitators. The tax ID of the sub-merchant. - - * Format: Numeric - - * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' - type: string - AdditionalDataTemporaryServices: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - * Encoding: ASCII - - * maxLength: 25' - type: string - enhancedSchemeData.employeeName: - description: 'Name or ID associated with the individual working in a temporary - capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.jobDescription: - description: 'Description of the job or task of the individual working in - a temporary capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.regularHoursRate: - description: 'Amount paid per regular hours worked, minor units. - - * maxLength: 7' - type: string - enhancedSchemeData.regularHoursWorked: - description: 'Amount of time worked during a normal operation for the task - or job. - - * maxLength: 7' - type: string - enhancedSchemeData.requestName: - description: 'Name of the individual requesting temporary services. - - * maxLength: 40' - type: string - enhancedSchemeData.tempStartDate: - description: 'Date for the beginning of the pay period. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.tempWeekEnding: - description: 'Date of the end of the billing cycle. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. For example, 2000 means - USD 20.00 - - * maxLength: 12' - type: string - AdditionalDataWallets: - properties: - androidpay.token: - description: The Android Pay token retrieved from the SDK. - type: string - masterpass.transactionId: - description: The Mastercard Masterpass Transaction ID retrieved from the - SDK. - type: string - payment.token: - description: The Apple Pay token retrieved from the SDK. - type: string - paywithgoogle.token: - description: The Google Pay token retrieved from the SDK. - type: string - samsungpay.token: - description: The Samsung Pay token retrieved from the SDK. - type: string - visacheckout.callId: - description: The Visa Checkout Call ID retrieved from the SDK. - type: string Address: properties: city: @@ -2105,32 +515,6 @@ components: required: - value - currency - ApplicationInfo: - properties: - adyenLibrary: - description: Adyen-developed software, such as libraries and plugins, used - to interact with the Adyen API. For example, Magento plugin, Java API - library, etc. - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - description: Adyen-developed software to get payment details. For example, - Checkout SDK, Secured Fields SDK, etc. - $ref: '#/components/schemas/CommonField' - externalPlatform: - description: Third-party developed platform used to initiate payment requests. - For example, Magento, Zuora, etc. - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - description: Merchant developed software, such as cashier application, used - to interact with the Adyen API. - $ref: '#/components/schemas/CommonField' - merchantDevice: - description: Merchant device information. - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - description: Shopper interaction device, such as terminal, mobile device - or web browser, to initiate payment requests. - $ref: '#/components/schemas/ShopperInteractionDevice' BankAccount: properties: bankAccountNumber: @@ -2179,67 +563,6 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string - BrowserInfo: - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - colorDepth: - x-addedInVersion: '40' - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - x-addedInVersion: '40' - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - x-addedInVersion: '40' - default: true - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - x-addedInVersion: '40' - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). - type: string - screenHeight: - x-addedInVersion: '40' - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - x-addedInVersion: '40' - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - x-addedInVersion: '40' - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - userAgent - - acceptHeader - - javaEnabled - - colorDepth - - screenHeight - - screenWidth - - timeZoneOffset - - language Card: properties: cvc: @@ -2308,109 +631,6 @@ components: - expiryMonth - expiryYear - holderName - CommonField: - properties: - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - DeviceRenderOptions: - properties: - sdkInterface: - default: both - description: 'Supported SDK interface types. - - Allowed values: - - * native - - * html - - * both' - enum: - - native - - html - - both - type: string - sdkUiType: - description: 'UI types supported for displaying specific challenges. - - Allowed values: - - * text - - * singleSelect - - * outOfBand - - * otherHtml - - * multiSelect' - items: - enum: - - multiSelect - - otherHtml - - outOfBand - - singleSelect - - text - type: string - type: array - ExternalPlatform: - properties: - integrator: - description: External platform integrator. - type: string - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - ForexQuote: - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - description: The base amount. - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - description: The buy rate. - $ref: '#/components/schemas/Amount' - interbank: - description: The interbank amount. - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - description: The sell rate. - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - validTill - - basePoints FraudCheckResult: properties: accountScore: @@ -2468,170 +688,6 @@ components: telephoneNumber: description: Phone number of the person type: string - Installments: - properties: - value: - description: 'Defines the number of installments. Its value needs to be - greater than zero. - - - Usually, the maximum allowed number of installments is capped. For example, - it may not be possible to split a payment in more than 24 installments. - The acquirer sets this upper limit, so its value may vary.' - format: int32 - type: integer - required: - - value - Mandate: - properties: - amount: - description: The billing amount (in minor units) of the recurring transactions. - type: string - amountRule: - description: "The limitation rule of the billing amount.\n\nPossible values:\n\ - \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ - \ **exact**: The transaction amount should be the same as the `amount`.\n\ - \n" - enum: - - max - - exact - type: string - billingAttemptsRule: - description: "The rule to specify the period, within which the recurring\ - \ debit can happen, relative to the mandate recurring date.\n\nPossible\ - \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ - \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ - \n" - enum: - - 'on' - - before - - after - type: string - billingDay: - description: 'The number of the day, on which the recurring debit can happen. - Should be within the same calendar month as the mandate recurring date. - - - Possible values: 1-31 based on the `frequency`.' - type: string - endsAt: - description: End date of the billing plan, in YYYY-MM-DD format. - type: string - frequency: - description: 'The frequency with which a shopper should be charged. - - - Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, - **halfYearly**, **yearly**.' - enum: - - adhoc - - daily - - weekly - - biWeekly - - monthly - - quarterly - - halfYearly - - yearly - type: string - remarks: - description: The message shown by UPI to the shopper on the approval screen. - type: string - startsAt: - description: Start date of the billing plan, in YYYY-MM-DD format. By default, - the transaction date. - type: string - required: - - frequency - - amount - - endsAt - MerchantDevice: - properties: - os: - description: Operating system running on the merchant device. - type: string - osVersion: - description: Version of the operating system on the merchant device. - type: string - reference: - description: Merchant device reference. - type: string - MerchantRiskIndicator: - properties: - addressMatch: - description: Whether the chosen delivery address is identical to the billing - address. - type: boolean - deliveryAddressIndicator: - description: 'Indicator regarding the delivery address. - - Allowed values: - - * `shipToBillingAddress` - - * `shipToVerifiedAddress` - - * `shipToNewAddress` - - * `shipToStore` - - * `digitalGoods` - - * `goodsNotShipped` - - * `other`' - enum: - - shipToBillingAddress - - shipToVerifiedAddress - - shipToNewAddress - - shipToStore - - digitalGoods - - goodsNotShipped - - other - type: string - deliveryEmail: - description: The delivery email address (for digital goods). - type: string - deliveryTimeframe: - description: 'The estimated delivery time for the shopper to receive the - goods. - - Allowed values: - - * `electronicDelivery` - - * `sameDayShipping` - - * `overnightShipping` - - * `twoOrMoreDaysShipping`' - enum: - - electronicDelivery - - sameDayShipping - - overnightShipping - - twoOrMoreDaysShipping - type: string - giftCardAmount: - description: For prepaid or gift card purchase, the purchase amount total - of prepaid or gift card(s). - $ref: '#/components/schemas/Amount' - giftCardCount: - description: For prepaid or gift card purchase, total count of individual - prepaid or gift cards/codes purchased. - format: int32 - type: integer - preOrderDate: - description: For pre-order purchases, the expected date this product will - be available to the shopper. - format: date-time - type: string - preOrderPurchase: - description: Indicator for whether this transaction is for pre-ordering - a product. - type: boolean - reorderItems: - description: Indicator for whether the shopper has already purchased the - same items in the past. - type: boolean ModifyRequest: properties: additionalData: @@ -3624,20 +1680,6 @@ components: Example: OOFF' type: string - SDKEphemPubKey: - properties: - crv: - description: The `crv` value as received from the 3D Secure 2 SDK. - type: string - kty: - description: The `kty` value as received from the 3D Secure 2 SDK. - type: string - x: - description: The `x` value as received from the 3D Secure 2 SDK. - type: string - y: - description: The `y` value as received from the 3D Secure 2 SDK. - type: string ServiceError: properties: additionalData: @@ -3664,80 +1706,6 @@ components: description: The HTTP response status. format: int32 type: integer - ShopperInteractionDevice: - properties: - locale: - description: Locale on the shopper interaction device. - type: string - os: - description: Operating system running on the shopper interaction device. - type: string - osVersion: - description: Version of the operating system on the shopper interaction - device. - type: string - Split: - properties: - account: - description: 'Unique identifier of the account where the split amount should - be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. - - - ' - type: string - amount: - description: The amount of this split. - $ref: '#/components/schemas/SplitAmount' - description: - description: A description of this split. - type: string - reference: - description: 'Your reference for the split, which you can use to link the - split to other operations such as captures and refunds. - - - This is required if `type` is **MarketPlace** or **BalanceAccount**. For - the other types, we also recommend sending a reference so you can reconcile - the split and the associated payment in the transaction overview and in - the reports. If the reference is not provided, the split is reported as - part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) - in Adyen for Platforms.' - type: string - type: - description: 'The type of split. - - Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, - **MarketPlace**, **BalanceAccount**, **Remainder**.' - enum: - - BalanceAccount - - Commission - - Default - - MarketPlace - - PaymentFee - - Remainder - - VAT - - Verification - type: string - required: - - amount - - type - SplitAmount: - properties: - currency: - description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - - - If this value is not provided, the currency in which the payment is made - will be used.' - maxLength: 3 - minLength: 3 - type: string - value: - description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). - format: int64 - type: integer - required: - - value StoreDetailAndSubmitRequest: properties: additionalData: @@ -4141,223 +2109,6 @@ components: required: - pspReference - resultCode - ThreeDS2RequestData: - properties: - acquirerBIN: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The acquiring BIN enrolled for 3D Secure 2. This string should match the - value that you will use in the authorisation. Use 123456 on the Test platform. - type: string - acquirerMerchantID: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. - This string should match the value that you will use in the authorisation. - Use 123456 on the Test platform. - type: string - authenticationOnly: - deprecated: true - x-deprecatedInVersion: '50' - x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. - default: false - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - challengeIndicator: - description: 'Possibility to specify a preference for receiving a challenge - from the issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string - deviceChannel: - description: 'The environment of the shopper. - - Allowed values: - - * `app` - - * `browser`' - type: string - deviceRenderOptions: - description: 'Display options for the 3D Secure 2 SDK. - - Optional and only for `deviceChannel` **app**.' - $ref: '#/components/schemas/DeviceRenderOptions' - mcc: - x-addedInVersion: '49' - description: Required for merchants that have been enrolled for 3D Secure - 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` - is registered at the scheme. - type: string - merchantName: - x-addedInVersion: '49' - description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchant name that the issuer presents to the shopper if they get - a challenge. We recommend to use the same value that you will use in the - authorization. Maximum length is 40 characters. - - > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). - Use this field if you are enrolled for 3D Secure 2 with us and want to - override the merchant name already configured on your account.' - type: string - messageVersion: - default: 2.1.0 - description: The `messageVersion` value indicating the 3D Secure 2 protocol - version. - type: string - notificationURL: - description: URL to where the issuer should send the `CRes`. Required if - you are not using components for `channel` **Web** or if you are using - classic integration `deviceChannel` **browser**. - type: string - sdkAppID: - description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEncData: - description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEphemPubKey: - description: 'The `sdkEphemPubKey` value as received from the 3D Secure - 2 SDK. - - Required for `deviceChannel` set to **app**.' - $ref: '#/components/schemas/SDKEphemPubKey' - sdkMaxTimeout: - default: 60 - description: 'The maximum amount of time in minutes for the 3D Secure 2 - authentication process. - - Optional and only for `deviceChannel` set to **app**. Defaults to **60** - minutes.' - format: int32 - type: integer - sdkReferenceNumber: - description: 'The `sdkReferenceNumber` value as received from the 3D Secure - 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkTransID: - description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkVersion: - x-addedInVersion: '40' - description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ - \ set to **app**." - type: string - threeDSCompInd: - description: Completion indicator for the device fingerprinting. - type: string - threeDSRequestorID: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor identifier assigned by the Directory - Server when you enrol for 3D Secure 2. - type: string - threeDSRequestorName: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor name assigned by the Directory Server - when you enrol for 3D Secure 2. - type: string - threeDSRequestorURL: - description: URL of the (customer service) website that will be shown to - the shopper in case of technical errors during the 3D Secure 2 process. - type: string - transactionType: - x-addedInVersion: '50' - description: Identify the type of the transaction being authenticated. - enum: - - goodsOrServicePurchase - - checkAcceptance - - accountFunding - - quasiCashTransaction - - prepaidActivationAndLoad - type: string - whiteListStatus: - x-addedInVersion: '49' - description: The `whiteListStatus` value returned from a previous 3D Secure - 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. - type: string - required: - - deviceChannel - ThreeDSecureData: - properties: - authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. - - - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' - enum: - - Y - - N - - U - - A - type: string - cavv: - description: The cardholder authentication value (base64 encoded, 20 bytes - in a decoded form). - format: byte - type: string - cavvAlgorithm: - description: The CAVV algorithm used. Include this only for 3D Secure 1. - type: string - directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. - - - In 3D Secure 2, this is the `transStatus` from the `ARes`.' - enum: - - A - - C - - D - - I - - N - - R - - U - - Y - type: string - dsTransID: - x-addedInVersion: '40' - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the Directory Server (DS) to identify a single transaction. - type: string - eci: - description: The electronic commerce indicator. - type: string - threeDSVersion: - x-addedInVersion: '40' - description: The version of the 3D Secure protocol. - type: string - xid: - description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, - 20 bytes in a decoded form). - format: byte - type: string securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PayoutService-v52.yaml b/yaml/PayoutService-v52.yaml index 81c1516..725c2ed 100644 --- a/yaml/PayoutService-v52.yaml +++ b/yaml/PayoutService-v52.yaml @@ -40,7 +40,7 @@ info: ' - x-timestamp: '2022-05-03T09:24:06Z' + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -59,7 +59,7 @@ paths: post: tags: - Reviewing - summary: Confirms a payout. + summary: Confirm a payout description: 'Confirms a previously submitted payout. @@ -126,7 +126,7 @@ paths: post: tags: - Reviewing - summary: Cancels a payout. + summary: Cancel a payout description: 'Cancels a previously submitted payout. @@ -193,7 +193,7 @@ paths: post: tags: - Instant payouts - summary: Pay out directly. + summary: Make an instant card payout description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card @@ -259,7 +259,7 @@ paths: post: tags: - Initialization - summary: Stores payout details. + summary: Store payout details description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call. @@ -324,7 +324,7 @@ paths: post: tags: - Initialization - summary: Stores details and submits a payout. + summary: Store details and submit a payout description: 'Submits a payout and stores its details for subsequent payouts. @@ -397,7 +397,7 @@ paths: post: tags: - Initialization - summary: Submits a payout. + summary: Submit a payout description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -461,1596 +461,6 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: - AccountInfo: - properties: - accountAgeIndicator: - description: 'Indicator for the length of time since this shopper account - was created in the merchant''s environment. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountChangeDate: - description: Date when the shopper's account was last changed. - format: date-time - type: string - accountChangeIndicator: - description: 'Indicator for the length of time since the shopper''s account - was last updated. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountCreationDate: - description: Date when the shopper's account was created. - format: date-time - type: string - accountType: - x-addedInVersion: '50' - description: 'Indicates the type of account. For example, for a multi-account - card product. - - Allowed values: - - * notApplicable - - * credit - - * debit' - enum: - - notApplicable - - credit - - debit - type: string - addCardAttemptsDay: - description: Number of attempts the shopper tried to add a card to their - account in the last day. - format: int32 - type: integer - deliveryAddressUsageDate: - description: Date the selected delivery address was first used. - format: date-time - type: string - deliveryAddressUsageIndicator: - description: 'Indicator for the length of time since this delivery address - was first used. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - homePhone: - description: Shopper's home phone number (including the country code). - type: string - mobilePhone: - description: Shopper's mobile phone number (including the country code). - type: string - passwordChangeDate: - description: Date when the shopper last changed their password. - format: date-time - type: string - passwordChangeIndicator: - description: 'Indicator when the shopper has changed their password. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - pastTransactionsDay: - description: Number of all transactions (successful and abandoned) from - this shopper in the past 24 hours. - format: int32 - type: integer - pastTransactionsYear: - description: Number of all transactions (successful and abandoned) from - this shopper in the past year. - format: int32 - type: integer - paymentAccountAge: - description: Date this payment method was added to the shopper's account. - format: date-time - type: string - paymentAccountIndicator: - description: 'Indicator for the length of time since this payment method - was added to this shopper''s account. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - purchasesLast6Months: - description: Number of successful purchases in the last six months. - format: int32 - type: integer - suspiciousActivity: - description: Whether suspicious activity was recorded on this account. - type: boolean - workPhone: - description: Shopper's work phone number (including the country code). - type: string - AdditionalData3DSecure: - properties: - allow3DS2: - description: "Indicates if you are able to process 3D Secure 2 transactions\ - \ natively on your payment page. Send this parameter when you are using\ - \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ - \n > This parameter only indicates readiness to support native 3D Secure\ - \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ - \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ - \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ - \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" - type: string - executeThreeD: - description: "Indicates if you want to perform 3D Secure authentication\ - \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ - \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ - \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ - \ 3D Secure authentication. Note that this setting results in refusals\ - \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ - \ national regulations. \n" - type: string - mpiImplementationType: - description: In case of Secure+, this field must be set to **CUPSecurePlus**. - type: string - scaExemption: - description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction.\n\n Possible values:\n\ - * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ - \ **transactionRiskAnalysis** " - type: string - threeDSVersion: - description: "Indicates your preference for the 3D Secure version. \n> If\ - \ you use this parameter, you override the checks from Adyen's Authentication\ - \ Engine. We recommend to use this field only if you have an extensive\ - \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ - \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ - \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ - \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ - \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ - \ in the `ARes`, we will apply the fallback policy configured in your\ - \ account. For example, if the configuration is to fall back to 3D Secure\ - \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ - \ the BIN is not enrolled, you will receive an error.\n\n" - type: string - AdditionalDataAirline: - properties: - airline.agency_invoice_number: - description: 'Reference number for the invoice, issued by the agency. - - * minLength: 1 - - * maxLength: 6' - type: string - airline.agency_plan_name: - description: '2-letter agency plan identifier; alphabetical. - - * minLength: 2 - - * maxLength: 2' - type: string - airline.airline_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit - accounting code (PAX); numeric. It identifies the carrier. - - * Format: IATA 3-digit accounting code (PAX) - - * Example: KLM = 074 - - * minLength: 3 - - * maxLength: 3' - type: string - airline.airline_designator_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.boarding_fee: - description: 'Chargeable amount for boarding the plane. - - The transaction amount needs to be represented in minor units according - to the [following table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 18' - type: string - airline.computerized_reservation_system: - description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) - used to make the reservation and purchase the ticket. - - * Format: alphanumeric. - - * minLength: 4 - - * maxLength: 4' - type: string - airline.customer_reference_number: - description: 'Reference number; alphanumeric. - - * minLength: 0 - - * maxLength: 20' - type: string - airline.document_type: - description: 'Optional 2-digit code; alphanumeric. It identifies the type - of product of the transaction. The description of the code may appear - on credit card statements. - - * Format: 2-digit code - - * Example: Passenger ticket = 01 - - * minLength: 2 - - * maxLength: 2' - type: string - airline.flight_date: - description: 'Flight departure date. Local time `(HH:mm)` is optional. - - * Date format: `yyyy-MM-dd` - - * Date and time format: `yyyy-MM-dd HH:mm` - - * minLength: 10 - - * maxLength: 16' - type: string - airline.leg.carrier_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - This field is required/mandatory if the airline data includes leg details. - - * Format: IATA 2-letter airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.leg.class_of_travel: - description: '1-letter travel class identifier; alphabetical. There is no - standard; however, the following codes are used rather consistently: - - * F: first class - - * J: business class - - * Y: economy class - - * W: premium economy - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_airport: - description: 'Alphabetical identifier of the departure airport. - - This field is required if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.depart_tax: - description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). - Amount charged by a country to an individual upon their leaving. The transaction - amount needs to be represented in minor units according to the [following - table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 12' - type: string - airline.leg.destination_code: - description: 'Alphabetical identifier of the destination/arrival airport. - - This field is required/mandatory if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.fare_base_code: - description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); - alphanumeric. - - * minLength: 1 - - * maxLength: 7' - type: string - airline.leg.flight_number: - description: 'The flight identifier. - - * minLength: 1 - - * maxLength: 5' - type: string - airline.leg.stop_over_code: - description: '1-letter code that indicates whether the passenger is entitled - to make a stopover. Only two types of characters are allowed: - - * O: Stopover allowed - - * X: Stopover not allowed - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.passenger.date_of_birth: - description: 'Date of birth of the passenger. - - - Date format: `yyyy-MM-dd` - - * minLength: 10 - - * maxLength: 10' - type: string - airline.passenger.first_name: - description: 'Passenger first name/given name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.last_name: - description: 'Passenger last name/family name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.telephone_number: - description: 'Telephone number of the passenger, including country code. - This is an alphanumeric field that can include the ''+'' and ''-'' signs. - - * minLength: 3 - - * maxLength: 30' - type: string - airline.passenger.traveller_type: - description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. - Example: ADT, SRC, CNN, INS. - - - However, several carriers use non-standard codes that can be up to 5 alphanumeric - characters. - - * minLength: 3 - - * maxLength: 6' - type: string - airline.passenger_name: - description: 'Passenger name, initials, and a title. - - * Format: last name + first name or initials + title. - - * Example: *FLYER / MARY MS*. - - * minLength: 1 - - * maxLength: 49' - type: string - airline.ticket_issue_address: - description: 'Address of the place/agency that issued the ticket. - - * minLength: 0 - - * maxLength: 16' - type: string - airline.ticket_number: - description: 'The ticket''s unique identifier. - - * minLength: 1 - - * maxLength: 150' - type: string - airline.travel_agency_code: - description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier - number for travel agencies. - - * minLength: 1 - - * maxLength: 8' - type: string - airline.travel_agency_name: - description: 'The name of the travel agency. - - * minLength: 1 - - * maxLength: 25' - type: string - required: - - airline.passenger_name - AdditionalDataCarRental: - properties: - carRental.checkOutDate: - description: 'Pick-up date. - - * Date format: `yyyyMMdd`' - type: string - carRental.customerServiceTollFreeNumber: - description: 'The customer service phone number of the car rental company. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - carRental.daysRented: - description: 'Number of days for which the car is being rented. - - * Format: Numeric - - * maxLength: 19' - type: string - carRental.fuelCharges: - description: 'Any fuel charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.insuranceCharges: - description: 'Any insurance charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.locationCity: - description: 'The city from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.locationCountry: - description: 'The country from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.locationStateProvince: - description: 'The state or province from where the car is rented. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - * Y - Customer was a no show. - - * N - Not applicable.' - type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. - type: string - carRental.rate: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.rateIndicator: - description: 'Specifies whether the given rate is applied daily or weekly. - - * D - Daily rate. - - * W - Weekly rate.' - type: string - carRental.rentalAgreementNumber: - description: 'The rental agreement number associated with this car rental. - - * Format: Alphanumeric - - * maxLength: 9' - type: string - carRental.rentalClassId: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.renterName: - description: 'The name of the person renting the car. - - * Format: Alphanumeric - - * maxLength: 26' - type: string - carRental.returnCity: - description: 'The city where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.returnCountry: - description: 'The country where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.returnDate: - description: 'The last date to return the car by. - - * Date format: `yyyyMMdd`' - type: string - carRental.returnLocationId: - description: 'Agency code, phone number, or address abbreviation - - * Format: Alphanumeric - - * maxLength: 10' - type: string - carRental.returnStateProvince: - description: 'The state or province where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.taxExemptIndicator: - description: 'Indicates whether the goods or services were tax-exempt, or - tax was not collected. - - - Values: - - * Y - Goods or services were tax exempt - - * N - Tax was not collected' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "A" for Car rental. This should be - included in the auth message. - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataCommon: - properties: - RequestedTestErrorResponseCode: - description: "Triggers test scenarios that allow to replicate certain communication\ - \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ - \ wasn't a connection available to service the outgoing communication.\n\ - This is a transient, retriable error since no messaging could be initiated\ - \ to an issuing system (or third-party acquiring system). Therefore, the\ - \ header Transient-Error: true is returned in the response. A subsequent\ - \ request using the same idempotency key will be processed as if it was\ - \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ - \ wrong during transmission of the message or receiving the response.\n\ - This is a classified as non-transient because the message could have been\ - \ received by the issuing party and been acted upon. No transient error\ - \ header is returned. If using idempotency, the (error) response is stored\ - \ as the final result for the idempotency key. Subsequent messages with\ - \ the same idempotency key not be processed beyond returning the stored\ - \ response." - type: string - authorisationType: - description: "Flags a card payment request for either pre-authorisation\ - \ or final authorisation. For more information, refer to [Authorisation\ - \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ - \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ - \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ - \ request to be handled as a final authorisation." - type: string - customRoutingFlag: - description: 'Allows you to determine or override the acquirer account that - should be used for the transaction. - - - If you need to process a payment with an acquirer different from a default - one, you can set up a corresponding configuration on the Adyen payments - platform. Then you can pass a custom routing flag in a payment request''s - additional data to target a specific acquirer. - - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' - type: string - industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge - description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ - \ this field denotes why the additional payment is made.\n\nPossible values:\n\ - \n * **NoShow**: An incremental charge is carried out because of a no-show\ - \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ - \ charge is carried out to process an additional payment after the original\ - \ services have been rendered and the respective payment has been processed." - enum: - - NoShow - - DelayedCharge - type: string - networkTxReference: - description: 'Allows you to link the transaction to the original or previous - one in a subscription/card-on-file chain. This field is required for token-based - transactions where Adyen does not tokenize the card. - - - Transaction identifier from card schemes, for example, Mastercard Trace - ID or the Visa Transaction ID. - - - Submit the original transaction ID of the contract in your payment request - if you are not tokenizing card details with Adyen and are making a merchant-initiated - transaction (MIT) for subsequent charges. - - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` - **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction - is classified as MIT.' - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - subMerchantCity: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the city of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 13 characters.' - type: string - subMerchantCountry: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the three-letter - country code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Fixed length: 3 characters.' - type: string - subMerchantID: - description: 'This field contains an identifier of the actual merchant when - a transaction is submitted via a payment facilitator. The payment facilitator - must send in this unique ID. - - - A unique identifier per submerchant that is required if the transaction - is performed by a registered payment facilitator. - - * Format: alpha-numeric. - - * Fixed length: 15 characters.' - type: string - subMerchantName: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the name of - the actual merchant. - - * Format: alpha-numeric. - - * Maximum length: 22 characters.' - type: string - subMerchantPostalCode: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the postal code - of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 10 characters.' - type: string - subMerchantState: - description: 'This field is required if the transaction is performed by - a registered payment facilitator, and if applicable to the country. This - field must contain the state code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 3 characters.' - type: string - subMerchantStreet: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the street of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 60 characters.' - type: string - subMerchantTaxId: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the tax ID of - the actual merchant. - - * Format: alpha-numeric. - - * Fixed length: 11 or 14 characters.' - type: string - AdditionalDataLevel23: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - - Encoding: ASCII. - - - Max length: 25 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - enhancedSchemeData.destinationCountryCode: - description: 'Destination country code. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.destinationPostalCode: - description: 'The postal code of a destination address. - - - Encoding: ASCII. - - - Max length: 10 characters. - - - > Required for American Express.' - type: string - enhancedSchemeData.destinationStateProvinceCode: - description: 'Destination state or province code. - - - Encoding: ASCII.Max length: 3 characters.' - type: string - enhancedSchemeData.dutyAmount: - description: 'Duty amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.freightAmount: - description: 'Shipping amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].commodityCode: - description: 'Item commodity code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].description: - description: 'Item description. - - - Encoding: ASCII. - - - Max length: 26 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: - description: 'Discount amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].productCode: - description: 'Product code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].quantity: - description: 'Quantity, specified as an integer value. - - - Value must be greater than 0. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: - description: 'Total amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: - description: 'Item unit of measurement. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitPrice: - description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - - - Max length: 12 characters.' - type: string - enhancedSchemeData.orderDate: - description: 'Order date. - - * Format: `ddMMyy` - - - Encoding: ASCII. - - - Max length: 6 characters.' - type: string - enhancedSchemeData.shipFromPostalCode: - description: 'The postal code of a "ship-from" address. - - - Encoding: ASCII. - - - Max length: 10 characters.' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - AdditionalDataLodging: - properties: - lodging.checkInDate: - description: 'The arrival date. - - * Date format: `yyyyMMdd`' - type: string - lodging.checkOutDate: - description: 'The departure date. - - * Date format: `yyyyMMdd`' - type: string - lodging.customerServiceTollFreeNumber: - description: 'The toll free phone number for the hotel/lodgings. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.fireSafetyActIndicator: - description: 'Identifies that the facility complies with the Hotel and Motel - Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. - - * Format: Alphabetic - - * maxLength: 1' - type: string - lodging.folioCashAdvances: - description: 'The folio cash advances. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.folioNumber: - description: "Card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Format: Alphanumeric\n* maxLength: 25" - type: string - lodging.foodBeverageCharges: - description: 'Any charges for food and beverages associated with the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - - Value should be Y or N. - - * Format: Numeric - - * maxLength: 1' - type: string - lodging.prepaidExpenses: - description: 'Prepaid expenses for the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.propertyPhoneNumber: - description: 'Identifies specific lodging property location by its local - phone number. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.room1.numberOfNights: - description: 'Total number of nights the room will be rented. - - * Format: Numeric - - * maxLength: 4' - type: string - lodging.room1.rate: - description: 'The rate of the room. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.room1.tax: - description: 'The total amount of tax to be paid. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalRoomTax: - description: 'Total room tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalTax: - description: 'Total tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "H" for Hotel. This should be included - in the auth message. - - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.merchantData: - description: 'Holds different merchant data points like product, purchase, - customer, and so on. It takes data in a Base64 encoded string. - - - The `merchantData` parameter needs to be added to the `openinvoicedata` - signature at the end. - - - Since the field is optional, if it''s not included it does not impact - computing the merchant signature. - - - Applies only to Klarna. - - - You can contact Klarna for the format and structure of the string.' - type: string - openinvoicedata.numberOfLines: - description: 'The number of invoice lines included in `openinvoicedata`. - - - There needs to be at least one line, so `numberOfLines` needs to be at - least 1.' - type: string - openinvoicedataLine[itemNr].currencyCode: - description: The three-character ISO currency code. - type: string - openinvoicedataLine[itemNr].description: - description: A text description of the product the invoice line refers to. - type: string - openinvoicedataLine[itemNr].itemAmount: - description: 'The price for one item in the invoice line, represented in - minor units. - - - The due amount for the item, VAT excluded.' - type: string - openinvoicedataLine[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. - type: string - openinvoicedataLine[itemNr].itemVatAmount: - description: The VAT due for one item in the invoice line, represented in - minor units. - type: string - openinvoicedataLine[itemNr].itemVatPercentage: - description: 'The VAT percentage for one item in the invoice line, represented - in minor units. - - - For example, 19% VAT is specified as 1900.' - type: string - openinvoicedataLine[itemNr].numberOfItems: - description: The number of units purchased of a specific product. - type: string - openinvoicedataLine[itemNr].returnShippingCompany: - description: Name of the shipping company handling the the return shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingNumber: - description: The tracking number for the return of the shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingUri: - description: URI where the customer can track the return of their shipment. - type: string - openinvoicedataLine[itemNr].shippingCompany: - description: Name of the shipping company handling the delivery. - type: string - openinvoicedataLine[itemNr].shippingMethod: - description: Shipping method. - type: string - openinvoicedataLine[itemNr].trackingNumber: - description: The tracking number for the shipment. - type: string - openinvoicedataLine[itemNr].trackingUri: - description: URI where the customer can track their shipment. - type: string - AdditionalDataOpi: - properties: - opi.includeTransToken: - description: 'Optional boolean indicator. Set to **true** if you want an - ecommerce transaction to return an `opi.transToken` as additional data - in the response. - - - You can store this Oracle Payment Interface token in your Oracle Opera - database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' - type: string - AdditionalDataPayout: - properties: - fundingNetwork: - description: '' - type: string - fundingSource: - description: '' - enum: - - CREDIT - - DEBIT - - PREPAID - - DEPOSIT_ACCOUNT - type: string - fundingTransactionId: - description: '' - type: string - payoutAccountCode: - description: '' - type: string - payoutAccountHolderCode: - description: '' - type: string - payoutMarketPayUser: - description: '' - type: string - processOver: - description: '' - enum: - - MC_P2P - - Visa_OCT - - UnlinkedRefund - type: string - verifyOver: - description: '' - type: string - walletIdentifier: - description: '' - type: string - AdditionalDataRatepay: - properties: - ratepay.installmentAmount: - description: Amount the customer has to pay each month. - type: string - ratepay.interestRate: - description: Interest rate of this installment. - type: string - ratepay.lastInstallmentAmount: - description: Amount of the last installment. - type: string - ratepay.paymentFirstday: - description: Calendar day of the first payment. - type: string - ratepaydata.deliveryDate: - description: Date the merchant delivered the goods to the customer. - type: string - ratepaydata.dueDate: - description: Date by which the customer must settle the payment. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. - type: string - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - AdditionalDataRetry: - properties: - retry.chainAttemptNumber: - description: 'The number of times the transaction (not order) has been retried - between different payment service providers. For instance, the `chainAttemptNumber` - set to 2 means that this transaction has been recently tried on another - provider before being sent to Adyen. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.orderAttemptNumber: - description: 'The index of the attempt to bill a particular order, which - is identified by the `merchantOrderReference` field. For example, if a - recurring transaction fails and is retried one day later, then the order - number for these attempts would be 1 and 2, respectively. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.skipRetry: - description: 'The Boolean value indicating whether Adyen should skip or - retry this transaction, if possible. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - AdditionalDataRisk: - properties: - riskdata.[customFieldName]: - description: The data for your custom risk field. For more information, - refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). - type: string - riskdata.basket.item[itemNr].amountPerItem: - description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.basket.item[itemNr].brand: - description: Brand of the item. - type: string - riskdata.basket.item[itemNr].category: - description: Category of the item. - type: string - riskdata.basket.item[itemNr].color: - description: Color of the item. - type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string - riskdata.basket.item[itemNr].quantity: - description: Quantity of the item purchased. - type: string - riskdata.basket.item[itemNr].receiverEmail: - description: Email associated with the given product in the basket (usually - in electronic gift cards). - type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.promotions.promotion[itemNr].promotionCode: - description: Code of the promotion. - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountAmount: - description: The discount amount of the promotion, represented in [minor - units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: - description: 'Promotion''s percentage discount. It is represented in percentage - value and there is no need to include the ''%'' sign. - - - e.g. for a promotion discount of 30%, the value of the field should be - 30.' - type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string - riskdata.riskProfileReference: - description: Reference number of the risk profile that you want to apply - to the payment. If not provided or left blank, the merchant-level account's - default risk profile will be applied to the payment. For more information, - see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). - type: string - riskdata.skipRisk: - description: If this parameter is provided with the value **true**, risk - checks for the payment request are skipped and the transaction will not - get a risk score. - type: string - AdditionalDataRiskStandalone: - properties: - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.ProtectionEligibility: - description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ - \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ - \ \u2014 Merchant is not protected under the Seller Protection Policy." - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - avsResultRaw: - description: 'Raw AVS result received from the acquirer, where available. - Example: D' - type: string - bin: - description: The Bank Identification Number of a credit card, which is the - first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). - type: string - cvcResultRaw: - description: 'Raw CVC result received from the acquirer, where available. - Example: 1' - type: string - riskToken: - description: Unique identifier or token for the shopper's card details. - type: string - threeDAuthenticated: - description: 'A Boolean value indicating whether 3DS authentication was - completed on this payment. Example: true' - type: string - threeDOffered: - description: 'A Boolean value indicating whether 3DS was offered for this - payment. Example: true' - type: string - tokenDataType: - description: 'Required for PayPal payments only. The only supported value - is: **paypal**.' - type: string - AdditionalDataSubMerchant: - properties: - subMerchant.numberOfSubSellers: - description: Required for transactions performed by registered payment facilitators. - Indicates the number of sub-merchants contained in the request. For example, - **3**. - type: string - subMerchant.subSeller[subSellerNr].city: - description: 'Required for transactions performed by registered payment - facilitators. The city of the sub-merchant''s address. - - * Format: Alphanumeric - - * Maximum length: 13 characters' - type: string - subMerchant.subSeller[subSellerNr].country: - description: "Required for transactions performed by registered payment\ - \ facilitators. The three-letter country code of the sub-merchant's address.\ - \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ - * Fixed length: 3 characters" - type: string - subMerchant.subSeller[subSellerNr].id: - description: "Required for transactions performed by registered payment\ - \ facilitators. A unique identifier that you create for the sub-merchant,\ - \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ - * Maximum length: 15 characters" - type: string - subMerchant.subSeller[subSellerNr].mcc: - description: "Required for transactions performed by registered payment\ - \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ - \ \n* Format: Numeric\n* Fixed length: 4 digits" - type: string - subMerchant.subSeller[subSellerNr].name: - description: 'Required for transactions performed by registered payment - facilitators. The name of the sub-merchant. Based on scheme specifications, - this value will overwrite the shopper statement that will appear in the - card statement. - - * Format: Alphanumeric - - * Maximum length: 22 characters' - type: string - subMerchant.subSeller[subSellerNr].postalCode: - description: 'Required for transactions performed by registered payment - facilitators. The postal code of the sub-merchant''s address, without - dashes. - - * Format: Numeric - - * Fixed length: 8 digits' - type: string - subMerchant.subSeller[subSellerNr].state: - description: 'Required for transactions performed by registered payment - facilitators. The state code of the sub-merchant''s address, if applicable - to the country. - - * Format: Alphanumeric - - * Maximum length: 2 characters' - type: string - subMerchant.subSeller[subSellerNr].street: - description: 'Required for transactions performed by registered payment - facilitators. The street name and house number of the sub-merchant''s - address. - - * Format: Alphanumeric - - * Maximum length: 60 characters' - type: string - subMerchant.subSeller[subSellerNr].taxId: - description: 'Required for transactions performed by registered payment - facilitators. The tax ID of the sub-merchant. - - * Format: Numeric - - * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' - type: string - AdditionalDataTemporaryServices: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - * Encoding: ASCII - - * maxLength: 25' - type: string - enhancedSchemeData.employeeName: - description: 'Name or ID associated with the individual working in a temporary - capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.jobDescription: - description: 'Description of the job or task of the individual working in - a temporary capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.regularHoursRate: - description: 'Amount paid per regular hours worked, minor units. - - * maxLength: 7' - type: string - enhancedSchemeData.regularHoursWorked: - description: 'Amount of time worked during a normal operation for the task - or job. - - * maxLength: 7' - type: string - enhancedSchemeData.requestName: - description: 'Name of the individual requesting temporary services. - - * maxLength: 40' - type: string - enhancedSchemeData.tempStartDate: - description: 'Date for the beginning of the pay period. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.tempWeekEnding: - description: 'Date of the end of the billing cycle. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. For example, 2000 means - USD 20.00 - - * maxLength: 12' - type: string - AdditionalDataWallets: - properties: - androidpay.token: - description: The Android Pay token retrieved from the SDK. - type: string - masterpass.transactionId: - description: The Mastercard Masterpass Transaction ID retrieved from the - SDK. - type: string - payment.token: - description: The Apple Pay token retrieved from the SDK. - type: string - paywithgoogle.token: - description: The Google Pay token retrieved from the SDK. - type: string - samsungpay.token: - description: The Samsung Pay token retrieved from the SDK. - type: string - visacheckout.callId: - description: The Visa Checkout Call ID retrieved from the SDK. - type: string Address: properties: city: @@ -2105,32 +515,6 @@ components: required: - value - currency - ApplicationInfo: - properties: - adyenLibrary: - description: Adyen-developed software, such as libraries and plugins, used - to interact with the Adyen API. For example, Magento plugin, Java API - library, etc. - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - description: Adyen-developed software to get payment details. For example, - Checkout SDK, Secured Fields SDK, etc. - $ref: '#/components/schemas/CommonField' - externalPlatform: - description: Third-party developed platform used to initiate payment requests. - For example, Magento, Zuora, etc. - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - description: Merchant developed software, such as cashier application, used - to interact with the Adyen API. - $ref: '#/components/schemas/CommonField' - merchantDevice: - description: Merchant device information. - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - description: Shopper interaction device, such as terminal, mobile device - or web browser, to initiate payment requests. - $ref: '#/components/schemas/ShopperInteractionDevice' BankAccount: properties: bankAccountNumber: @@ -2179,67 +563,6 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string - BrowserInfo: - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - colorDepth: - x-addedInVersion: '40' - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - x-addedInVersion: '40' - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - x-addedInVersion: '40' - default: true - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - x-addedInVersion: '40' - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). - type: string - screenHeight: - x-addedInVersion: '40' - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - x-addedInVersion: '40' - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - x-addedInVersion: '40' - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - userAgent - - acceptHeader - - javaEnabled - - colorDepth - - screenHeight - - screenWidth - - timeZoneOffset - - language Card: properties: cvc: @@ -2308,109 +631,6 @@ components: - expiryMonth - expiryYear - holderName - CommonField: - properties: - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - DeviceRenderOptions: - properties: - sdkInterface: - default: both - description: 'Supported SDK interface types. - - Allowed values: - - * native - - * html - - * both' - enum: - - native - - html - - both - type: string - sdkUiType: - description: 'UI types supported for displaying specific challenges. - - Allowed values: - - * text - - * singleSelect - - * outOfBand - - * otherHtml - - * multiSelect' - items: - enum: - - multiSelect - - otherHtml - - outOfBand - - singleSelect - - text - type: string - type: array - ExternalPlatform: - properties: - integrator: - description: External platform integrator. - type: string - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - ForexQuote: - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - description: The base amount. - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - description: The buy rate. - $ref: '#/components/schemas/Amount' - interbank: - description: The interbank amount. - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - description: The sell rate. - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - validTill - - basePoints FraudCheckResult: properties: accountScore: @@ -2468,170 +688,6 @@ components: telephoneNumber: description: Phone number of the person type: string - Installments: - properties: - value: - description: 'Defines the number of installments. Its value needs to be - greater than zero. - - - Usually, the maximum allowed number of installments is capped. For example, - it may not be possible to split a payment in more than 24 installments. - The acquirer sets this upper limit, so its value may vary.' - format: int32 - type: integer - required: - - value - Mandate: - properties: - amount: - description: The billing amount (in minor units) of the recurring transactions. - type: string - amountRule: - description: "The limitation rule of the billing amount.\n\nPossible values:\n\ - \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ - \ **exact**: The transaction amount should be the same as the `amount`.\n\ - \n" - enum: - - max - - exact - type: string - billingAttemptsRule: - description: "The rule to specify the period, within which the recurring\ - \ debit can happen, relative to the mandate recurring date.\n\nPossible\ - \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ - \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ - \n" - enum: - - 'on' - - before - - after - type: string - billingDay: - description: 'The number of the day, on which the recurring debit can happen. - Should be within the same calendar month as the mandate recurring date. - - - Possible values: 1-31 based on the `frequency`.' - type: string - endsAt: - description: End date of the billing plan, in YYYY-MM-DD format. - type: string - frequency: - description: 'The frequency with which a shopper should be charged. - - - Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, - **halfYearly**, **yearly**.' - enum: - - adhoc - - daily - - weekly - - biWeekly - - monthly - - quarterly - - halfYearly - - yearly - type: string - remarks: - description: The message shown by UPI to the shopper on the approval screen. - type: string - startsAt: - description: Start date of the billing plan, in YYYY-MM-DD format. By default, - the transaction date. - type: string - required: - - frequency - - amount - - endsAt - MerchantDevice: - properties: - os: - description: Operating system running on the merchant device. - type: string - osVersion: - description: Version of the operating system on the merchant device. - type: string - reference: - description: Merchant device reference. - type: string - MerchantRiskIndicator: - properties: - addressMatch: - description: Whether the chosen delivery address is identical to the billing - address. - type: boolean - deliveryAddressIndicator: - description: 'Indicator regarding the delivery address. - - Allowed values: - - * `shipToBillingAddress` - - * `shipToVerifiedAddress` - - * `shipToNewAddress` - - * `shipToStore` - - * `digitalGoods` - - * `goodsNotShipped` - - * `other`' - enum: - - shipToBillingAddress - - shipToVerifiedAddress - - shipToNewAddress - - shipToStore - - digitalGoods - - goodsNotShipped - - other - type: string - deliveryEmail: - description: The delivery email address (for digital goods). - type: string - deliveryTimeframe: - description: 'The estimated delivery time for the shopper to receive the - goods. - - Allowed values: - - * `electronicDelivery` - - * `sameDayShipping` - - * `overnightShipping` - - * `twoOrMoreDaysShipping`' - enum: - - electronicDelivery - - sameDayShipping - - overnightShipping - - twoOrMoreDaysShipping - type: string - giftCardAmount: - description: For prepaid or gift card purchase, the purchase amount total - of prepaid or gift card(s). - $ref: '#/components/schemas/Amount' - giftCardCount: - description: For prepaid or gift card purchase, total count of individual - prepaid or gift cards/codes purchased. - format: int32 - type: integer - preOrderDate: - description: For pre-order purchases, the expected date this product will - be available to the shopper. - format: date-time - type: string - preOrderPurchase: - description: Indicator for whether this transaction is for pre-ordering - a product. - type: boolean - reorderItems: - description: Indicator for whether the shopper has already purchased the - same items in the past. - type: boolean ModifyRequest: properties: additionalData: @@ -3624,20 +1680,6 @@ components: Example: OOFF' type: string - SDKEphemPubKey: - properties: - crv: - description: The `crv` value as received from the 3D Secure 2 SDK. - type: string - kty: - description: The `kty` value as received from the 3D Secure 2 SDK. - type: string - x: - description: The `x` value as received from the 3D Secure 2 SDK. - type: string - y: - description: The `y` value as received from the 3D Secure 2 SDK. - type: string ServiceError: properties: additionalData: @@ -3664,80 +1706,6 @@ components: description: The HTTP response status. format: int32 type: integer - ShopperInteractionDevice: - properties: - locale: - description: Locale on the shopper interaction device. - type: string - os: - description: Operating system running on the shopper interaction device. - type: string - osVersion: - description: Version of the operating system on the shopper interaction - device. - type: string - Split: - properties: - account: - description: 'Unique identifier of the account where the split amount should - be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. - - - ' - type: string - amount: - description: The amount of this split. - $ref: '#/components/schemas/SplitAmount' - description: - description: A description of this split. - type: string - reference: - description: 'Your reference for the split, which you can use to link the - split to other operations such as captures and refunds. - - - This is required if `type` is **MarketPlace** or **BalanceAccount**. For - the other types, we also recommend sending a reference so you can reconcile - the split and the associated payment in the transaction overview and in - the reports. If the reference is not provided, the split is reported as - part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) - in Adyen for Platforms.' - type: string - type: - description: 'The type of split. - - Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, - **MarketPlace**, **BalanceAccount**, **Remainder**.' - enum: - - BalanceAccount - - Commission - - Default - - MarketPlace - - PaymentFee - - Remainder - - VAT - - Verification - type: string - required: - - amount - - type - SplitAmount: - properties: - currency: - description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - - - If this value is not provided, the currency in which the payment is made - will be used.' - maxLength: 3 - minLength: 3 - type: string - value: - description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). - format: int64 - type: integer - required: - - value StoreDetailAndSubmitRequest: properties: additionalData: @@ -4149,223 +2117,6 @@ components: required: - pspReference - resultCode - ThreeDS2RequestData: - properties: - acquirerBIN: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The acquiring BIN enrolled for 3D Secure 2. This string should match the - value that you will use in the authorisation. Use 123456 on the Test platform. - type: string - acquirerMerchantID: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. - This string should match the value that you will use in the authorisation. - Use 123456 on the Test platform. - type: string - authenticationOnly: - deprecated: true - x-deprecatedInVersion: '50' - x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. - default: false - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - challengeIndicator: - description: 'Possibility to specify a preference for receiving a challenge - from the issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string - deviceChannel: - description: 'The environment of the shopper. - - Allowed values: - - * `app` - - * `browser`' - type: string - deviceRenderOptions: - description: 'Display options for the 3D Secure 2 SDK. - - Optional and only for `deviceChannel` **app**.' - $ref: '#/components/schemas/DeviceRenderOptions' - mcc: - x-addedInVersion: '49' - description: Required for merchants that have been enrolled for 3D Secure - 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` - is registered at the scheme. - type: string - merchantName: - x-addedInVersion: '49' - description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchant name that the issuer presents to the shopper if they get - a challenge. We recommend to use the same value that you will use in the - authorization. Maximum length is 40 characters. - - > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). - Use this field if you are enrolled for 3D Secure 2 with us and want to - override the merchant name already configured on your account.' - type: string - messageVersion: - default: 2.1.0 - description: The `messageVersion` value indicating the 3D Secure 2 protocol - version. - type: string - notificationURL: - description: URL to where the issuer should send the `CRes`. Required if - you are not using components for `channel` **Web** or if you are using - classic integration `deviceChannel` **browser**. - type: string - sdkAppID: - description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEncData: - description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEphemPubKey: - description: 'The `sdkEphemPubKey` value as received from the 3D Secure - 2 SDK. - - Required for `deviceChannel` set to **app**.' - $ref: '#/components/schemas/SDKEphemPubKey' - sdkMaxTimeout: - default: 60 - description: 'The maximum amount of time in minutes for the 3D Secure 2 - authentication process. - - Optional and only for `deviceChannel` set to **app**. Defaults to **60** - minutes.' - format: int32 - type: integer - sdkReferenceNumber: - description: 'The `sdkReferenceNumber` value as received from the 3D Secure - 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkTransID: - description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkVersion: - x-addedInVersion: '40' - description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ - \ set to **app**." - type: string - threeDSCompInd: - description: Completion indicator for the device fingerprinting. - type: string - threeDSRequestorID: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor identifier assigned by the Directory - Server when you enrol for 3D Secure 2. - type: string - threeDSRequestorName: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor name assigned by the Directory Server - when you enrol for 3D Secure 2. - type: string - threeDSRequestorURL: - description: URL of the (customer service) website that will be shown to - the shopper in case of technical errors during the 3D Secure 2 process. - type: string - transactionType: - x-addedInVersion: '50' - description: Identify the type of the transaction being authenticated. - enum: - - goodsOrServicePurchase - - checkAcceptance - - accountFunding - - quasiCashTransaction - - prepaidActivationAndLoad - type: string - whiteListStatus: - x-addedInVersion: '49' - description: The `whiteListStatus` value returned from a previous 3D Secure - 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. - type: string - required: - - deviceChannel - ThreeDSecureData: - properties: - authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. - - - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' - enum: - - Y - - N - - U - - A - type: string - cavv: - description: The cardholder authentication value (base64 encoded, 20 bytes - in a decoded form). - format: byte - type: string - cavvAlgorithm: - description: The CAVV algorithm used. Include this only for 3D Secure 1. - type: string - directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. - - - In 3D Secure 2, this is the `transStatus` from the `ARes`.' - enum: - - A - - C - - D - - I - - N - - R - - U - - Y - type: string - dsTransID: - x-addedInVersion: '40' - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the Directory Server (DS) to identify a single transaction. - type: string - eci: - description: The electronic commerce indicator. - type: string - threeDSVersion: - x-addedInVersion: '40' - description: The version of the 3D Secure protocol. - type: string - xid: - description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, - 20 bytes in a decoded form). - format: byte - type: string securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PayoutService-v64.yaml b/yaml/PayoutService-v64.yaml index ca66994..a3edaa7 100644 --- a/yaml/PayoutService-v64.yaml +++ b/yaml/PayoutService-v64.yaml @@ -40,7 +40,7 @@ info: ' - x-timestamp: '2022-05-03T09:24:06Z' + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -59,7 +59,7 @@ paths: post: tags: - Reviewing - summary: Confirms a payout. + summary: Confirm a payout description: 'Confirms a previously submitted payout. @@ -126,7 +126,7 @@ paths: post: tags: - Reviewing - summary: Cancels a payout. + summary: Cancel a payout description: 'Cancels a previously submitted payout. @@ -193,7 +193,7 @@ paths: post: tags: - Instant payouts - summary: Pay out directly. + summary: Make an instant card payout description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card @@ -259,7 +259,7 @@ paths: post: tags: - Initialization - summary: Stores payout details. + summary: Store payout details description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call. @@ -324,7 +324,7 @@ paths: post: tags: - Initialization - summary: Stores details and submits a payout. + summary: Store details and submit a payout description: 'Submits a payout and stores its details for subsequent payouts. @@ -397,7 +397,7 @@ paths: post: tags: - Initialization - summary: Submits a payout. + summary: Submit a payout description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -461,1596 +461,6 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: - AccountInfo: - properties: - accountAgeIndicator: - description: 'Indicator for the length of time since this shopper account - was created in the merchant''s environment. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountChangeDate: - description: Date when the shopper's account was last changed. - format: date-time - type: string - accountChangeIndicator: - description: 'Indicator for the length of time since the shopper''s account - was last updated. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountCreationDate: - description: Date when the shopper's account was created. - format: date-time - type: string - accountType: - x-addedInVersion: '50' - description: 'Indicates the type of account. For example, for a multi-account - card product. - - Allowed values: - - * notApplicable - - * credit - - * debit' - enum: - - notApplicable - - credit - - debit - type: string - addCardAttemptsDay: - description: Number of attempts the shopper tried to add a card to their - account in the last day. - format: int32 - type: integer - deliveryAddressUsageDate: - description: Date the selected delivery address was first used. - format: date-time - type: string - deliveryAddressUsageIndicator: - description: 'Indicator for the length of time since this delivery address - was first used. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - homePhone: - description: Shopper's home phone number (including the country code). - type: string - mobilePhone: - description: Shopper's mobile phone number (including the country code). - type: string - passwordChangeDate: - description: Date when the shopper last changed their password. - format: date-time - type: string - passwordChangeIndicator: - description: 'Indicator when the shopper has changed their password. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - pastTransactionsDay: - description: Number of all transactions (successful and abandoned) from - this shopper in the past 24 hours. - format: int32 - type: integer - pastTransactionsYear: - description: Number of all transactions (successful and abandoned) from - this shopper in the past year. - format: int32 - type: integer - paymentAccountAge: - description: Date this payment method was added to the shopper's account. - format: date-time - type: string - paymentAccountIndicator: - description: 'Indicator for the length of time since this payment method - was added to this shopper''s account. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - purchasesLast6Months: - description: Number of successful purchases in the last six months. - format: int32 - type: integer - suspiciousActivity: - description: Whether suspicious activity was recorded on this account. - type: boolean - workPhone: - description: Shopper's work phone number (including the country code). - type: string - AdditionalData3DSecure: - properties: - allow3DS2: - description: "Indicates if you are able to process 3D Secure 2 transactions\ - \ natively on your payment page. Send this parameter when you are using\ - \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ - \n > This parameter only indicates readiness to support native 3D Secure\ - \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ - \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ - \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ - \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" - type: string - executeThreeD: - description: "Indicates if you want to perform 3D Secure authentication\ - \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ - \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ - \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ - \ 3D Secure authentication. Note that this setting results in refusals\ - \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ - \ national regulations. \n" - type: string - mpiImplementationType: - description: In case of Secure+, this field must be set to **CUPSecurePlus**. - type: string - scaExemption: - description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction.\n\n Possible values:\n\ - * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ - \ **transactionRiskAnalysis** " - type: string - threeDSVersion: - description: "Indicates your preference for the 3D Secure version. \n> If\ - \ you use this parameter, you override the checks from Adyen's Authentication\ - \ Engine. We recommend to use this field only if you have an extensive\ - \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ - \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ - \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ - \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ - \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ - \ in the `ARes`, we will apply the fallback policy configured in your\ - \ account. For example, if the configuration is to fall back to 3D Secure\ - \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ - \ the BIN is not enrolled, you will receive an error.\n\n" - type: string - AdditionalDataAirline: - properties: - airline.agency_invoice_number: - description: 'Reference number for the invoice, issued by the agency. - - * minLength: 1 - - * maxLength: 6' - type: string - airline.agency_plan_name: - description: '2-letter agency plan identifier; alphabetical. - - * minLength: 2 - - * maxLength: 2' - type: string - airline.airline_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit - accounting code (PAX); numeric. It identifies the carrier. - - * Format: IATA 3-digit accounting code (PAX) - - * Example: KLM = 074 - - * minLength: 3 - - * maxLength: 3' - type: string - airline.airline_designator_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.boarding_fee: - description: 'Chargeable amount for boarding the plane. - - The transaction amount needs to be represented in minor units according - to the [following table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 18' - type: string - airline.computerized_reservation_system: - description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) - used to make the reservation and purchase the ticket. - - * Format: alphanumeric. - - * minLength: 4 - - * maxLength: 4' - type: string - airline.customer_reference_number: - description: 'Reference number; alphanumeric. - - * minLength: 0 - - * maxLength: 20' - type: string - airline.document_type: - description: 'Optional 2-digit code; alphanumeric. It identifies the type - of product of the transaction. The description of the code may appear - on credit card statements. - - * Format: 2-digit code - - * Example: Passenger ticket = 01 - - * minLength: 2 - - * maxLength: 2' - type: string - airline.flight_date: - description: 'Flight departure date. Local time `(HH:mm)` is optional. - - * Date format: `yyyy-MM-dd` - - * Date and time format: `yyyy-MM-dd HH:mm` - - * minLength: 10 - - * maxLength: 16' - type: string - airline.leg.carrier_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - This field is required/mandatory if the airline data includes leg details. - - * Format: IATA 2-letter airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.leg.class_of_travel: - description: '1-letter travel class identifier; alphabetical. There is no - standard; however, the following codes are used rather consistently: - - * F: first class - - * J: business class - - * Y: economy class - - * W: premium economy - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_airport: - description: 'Alphabetical identifier of the departure airport. - - This field is required if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.depart_tax: - description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). - Amount charged by a country to an individual upon their leaving. The transaction - amount needs to be represented in minor units according to the [following - table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 12' - type: string - airline.leg.destination_code: - description: 'Alphabetical identifier of the destination/arrival airport. - - This field is required/mandatory if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.fare_base_code: - description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); - alphanumeric. - - * minLength: 1 - - * maxLength: 7' - type: string - airline.leg.flight_number: - description: 'The flight identifier. - - * minLength: 1 - - * maxLength: 5' - type: string - airline.leg.stop_over_code: - description: '1-letter code that indicates whether the passenger is entitled - to make a stopover. Only two types of characters are allowed: - - * O: Stopover allowed - - * X: Stopover not allowed - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.passenger.date_of_birth: - description: 'Date of birth of the passenger. - - - Date format: `yyyy-MM-dd` - - * minLength: 10 - - * maxLength: 10' - type: string - airline.passenger.first_name: - description: 'Passenger first name/given name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.last_name: - description: 'Passenger last name/family name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.telephone_number: - description: 'Telephone number of the passenger, including country code. - This is an alphanumeric field that can include the ''+'' and ''-'' signs. - - * minLength: 3 - - * maxLength: 30' - type: string - airline.passenger.traveller_type: - description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. - Example: ADT, SRC, CNN, INS. - - - However, several carriers use non-standard codes that can be up to 5 alphanumeric - characters. - - * minLength: 3 - - * maxLength: 6' - type: string - airline.passenger_name: - description: 'Passenger name, initials, and a title. - - * Format: last name + first name or initials + title. - - * Example: *FLYER / MARY MS*. - - * minLength: 1 - - * maxLength: 49' - type: string - airline.ticket_issue_address: - description: 'Address of the place/agency that issued the ticket. - - * minLength: 0 - - * maxLength: 16' - type: string - airline.ticket_number: - description: 'The ticket''s unique identifier. - - * minLength: 1 - - * maxLength: 150' - type: string - airline.travel_agency_code: - description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier - number for travel agencies. - - * minLength: 1 - - * maxLength: 8' - type: string - airline.travel_agency_name: - description: 'The name of the travel agency. - - * minLength: 1 - - * maxLength: 25' - type: string - required: - - airline.passenger_name - AdditionalDataCarRental: - properties: - carRental.checkOutDate: - description: 'Pick-up date. - - * Date format: `yyyyMMdd`' - type: string - carRental.customerServiceTollFreeNumber: - description: 'The customer service phone number of the car rental company. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - carRental.daysRented: - description: 'Number of days for which the car is being rented. - - * Format: Numeric - - * maxLength: 19' - type: string - carRental.fuelCharges: - description: 'Any fuel charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.insuranceCharges: - description: 'Any insurance charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.locationCity: - description: 'The city from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.locationCountry: - description: 'The country from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.locationStateProvince: - description: 'The state or province from where the car is rented. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - * Y - Customer was a no show. - - * N - Not applicable.' - type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. - type: string - carRental.rate: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.rateIndicator: - description: 'Specifies whether the given rate is applied daily or weekly. - - * D - Daily rate. - - * W - Weekly rate.' - type: string - carRental.rentalAgreementNumber: - description: 'The rental agreement number associated with this car rental. - - * Format: Alphanumeric - - * maxLength: 9' - type: string - carRental.rentalClassId: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.renterName: - description: 'The name of the person renting the car. - - * Format: Alphanumeric - - * maxLength: 26' - type: string - carRental.returnCity: - description: 'The city where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.returnCountry: - description: 'The country where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.returnDate: - description: 'The last date to return the car by. - - * Date format: `yyyyMMdd`' - type: string - carRental.returnLocationId: - description: 'Agency code, phone number, or address abbreviation - - * Format: Alphanumeric - - * maxLength: 10' - type: string - carRental.returnStateProvince: - description: 'The state or province where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.taxExemptIndicator: - description: 'Indicates whether the goods or services were tax-exempt, or - tax was not collected. - - - Values: - - * Y - Goods or services were tax exempt - - * N - Tax was not collected' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "A" for Car rental. This should be - included in the auth message. - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataCommon: - properties: - RequestedTestErrorResponseCode: - description: "Triggers test scenarios that allow to replicate certain communication\ - \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ - \ wasn't a connection available to service the outgoing communication.\n\ - This is a transient, retriable error since no messaging could be initiated\ - \ to an issuing system (or third-party acquiring system). Therefore, the\ - \ header Transient-Error: true is returned in the response. A subsequent\ - \ request using the same idempotency key will be processed as if it was\ - \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ - \ wrong during transmission of the message or receiving the response.\n\ - This is a classified as non-transient because the message could have been\ - \ received by the issuing party and been acted upon. No transient error\ - \ header is returned. If using idempotency, the (error) response is stored\ - \ as the final result for the idempotency key. Subsequent messages with\ - \ the same idempotency key not be processed beyond returning the stored\ - \ response." - type: string - authorisationType: - description: "Flags a card payment request for either pre-authorisation\ - \ or final authorisation. For more information, refer to [Authorisation\ - \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ - \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ - \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ - \ request to be handled as a final authorisation." - type: string - customRoutingFlag: - description: 'Allows you to determine or override the acquirer account that - should be used for the transaction. - - - If you need to process a payment with an acquirer different from a default - one, you can set up a corresponding configuration on the Adyen payments - platform. Then you can pass a custom routing flag in a payment request''s - additional data to target a specific acquirer. - - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' - type: string - industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge - description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ - \ this field denotes why the additional payment is made.\n\nPossible values:\n\ - \n * **NoShow**: An incremental charge is carried out because of a no-show\ - \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ - \ charge is carried out to process an additional payment after the original\ - \ services have been rendered and the respective payment has been processed." - enum: - - NoShow - - DelayedCharge - type: string - networkTxReference: - description: 'Allows you to link the transaction to the original or previous - one in a subscription/card-on-file chain. This field is required for token-based - transactions where Adyen does not tokenize the card. - - - Transaction identifier from card schemes, for example, Mastercard Trace - ID or the Visa Transaction ID. - - - Submit the original transaction ID of the contract in your payment request - if you are not tokenizing card details with Adyen and are making a merchant-initiated - transaction (MIT) for subsequent charges. - - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` - **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction - is classified as MIT.' - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - subMerchantCity: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the city of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 13 characters.' - type: string - subMerchantCountry: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the three-letter - country code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Fixed length: 3 characters.' - type: string - subMerchantID: - description: 'This field contains an identifier of the actual merchant when - a transaction is submitted via a payment facilitator. The payment facilitator - must send in this unique ID. - - - A unique identifier per submerchant that is required if the transaction - is performed by a registered payment facilitator. - - * Format: alpha-numeric. - - * Fixed length: 15 characters.' - type: string - subMerchantName: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the name of - the actual merchant. - - * Format: alpha-numeric. - - * Maximum length: 22 characters.' - type: string - subMerchantPostalCode: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the postal code - of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 10 characters.' - type: string - subMerchantState: - description: 'This field is required if the transaction is performed by - a registered payment facilitator, and if applicable to the country. This - field must contain the state code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 3 characters.' - type: string - subMerchantStreet: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the street of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 60 characters.' - type: string - subMerchantTaxId: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the tax ID of - the actual merchant. - - * Format: alpha-numeric. - - * Fixed length: 11 or 14 characters.' - type: string - AdditionalDataLevel23: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - - Encoding: ASCII. - - - Max length: 25 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - enhancedSchemeData.destinationCountryCode: - description: 'Destination country code. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.destinationPostalCode: - description: 'The postal code of a destination address. - - - Encoding: ASCII. - - - Max length: 10 characters. - - - > Required for American Express.' - type: string - enhancedSchemeData.destinationStateProvinceCode: - description: 'Destination state or province code. - - - Encoding: ASCII.Max length: 3 characters.' - type: string - enhancedSchemeData.dutyAmount: - description: 'Duty amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.freightAmount: - description: 'Shipping amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].commodityCode: - description: 'Item commodity code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].description: - description: 'Item description. - - - Encoding: ASCII. - - - Max length: 26 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: - description: 'Discount amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].productCode: - description: 'Product code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].quantity: - description: 'Quantity, specified as an integer value. - - - Value must be greater than 0. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: - description: 'Total amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: - description: 'Item unit of measurement. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitPrice: - description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - - - Max length: 12 characters.' - type: string - enhancedSchemeData.orderDate: - description: 'Order date. - - * Format: `ddMMyy` - - - Encoding: ASCII. - - - Max length: 6 characters.' - type: string - enhancedSchemeData.shipFromPostalCode: - description: 'The postal code of a "ship-from" address. - - - Encoding: ASCII. - - - Max length: 10 characters.' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - AdditionalDataLodging: - properties: - lodging.checkInDate: - description: 'The arrival date. - - * Date format: `yyyyMMdd`' - type: string - lodging.checkOutDate: - description: 'The departure date. - - * Date format: `yyyyMMdd`' - type: string - lodging.customerServiceTollFreeNumber: - description: 'The toll free phone number for the hotel/lodgings. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.fireSafetyActIndicator: - description: 'Identifies that the facility complies with the Hotel and Motel - Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. - - * Format: Alphabetic - - * maxLength: 1' - type: string - lodging.folioCashAdvances: - description: 'The folio cash advances. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.folioNumber: - description: "Card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Format: Alphanumeric\n* maxLength: 25" - type: string - lodging.foodBeverageCharges: - description: 'Any charges for food and beverages associated with the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - - Value should be Y or N. - - * Format: Numeric - - * maxLength: 1' - type: string - lodging.prepaidExpenses: - description: 'Prepaid expenses for the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.propertyPhoneNumber: - description: 'Identifies specific lodging property location by its local - phone number. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.room1.numberOfNights: - description: 'Total number of nights the room will be rented. - - * Format: Numeric - - * maxLength: 4' - type: string - lodging.room1.rate: - description: 'The rate of the room. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.room1.tax: - description: 'The total amount of tax to be paid. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalRoomTax: - description: 'Total room tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalTax: - description: 'Total tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "H" for Hotel. This should be included - in the auth message. - - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.merchantData: - description: 'Holds different merchant data points like product, purchase, - customer, and so on. It takes data in a Base64 encoded string. - - - The `merchantData` parameter needs to be added to the `openinvoicedata` - signature at the end. - - - Since the field is optional, if it''s not included it does not impact - computing the merchant signature. - - - Applies only to Klarna. - - - You can contact Klarna for the format and structure of the string.' - type: string - openinvoicedata.numberOfLines: - description: 'The number of invoice lines included in `openinvoicedata`. - - - There needs to be at least one line, so `numberOfLines` needs to be at - least 1.' - type: string - openinvoicedataLine[itemNr].currencyCode: - description: The three-character ISO currency code. - type: string - openinvoicedataLine[itemNr].description: - description: A text description of the product the invoice line refers to. - type: string - openinvoicedataLine[itemNr].itemAmount: - description: 'The price for one item in the invoice line, represented in - minor units. - - - The due amount for the item, VAT excluded.' - type: string - openinvoicedataLine[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. - type: string - openinvoicedataLine[itemNr].itemVatAmount: - description: The VAT due for one item in the invoice line, represented in - minor units. - type: string - openinvoicedataLine[itemNr].itemVatPercentage: - description: 'The VAT percentage for one item in the invoice line, represented - in minor units. - - - For example, 19% VAT is specified as 1900.' - type: string - openinvoicedataLine[itemNr].numberOfItems: - description: The number of units purchased of a specific product. - type: string - openinvoicedataLine[itemNr].returnShippingCompany: - description: Name of the shipping company handling the the return shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingNumber: - description: The tracking number for the return of the shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingUri: - description: URI where the customer can track the return of their shipment. - type: string - openinvoicedataLine[itemNr].shippingCompany: - description: Name of the shipping company handling the delivery. - type: string - openinvoicedataLine[itemNr].shippingMethod: - description: Shipping method. - type: string - openinvoicedataLine[itemNr].trackingNumber: - description: The tracking number for the shipment. - type: string - openinvoicedataLine[itemNr].trackingUri: - description: URI where the customer can track their shipment. - type: string - AdditionalDataOpi: - properties: - opi.includeTransToken: - description: 'Optional boolean indicator. Set to **true** if you want an - ecommerce transaction to return an `opi.transToken` as additional data - in the response. - - - You can store this Oracle Payment Interface token in your Oracle Opera - database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' - type: string - AdditionalDataPayout: - properties: - fundingNetwork: - description: '' - type: string - fundingSource: - description: '' - enum: - - CREDIT - - DEBIT - - PREPAID - - DEPOSIT_ACCOUNT - type: string - fundingTransactionId: - description: '' - type: string - payoutAccountCode: - description: '' - type: string - payoutAccountHolderCode: - description: '' - type: string - payoutMarketPayUser: - description: '' - type: string - processOver: - description: '' - enum: - - MC_P2P - - Visa_OCT - - UnlinkedRefund - type: string - verifyOver: - description: '' - type: string - walletIdentifier: - description: '' - type: string - AdditionalDataRatepay: - properties: - ratepay.installmentAmount: - description: Amount the customer has to pay each month. - type: string - ratepay.interestRate: - description: Interest rate of this installment. - type: string - ratepay.lastInstallmentAmount: - description: Amount of the last installment. - type: string - ratepay.paymentFirstday: - description: Calendar day of the first payment. - type: string - ratepaydata.deliveryDate: - description: Date the merchant delivered the goods to the customer. - type: string - ratepaydata.dueDate: - description: Date by which the customer must settle the payment. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. - type: string - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - AdditionalDataRetry: - properties: - retry.chainAttemptNumber: - description: 'The number of times the transaction (not order) has been retried - between different payment service providers. For instance, the `chainAttemptNumber` - set to 2 means that this transaction has been recently tried on another - provider before being sent to Adyen. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.orderAttemptNumber: - description: 'The index of the attempt to bill a particular order, which - is identified by the `merchantOrderReference` field. For example, if a - recurring transaction fails and is retried one day later, then the order - number for these attempts would be 1 and 2, respectively. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.skipRetry: - description: 'The Boolean value indicating whether Adyen should skip or - retry this transaction, if possible. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - AdditionalDataRisk: - properties: - riskdata.[customFieldName]: - description: The data for your custom risk field. For more information, - refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). - type: string - riskdata.basket.item[itemNr].amountPerItem: - description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.basket.item[itemNr].brand: - description: Brand of the item. - type: string - riskdata.basket.item[itemNr].category: - description: Category of the item. - type: string - riskdata.basket.item[itemNr].color: - description: Color of the item. - type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string - riskdata.basket.item[itemNr].quantity: - description: Quantity of the item purchased. - type: string - riskdata.basket.item[itemNr].receiverEmail: - description: Email associated with the given product in the basket (usually - in electronic gift cards). - type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.promotions.promotion[itemNr].promotionCode: - description: Code of the promotion. - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountAmount: - description: The discount amount of the promotion, represented in [minor - units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: - description: 'Promotion''s percentage discount. It is represented in percentage - value and there is no need to include the ''%'' sign. - - - e.g. for a promotion discount of 30%, the value of the field should be - 30.' - type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string - riskdata.riskProfileReference: - description: Reference number of the risk profile that you want to apply - to the payment. If not provided or left blank, the merchant-level account's - default risk profile will be applied to the payment. For more information, - see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). - type: string - riskdata.skipRisk: - description: If this parameter is provided with the value **true**, risk - checks for the payment request are skipped and the transaction will not - get a risk score. - type: string - AdditionalDataRiskStandalone: - properties: - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.ProtectionEligibility: - description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ - \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ - \ \u2014 Merchant is not protected under the Seller Protection Policy." - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - avsResultRaw: - description: 'Raw AVS result received from the acquirer, where available. - Example: D' - type: string - bin: - description: The Bank Identification Number of a credit card, which is the - first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). - type: string - cvcResultRaw: - description: 'Raw CVC result received from the acquirer, where available. - Example: 1' - type: string - riskToken: - description: Unique identifier or token for the shopper's card details. - type: string - threeDAuthenticated: - description: 'A Boolean value indicating whether 3DS authentication was - completed on this payment. Example: true' - type: string - threeDOffered: - description: 'A Boolean value indicating whether 3DS was offered for this - payment. Example: true' - type: string - tokenDataType: - description: 'Required for PayPal payments only. The only supported value - is: **paypal**.' - type: string - AdditionalDataSubMerchant: - properties: - subMerchant.numberOfSubSellers: - description: Required for transactions performed by registered payment facilitators. - Indicates the number of sub-merchants contained in the request. For example, - **3**. - type: string - subMerchant.subSeller[subSellerNr].city: - description: 'Required for transactions performed by registered payment - facilitators. The city of the sub-merchant''s address. - - * Format: Alphanumeric - - * Maximum length: 13 characters' - type: string - subMerchant.subSeller[subSellerNr].country: - description: "Required for transactions performed by registered payment\ - \ facilitators. The three-letter country code of the sub-merchant's address.\ - \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ - * Fixed length: 3 characters" - type: string - subMerchant.subSeller[subSellerNr].id: - description: "Required for transactions performed by registered payment\ - \ facilitators. A unique identifier that you create for the sub-merchant,\ - \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ - * Maximum length: 15 characters" - type: string - subMerchant.subSeller[subSellerNr].mcc: - description: "Required for transactions performed by registered payment\ - \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ - \ \n* Format: Numeric\n* Fixed length: 4 digits" - type: string - subMerchant.subSeller[subSellerNr].name: - description: 'Required for transactions performed by registered payment - facilitators. The name of the sub-merchant. Based on scheme specifications, - this value will overwrite the shopper statement that will appear in the - card statement. - - * Format: Alphanumeric - - * Maximum length: 22 characters' - type: string - subMerchant.subSeller[subSellerNr].postalCode: - description: 'Required for transactions performed by registered payment - facilitators. The postal code of the sub-merchant''s address, without - dashes. - - * Format: Numeric - - * Fixed length: 8 digits' - type: string - subMerchant.subSeller[subSellerNr].state: - description: 'Required for transactions performed by registered payment - facilitators. The state code of the sub-merchant''s address, if applicable - to the country. - - * Format: Alphanumeric - - * Maximum length: 2 characters' - type: string - subMerchant.subSeller[subSellerNr].street: - description: 'Required for transactions performed by registered payment - facilitators. The street name and house number of the sub-merchant''s - address. - - * Format: Alphanumeric - - * Maximum length: 60 characters' - type: string - subMerchant.subSeller[subSellerNr].taxId: - description: 'Required for transactions performed by registered payment - facilitators. The tax ID of the sub-merchant. - - * Format: Numeric - - * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' - type: string - AdditionalDataTemporaryServices: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - * Encoding: ASCII - - * maxLength: 25' - type: string - enhancedSchemeData.employeeName: - description: 'Name or ID associated with the individual working in a temporary - capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.jobDescription: - description: 'Description of the job or task of the individual working in - a temporary capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.regularHoursRate: - description: 'Amount paid per regular hours worked, minor units. - - * maxLength: 7' - type: string - enhancedSchemeData.regularHoursWorked: - description: 'Amount of time worked during a normal operation for the task - or job. - - * maxLength: 7' - type: string - enhancedSchemeData.requestName: - description: 'Name of the individual requesting temporary services. - - * maxLength: 40' - type: string - enhancedSchemeData.tempStartDate: - description: 'Date for the beginning of the pay period. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.tempWeekEnding: - description: 'Date of the end of the billing cycle. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. For example, 2000 means - USD 20.00 - - * maxLength: 12' - type: string - AdditionalDataWallets: - properties: - androidpay.token: - description: The Android Pay token retrieved from the SDK. - type: string - masterpass.transactionId: - description: The Mastercard Masterpass Transaction ID retrieved from the - SDK. - type: string - payment.token: - description: The Apple Pay token retrieved from the SDK. - type: string - paywithgoogle.token: - description: The Google Pay token retrieved from the SDK. - type: string - samsungpay.token: - description: The Samsung Pay token retrieved from the SDK. - type: string - visacheckout.callId: - description: The Visa Checkout Call ID retrieved from the SDK. - type: string Address: properties: city: @@ -2105,32 +515,6 @@ components: required: - value - currency - ApplicationInfo: - properties: - adyenLibrary: - description: Adyen-developed software, such as libraries and plugins, used - to interact with the Adyen API. For example, Magento plugin, Java API - library, etc. - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - description: Adyen-developed software to get payment details. For example, - Checkout SDK, Secured Fields SDK, etc. - $ref: '#/components/schemas/CommonField' - externalPlatform: - description: Third-party developed platform used to initiate payment requests. - For example, Magento, Zuora, etc. - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - description: Merchant developed software, such as cashier application, used - to interact with the Adyen API. - $ref: '#/components/schemas/CommonField' - merchantDevice: - description: Merchant device information. - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - description: Shopper interaction device, such as terminal, mobile device - or web browser, to initiate payment requests. - $ref: '#/components/schemas/ShopperInteractionDevice' BankAccount: properties: bankAccountNumber: @@ -2179,67 +563,6 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string - BrowserInfo: - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - colorDepth: - x-addedInVersion: '40' - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - x-addedInVersion: '40' - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - x-addedInVersion: '40' - default: true - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - x-addedInVersion: '40' - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). - type: string - screenHeight: - x-addedInVersion: '40' - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - x-addedInVersion: '40' - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - x-addedInVersion: '40' - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - userAgent - - acceptHeader - - javaEnabled - - colorDepth - - screenHeight - - screenWidth - - timeZoneOffset - - language Card: properties: cvc: @@ -2308,109 +631,6 @@ components: - expiryMonth - expiryYear - holderName - CommonField: - properties: - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - DeviceRenderOptions: - properties: - sdkInterface: - default: both - description: 'Supported SDK interface types. - - Allowed values: - - * native - - * html - - * both' - enum: - - native - - html - - both - type: string - sdkUiType: - description: 'UI types supported for displaying specific challenges. - - Allowed values: - - * text - - * singleSelect - - * outOfBand - - * otherHtml - - * multiSelect' - items: - enum: - - multiSelect - - otherHtml - - outOfBand - - singleSelect - - text - type: string - type: array - ExternalPlatform: - properties: - integrator: - description: External platform integrator. - type: string - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - ForexQuote: - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - description: The base amount. - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - description: The buy rate. - $ref: '#/components/schemas/Amount' - interbank: - description: The interbank amount. - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - description: The sell rate. - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - validTill - - basePoints FraudCheckResult: properties: accountScore: @@ -2468,184 +688,6 @@ components: telephoneNumber: description: Phone number of the person type: string - Installments: - properties: - plan: - x-addedInVersion: '64' - description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). - By default, this is set to **regular**. Possible values: - - * **regular** - - * **revolving** - - ' - enum: - - regular - - revolving - type: string - value: - description: 'Defines the number of installments. Its value needs to be - greater than zero. - - - Usually, the maximum allowed number of installments is capped. For example, - it may not be possible to split a payment in more than 24 installments. - The acquirer sets this upper limit, so its value may vary.' - format: int32 - type: integer - required: - - value - Mandate: - properties: - amount: - description: The billing amount (in minor units) of the recurring transactions. - type: string - amountRule: - description: "The limitation rule of the billing amount.\n\nPossible values:\n\ - \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ - \ **exact**: The transaction amount should be the same as the `amount`.\n\ - \n" - enum: - - max - - exact - type: string - billingAttemptsRule: - description: "The rule to specify the period, within which the recurring\ - \ debit can happen, relative to the mandate recurring date.\n\nPossible\ - \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ - \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ - \n" - enum: - - 'on' - - before - - after - type: string - billingDay: - description: 'The number of the day, on which the recurring debit can happen. - Should be within the same calendar month as the mandate recurring date. - - - Possible values: 1-31 based on the `frequency`.' - type: string - endsAt: - description: End date of the billing plan, in YYYY-MM-DD format. - type: string - frequency: - description: 'The frequency with which a shopper should be charged. - - - Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, - **halfYearly**, **yearly**.' - enum: - - adhoc - - daily - - weekly - - biWeekly - - monthly - - quarterly - - halfYearly - - yearly - type: string - remarks: - description: The message shown by UPI to the shopper on the approval screen. - type: string - startsAt: - description: Start date of the billing plan, in YYYY-MM-DD format. By default, - the transaction date. - type: string - required: - - frequency - - amount - - endsAt - MerchantDevice: - properties: - os: - description: Operating system running on the merchant device. - type: string - osVersion: - description: Version of the operating system on the merchant device. - type: string - reference: - description: Merchant device reference. - type: string - MerchantRiskIndicator: - properties: - addressMatch: - description: Whether the chosen delivery address is identical to the billing - address. - type: boolean - deliveryAddressIndicator: - description: 'Indicator regarding the delivery address. - - Allowed values: - - * `shipToBillingAddress` - - * `shipToVerifiedAddress` - - * `shipToNewAddress` - - * `shipToStore` - - * `digitalGoods` - - * `goodsNotShipped` - - * `other`' - enum: - - shipToBillingAddress - - shipToVerifiedAddress - - shipToNewAddress - - shipToStore - - digitalGoods - - goodsNotShipped - - other - type: string - deliveryEmail: - description: The delivery email address (for digital goods). - type: string - deliveryTimeframe: - description: 'The estimated delivery time for the shopper to receive the - goods. - - Allowed values: - - * `electronicDelivery` - - * `sameDayShipping` - - * `overnightShipping` - - * `twoOrMoreDaysShipping`' - enum: - - electronicDelivery - - sameDayShipping - - overnightShipping - - twoOrMoreDaysShipping - type: string - giftCardAmount: - description: For prepaid or gift card purchase, the purchase amount total - of prepaid or gift card(s). - $ref: '#/components/schemas/Amount' - giftCardCount: - description: For prepaid or gift card purchase, total count of individual - prepaid or gift cards/codes purchased. - format: int32 - type: integer - preOrderDate: - description: For pre-order purchases, the expected date this product will - be available to the shopper. - format: date-time - type: string - preOrderPurchase: - description: Indicator for whether this transaction is for pre-ordering - a product. - type: boolean - reorderItems: - description: Indicator for whether the shopper has already purchased the - same items in the past. - type: boolean ModifyRequest: properties: additionalData: @@ -3638,20 +1680,6 @@ components: Example: OOFF' type: string - SDKEphemPubKey: - properties: - crv: - description: The `crv` value as received from the 3D Secure 2 SDK. - type: string - kty: - description: The `kty` value as received from the 3D Secure 2 SDK. - type: string - x: - description: The `x` value as received from the 3D Secure 2 SDK. - type: string - y: - description: The `y` value as received from the 3D Secure 2 SDK. - type: string ServiceError: properties: additionalData: @@ -3678,80 +1706,6 @@ components: description: The HTTP response status. format: int32 type: integer - ShopperInteractionDevice: - properties: - locale: - description: Locale on the shopper interaction device. - type: string - os: - description: Operating system running on the shopper interaction device. - type: string - osVersion: - description: Version of the operating system on the shopper interaction - device. - type: string - Split: - properties: - account: - description: 'Unique identifier of the account where the split amount should - be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. - - - ' - type: string - amount: - description: The amount of this split. - $ref: '#/components/schemas/SplitAmount' - description: - description: A description of this split. - type: string - reference: - description: 'Your reference for the split, which you can use to link the - split to other operations such as captures and refunds. - - - This is required if `type` is **MarketPlace** or **BalanceAccount**. For - the other types, we also recommend sending a reference so you can reconcile - the split and the associated payment in the transaction overview and in - the reports. If the reference is not provided, the split is reported as - part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) - in Adyen for Platforms.' - type: string - type: - description: 'The type of split. - - Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, - **MarketPlace**, **BalanceAccount**, **Remainder**.' - enum: - - BalanceAccount - - Commission - - Default - - MarketPlace - - PaymentFee - - Remainder - - VAT - - Verification - type: string - required: - - amount - - type - SplitAmount: - properties: - currency: - description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - - - If this value is not provided, the currency in which the payment is made - will be used.' - maxLength: 3 - minLength: 3 - type: string - value: - description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). - format: int64 - type: integer - required: - - value StoreDetailAndSubmitRequest: properties: additionalData: @@ -4163,223 +2117,6 @@ components: required: - pspReference - resultCode - ThreeDS2RequestData: - properties: - acquirerBIN: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The acquiring BIN enrolled for 3D Secure 2. This string should match the - value that you will use in the authorisation. Use 123456 on the Test platform. - type: string - acquirerMerchantID: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. - This string should match the value that you will use in the authorisation. - Use 123456 on the Test platform. - type: string - authenticationOnly: - deprecated: true - x-deprecatedInVersion: '50' - x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. - default: false - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - challengeIndicator: - description: 'Possibility to specify a preference for receiving a challenge - from the issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string - deviceChannel: - description: 'The environment of the shopper. - - Allowed values: - - * `app` - - * `browser`' - type: string - deviceRenderOptions: - description: 'Display options for the 3D Secure 2 SDK. - - Optional and only for `deviceChannel` **app**.' - $ref: '#/components/schemas/DeviceRenderOptions' - mcc: - x-addedInVersion: '49' - description: Required for merchants that have been enrolled for 3D Secure - 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` - is registered at the scheme. - type: string - merchantName: - x-addedInVersion: '49' - description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchant name that the issuer presents to the shopper if they get - a challenge. We recommend to use the same value that you will use in the - authorization. Maximum length is 40 characters. - - > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). - Use this field if you are enrolled for 3D Secure 2 with us and want to - override the merchant name already configured on your account.' - type: string - messageVersion: - default: 2.1.0 - description: The `messageVersion` value indicating the 3D Secure 2 protocol - version. - type: string - notificationURL: - description: URL to where the issuer should send the `CRes`. Required if - you are not using components for `channel` **Web** or if you are using - classic integration `deviceChannel` **browser**. - type: string - sdkAppID: - description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEncData: - description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEphemPubKey: - description: 'The `sdkEphemPubKey` value as received from the 3D Secure - 2 SDK. - - Required for `deviceChannel` set to **app**.' - $ref: '#/components/schemas/SDKEphemPubKey' - sdkMaxTimeout: - default: 60 - description: 'The maximum amount of time in minutes for the 3D Secure 2 - authentication process. - - Optional and only for `deviceChannel` set to **app**. Defaults to **60** - minutes.' - format: int32 - type: integer - sdkReferenceNumber: - description: 'The `sdkReferenceNumber` value as received from the 3D Secure - 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkTransID: - description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkVersion: - x-addedInVersion: '40' - description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ - \ set to **app**." - type: string - threeDSCompInd: - description: Completion indicator for the device fingerprinting. - type: string - threeDSRequestorID: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor identifier assigned by the Directory - Server when you enrol for 3D Secure 2. - type: string - threeDSRequestorName: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor name assigned by the Directory Server - when you enrol for 3D Secure 2. - type: string - threeDSRequestorURL: - description: URL of the (customer service) website that will be shown to - the shopper in case of technical errors during the 3D Secure 2 process. - type: string - transactionType: - x-addedInVersion: '50' - description: Identify the type of the transaction being authenticated. - enum: - - goodsOrServicePurchase - - checkAcceptance - - accountFunding - - quasiCashTransaction - - prepaidActivationAndLoad - type: string - whiteListStatus: - x-addedInVersion: '49' - description: The `whiteListStatus` value returned from a previous 3D Secure - 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. - type: string - required: - - deviceChannel - ThreeDSecureData: - properties: - authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. - - - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' - enum: - - Y - - N - - U - - A - type: string - cavv: - description: The cardholder authentication value (base64 encoded, 20 bytes - in a decoded form). - format: byte - type: string - cavvAlgorithm: - description: The CAVV algorithm used. Include this only for 3D Secure 1. - type: string - directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. - - - In 3D Secure 2, this is the `transStatus` from the `ARes`.' - enum: - - A - - C - - D - - I - - N - - R - - U - - Y - type: string - dsTransID: - x-addedInVersion: '40' - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the Directory Server (DS) to identify a single transaction. - type: string - eci: - description: The electronic commerce indicator. - type: string - threeDSVersion: - x-addedInVersion: '40' - description: The version of the 3D Secure protocol. - type: string - xid: - description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, - 20 bytes in a decoded form). - format: byte - type: string securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PayoutService-v67.yaml b/yaml/PayoutService-v67.yaml index d7a80a9..183225c 100644 --- a/yaml/PayoutService-v67.yaml +++ b/yaml/PayoutService-v67.yaml @@ -40,7 +40,7 @@ info: ' - x-timestamp: '2022-05-03T09:24:06Z' + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -59,7 +59,7 @@ paths: post: tags: - Reviewing - summary: Confirms a payout. + summary: Confirm a payout description: 'Confirms a previously submitted payout. @@ -126,7 +126,7 @@ paths: post: tags: - Reviewing - summary: Cancels a payout. + summary: Cancel a payout description: 'Cancels a previously submitted payout. @@ -193,7 +193,7 @@ paths: post: tags: - Instant payouts - summary: Pay out directly. + summary: Make an instant card payout description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card @@ -259,7 +259,7 @@ paths: post: tags: - Initialization - summary: Stores payout details. + summary: Store payout details description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call. @@ -324,7 +324,7 @@ paths: post: tags: - Initialization - summary: Stores details and submits a payout. + summary: Store details and submit a payout description: 'Submits a payout and stores its details for subsequent payouts. @@ -397,7 +397,7 @@ paths: post: tags: - Initialization - summary: Submits a payout. + summary: Submit a payout description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -461,1596 +461,6 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: - AccountInfo: - properties: - accountAgeIndicator: - description: 'Indicator for the length of time since this shopper account - was created in the merchant''s environment. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountChangeDate: - description: Date when the shopper's account was last changed. - format: date-time - type: string - accountChangeIndicator: - description: 'Indicator for the length of time since the shopper''s account - was last updated. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountCreationDate: - description: Date when the shopper's account was created. - format: date-time - type: string - accountType: - x-addedInVersion: '50' - description: 'Indicates the type of account. For example, for a multi-account - card product. - - Allowed values: - - * notApplicable - - * credit - - * debit' - enum: - - notApplicable - - credit - - debit - type: string - addCardAttemptsDay: - description: Number of attempts the shopper tried to add a card to their - account in the last day. - format: int32 - type: integer - deliveryAddressUsageDate: - description: Date the selected delivery address was first used. - format: date-time - type: string - deliveryAddressUsageIndicator: - description: 'Indicator for the length of time since this delivery address - was first used. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - homePhone: - description: Shopper's home phone number (including the country code). - type: string - mobilePhone: - description: Shopper's mobile phone number (including the country code). - type: string - passwordChangeDate: - description: Date when the shopper last changed their password. - format: date-time - type: string - passwordChangeIndicator: - description: 'Indicator when the shopper has changed their password. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - pastTransactionsDay: - description: Number of all transactions (successful and abandoned) from - this shopper in the past 24 hours. - format: int32 - type: integer - pastTransactionsYear: - description: Number of all transactions (successful and abandoned) from - this shopper in the past year. - format: int32 - type: integer - paymentAccountAge: - description: Date this payment method was added to the shopper's account. - format: date-time - type: string - paymentAccountIndicator: - description: 'Indicator for the length of time since this payment method - was added to this shopper''s account. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - purchasesLast6Months: - description: Number of successful purchases in the last six months. - format: int32 - type: integer - suspiciousActivity: - description: Whether suspicious activity was recorded on this account. - type: boolean - workPhone: - description: Shopper's work phone number (including the country code). - type: string - AdditionalData3DSecure: - properties: - allow3DS2: - description: "Indicates if you are able to process 3D Secure 2 transactions\ - \ natively on your payment page. Send this parameter when you are using\ - \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ - \n > This parameter only indicates readiness to support native 3D Secure\ - \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ - \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ - \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ - \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" - type: string - executeThreeD: - description: "Indicates if you want to perform 3D Secure authentication\ - \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ - \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ - \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ - \ 3D Secure authentication. Note that this setting results in refusals\ - \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ - \ national regulations. \n" - type: string - mpiImplementationType: - description: In case of Secure+, this field must be set to **CUPSecurePlus**. - type: string - scaExemption: - description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction.\n\n Possible values:\n\ - * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ - \ **transactionRiskAnalysis** " - type: string - threeDSVersion: - description: "Indicates your preference for the 3D Secure version. \n> If\ - \ you use this parameter, you override the checks from Adyen's Authentication\ - \ Engine. We recommend to use this field only if you have an extensive\ - \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ - \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ - \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ - \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ - \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ - \ in the `ARes`, we will apply the fallback policy configured in your\ - \ account. For example, if the configuration is to fall back to 3D Secure\ - \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ - \ the BIN is not enrolled, you will receive an error.\n\n" - type: string - AdditionalDataAirline: - properties: - airline.agency_invoice_number: - description: 'Reference number for the invoice, issued by the agency. - - * minLength: 1 - - * maxLength: 6' - type: string - airline.agency_plan_name: - description: '2-letter agency plan identifier; alphabetical. - - * minLength: 2 - - * maxLength: 2' - type: string - airline.airline_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit - accounting code (PAX); numeric. It identifies the carrier. - - * Format: IATA 3-digit accounting code (PAX) - - * Example: KLM = 074 - - * minLength: 3 - - * maxLength: 3' - type: string - airline.airline_designator_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.boarding_fee: - description: 'Chargeable amount for boarding the plane. - - The transaction amount needs to be represented in minor units according - to the [following table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 18' - type: string - airline.computerized_reservation_system: - description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) - used to make the reservation and purchase the ticket. - - * Format: alphanumeric. - - * minLength: 4 - - * maxLength: 4' - type: string - airline.customer_reference_number: - description: 'Reference number; alphanumeric. - - * minLength: 0 - - * maxLength: 20' - type: string - airline.document_type: - description: 'Optional 2-digit code; alphanumeric. It identifies the type - of product of the transaction. The description of the code may appear - on credit card statements. - - * Format: 2-digit code - - * Example: Passenger ticket = 01 - - * minLength: 2 - - * maxLength: 2' - type: string - airline.flight_date: - description: 'Flight departure date. Local time `(HH:mm)` is optional. - - * Date format: `yyyy-MM-dd` - - * Date and time format: `yyyy-MM-dd HH:mm` - - * minLength: 10 - - * maxLength: 16' - type: string - airline.leg.carrier_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - This field is required/mandatory if the airline data includes leg details. - - * Format: IATA 2-letter airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.leg.class_of_travel: - description: '1-letter travel class identifier; alphabetical. There is no - standard; however, the following codes are used rather consistently: - - * F: first class - - * J: business class - - * Y: economy class - - * W: premium economy - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_airport: - description: 'Alphabetical identifier of the departure airport. - - This field is required if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.depart_tax: - description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). - Amount charged by a country to an individual upon their leaving. The transaction - amount needs to be represented in minor units according to the [following - table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 12' - type: string - airline.leg.destination_code: - description: 'Alphabetical identifier of the destination/arrival airport. - - This field is required/mandatory if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.fare_base_code: - description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); - alphanumeric. - - * minLength: 1 - - * maxLength: 7' - type: string - airline.leg.flight_number: - description: 'The flight identifier. - - * minLength: 1 - - * maxLength: 5' - type: string - airline.leg.stop_over_code: - description: '1-letter code that indicates whether the passenger is entitled - to make a stopover. Only two types of characters are allowed: - - * O: Stopover allowed - - * X: Stopover not allowed - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.passenger.date_of_birth: - description: 'Date of birth of the passenger. - - - Date format: `yyyy-MM-dd` - - * minLength: 10 - - * maxLength: 10' - type: string - airline.passenger.first_name: - description: 'Passenger first name/given name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.last_name: - description: 'Passenger last name/family name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.telephone_number: - description: 'Telephone number of the passenger, including country code. - This is an alphanumeric field that can include the ''+'' and ''-'' signs. - - * minLength: 3 - - * maxLength: 30' - type: string - airline.passenger.traveller_type: - description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. - Example: ADT, SRC, CNN, INS. - - - However, several carriers use non-standard codes that can be up to 5 alphanumeric - characters. - - * minLength: 3 - - * maxLength: 6' - type: string - airline.passenger_name: - description: 'Passenger name, initials, and a title. - - * Format: last name + first name or initials + title. - - * Example: *FLYER / MARY MS*. - - * minLength: 1 - - * maxLength: 49' - type: string - airline.ticket_issue_address: - description: 'Address of the place/agency that issued the ticket. - - * minLength: 0 - - * maxLength: 16' - type: string - airline.ticket_number: - description: 'The ticket''s unique identifier. - - * minLength: 1 - - * maxLength: 150' - type: string - airline.travel_agency_code: - description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier - number for travel agencies. - - * minLength: 1 - - * maxLength: 8' - type: string - airline.travel_agency_name: - description: 'The name of the travel agency. - - * minLength: 1 - - * maxLength: 25' - type: string - required: - - airline.passenger_name - AdditionalDataCarRental: - properties: - carRental.checkOutDate: - description: 'Pick-up date. - - * Date format: `yyyyMMdd`' - type: string - carRental.customerServiceTollFreeNumber: - description: 'The customer service phone number of the car rental company. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - carRental.daysRented: - description: 'Number of days for which the car is being rented. - - * Format: Numeric - - * maxLength: 19' - type: string - carRental.fuelCharges: - description: 'Any fuel charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.insuranceCharges: - description: 'Any insurance charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.locationCity: - description: 'The city from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.locationCountry: - description: 'The country from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.locationStateProvince: - description: 'The state or province from where the car is rented. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - * Y - Customer was a no show. - - * N - Not applicable.' - type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. - type: string - carRental.rate: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.rateIndicator: - description: 'Specifies whether the given rate is applied daily or weekly. - - * D - Daily rate. - - * W - Weekly rate.' - type: string - carRental.rentalAgreementNumber: - description: 'The rental agreement number associated with this car rental. - - * Format: Alphanumeric - - * maxLength: 9' - type: string - carRental.rentalClassId: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.renterName: - description: 'The name of the person renting the car. - - * Format: Alphanumeric - - * maxLength: 26' - type: string - carRental.returnCity: - description: 'The city where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.returnCountry: - description: 'The country where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.returnDate: - description: 'The last date to return the car by. - - * Date format: `yyyyMMdd`' - type: string - carRental.returnLocationId: - description: 'Agency code, phone number, or address abbreviation - - * Format: Alphanumeric - - * maxLength: 10' - type: string - carRental.returnStateProvince: - description: 'The state or province where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.taxExemptIndicator: - description: 'Indicates whether the goods or services were tax-exempt, or - tax was not collected. - - - Values: - - * Y - Goods or services were tax exempt - - * N - Tax was not collected' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "A" for Car rental. This should be - included in the auth message. - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataCommon: - properties: - RequestedTestErrorResponseCode: - description: "Triggers test scenarios that allow to replicate certain communication\ - \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ - \ wasn't a connection available to service the outgoing communication.\n\ - This is a transient, retriable error since no messaging could be initiated\ - \ to an issuing system (or third-party acquiring system). Therefore, the\ - \ header Transient-Error: true is returned in the response. A subsequent\ - \ request using the same idempotency key will be processed as if it was\ - \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ - \ wrong during transmission of the message or receiving the response.\n\ - This is a classified as non-transient because the message could have been\ - \ received by the issuing party and been acted upon. No transient error\ - \ header is returned. If using idempotency, the (error) response is stored\ - \ as the final result for the idempotency key. Subsequent messages with\ - \ the same idempotency key not be processed beyond returning the stored\ - \ response." - type: string - authorisationType: - description: "Flags a card payment request for either pre-authorisation\ - \ or final authorisation. For more information, refer to [Authorisation\ - \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ - \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ - \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ - \ request to be handled as a final authorisation." - type: string - customRoutingFlag: - description: 'Allows you to determine or override the acquirer account that - should be used for the transaction. - - - If you need to process a payment with an acquirer different from a default - one, you can set up a corresponding configuration on the Adyen payments - platform. Then you can pass a custom routing flag in a payment request''s - additional data to target a specific acquirer. - - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' - type: string - industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge - description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ - \ this field denotes why the additional payment is made.\n\nPossible values:\n\ - \n * **NoShow**: An incremental charge is carried out because of a no-show\ - \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ - \ charge is carried out to process an additional payment after the original\ - \ services have been rendered and the respective payment has been processed." - enum: - - NoShow - - DelayedCharge - type: string - networkTxReference: - description: 'Allows you to link the transaction to the original or previous - one in a subscription/card-on-file chain. This field is required for token-based - transactions where Adyen does not tokenize the card. - - - Transaction identifier from card schemes, for example, Mastercard Trace - ID or the Visa Transaction ID. - - - Submit the original transaction ID of the contract in your payment request - if you are not tokenizing card details with Adyen and are making a merchant-initiated - transaction (MIT) for subsequent charges. - - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` - **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction - is classified as MIT.' - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - subMerchantCity: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the city of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 13 characters.' - type: string - subMerchantCountry: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the three-letter - country code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Fixed length: 3 characters.' - type: string - subMerchantID: - description: 'This field contains an identifier of the actual merchant when - a transaction is submitted via a payment facilitator. The payment facilitator - must send in this unique ID. - - - A unique identifier per submerchant that is required if the transaction - is performed by a registered payment facilitator. - - * Format: alpha-numeric. - - * Fixed length: 15 characters.' - type: string - subMerchantName: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the name of - the actual merchant. - - * Format: alpha-numeric. - - * Maximum length: 22 characters.' - type: string - subMerchantPostalCode: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the postal code - of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 10 characters.' - type: string - subMerchantState: - description: 'This field is required if the transaction is performed by - a registered payment facilitator, and if applicable to the country. This - field must contain the state code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 3 characters.' - type: string - subMerchantStreet: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the street of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 60 characters.' - type: string - subMerchantTaxId: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the tax ID of - the actual merchant. - - * Format: alpha-numeric. - - * Fixed length: 11 or 14 characters.' - type: string - AdditionalDataLevel23: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - - Encoding: ASCII. - - - Max length: 25 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - enhancedSchemeData.destinationCountryCode: - description: 'Destination country code. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.destinationPostalCode: - description: 'The postal code of a destination address. - - - Encoding: ASCII. - - - Max length: 10 characters. - - - > Required for American Express.' - type: string - enhancedSchemeData.destinationStateProvinceCode: - description: 'Destination state or province code. - - - Encoding: ASCII.Max length: 3 characters.' - type: string - enhancedSchemeData.dutyAmount: - description: 'Duty amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.freightAmount: - description: 'Shipping amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].commodityCode: - description: 'Item commodity code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].description: - description: 'Item description. - - - Encoding: ASCII. - - - Max length: 26 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: - description: 'Discount amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].productCode: - description: 'Product code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].quantity: - description: 'Quantity, specified as an integer value. - - - Value must be greater than 0. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: - description: 'Total amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: - description: 'Item unit of measurement. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitPrice: - description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - - - Max length: 12 characters.' - type: string - enhancedSchemeData.orderDate: - description: 'Order date. - - * Format: `ddMMyy` - - - Encoding: ASCII. - - - Max length: 6 characters.' - type: string - enhancedSchemeData.shipFromPostalCode: - description: 'The postal code of a "ship-from" address. - - - Encoding: ASCII. - - - Max length: 10 characters.' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - AdditionalDataLodging: - properties: - lodging.checkInDate: - description: 'The arrival date. - - * Date format: `yyyyMMdd`' - type: string - lodging.checkOutDate: - description: 'The departure date. - - * Date format: `yyyyMMdd`' - type: string - lodging.customerServiceTollFreeNumber: - description: 'The toll free phone number for the hotel/lodgings. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.fireSafetyActIndicator: - description: 'Identifies that the facility complies with the Hotel and Motel - Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. - - * Format: Alphabetic - - * maxLength: 1' - type: string - lodging.folioCashAdvances: - description: 'The folio cash advances. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.folioNumber: - description: "Card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Format: Alphanumeric\n* maxLength: 25" - type: string - lodging.foodBeverageCharges: - description: 'Any charges for food and beverages associated with the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - - Value should be Y or N. - - * Format: Numeric - - * maxLength: 1' - type: string - lodging.prepaidExpenses: - description: 'Prepaid expenses for the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.propertyPhoneNumber: - description: 'Identifies specific lodging property location by its local - phone number. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.room1.numberOfNights: - description: 'Total number of nights the room will be rented. - - * Format: Numeric - - * maxLength: 4' - type: string - lodging.room1.rate: - description: 'The rate of the room. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.room1.tax: - description: 'The total amount of tax to be paid. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalRoomTax: - description: 'Total room tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalTax: - description: 'Total tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "H" for Hotel. This should be included - in the auth message. - - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.merchantData: - description: 'Holds different merchant data points like product, purchase, - customer, and so on. It takes data in a Base64 encoded string. - - - The `merchantData` parameter needs to be added to the `openinvoicedata` - signature at the end. - - - Since the field is optional, if it''s not included it does not impact - computing the merchant signature. - - - Applies only to Klarna. - - - You can contact Klarna for the format and structure of the string.' - type: string - openinvoicedata.numberOfLines: - description: 'The number of invoice lines included in `openinvoicedata`. - - - There needs to be at least one line, so `numberOfLines` needs to be at - least 1.' - type: string - openinvoicedataLine[itemNr].currencyCode: - description: The three-character ISO currency code. - type: string - openinvoicedataLine[itemNr].description: - description: A text description of the product the invoice line refers to. - type: string - openinvoicedataLine[itemNr].itemAmount: - description: 'The price for one item in the invoice line, represented in - minor units. - - - The due amount for the item, VAT excluded.' - type: string - openinvoicedataLine[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. - type: string - openinvoicedataLine[itemNr].itemVatAmount: - description: The VAT due for one item in the invoice line, represented in - minor units. - type: string - openinvoicedataLine[itemNr].itemVatPercentage: - description: 'The VAT percentage for one item in the invoice line, represented - in minor units. - - - For example, 19% VAT is specified as 1900.' - type: string - openinvoicedataLine[itemNr].numberOfItems: - description: The number of units purchased of a specific product. - type: string - openinvoicedataLine[itemNr].returnShippingCompany: - description: Name of the shipping company handling the the return shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingNumber: - description: The tracking number for the return of the shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingUri: - description: URI where the customer can track the return of their shipment. - type: string - openinvoicedataLine[itemNr].shippingCompany: - description: Name of the shipping company handling the delivery. - type: string - openinvoicedataLine[itemNr].shippingMethod: - description: Shipping method. - type: string - openinvoicedataLine[itemNr].trackingNumber: - description: The tracking number for the shipment. - type: string - openinvoicedataLine[itemNr].trackingUri: - description: URI where the customer can track their shipment. - type: string - AdditionalDataOpi: - properties: - opi.includeTransToken: - description: 'Optional boolean indicator. Set to **true** if you want an - ecommerce transaction to return an `opi.transToken` as additional data - in the response. - - - You can store this Oracle Payment Interface token in your Oracle Opera - database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' - type: string - AdditionalDataPayout: - properties: - fundingNetwork: - description: '' - type: string - fundingSource: - description: '' - enum: - - CREDIT - - DEBIT - - PREPAID - - DEPOSIT_ACCOUNT - type: string - fundingTransactionId: - description: '' - type: string - payoutAccountCode: - description: '' - type: string - payoutAccountHolderCode: - description: '' - type: string - payoutMarketPayUser: - description: '' - type: string - processOver: - description: '' - enum: - - MC_P2P - - Visa_OCT - - UnlinkedRefund - type: string - verifyOver: - description: '' - type: string - walletIdentifier: - description: '' - type: string - AdditionalDataRatepay: - properties: - ratepay.installmentAmount: - description: Amount the customer has to pay each month. - type: string - ratepay.interestRate: - description: Interest rate of this installment. - type: string - ratepay.lastInstallmentAmount: - description: Amount of the last installment. - type: string - ratepay.paymentFirstday: - description: Calendar day of the first payment. - type: string - ratepaydata.deliveryDate: - description: Date the merchant delivered the goods to the customer. - type: string - ratepaydata.dueDate: - description: Date by which the customer must settle the payment. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. - type: string - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - AdditionalDataRetry: - properties: - retry.chainAttemptNumber: - description: 'The number of times the transaction (not order) has been retried - between different payment service providers. For instance, the `chainAttemptNumber` - set to 2 means that this transaction has been recently tried on another - provider before being sent to Adyen. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.orderAttemptNumber: - description: 'The index of the attempt to bill a particular order, which - is identified by the `merchantOrderReference` field. For example, if a - recurring transaction fails and is retried one day later, then the order - number for these attempts would be 1 and 2, respectively. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.skipRetry: - description: 'The Boolean value indicating whether Adyen should skip or - retry this transaction, if possible. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - AdditionalDataRisk: - properties: - riskdata.[customFieldName]: - description: The data for your custom risk field. For more information, - refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). - type: string - riskdata.basket.item[itemNr].amountPerItem: - description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.basket.item[itemNr].brand: - description: Brand of the item. - type: string - riskdata.basket.item[itemNr].category: - description: Category of the item. - type: string - riskdata.basket.item[itemNr].color: - description: Color of the item. - type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string - riskdata.basket.item[itemNr].quantity: - description: Quantity of the item purchased. - type: string - riskdata.basket.item[itemNr].receiverEmail: - description: Email associated with the given product in the basket (usually - in electronic gift cards). - type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.promotions.promotion[itemNr].promotionCode: - description: Code of the promotion. - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountAmount: - description: The discount amount of the promotion, represented in [minor - units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: - description: 'Promotion''s percentage discount. It is represented in percentage - value and there is no need to include the ''%'' sign. - - - e.g. for a promotion discount of 30%, the value of the field should be - 30.' - type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string - riskdata.riskProfileReference: - description: Reference number of the risk profile that you want to apply - to the payment. If not provided or left blank, the merchant-level account's - default risk profile will be applied to the payment. For more information, - see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). - type: string - riskdata.skipRisk: - description: If this parameter is provided with the value **true**, risk - checks for the payment request are skipped and the transaction will not - get a risk score. - type: string - AdditionalDataRiskStandalone: - properties: - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.ProtectionEligibility: - description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ - \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ - \ \u2014 Merchant is not protected under the Seller Protection Policy." - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - avsResultRaw: - description: 'Raw AVS result received from the acquirer, where available. - Example: D' - type: string - bin: - description: The Bank Identification Number of a credit card, which is the - first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). - type: string - cvcResultRaw: - description: 'Raw CVC result received from the acquirer, where available. - Example: 1' - type: string - riskToken: - description: Unique identifier or token for the shopper's card details. - type: string - threeDAuthenticated: - description: 'A Boolean value indicating whether 3DS authentication was - completed on this payment. Example: true' - type: string - threeDOffered: - description: 'A Boolean value indicating whether 3DS was offered for this - payment. Example: true' - type: string - tokenDataType: - description: 'Required for PayPal payments only. The only supported value - is: **paypal**.' - type: string - AdditionalDataSubMerchant: - properties: - subMerchant.numberOfSubSellers: - description: Required for transactions performed by registered payment facilitators. - Indicates the number of sub-merchants contained in the request. For example, - **3**. - type: string - subMerchant.subSeller[subSellerNr].city: - description: 'Required for transactions performed by registered payment - facilitators. The city of the sub-merchant''s address. - - * Format: Alphanumeric - - * Maximum length: 13 characters' - type: string - subMerchant.subSeller[subSellerNr].country: - description: "Required for transactions performed by registered payment\ - \ facilitators. The three-letter country code of the sub-merchant's address.\ - \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ - * Fixed length: 3 characters" - type: string - subMerchant.subSeller[subSellerNr].id: - description: "Required for transactions performed by registered payment\ - \ facilitators. A unique identifier that you create for the sub-merchant,\ - \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ - * Maximum length: 15 characters" - type: string - subMerchant.subSeller[subSellerNr].mcc: - description: "Required for transactions performed by registered payment\ - \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ - \ \n* Format: Numeric\n* Fixed length: 4 digits" - type: string - subMerchant.subSeller[subSellerNr].name: - description: 'Required for transactions performed by registered payment - facilitators. The name of the sub-merchant. Based on scheme specifications, - this value will overwrite the shopper statement that will appear in the - card statement. - - * Format: Alphanumeric - - * Maximum length: 22 characters' - type: string - subMerchant.subSeller[subSellerNr].postalCode: - description: 'Required for transactions performed by registered payment - facilitators. The postal code of the sub-merchant''s address, without - dashes. - - * Format: Numeric - - * Fixed length: 8 digits' - type: string - subMerchant.subSeller[subSellerNr].state: - description: 'Required for transactions performed by registered payment - facilitators. The state code of the sub-merchant''s address, if applicable - to the country. - - * Format: Alphanumeric - - * Maximum length: 2 characters' - type: string - subMerchant.subSeller[subSellerNr].street: - description: 'Required for transactions performed by registered payment - facilitators. The street name and house number of the sub-merchant''s - address. - - * Format: Alphanumeric - - * Maximum length: 60 characters' - type: string - subMerchant.subSeller[subSellerNr].taxId: - description: 'Required for transactions performed by registered payment - facilitators. The tax ID of the sub-merchant. - - * Format: Numeric - - * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' - type: string - AdditionalDataTemporaryServices: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - * Encoding: ASCII - - * maxLength: 25' - type: string - enhancedSchemeData.employeeName: - description: 'Name or ID associated with the individual working in a temporary - capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.jobDescription: - description: 'Description of the job or task of the individual working in - a temporary capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.regularHoursRate: - description: 'Amount paid per regular hours worked, minor units. - - * maxLength: 7' - type: string - enhancedSchemeData.regularHoursWorked: - description: 'Amount of time worked during a normal operation for the task - or job. - - * maxLength: 7' - type: string - enhancedSchemeData.requestName: - description: 'Name of the individual requesting temporary services. - - * maxLength: 40' - type: string - enhancedSchemeData.tempStartDate: - description: 'Date for the beginning of the pay period. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.tempWeekEnding: - description: 'Date of the end of the billing cycle. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. For example, 2000 means - USD 20.00 - - * maxLength: 12' - type: string - AdditionalDataWallets: - properties: - androidpay.token: - description: The Android Pay token retrieved from the SDK. - type: string - masterpass.transactionId: - description: The Mastercard Masterpass Transaction ID retrieved from the - SDK. - type: string - payment.token: - description: The Apple Pay token retrieved from the SDK. - type: string - paywithgoogle.token: - description: The Google Pay token retrieved from the SDK. - type: string - samsungpay.token: - description: The Samsung Pay token retrieved from the SDK. - type: string - visacheckout.callId: - description: The Visa Checkout Call ID retrieved from the SDK. - type: string Address: properties: city: @@ -2105,32 +515,6 @@ components: required: - value - currency - ApplicationInfo: - properties: - adyenLibrary: - description: Adyen-developed software, such as libraries and plugins, used - to interact with the Adyen API. For example, Magento plugin, Java API - library, etc. - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - description: Adyen-developed software to get payment details. For example, - Checkout SDK, Secured Fields SDK, etc. - $ref: '#/components/schemas/CommonField' - externalPlatform: - description: Third-party developed platform used to initiate payment requests. - For example, Magento, Zuora, etc. - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - description: Merchant developed software, such as cashier application, used - to interact with the Adyen API. - $ref: '#/components/schemas/CommonField' - merchantDevice: - description: Merchant device information. - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - description: Shopper interaction device, such as terminal, mobile device - or web browser, to initiate payment requests. - $ref: '#/components/schemas/ShopperInteractionDevice' BankAccount: properties: bankAccountNumber: @@ -2179,67 +563,6 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string - BrowserInfo: - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - colorDepth: - x-addedInVersion: '40' - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - x-addedInVersion: '40' - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - x-addedInVersion: '40' - default: true - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - x-addedInVersion: '40' - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). - type: string - screenHeight: - x-addedInVersion: '40' - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - x-addedInVersion: '40' - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - x-addedInVersion: '40' - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - userAgent - - acceptHeader - - javaEnabled - - colorDepth - - screenHeight - - screenWidth - - timeZoneOffset - - language Card: properties: cvc: @@ -2308,109 +631,6 @@ components: - expiryMonth - expiryYear - holderName - CommonField: - properties: - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - DeviceRenderOptions: - properties: - sdkInterface: - default: both - description: 'Supported SDK interface types. - - Allowed values: - - * native - - * html - - * both' - enum: - - native - - html - - both - type: string - sdkUiType: - description: 'UI types supported for displaying specific challenges. - - Allowed values: - - * text - - * singleSelect - - * outOfBand - - * otherHtml - - * multiSelect' - items: - enum: - - multiSelect - - otherHtml - - outOfBand - - singleSelect - - text - type: string - type: array - ExternalPlatform: - properties: - integrator: - description: External platform integrator. - type: string - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - ForexQuote: - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - description: The base amount. - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - description: The buy rate. - $ref: '#/components/schemas/Amount' - interbank: - description: The interbank amount. - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - description: The sell rate. - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - validTill - - basePoints FraudCheckResult: properties: accountScore: @@ -2468,184 +688,6 @@ components: telephoneNumber: description: Phone number of the person type: string - Installments: - properties: - plan: - x-addedInVersion: '64' - description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). - By default, this is set to **regular**. Possible values: - - * **regular** - - * **revolving** - - ' - enum: - - regular - - revolving - type: string - value: - description: 'Defines the number of installments. Its value needs to be - greater than zero. - - - Usually, the maximum allowed number of installments is capped. For example, - it may not be possible to split a payment in more than 24 installments. - The acquirer sets this upper limit, so its value may vary.' - format: int32 - type: integer - required: - - value - Mandate: - properties: - amount: - description: The billing amount (in minor units) of the recurring transactions. - type: string - amountRule: - description: "The limitation rule of the billing amount.\n\nPossible values:\n\ - \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ - \ **exact**: The transaction amount should be the same as the `amount`.\n\ - \n" - enum: - - max - - exact - type: string - billingAttemptsRule: - description: "The rule to specify the period, within which the recurring\ - \ debit can happen, relative to the mandate recurring date.\n\nPossible\ - \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ - \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ - \n" - enum: - - 'on' - - before - - after - type: string - billingDay: - description: 'The number of the day, on which the recurring debit can happen. - Should be within the same calendar month as the mandate recurring date. - - - Possible values: 1-31 based on the `frequency`.' - type: string - endsAt: - description: End date of the billing plan, in YYYY-MM-DD format. - type: string - frequency: - description: 'The frequency with which a shopper should be charged. - - - Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, - **halfYearly**, **yearly**.' - enum: - - adhoc - - daily - - weekly - - biWeekly - - monthly - - quarterly - - halfYearly - - yearly - type: string - remarks: - description: The message shown by UPI to the shopper on the approval screen. - type: string - startsAt: - description: Start date of the billing plan, in YYYY-MM-DD format. By default, - the transaction date. - type: string - required: - - frequency - - amount - - endsAt - MerchantDevice: - properties: - os: - description: Operating system running on the merchant device. - type: string - osVersion: - description: Version of the operating system on the merchant device. - type: string - reference: - description: Merchant device reference. - type: string - MerchantRiskIndicator: - properties: - addressMatch: - description: Whether the chosen delivery address is identical to the billing - address. - type: boolean - deliveryAddressIndicator: - description: 'Indicator regarding the delivery address. - - Allowed values: - - * `shipToBillingAddress` - - * `shipToVerifiedAddress` - - * `shipToNewAddress` - - * `shipToStore` - - * `digitalGoods` - - * `goodsNotShipped` - - * `other`' - enum: - - shipToBillingAddress - - shipToVerifiedAddress - - shipToNewAddress - - shipToStore - - digitalGoods - - goodsNotShipped - - other - type: string - deliveryEmail: - description: The delivery email address (for digital goods). - type: string - deliveryTimeframe: - description: 'The estimated delivery time for the shopper to receive the - goods. - - Allowed values: - - * `electronicDelivery` - - * `sameDayShipping` - - * `overnightShipping` - - * `twoOrMoreDaysShipping`' - enum: - - electronicDelivery - - sameDayShipping - - overnightShipping - - twoOrMoreDaysShipping - type: string - giftCardAmount: - description: For prepaid or gift card purchase, the purchase amount total - of prepaid or gift card(s). - $ref: '#/components/schemas/Amount' - giftCardCount: - description: For prepaid or gift card purchase, total count of individual - prepaid or gift cards/codes purchased. - format: int32 - type: integer - preOrderDate: - description: For pre-order purchases, the expected date this product will - be available to the shopper. - format: date-time - type: string - preOrderPurchase: - description: Indicator for whether this transaction is for pre-ordering - a product. - type: boolean - reorderItems: - description: Indicator for whether the shopper has already purchased the - same items in the past. - type: boolean ModifyRequest: properties: additionalData: @@ -3631,20 +1673,6 @@ components: Example: OOFF' type: string - SDKEphemPubKey: - properties: - crv: - description: The `crv` value as received from the 3D Secure 2 SDK. - type: string - kty: - description: The `kty` value as received from the 3D Secure 2 SDK. - type: string - x: - description: The `x` value as received from the 3D Secure 2 SDK. - type: string - y: - description: The `y` value as received from the 3D Secure 2 SDK. - type: string ServiceError: properties: additionalData: @@ -3671,80 +1699,6 @@ components: description: The HTTP response status. format: int32 type: integer - ShopperInteractionDevice: - properties: - locale: - description: Locale on the shopper interaction device. - type: string - os: - description: Operating system running on the shopper interaction device. - type: string - osVersion: - description: Version of the operating system on the shopper interaction - device. - type: string - Split: - properties: - account: - description: 'Unique identifier of the account where the split amount should - be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. - - - ' - type: string - amount: - description: The amount of this split. - $ref: '#/components/schemas/SplitAmount' - description: - description: A description of this split. - type: string - reference: - description: 'Your reference for the split, which you can use to link the - split to other operations such as captures and refunds. - - - This is required if `type` is **MarketPlace** or **BalanceAccount**. For - the other types, we also recommend sending a reference so you can reconcile - the split and the associated payment in the transaction overview and in - the reports. If the reference is not provided, the split is reported as - part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) - in Adyen for Platforms.' - type: string - type: - description: 'The type of split. - - Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, - **MarketPlace**, **BalanceAccount**, **Remainder**.' - enum: - - BalanceAccount - - Commission - - Default - - MarketPlace - - PaymentFee - - Remainder - - VAT - - Verification - type: string - required: - - amount - - type - SplitAmount: - properties: - currency: - description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - - - If this value is not provided, the currency in which the payment is made - will be used.' - maxLength: 3 - minLength: 3 - type: string - value: - description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). - format: int64 - type: integer - required: - - value StoreDetailAndSubmitRequest: properties: additionalData: @@ -4156,247 +2110,6 @@ components: required: - pspReference - resultCode - ThreeDS2RequestData: - properties: - acquirerBIN: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The acquiring BIN enrolled for 3D Secure 2. This string should match the - value that you will use in the authorisation. Use 123456 on the Test platform. - type: string - acquirerMerchantID: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. - This string should match the value that you will use in the authorisation. - Use 123456 on the Test platform. - type: string - authenticationOnly: - deprecated: true - x-deprecatedInVersion: '50' - x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. - default: false - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - challengeIndicator: - description: 'Possibility to specify a preference for receiving a challenge - from the issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string - deviceChannel: - description: 'The environment of the shopper. - - Allowed values: - - * `app` - - * `browser`' - type: string - deviceRenderOptions: - description: 'Display options for the 3D Secure 2 SDK. - - Optional and only for `deviceChannel` **app**.' - $ref: '#/components/schemas/DeviceRenderOptions' - mcc: - x-addedInVersion: '49' - description: Required for merchants that have been enrolled for 3D Secure - 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` - is registered at the scheme. - type: string - merchantName: - x-addedInVersion: '49' - description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchant name that the issuer presents to the shopper if they get - a challenge. We recommend to use the same value that you will use in the - authorization. Maximum length is 40 characters. - - > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). - Use this field if you are enrolled for 3D Secure 2 with us and want to - override the merchant name already configured on your account.' - type: string - messageVersion: - default: 2.1.0 - description: The `messageVersion` value indicating the 3D Secure 2 protocol - version. - type: string - notificationURL: - description: URL to where the issuer should send the `CRes`. Required if - you are not using components for `channel` **Web** or if you are using - classic integration `deviceChannel` **browser**. - type: string - sdkAppID: - description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEncData: - description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEphemPubKey: - description: 'The `sdkEphemPubKey` value as received from the 3D Secure - 2 SDK. - - Required for `deviceChannel` set to **app**.' - $ref: '#/components/schemas/SDKEphemPubKey' - sdkMaxTimeout: - default: 60 - description: 'The maximum amount of time in minutes for the 3D Secure 2 - authentication process. - - Optional and only for `deviceChannel` set to **app**. Defaults to **60** - minutes.' - format: int32 - type: integer - sdkReferenceNumber: - description: 'The `sdkReferenceNumber` value as received from the 3D Secure - 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkTransID: - description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkVersion: - x-addedInVersion: '40' - description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ - \ set to **app**." - type: string - threeDSCompInd: - description: Completion indicator for the device fingerprinting. - type: string - threeDSRequestorID: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor identifier assigned by the Directory - Server when you enrol for 3D Secure 2. - type: string - threeDSRequestorName: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor name assigned by the Directory Server - when you enrol for 3D Secure 2. - type: string - threeDSRequestorURL: - description: URL of the (customer service) website that will be shown to - the shopper in case of technical errors during the 3D Secure 2 process. - type: string - transactionType: - x-addedInVersion: '50' - description: Identify the type of the transaction being authenticated. - enum: - - goodsOrServicePurchase - - checkAcceptance - - accountFunding - - quasiCashTransaction - - prepaidActivationAndLoad - type: string - whiteListStatus: - x-addedInVersion: '49' - description: The `whiteListStatus` value returned from a previous 3D Secure - 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. - type: string - required: - - deviceChannel - ThreeDSecureData: - properties: - authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. - - - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' - enum: - - Y - - N - - U - - A - type: string - cavv: - description: The cardholder authentication value (base64 encoded, 20 bytes - in a decoded form). - format: byte - type: string - cavvAlgorithm: - description: The CAVV algorithm used. Include this only for 3D Secure 1. - type: string - challengeCancel: - x-addedInVersion: '67' - description: Indicator informing the Access Control Server (ACS) and the - Directory Server (DS) that the authentication has been cancelled. For - possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata). - enum: - - '01' - - '02' - - '03' - - '04' - - '05' - - '06' - - '07' - type: string - directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. - - - In 3D Secure 2, this is the `transStatus` from the `ARes`.' - enum: - - A - - C - - D - - I - - N - - R - - U - - Y - type: string - dsTransID: - x-addedInVersion: '40' - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the Directory Server (DS) to identify a single transaction. - type: string - eci: - description: The electronic commerce indicator. - type: string - riskScore: - x-addedInVersion: '67' - description: Risk score calculated by Directory Server (DS). Required for - Cartes Bancaires integrations. - type: string - threeDSVersion: - x-addedInVersion: '40' - description: The version of the 3D Secure protocol. - type: string - transStatusReason: - x-addedInVersion: '67' - description: Provides information on why the `transStatus` field has the - specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values). - type: string - xid: - description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, - 20 bytes in a decoded form). - format: byte - type: string securitySchemes: ApiKeyAuth: in: header diff --git a/yaml/PayoutService-v68.yaml b/yaml/PayoutService-v68.yaml index 69570e0..9ef4b00 100644 --- a/yaml/PayoutService-v68.yaml +++ b/yaml/PayoutService-v68.yaml @@ -40,7 +40,7 @@ info: ' - x-timestamp: '2022-05-03T09:24:06Z' + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -59,7 +59,7 @@ paths: post: tags: - Reviewing - summary: Confirms a payout. + summary: Confirm a payout description: 'Confirms a previously submitted payout. @@ -126,7 +126,7 @@ paths: post: tags: - Reviewing - summary: Cancels a payout. + summary: Cancel a payout description: 'Cancels a previously submitted payout. @@ -193,7 +193,7 @@ paths: post: tags: - Instant payouts - summary: Pay out directly. + summary: Make an instant card payout description: With this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card @@ -259,7 +259,7 @@ paths: post: tags: - Initialization - summary: Stores payout details. + summary: Store payout details description: Stores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call. @@ -324,7 +324,7 @@ paths: post: tags: - Initialization - summary: Stores details and submits a payout. + summary: Store details and submit a payout description: 'Submits a payout and stores its details for subsequent payouts. @@ -397,7 +397,7 @@ paths: post: tags: - Initialization - summary: Submits a payout. + summary: Submit a payout description: 'Submits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call. @@ -461,1743 +461,6 @@ paths: description: Internal Server Error - the server could not process the request. components: schemas: - AccountInfo: - properties: - accountAgeIndicator: - description: 'Indicator for the length of time since this shopper account - was created in the merchant''s environment. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountChangeDate: - description: Date when the shopper's account was last changed. - format: date-time - type: string - accountChangeIndicator: - description: 'Indicator for the length of time since the shopper''s account - was last updated. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - accountCreationDate: - description: Date when the shopper's account was created. - format: date-time - type: string - accountType: - x-addedInVersion: '50' - description: 'Indicates the type of account. For example, for a multi-account - card product. - - Allowed values: - - * notApplicable - - * credit - - * debit' - enum: - - notApplicable - - credit - - debit - type: string - addCardAttemptsDay: - description: Number of attempts the shopper tried to add a card to their - account in the last day. - format: int32 - type: integer - deliveryAddressUsageDate: - description: Date the selected delivery address was first used. - format: date-time - type: string - deliveryAddressUsageIndicator: - description: 'Indicator for the length of time since this delivery address - was first used. - - Allowed values: - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - homePhone: - deprecated: true - x-deprecatedInVersion: '68' - x-deprecatedMessage: Use `ThreeDS2RequestData.homePhone` instead. - description: Shopper's home phone number (including the country code). - type: string - mobilePhone: - deprecated: true - x-deprecatedInVersion: '68' - x-deprecatedMessage: Use `ThreeDS2RequestData.mobilePhone` instead. - description: Shopper's mobile phone number (including the country code). - type: string - passwordChangeDate: - description: Date when the shopper last changed their password. - format: date-time - type: string - passwordChangeIndicator: - description: 'Indicator when the shopper has changed their password. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - pastTransactionsDay: - description: Number of all transactions (successful and abandoned) from - this shopper in the past 24 hours. - format: int32 - type: integer - pastTransactionsYear: - description: Number of all transactions (successful and abandoned) from - this shopper in the past year. - format: int32 - type: integer - paymentAccountAge: - description: Date this payment method was added to the shopper's account. - format: date-time - type: string - paymentAccountIndicator: - description: 'Indicator for the length of time since this payment method - was added to this shopper''s account. - - Allowed values: - - * notApplicable - - * thisTransaction - - * lessThan30Days - - * from30To60Days - - * moreThan60Days' - enum: - - notApplicable - - thisTransaction - - lessThan30Days - - from30To60Days - - moreThan60Days - type: string - purchasesLast6Months: - description: Number of successful purchases in the last six months. - format: int32 - type: integer - suspiciousActivity: - description: Whether suspicious activity was recorded on this account. - type: boolean - workPhone: - deprecated: true - x-deprecatedInVersion: '68' - x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. - description: Shopper's work phone number (including the country code). - type: string - AcctInfo: - properties: - chAccAgeInd: - description: "Length of time that the cardholder has had the account with\ - \ the 3DS Requestor. \nAllowed values:\n* **01** \u2014 No account\n*\ - \ **02** \u2014 Created during this transaction\n* **03** \u2014 Less\ - \ than 30 days\n* **04** \u2014 30\u201360 days\n* **05** \u2014 More\ - \ than 60 days" - enum: - - '01' - - '02' - - '03' - - '04' - - '05' - maxLength: 2 - minLength: 2 - type: string - chAccChange: - description: "Date that the cardholder\u2019s account with the 3DS Requestor\ - \ was last changed, including Billing or Shipping address, new payment\ - \ account, or new user(s) added. \nFormat: **YYYYMMDD**" - type: string - chAccChangeInd: - description: "Length of time since the cardholder\u2019s account information\ - \ with the 3DS Requestor was last changed, including Billing or Shipping\ - \ address, new payment account, or new user(s) added. \nAllowed values:\n\ - * **01** \u2014 Changed during this transaction\n* **02** \u2014 Less\ - \ than 30 days\n* **03** \u2014 30\u201360 days\n* **04** \u2014 More\ - \ than 60 days" - enum: - - '01' - - '02' - - '03' - - '04' - maxLength: 2 - minLength: 2 - type: string - chAccPwChange: - description: "Date that cardholder\u2019s account with the 3DS Requestor\ - \ had a password change or account reset. \nFormat: **YYYYMMDD**" - type: string - chAccPwChangeInd: - description: "Indicates the length of time since the cardholder\u2019s account\ - \ with the 3DS Requestor had a password change or account reset. \nAllowed\ - \ values:\n* **01** \u2014 No change\n* **02** \u2014 Changed during this\ - \ transaction\n* **03** \u2014 Less than 30 days\n* **04** \u2014 30\u2013\ - 60 days\n* **05** \u2014 More than 60 days" - enum: - - '01' - - '02' - - '03' - - '04' - - '05' - maxLength: 2 - minLength: 2 - type: string - chAccString: - description: "Date that the cardholder opened the account with the 3DS Requestor.\ - \ \nFormat: **YYYYMMDD**" - type: string - nbPurchaseAccount: - description: 'Number of purchases with this cardholder account during the - previous six months. Max length: 4 characters.' - type: string - paymentAccAge: - description: "String that the payment account was enrolled in the cardholder\u2019\ - s account with the 3DS Requestor. \nFormat: **YYYYMMDD**" - type: string - paymentAccInd: - description: "Indicates the length of time that the payment account was\ - \ enrolled in the cardholder\u2019s account with the 3DS Requestor. \n\ - Allowed values:\n* **01** \u2014 No account (guest checkout)\n* **02**\ - \ \u2014 During this transaction\n* **03** \u2014 Less than 30 days\n\ - * **04** \u2014 30\u201360 days\n* **05** \u2014 More than 60 days" - enum: - - '01' - - '02' - - '03' - - '04' - - '05' - maxLength: 2 - minLength: 2 - type: string - provisionAttemptsDay: - description: 'Number of Add Card attempts in the last 24 hours. Max length: - 3 characters.' - type: string - shipAddressUsage: - description: "String when the shipping address used for this transaction\ - \ was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**" - type: string - shipAddressUsageInd: - description: "Indicates when the shipping address used for this transaction\ - \ was first used with the 3DS Requestor. \nAllowed values:\n* **01** \u2014\ - \ This transaction\n* **02** \u2014 Less than 30 days\n* **03** \u2014\ - \ 30\u201360 days\n* **04** \u2014 More than 60 days" - enum: - - '01' - - '02' - - '03' - - '04' - maxLength: 2 - minLength: 2 - type: string - shipNameIndicator: - description: "Indicates if the Cardholder Name on the account is identical\ - \ to the shipping Name used for this transaction. \nAllowed values:\n\ - * **01** \u2014 Account Name identical to shipping Name\n* **02** \u2014\ - \ Account Name different to shipping Name" - enum: - - '01' - - '02' - maxLength: 2 - minLength: 2 - type: string - suspiciousAccActivity: - description: "Indicates whether the 3DS Requestor has experienced suspicious\ - \ activity (including previous fraud) on the cardholder account. \nAllowed\ - \ values:\n* **01** \u2014 No suspicious activity has been observed\n\ - * **02** \u2014 Suspicious activity has been observed" - enum: - - '01' - - '02' - maxLength: 2 - minLength: 2 - type: string - txnActivityDay: - description: 'Number of transactions (successful and abandoned) for this - cardholder account with the 3DS Requestor across all payment accounts - in the previous 24 hours. Max length: 3 characters.' - maxLength: 3 - type: string - txnActivityYear: - description: 'Number of transactions (successful and abandoned) for this - cardholder account with the 3DS Requestor across all payment accounts - in the previous year. Max length: 3 characters.' - maxLength: 3 - type: string - AdditionalData3DSecure: - properties: - allow3DS2: - description: "Indicates if you are able to process 3D Secure 2 transactions\ - \ natively on your payment page. Send this parameter when you are using\ - \ `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\ - \n > This parameter only indicates readiness to support native 3D Secure\ - \ 2 authentication. To specify if you _want_ to perform 3D Secure, use\ - \ [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the\ - \ `executeThreeD` parameter.\n\nPossible values:\n* **true** - Ready to\ - \ support native 3D Secure 2 authentication. Setting this to true does\ - \ not mean always applying 3D Secure 2. Adyen still selects the version\ - \ of 3D Secure based on configuration to optimize authorisation rates\ - \ and improve the shopper's experience.\n* **false** \u2013 Not ready\ - \ to support native 3D Secure 2 authentication. Adyen will not offer 3D\ - \ Secure 2 to your shopper regardless of your configuration.\n" - type: string - executeThreeD: - description: "Indicates if you want to perform 3D Secure authentication\ - \ on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\ - \ to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**\ - \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 Don't perform\ - \ 3D Secure authentication. Note that this setting results in refusals\ - \ if the issuer mandates 3D Secure because of the PSD2 directive or other,\ - \ national regulations. \n" - type: string - mpiImplementationType: - description: In case of Secure+, this field must be set to **CUPSecurePlus**. - type: string - scaExemption: - description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest)\ - \ that you want to request for the transaction.\n\n Possible values:\n\ - * **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n*\ - \ **transactionRiskAnalysis** " - type: string - threeDSVersion: - description: "Indicates your preference for the 3D Secure version. \n> If\ - \ you use this parameter, you override the checks from Adyen's Authentication\ - \ Engine. We recommend to use this field only if you have an extensive\ - \ knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure\ - \ version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**:\ - \ Apply 3D Secure version 2.2.0. If the issuer does not support version\ - \ 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n*\ - \ If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus`\ - \ in the `ARes`, we will apply the fallback policy configured in your\ - \ account. For example, if the configuration is to fall back to 3D Secure\ - \ 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but\ - \ the BIN is not enrolled, you will receive an error.\n\n" - type: string - AdditionalDataAirline: - properties: - airline.agency_invoice_number: - description: 'Reference number for the invoice, issued by the agency. - - * minLength: 1 - - * maxLength: 6' - type: string - airline.agency_plan_name: - description: '2-letter agency plan identifier; alphabetical. - - * minLength: 2 - - * maxLength: 2' - type: string - airline.airline_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit - accounting code (PAX); numeric. It identifies the carrier. - - * Format: IATA 3-digit accounting code (PAX) - - * Example: KLM = 074 - - * minLength: 3 - - * maxLength: 3' - type: string - airline.airline_designator_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.boarding_fee: - description: 'Chargeable amount for boarding the plane. - - The transaction amount needs to be represented in minor units according - to the [following table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 18' - type: string - airline.computerized_reservation_system: - description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) - used to make the reservation and purchase the ticket. - - * Format: alphanumeric. - - * minLength: 4 - - * maxLength: 4' - type: string - airline.customer_reference_number: - description: 'Reference number; alphanumeric. - - * minLength: 0 - - * maxLength: 20' - type: string - airline.document_type: - description: 'Optional 2-digit code; alphanumeric. It identifies the type - of product of the transaction. The description of the code may appear - on credit card statements. - - * Format: 2-digit code - - * Example: Passenger ticket = 01 - - * minLength: 2 - - * maxLength: 2' - type: string - airline.flight_date: - description: 'Flight departure date. Local time `(HH:mm)` is optional. - - * Date format: `yyyy-MM-dd` - - * Date and time format: `yyyy-MM-dd HH:mm` - - * minLength: 10 - - * maxLength: 16' - type: string - airline.leg.carrier_code: - description: '[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter - accounting code (PAX); alphabetical. It identifies the carrier. - - This field is required/mandatory if the airline data includes leg details. - - * Format: IATA 2-letter airline code - - * Example: KLM = KL - - * minLength: 2 - - * maxLength: 2' - type: string - airline.leg.class_of_travel: - description: '1-letter travel class identifier; alphabetical. There is no - standard; however, the following codes are used rather consistently: - - * F: first class - - * J: business class - - * Y: economy class - - * W: premium economy - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.leg.date_of_travel: - description: "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n\ - * Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16" - type: string - airline.leg.depart_airport: - description: 'Alphabetical identifier of the departure airport. - - This field is required if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.depart_tax: - description: '[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). - Amount charged by a country to an individual upon their leaving. The transaction - amount needs to be represented in minor units according to the [following - table](https://docs.adyen.com/development-resources/currency-codes). - - * minLength: 1 - - * maxLength: 12' - type: string - airline.leg.destination_code: - description: 'Alphabetical identifier of the destination/arrival airport. - - This field is required/mandatory if the airline data includes leg details. - - * Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter - airport code. - - * Example: Amsterdam = AMS - - * minLength: 3 - - * maxLength: 3' - type: string - airline.leg.fare_base_code: - description: '[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); - alphanumeric. - - * minLength: 1 - - * maxLength: 7' - type: string - airline.leg.flight_number: - description: 'The flight identifier. - - * minLength: 1 - - * maxLength: 5' - type: string - airline.leg.stop_over_code: - description: '1-letter code that indicates whether the passenger is entitled - to make a stopover. Only two types of characters are allowed: - - * O: Stopover allowed - - * X: Stopover not allowed - - - Limitations: - - * minLength: 1 - - * maxLength: 1' - type: string - airline.passenger.date_of_birth: - description: 'Date of birth of the passenger. - - - Date format: `yyyy-MM-dd` - - * minLength: 10 - - * maxLength: 10' - type: string - airline.passenger.first_name: - description: 'Passenger first name/given name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.last_name: - description: 'Passenger last name/family name. - - > This field is required/mandatory if the airline data includes passenger - details or leg details.' - type: string - airline.passenger.telephone_number: - description: 'Telephone number of the passenger, including country code. - This is an alphanumeric field that can include the ''+'' and ''-'' signs. - - * minLength: 3 - - * maxLength: 30' - type: string - airline.passenger.traveller_type: - description: 'Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. - Example: ADT, SRC, CNN, INS. - - - However, several carriers use non-standard codes that can be up to 5 alphanumeric - characters. - - * minLength: 3 - - * maxLength: 6' - type: string - airline.passenger_name: - description: 'Passenger name, initials, and a title. - - * Format: last name + first name or initials + title. - - * Example: *FLYER / MARY MS*. - - * minLength: 1 - - * maxLength: 49' - type: string - airline.ticket_issue_address: - description: 'Address of the place/agency that issued the ticket. - - * minLength: 0 - - * maxLength: 16' - type: string - airline.ticket_number: - description: 'The ticket''s unique identifier. - - * minLength: 1 - - * maxLength: 150' - type: string - airline.travel_agency_code: - description: 'IATA number, also ARC number or ARC/IATA number. Unique identifier - number for travel agencies. - - * minLength: 1 - - * maxLength: 8' - type: string - airline.travel_agency_name: - description: 'The name of the travel agency. - - * minLength: 1 - - * maxLength: 25' - type: string - required: - - airline.passenger_name - AdditionalDataCarRental: - properties: - carRental.checkOutDate: - description: 'Pick-up date. - - * Date format: `yyyyMMdd`' - type: string - carRental.customerServiceTollFreeNumber: - description: 'The customer service phone number of the car rental company. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - carRental.daysRented: - description: 'Number of days for which the car is being rented. - - * Format: Numeric - - * maxLength: 19' - type: string - carRental.fuelCharges: - description: 'Any fuel charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.insuranceCharges: - description: 'Any insurance charges associated with the rental. - - * Format: Numeric - - * maxLength: 12' - type: string - carRental.locationCity: - description: 'The city from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.locationCountry: - description: 'The country from which the car is rented. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.locationStateProvince: - description: 'The state or province from where the car is rented. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - * Y - Customer was a no show. - - * N - Not applicable.' - type: string - carRental.oneWayDropOffCharges: - description: Charge associated with not returning a vehicle to the original - rental location. - type: string - carRental.rate: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.rateIndicator: - description: 'Specifies whether the given rate is applied daily or weekly. - - * D - Daily rate. - - * W - Weekly rate.' - type: string - carRental.rentalAgreementNumber: - description: 'The rental agreement number associated with this car rental. - - * Format: Alphanumeric - - * maxLength: 9' - type: string - carRental.rentalClassId: - description: 'Daily rental rate. - - * Format: Alphanumeric - - * maxLength: 12' - type: string - carRental.renterName: - description: 'The name of the person renting the car. - - * Format: Alphanumeric - - * maxLength: 26' - type: string - carRental.returnCity: - description: 'The city where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 18' - type: string - carRental.returnCountry: - description: 'The country where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 2' - type: string - carRental.returnDate: - description: 'The last date to return the car by. - - * Date format: `yyyyMMdd`' - type: string - carRental.returnLocationId: - description: 'Agency code, phone number, or address abbreviation - - * Format: Alphanumeric - - * maxLength: 10' - type: string - carRental.returnStateProvince: - description: 'The state or province where the car must be returned. - - * Format: Alphanumeric - - * maxLength: 3' - type: string - carRental.taxExemptIndicator: - description: 'Indicates whether the goods or services were tax-exempt, or - tax was not collected. - - - Values: - - * Y - Goods or services were tax exempt - - * N - Tax was not collected' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "A" for Car rental. This should be - included in the auth message. - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataCommon: - properties: - RequestedTestErrorResponseCode: - description: "Triggers test scenarios that allow to replicate certain communication\ - \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ - \ wasn't a connection available to service the outgoing communication.\n\ - This is a transient, retriable error since no messaging could be initiated\ - \ to an issuing system (or third-party acquiring system). Therefore, the\ - \ header Transient-Error: true is returned in the response. A subsequent\ - \ request using the same idempotency key will be processed as if it was\ - \ the first request.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ - \ wrong during transmission of the message or receiving the response.\n\ - This is a classified as non-transient because the message could have been\ - \ received by the issuing party and been acted upon. No transient error\ - \ header is returned. If using idempotency, the (error) response is stored\ - \ as the final result for the idempotency key. Subsequent messages with\ - \ the same idempotency key not be processed beyond returning the stored\ - \ response." - type: string - authorisationType: - description: "Flags a card payment request for either pre-authorisation\ - \ or final authorisation. For more information, refer to [Authorisation\ - \ types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\ - \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ - \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ - \ request to be handled as a final authorisation." - type: string - customRoutingFlag: - description: 'Allows you to determine or override the acquirer account that - should be used for the transaction. - - - If you need to process a payment with an acquirer different from a default - one, you can set up a corresponding configuration on the Adyen payments - platform. Then you can pass a custom routing flag in a payment request''s - additional data to target a specific acquirer. - - - To enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).' - type: string - industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge - description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ - \ this field denotes why the additional payment is made.\n\nPossible values:\n\ - \n * **NoShow**: An incremental charge is carried out because of a no-show\ - \ for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental\ - \ charge is carried out to process an additional payment after the original\ - \ services have been rendered and the respective payment has been processed." - enum: - - NoShow - - DelayedCharge - type: string - networkTxReference: - description: 'Allows you to link the transaction to the original or previous - one in a subscription/card-on-file chain. This field is required for token-based - transactions where Adyen does not tokenize the card. - - - Transaction identifier from card schemes, for example, Mastercard Trace - ID or the Visa Transaction ID. - - - Submit the original transaction ID of the contract in your payment request - if you are not tokenizing card details with Adyen and are making a merchant-initiated - transaction (MIT) for subsequent charges. - - - Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` - **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction - is classified as MIT.' - type: string - overwriteBrand: - description: Boolean indicator that can be optionally used for performing - debit transactions on combo cards (for example, combo cards in Brazil). - This is not mandatory but we recommend that you set this to true if you - want to use the `selectedBrand` value to specify how to process the transaction. - type: string - subMerchantCity: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the city of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 13 characters.' - type: string - subMerchantCountry: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the three-letter - country code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Fixed length: 3 characters.' - type: string - subMerchantID: - description: 'This field contains an identifier of the actual merchant when - a transaction is submitted via a payment facilitator. The payment facilitator - must send in this unique ID. - - - A unique identifier per submerchant that is required if the transaction - is performed by a registered payment facilitator. - - * Format: alpha-numeric. - - * Fixed length: 15 characters.' - type: string - subMerchantName: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the name of - the actual merchant. - - * Format: alpha-numeric. - - * Maximum length: 22 characters.' - type: string - subMerchantPostalCode: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the postal code - of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 10 characters.' - type: string - subMerchantState: - description: 'This field is required if the transaction is performed by - a registered payment facilitator, and if applicable to the country. This - field must contain the state code of the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 3 characters.' - type: string - subMerchantStreet: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the street of - the actual merchant''s address. - - * Format: alpha-numeric. - - * Maximum length: 60 characters.' - type: string - subMerchantTaxId: - description: 'This field is required if the transaction is performed by - a registered payment facilitator. This field must contain the tax ID of - the actual merchant. - - * Format: alpha-numeric. - - * Fixed length: 11 or 14 characters.' - type: string - AdditionalDataLevel23: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - - Encoding: ASCII. - - - Max length: 25 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - enhancedSchemeData.destinationCountryCode: - description: 'Destination country code. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.destinationPostalCode: - description: 'The postal code of a destination address. - - - Encoding: ASCII. - - - Max length: 10 characters. - - - > Required for American Express.' - type: string - enhancedSchemeData.destinationStateProvinceCode: - description: 'Destination state or province code. - - - Encoding: ASCII.Max length: 3 characters.' - type: string - enhancedSchemeData.dutyAmount: - description: 'Duty amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.freightAmount: - description: 'Shipping amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].commodityCode: - description: 'Item commodity code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].description: - description: 'Item description. - - - Encoding: ASCII. - - - Max length: 26 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].discountAmount: - description: 'Discount amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].productCode: - description: 'Product code. - - - Encoding: ASCII. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].quantity: - description: 'Quantity, specified as an integer value. - - - Value must be greater than 0. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].totalAmount: - description: 'Total amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: - description: 'Item unit of measurement. - - - Encoding: ASCII. - - - Max length: 3 characters.' - type: string - enhancedSchemeData.itemDetailLine[itemNr].unitPrice: - description: 'Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). - - - Max length: 12 characters.' - type: string - enhancedSchemeData.orderDate: - description: 'Order date. - - * Format: `ddMMyy` - - - Encoding: ASCII. - - - Max length: 6 characters.' - type: string - enhancedSchemeData.shipFromPostalCode: - description: 'The postal code of a "ship-from" address. - - - Encoding: ASCII. - - - Max length: 10 characters.' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. - - - For example, 2000 means USD 20.00. - - - Max length: 12 characters. - - - > Required for Level 2 and Level 3 data.' - type: string - AdditionalDataLodging: - properties: - lodging.checkInDate: - description: 'The arrival date. - - * Date format: `yyyyMMdd`' - type: string - lodging.checkOutDate: - description: 'The departure date. - - * Date format: `yyyyMMdd`' - type: string - lodging.customerServiceTollFreeNumber: - description: 'The toll free phone number for the hotel/lodgings. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.fireSafetyActIndicator: - description: 'Identifies that the facility complies with the Hotel and Motel - Fire Safety Act of 1990. Values can be: ''Y'' or ''N''. - - * Format: Alphabetic - - * maxLength: 1' - type: string - lodging.folioCashAdvances: - description: 'The folio cash advances. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.folioNumber: - description: "Card acceptor\u2019s internal invoice or billing ID reference\ - \ number.\n* Format: Alphanumeric\n* maxLength: 25" - type: string - lodging.foodBeverageCharges: - description: 'Any charges for food and beverages associated with the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.noShowIndicator: - description: 'Indicates if the customer was a "no-show" (neither keeps nor - cancels their booking). - - - Value should be Y or N. - - * Format: Numeric - - * maxLength: 1' - type: string - lodging.prepaidExpenses: - description: 'Prepaid expenses for the booking. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.propertyPhoneNumber: - description: 'Identifies specific lodging property location by its local - phone number. - - * Format: Alphanumeric - - * maxLength: 17' - type: string - lodging.room1.numberOfNights: - description: 'Total number of nights the room will be rented. - - * Format: Numeric - - * maxLength: 4' - type: string - lodging.room1.rate: - description: 'The rate of the room. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.room1.tax: - description: 'The total amount of tax to be paid. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalRoomTax: - description: 'Total room tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - lodging.totalTax: - description: 'Total tax amount. - - * Format: Numeric - - * maxLength: 12' - type: string - travelEntertainmentAuthData.duration: - description: 'Number of nights. This should be included in the auth message. - - * Format: Numeric - - * maxLength: 2' - type: string - travelEntertainmentAuthData.market: - description: 'Indicates what market-specific dataset will be submitted or - is being submitted. Value should be "H" for Hotel. This should be included - in the auth message. - - - * Format: Alphanumeric - - * maxLength: 1' - type: string - AdditionalDataOpenInvoice: - properties: - openinvoicedata.merchantData: - description: 'Holds different merchant data points like product, purchase, - customer, and so on. It takes data in a Base64 encoded string. - - - The `merchantData` parameter needs to be added to the `openinvoicedata` - signature at the end. - - - Since the field is optional, if it''s not included it does not impact - computing the merchant signature. - - - Applies only to Klarna. - - - You can contact Klarna for the format and structure of the string.' - type: string - openinvoicedata.numberOfLines: - description: 'The number of invoice lines included in `openinvoicedata`. - - - There needs to be at least one line, so `numberOfLines` needs to be at - least 1.' - type: string - openinvoicedataLine[itemNr].currencyCode: - description: The three-character ISO currency code. - type: string - openinvoicedataLine[itemNr].description: - description: A text description of the product the invoice line refers to. - type: string - openinvoicedataLine[itemNr].itemAmount: - description: 'The price for one item in the invoice line, represented in - minor units. - - - The due amount for the item, VAT excluded.' - type: string - openinvoicedataLine[itemNr].itemId: - description: A unique id for this item. Required for RatePay if the description - of each item is not unique. - type: string - openinvoicedataLine[itemNr].itemVatAmount: - description: The VAT due for one item in the invoice line, represented in - minor units. - type: string - openinvoicedataLine[itemNr].itemVatPercentage: - description: 'The VAT percentage for one item in the invoice line, represented - in minor units. - - - For example, 19% VAT is specified as 1900.' - type: string - openinvoicedataLine[itemNr].numberOfItems: - description: The number of units purchased of a specific product. - type: string - openinvoicedataLine[itemNr].returnShippingCompany: - description: Name of the shipping company handling the the return shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingNumber: - description: The tracking number for the return of the shipment. - type: string - openinvoicedataLine[itemNr].returnTrackingUri: - description: URI where the customer can track the return of their shipment. - type: string - openinvoicedataLine[itemNr].shippingCompany: - description: Name of the shipping company handling the delivery. - type: string - openinvoicedataLine[itemNr].shippingMethod: - description: Shipping method. - type: string - openinvoicedataLine[itemNr].trackingNumber: - description: The tracking number for the shipment. - type: string - openinvoicedataLine[itemNr].trackingUri: - description: URI where the customer can track their shipment. - type: string - AdditionalDataOpi: - properties: - opi.includeTransToken: - description: 'Optional boolean indicator. Set to **true** if you want an - ecommerce transaction to return an `opi.transToken` as additional data - in the response. - - - You can store this Oracle Payment Interface token in your Oracle Opera - database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' - type: string - AdditionalDataPayout: - properties: - fundingNetwork: - description: '' - type: string - fundingSource: - description: '' - enum: - - CREDIT - - DEBIT - - PREPAID - - DEPOSIT_ACCOUNT - type: string - fundingTransactionId: - description: '' - type: string - payoutAccountCode: - description: '' - type: string - payoutAccountHolderCode: - description: '' - type: string - payoutMarketPayUser: - description: '' - type: string - processOver: - description: '' - enum: - - MC_P2P - - Visa_OCT - - UnlinkedRefund - type: string - verifyOver: - description: '' - type: string - walletIdentifier: - description: '' - type: string - AdditionalDataRatepay: - properties: - ratepay.installmentAmount: - description: Amount the customer has to pay each month. - type: string - ratepay.interestRate: - description: Interest rate of this installment. - type: string - ratepay.lastInstallmentAmount: - description: Amount of the last installment. - type: string - ratepay.paymentFirstday: - description: Calendar day of the first payment. - type: string - ratepaydata.deliveryDate: - description: Date the merchant delivered the goods to the customer. - type: string - ratepaydata.dueDate: - description: Date by which the customer must settle the payment. - type: string - ratepaydata.invoiceDate: - description: Invoice date, defined by the merchant. If not included, the - invoice date is set to the delivery date. - type: string - ratepaydata.invoiceId: - description: Identification name or number for the invoice, defined by the - merchant. - type: string - AdditionalDataRetry: - properties: - retry.chainAttemptNumber: - description: 'The number of times the transaction (not order) has been retried - between different payment service providers. For instance, the `chainAttemptNumber` - set to 2 means that this transaction has been recently tried on another - provider before being sent to Adyen. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.orderAttemptNumber: - description: 'The index of the attempt to bill a particular order, which - is identified by the `merchantOrderReference` field. For example, if a - recurring transaction fails and is retried one day later, then the order - number for these attempts would be 1 and 2, respectively. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - retry.skipRetry: - description: 'The Boolean value indicating whether Adyen should skip or - retry this transaction, if possible. - - - > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, - and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` - to facilitate linking payment attempts together.' - type: string - AdditionalDataRisk: - properties: - riskdata.[customFieldName]: - description: The data for your custom risk field. For more information, - refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). - type: string - riskdata.basket.item[itemNr].amountPerItem: - description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.basket.item[itemNr].brand: - description: Brand of the item. - type: string - riskdata.basket.item[itemNr].category: - description: Category of the item. - type: string - riskdata.basket.item[itemNr].color: - description: Color of the item. - type: string - riskdata.basket.item[itemNr].currency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.basket.item[itemNr].itemID: - description: ID of the item. - type: string - riskdata.basket.item[itemNr].manufacturer: - description: Manufacturer of the item. - type: string - riskdata.basket.item[itemNr].productTitle: - description: A text description of the product the invoice line refers to. - type: string - riskdata.basket.item[itemNr].quantity: - description: Quantity of the item purchased. - type: string - riskdata.basket.item[itemNr].receiverEmail: - description: Email associated with the given product in the basket (usually - in electronic gift cards). - type: string - riskdata.basket.item[itemNr].size: - description: Size of the item. - type: string - riskdata.basket.item[itemNr].sku: - description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' - type: string - riskdata.basket.item[itemNr].upc: - description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' - type: string - riskdata.promotions.promotion[itemNr].promotionCode: - description: Code of the promotion. - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountAmount: - description: The discount amount of the promotion, represented in [minor - units](https://docs.adyen.com/development-resources/currency-codes). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: - description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). - type: string - riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: - description: 'Promotion''s percentage discount. It is represented in percentage - value and there is no need to include the ''%'' sign. - - - e.g. for a promotion discount of 30%, the value of the field should be - 30.' - type: string - riskdata.promotions.promotion[itemNr].promotionName: - description: Name of the promotion. - type: string - riskdata.riskProfileReference: - description: Reference number of the risk profile that you want to apply - to the payment. If not provided or left blank, the merchant-level account's - default risk profile will be applied to the payment. For more information, - see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). - type: string - riskdata.skipRisk: - description: If this parameter is provided with the value **true**, risk - checks for the payment request are skipped and the transaction will not - get a risk score. - type: string - AdditionalDataRiskStandalone: - properties: - PayPal.CountryCode: - description: Shopper's country of residence in the form of ISO standard - 3166 2-character country codes. - type: string - PayPal.EmailId: - description: Shopper's email. - type: string - PayPal.FirstName: - description: Shopper's first name. - type: string - PayPal.LastName: - description: Shopper's last name. - type: string - PayPal.PayerId: - description: 'Unique PayPal Customer Account identification number. Character - length and limitations: 13 single-byte alphanumeric characters.' - type: string - PayPal.Phone: - description: Shopper's phone number. - type: string - PayPal.ProtectionEligibility: - description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ - \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ - \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ - \ \u2014 Merchant is not protected under the Seller Protection Policy." - type: string - PayPal.TransactionId: - description: Unique transaction ID of the payment. - type: string - avsResultRaw: - description: 'Raw AVS result received from the acquirer, where available. - Example: D' - type: string - bin: - description: The Bank Identification Number of a credit card, which is the - first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). - type: string - cvcResultRaw: - description: 'Raw CVC result received from the acquirer, where available. - Example: 1' - type: string - riskToken: - description: Unique identifier or token for the shopper's card details. - type: string - threeDAuthenticated: - description: 'A Boolean value indicating whether 3DS authentication was - completed on this payment. Example: true' - type: string - threeDOffered: - description: 'A Boolean value indicating whether 3DS was offered for this - payment. Example: true' - type: string - tokenDataType: - description: 'Required for PayPal payments only. The only supported value - is: **paypal**.' - type: string - AdditionalDataSubMerchant: - properties: - subMerchant.numberOfSubSellers: - description: Required for transactions performed by registered payment facilitators. - Indicates the number of sub-merchants contained in the request. For example, - **3**. - type: string - subMerchant.subSeller[subSellerNr].city: - description: 'Required for transactions performed by registered payment - facilitators. The city of the sub-merchant''s address. - - * Format: Alphanumeric - - * Maximum length: 13 characters' - type: string - subMerchant.subSeller[subSellerNr].country: - description: "Required for transactions performed by registered payment\ - \ facilitators. The three-letter country code of the sub-merchant's address.\ - \ For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n\ - * Fixed length: 3 characters" - type: string - subMerchant.subSeller[subSellerNr].id: - description: "Required for transactions performed by registered payment\ - \ facilitators. A unique identifier that you create for the sub-merchant,\ - \ used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n\ - * Maximum length: 15 characters" - type: string - subMerchant.subSeller[subSellerNr].mcc: - description: "Required for transactions performed by registered payment\ - \ facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC).\ - \ \n* Format: Numeric\n* Fixed length: 4 digits" - type: string - subMerchant.subSeller[subSellerNr].name: - description: 'Required for transactions performed by registered payment - facilitators. The name of the sub-merchant. Based on scheme specifications, - this value will overwrite the shopper statement that will appear in the - card statement. - - * Format: Alphanumeric - - * Maximum length: 22 characters' - type: string - subMerchant.subSeller[subSellerNr].postalCode: - description: 'Required for transactions performed by registered payment - facilitators. The postal code of the sub-merchant''s address, without - dashes. - - * Format: Numeric - - * Fixed length: 8 digits' - type: string - subMerchant.subSeller[subSellerNr].state: - description: 'Required for transactions performed by registered payment - facilitators. The state code of the sub-merchant''s address, if applicable - to the country. - - * Format: Alphanumeric - - * Maximum length: 2 characters' - type: string - subMerchant.subSeller[subSellerNr].street: - description: 'Required for transactions performed by registered payment - facilitators. The street name and house number of the sub-merchant''s - address. - - * Format: Alphanumeric - - * Maximum length: 60 characters' - type: string - subMerchant.subSeller[subSellerNr].taxId: - description: 'Required for transactions performed by registered payment - facilitators. The tax ID of the sub-merchant. - - * Format: Numeric - - * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' - type: string - AdditionalDataTemporaryServices: - properties: - enhancedSchemeData.customerReference: - description: 'Customer code, if supplied by a customer. - - * Encoding: ASCII - - * maxLength: 25' - type: string - enhancedSchemeData.employeeName: - description: 'Name or ID associated with the individual working in a temporary - capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.jobDescription: - description: 'Description of the job or task of the individual working in - a temporary capacity. - - * maxLength: 40' - type: string - enhancedSchemeData.regularHoursRate: - description: 'Amount paid per regular hours worked, minor units. - - * maxLength: 7' - type: string - enhancedSchemeData.regularHoursWorked: - description: 'Amount of time worked during a normal operation for the task - or job. - - * maxLength: 7' - type: string - enhancedSchemeData.requestName: - description: 'Name of the individual requesting temporary services. - - * maxLength: 40' - type: string - enhancedSchemeData.tempStartDate: - description: 'Date for the beginning of the pay period. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.tempWeekEnding: - description: 'Date of the end of the billing cycle. - - * Format: ddMMyy - - * maxLength: 6' - type: string - enhancedSchemeData.totalTaxAmount: - description: 'Total tax amount, in minor units. For example, 2000 means - USD 20.00 - - * maxLength: 12' - type: string - AdditionalDataWallets: - properties: - androidpay.token: - description: The Android Pay token retrieved from the SDK. - type: string - masterpass.transactionId: - description: The Mastercard Masterpass Transaction ID retrieved from the - SDK. - type: string - payment.token: - description: The Apple Pay token retrieved from the SDK. - type: string - paywithgoogle.token: - description: The Google Pay token retrieved from the SDK. - type: string - samsungpay.token: - description: The Samsung Pay token retrieved from the SDK. - type: string - visacheckout.callId: - description: The Visa Checkout Call ID retrieved from the SDK. - type: string Address: properties: city: @@ -2252,32 +515,6 @@ components: required: - value - currency - ApplicationInfo: - properties: - adyenLibrary: - description: Adyen-developed software, such as libraries and plugins, used - to interact with the Adyen API. For example, Magento plugin, Java API - library, etc. - $ref: '#/components/schemas/CommonField' - adyenPaymentSource: - description: Adyen-developed software to get payment details. For example, - Checkout SDK, Secured Fields SDK, etc. - $ref: '#/components/schemas/CommonField' - externalPlatform: - description: Third-party developed platform used to initiate payment requests. - For example, Magento, Zuora, etc. - $ref: '#/components/schemas/ExternalPlatform' - merchantApplication: - description: Merchant developed software, such as cashier application, used - to interact with the Adyen API. - $ref: '#/components/schemas/CommonField' - merchantDevice: - description: Merchant device information. - $ref: '#/components/schemas/MerchantDevice' - shopperInteractionDevice: - description: Shopper interaction device, such as terminal, mobile device - or web browser, to initiate payment requests. - $ref: '#/components/schemas/ShopperInteractionDevice' BankAccount: properties: bankAccountNumber: @@ -2326,67 +563,6 @@ components: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string - BrowserInfo: - properties: - acceptHeader: - description: The accept header value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - colorDepth: - x-addedInVersion: '40' - description: 'The color depth of the shopper''s browser in bits per pixel. - This should be obtained by using the browser''s `screen.colorDepth` property. - Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.' - format: int32 - type: integer - javaEnabled: - x-addedInVersion: '40' - description: Boolean value indicating if the shopper's browser is able to - execute Java. - type: boolean - javaScriptEnabled: - x-addedInVersion: '40' - default: true - description: Boolean value indicating if the shopper's browser is able to - execute JavaScript. A default 'true' value is assumed if the field is - not present. - type: boolean - language: - x-addedInVersion: '40' - description: The `navigator.language` value of the shopper's browser (as - defined in IETF BCP 47). - type: string - screenHeight: - x-addedInVersion: '40' - description: The total height of the shopper's device screen in pixels. - format: int32 - type: integer - screenWidth: - x-addedInVersion: '40' - description: The total width of the shopper's device screen in pixels. - format: int32 - type: integer - timeZoneOffset: - x-addedInVersion: '40' - description: Time difference between UTC time and the shopper's browser - local time, in minutes. - format: int32 - type: integer - userAgent: - description: The user agent value of the shopper's browser. - maxLength: 50 - minLength: 10 - type: string - required: - - userAgent - - acceptHeader - - javaEnabled - - colorDepth - - screenHeight - - screenWidth - - timeZoneOffset - - language Card: properties: cvc: @@ -2455,109 +631,6 @@ components: - expiryMonth - expiryYear - holderName - CommonField: - properties: - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - DeviceRenderOptions: - properties: - sdkInterface: - default: both - description: 'Supported SDK interface types. - - Allowed values: - - * native - - * html - - * both' - enum: - - native - - html - - both - type: string - sdkUiType: - description: 'UI types supported for displaying specific challenges. - - Allowed values: - - * text - - * singleSelect - - * outOfBand - - * otherHtml - - * multiSelect' - items: - enum: - - multiSelect - - otherHtml - - outOfBand - - singleSelect - - text - type: string - type: array - ExternalPlatform: - properties: - integrator: - description: External platform integrator. - type: string - name: - description: Name of the field. For example, Name of External Platform. - type: string - version: - description: Version of the field. For example, Version of External Platform. - type: string - ForexQuote: - properties: - account: - description: The account name. - type: string - accountType: - description: The account type. - type: string - baseAmount: - description: The base amount. - $ref: '#/components/schemas/Amount' - basePoints: - description: The base points. - format: int32 - type: integer - buy: - description: The buy rate. - $ref: '#/components/schemas/Amount' - interbank: - description: The interbank amount. - $ref: '#/components/schemas/Amount' - reference: - description: The reference assigned to the forex quote request. - type: string - sell: - description: The sell rate. - $ref: '#/components/schemas/Amount' - signature: - description: The signature to validate the integrity. - type: string - source: - description: The source of the forex quote. - type: string - type: - description: The type of forex. - type: string - validTill: - description: The date until which the forex quote is valid. - format: date-time - type: string - required: - - validTill - - basePoints FraudCheckResult: properties: accountScore: @@ -2615,213 +688,6 @@ components: telephoneNumber: description: Phone number of the person type: string - Installments: - properties: - plan: - x-addedInVersion: '64' - description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). - By default, this is set to **regular**. Possible values: - - * **regular** - - * **revolving** - - ' - enum: - - regular - - revolving - type: string - value: - description: 'Defines the number of installments. Its value needs to be - greater than zero. - - - Usually, the maximum allowed number of installments is capped. For example, - it may not be possible to split a payment in more than 24 installments. - The acquirer sets this upper limit, so its value may vary.' - format: int32 - type: integer - required: - - value - Mandate: - properties: - amount: - description: The billing amount (in minor units) of the recurring transactions. - type: string - amountRule: - description: "The limitation rule of the billing amount.\n\nPossible values:\n\ - \ * **max**: The transaction amount can not exceed the `amount`.\n\n *\ - \ **exact**: The transaction amount should be the same as the `amount`.\n\ - \n" - enum: - - max - - exact - type: string - billingAttemptsRule: - description: "The rule to specify the period, within which the recurring\ - \ debit can happen, relative to the mandate recurring date.\n\nPossible\ - \ values:\n\n * **on**: On a specific date.\n\n * **before**: Before\ - \ and on a specific date.\n\n * **after**: On and after a specific date.\n\ - \n" - enum: - - 'on' - - before - - after - type: string - billingDay: - description: 'The number of the day, on which the recurring debit can happen. - Should be within the same calendar month as the mandate recurring date. - - - Possible values: 1-31 based on the `frequency`.' - type: string - endsAt: - description: End date of the billing plan, in YYYY-MM-DD format. - type: string - frequency: - description: 'The frequency with which a shopper should be charged. - - - Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, - **halfYearly**, **yearly**.' - enum: - - adhoc - - daily - - weekly - - biWeekly - - monthly - - quarterly - - halfYearly - - yearly - type: string - remarks: - description: The message shown by UPI to the shopper on the approval screen. - type: string - startsAt: - description: Start date of the billing plan, in YYYY-MM-DD format. By default, - the transaction date. - type: string - required: - - frequency - - amount - - endsAt - MerchantDevice: - properties: - os: - description: Operating system running on the merchant device. - type: string - osVersion: - description: Version of the operating system on the merchant device. - type: string - reference: - description: Merchant device reference. - type: string - MerchantRiskIndicator: - properties: - addressMatch: - description: Whether the chosen delivery address is identical to the billing - address. - type: boolean - deliveryAddressIndicator: - description: 'Indicator regarding the delivery address. - - Allowed values: - - * `shipToBillingAddress` - - * `shipToVerifiedAddress` - - * `shipToNewAddress` - - * `shipToStore` - - * `digitalGoods` - - * `goodsNotShipped` - - * `other`' - enum: - - shipToBillingAddress - - shipToVerifiedAddress - - shipToNewAddress - - shipToStore - - digitalGoods - - goodsNotShipped - - other - type: string - deliveryEmail: - deprecated: true - x-deprecatedInVersion: '68' - x-deprecatedMessage: Use `deliveryEmailAddress` instead. - description: The delivery email address (for digital goods). - type: string - deliveryEmailAddress: - x-addedInVersion: '68' - description: 'For Electronic delivery, the email address to which the merchandise - was delivered. Maximum length: 254 characters.' - maxLength: 254 - type: string - deliveryTimeframe: - description: 'The estimated delivery time for the shopper to receive the - goods. - - Allowed values: - - * `electronicDelivery` - - * `sameDayShipping` - - * `overnightShipping` - - * `twoOrMoreDaysShipping`' - enum: - - electronicDelivery - - sameDayShipping - - overnightShipping - - twoOrMoreDaysShipping - type: string - giftCardAmount: - description: For prepaid or gift card purchase, the purchase amount total - of prepaid or gift card(s). - $ref: '#/components/schemas/Amount' - giftCardCount: - description: For prepaid or gift card purchase, total count of individual - prepaid or gift cards/codes purchased. - format: int32 - type: integer - giftCardCurr: - x-addedInVersion: '68' - description: For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) - three-digit currency code of the gift card, other than those listed in - Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification. - type: string - preOrderDate: - description: For pre-order purchases, the expected date this product will - be available to the shopper. - format: date-time - type: string - preOrderPurchase: - description: Indicator for whether this transaction is for pre-ordering - a product. - type: boolean - preOrderPurchaseInd: - x-addedInVersion: '68' - description: Indicates whether Cardholder is placing an order for merchandise - with a future availability or release date. - type: string - reorderItems: - description: Indicator for whether the shopper has already purchased the - same items in the past. - type: boolean - reorderItemsInd: - x-addedInVersion: '68' - description: Indicates whether the cardholder is reordering previously purchased - merchandise. - type: string - shipIndicator: - x-addedInVersion: '68' - description: Indicates shipping method chosen for the transaction. - type: string ModifyRequest: properties: additionalData: @@ -3102,17 +968,6 @@ components: - Refused - Success type: string - Phone: - properties: - cc: - description: "Country code. Length: 1\u20133 characters." - maxLength: 3 - minLength: 1 - type: string - subscriber: - description: 'Subscriber number. Maximum length: 15 characters.' - maxLength: 15 - type: string Recurring: properties: contract: @@ -3818,20 +1673,6 @@ components: Example: OOFF' type: string - SDKEphemPubKey: - properties: - crv: - description: The `crv` value as received from the 3D Secure 2 SDK. - type: string - kty: - description: The `kty` value as received from the 3D Secure 2 SDK. - type: string - x: - description: The `x` value as received from the 3D Secure 2 SDK. - type: string - y: - description: The `y` value as received from the 3D Secure 2 SDK. - type: string ServiceError: properties: additionalData: @@ -3858,80 +1699,6 @@ components: description: The HTTP response status. format: int32 type: integer - ShopperInteractionDevice: - properties: - locale: - description: Locale on the shopper interaction device. - type: string - os: - description: Operating system running on the shopper interaction device. - type: string - osVersion: - description: Version of the operating system on the shopper interaction - device. - type: string - Split: - properties: - account: - description: 'Unique identifier of the account where the split amount should - be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**. - - - ' - type: string - amount: - description: The amount of this split. - $ref: '#/components/schemas/SplitAmount' - description: - description: A description of this split. - type: string - reference: - description: 'Your reference for the split, which you can use to link the - split to other operations such as captures and refunds. - - - This is required if `type` is **MarketPlace** or **BalanceAccount**. For - the other types, we also recommend sending a reference so you can reconcile - the split and the associated payment in the transaction overview and in - the reports. If the reference is not provided, the split is reported as - part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) - in Adyen for Platforms.' - type: string - type: - description: 'The type of split. - - Possible values: **Default**, **PaymentFee**, **VAT**, **Commission**, - **MarketPlace**, **BalanceAccount**, **Remainder**.' - enum: - - BalanceAccount - - Commission - - Default - - MarketPlace - - PaymentFee - - Remainder - - VAT - - Verification - type: string - required: - - amount - - type - SplitAmount: - properties: - currency: - description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - - - If this value is not provided, the currency in which the payment is made - will be used.' - maxLength: 3 - minLength: 3 - type: string - value: - description: The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). - format: int64 - type: integer - required: - - value StoreDetailAndSubmitRequest: properties: additionalData: @@ -4343,449 +2110,6 @@ components: required: - pspReference - resultCode - ThreeDS2RequestData: - properties: - acctInfo: - x-addedInVersion: '68' - description: "Additional information about the Cardholder\u2019s account\ - \ provided by the 3DS Requestor." - $ref: '#/components/schemas/AcctInfo' - acctType: - x-addedInVersion: '68' - description: "Indicates the type of account. For example, for a multi-account\ - \ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\ - \ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit" - enum: - - '01' - - '02' - - '03' - maxLength: 2 - minLength: 2 - type: string - acquirerBIN: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The acquiring BIN enrolled for 3D Secure 2. This string should match the - value that you will use in the authorisation. Use 123456 on the Test platform. - type: string - acquirerMerchantID: - x-addedInVersion: '49' - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. - This string should match the value that you will use in the authorisation. - Use 123456 on the Test platform. - type: string - addrMatch: - x-addedInVersion: '68' - description: "Indicates whether the Cardholder Shipping Address and Cardholder\ - \ Billing Address are the same. Allowed values:\n* **Y** \u2014 Shipping\ - \ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\ - \ not match Billing Address." - enum: - - Y - - N - maxLength: 1 - minLength: 1 - type: string - authenticationOnly: - deprecated: true - x-deprecatedInVersion: '50' - x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. - default: false - description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), - and not the payment authorisation. - type: boolean - challengeIndicator: - deprecated: true - x-deprecatedInVersion: '68' - x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead. - description: 'Possibility to specify a preference for receiving a challenge - from the issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string - deviceChannel: - description: 'The environment of the shopper. - - Allowed values: - - * `app` - - * `browser`' - type: string - deviceRenderOptions: - description: 'Display options for the 3D Secure 2 SDK. - - Optional and only for `deviceChannel` **app**.' - $ref: '#/components/schemas/DeviceRenderOptions' - homePhone: - x-addedInVersion: '68' - description: The home phone number provided by the Cardholder. - $ref: '#/components/schemas/Phone' - mcc: - x-addedInVersion: '49' - description: Required for merchants that have been enrolled for 3D Secure - 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` - is registered at the scheme. - type: string - merchantName: - x-addedInVersion: '49' - description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). - The merchant name that the issuer presents to the shopper if they get - a challenge. We recommend to use the same value that you will use in the - authorization. Maximum length is 40 characters. - - > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). - Use this field if you are enrolled for 3D Secure 2 with us and want to - override the merchant name already configured on your account.' - type: string - messageVersion: - default: 2.1.0 - description: The `messageVersion` value indicating the 3D Secure 2 protocol - version. - type: string - mobilePhone: - x-addedInVersion: '68' - description: The mobile phone number provided by the Cardholder. - $ref: '#/components/schemas/Phone' - notificationURL: - description: URL to where the issuer should send the `CRes`. Required if - you are not using components for `channel` **Web** or if you are using - classic integration `deviceChannel` **browser**. - type: string - payTokenInd: - x-addedInVersion: '68' - description: Value **true** indicates that the transaction was de-tokenised - prior to being received by the ACS. - type: boolean - paymentAuthenticationUseCase: - x-addedInVersion: '68' - description: Indicates the type of payment for which an authentication is - requested (message extension) - type: string - purchaseInstalData: - x-addedInVersion: '68' - description: "Indicates the maximum number of authorisations permitted for\ - \ instalment payments. Length: 1\u20133 characters." - maxLength: 3 - minLength: 1 - type: string - recurringExpiry: - x-addedInVersion: '68' - description: 'Date after which no further authorisations shall be performed. - Format: YYYYMMDD' - type: string - recurringFrequency: - x-addedInVersion: '68' - description: 'Indicates the minimum number of days between authorisations. - Maximum length: 4 characters.' - maxLength: 4 - type: string - sdkAppID: - description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEncData: - description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. - - Required for `deviceChannel` set to **app**.' - type: string - sdkEphemPubKey: - description: 'The `sdkEphemPubKey` value as received from the 3D Secure - 2 SDK. - - Required for `deviceChannel` set to **app**.' - $ref: '#/components/schemas/SDKEphemPubKey' - sdkMaxTimeout: - default: 60 - description: 'The maximum amount of time in minutes for the 3D Secure 2 - authentication process. - - Optional and only for `deviceChannel` set to **app**. Defaults to **60** - minutes.' - format: int32 - type: integer - sdkReferenceNumber: - description: 'The `sdkReferenceNumber` value as received from the 3D Secure - 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkTransID: - description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. - - Only for `deviceChannel` set to **app**.' - type: string - sdkVersion: - x-addedInVersion: '40' - description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ - \ set to **app**." - type: string - threeDSCompInd: - description: Completion indicator for the device fingerprinting. - type: string - threeDSRequestorAuthenticationInd: - x-addedInVersion: '68' - description: Indicates the type of Authentication request. - type: string - threeDSRequestorAuthenticationInfo: - x-addedInVersion: '68' - description: Information about how the 3DS Requestor authenticated the cardholder - before or during the transaction - $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo' - threeDSRequestorChallengeInd: - x-addedInVersion: '68' - x-enum: - - description: No preference - value: '01' - - description: No challenge requested - value: '02' - - description: Challenge requested (3DS Requestor preference) - value: '03' - - description: Challenge requested (Mandate) - value: '04' - - description: No challenge (transactional risk analysis is already performed) - value: '05' - description: "Indicates whether a challenge is requested for this transaction.\ - \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\ - \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\ - \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\ - \ \u2014 No challenge (transactional risk analysis is already performed)" - enum: - - '01' - - '02' - - '03' - - '04' - - '05' - type: string - threeDSRequestorID: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor identifier assigned by the Directory - Server when you enrol for 3D Secure 2. - type: string - threeDSRequestorName: - description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) - for Visa. Unique 3D Secure requestor name assigned by the Directory Server - when you enrol for 3D Secure 2. - type: string - threeDSRequestorPriorAuthenticationInfo: - x-addedInVersion: '68' - description: Information about how the 3DS Requestor authenticated the cardholder - as part of a previous 3DS transaction. - $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo' - threeDSRequestorURL: - description: URL of the (customer service) website that will be shown to - the shopper in case of technical errors during the 3D Secure 2 process. - type: string - transType: - x-addedInVersion: '68' - description: "Identifies the type of transaction being authenticated. Length:\ - \ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\ - * **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\ - \ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\ - \ Load" - enum: - - '01' - - '03' - - '10' - - '11' - - '28' - maxLength: 2 - minLength: 2 - type: string - transactionType: - x-addedInVersion: '50' - description: Identify the type of the transaction being authenticated. - enum: - - goodsOrServicePurchase - - checkAcceptance - - accountFunding - - quasiCashTransaction - - prepaidActivationAndLoad - type: string - whiteListStatus: - x-addedInVersion: '49' - description: The `whiteListStatus` value returned from a previous 3D Secure - 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. - type: string - workPhone: - x-addedInVersion: '68' - description: The work phone number provided by the Cardholder. - $ref: '#/components/schemas/Phone' - required: - - deviceChannel - ThreeDSRequestorAuthenticationInfo: - properties: - threeDSReqAuthData: - description: 'Data that documents and supports a specific authentication - process. Maximum length: 2048 bytes.' - type: string - threeDSReqAuthMethod: - description: "Mechanism used by the Cardholder to authenticate to the 3DS\ - \ Requestor. Allowed values:\n* **01** \u2014 No 3DS Requestor authentication\ - \ occurred (for example, cardholder \u201Clogged in\u201D as guest).\n\ - * **02** \u2014 Login to the cardholder account at the 3DS Requestor system\ - \ using 3DS Requestor\u2019s own credentials.\n* **03** \u2014 Login to\ - \ the cardholder account at the 3DS Requestor system using federated ID.\n\ - * **04** \u2014 Login to the cardholder account at the 3DS Requestor system\ - \ using issuer credentials.\n* **05** \u2014 Login to the cardholder account\ - \ at the 3DS Requestor system using third-party authentication.\n* **06**\ - \ \u2014 Login to the cardholder account at the 3DS Requestor system using\ - \ FIDO Authenticator." - enum: - - '01' - - '02' - - '03' - - '04' - - '05' - - '06' - maxLength: 2 - minLength: 2 - type: string - threeDSReqAuthTimestamp: - description: 'Date and time in UTC of the cardholder authentication. Format: - YYYYMMDDHHMM' - maxLength: 12 - minLength: 12 - type: string - ThreeDSRequestorPriorAuthenticationInfo: - properties: - threeDSReqPriorAuthData: - description: 'Data that documents and supports a specific authentication - process. Maximum length: 2048 bytes.' - type: string - threeDSReqPriorAuthMethod: - description: "Mechanism used by the Cardholder to previously authenticate\ - \ to the 3DS Requestor. Allowed values:\n* **01** \u2014 Frictionless\ - \ authentication occurred by ACS.\n* **02** \u2014 Cardholder challenge\ - \ occurred by ACS.\n* **03** \u2014 AVS verified.\n* **04** \u2014 Other\ - \ issuer methods." - enum: - - '01' - - '02' - - '03' - - '04' - maxLength: 2 - minLength: 2 - type: string - threeDSReqPriorAuthTimestamp: - description: 'Date and time in UTC of the prior cardholder authentication. - Format: YYYYMMDDHHMM' - maxLength: 12 - minLength: 12 - type: string - threeDSReqPriorRef: - description: 'This data element provides additional information to the ACS - to determine the best approach for handing a request. This data element - contains an ACS Transaction ID for a prior authenticated transaction. - For example, the first recurring transaction that was authenticated with - the cardholder. Length: 30 characters.' - maxLength: 36 - minLength: 36 - type: string - ThreeDSecureData: - properties: - authenticationResponse: - description: 'In 3D Secure 1, the authentication response if the shopper - was redirected. - - - In 3D Secure 2, this is the `transStatus` from the challenge result. If - the transaction was frictionless, omit this parameter.' - enum: - - Y - - N - - U - - A - type: string - cavv: - description: The cardholder authentication value (base64 encoded, 20 bytes - in a decoded form). - format: byte - type: string - cavvAlgorithm: - description: The CAVV algorithm used. Include this only for 3D Secure 1. - type: string - challengeCancel: - x-addedInVersion: '67' - description: Indicator informing the Access Control Server (ACS) and the - Directory Server (DS) that the authentication has been cancelled. For - possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata). - enum: - - '01' - - '02' - - '03' - - '04' - - '05' - - '06' - - '07' - type: string - directoryResponse: - description: 'In 3D Secure 1, this is the enrollment response from the 3D - directory server. - - - In 3D Secure 2, this is the `transStatus` from the `ARes`.' - enum: - - A - - C - - D - - I - - N - - R - - U - - Y - type: string - dsTransID: - x-addedInVersion: '40' - description: Supported for 3D Secure 2. The unique transaction identifier - assigned by the Directory Server (DS) to identify a single transaction. - type: string - eci: - description: The electronic commerce indicator. - type: string - riskScore: - x-addedInVersion: '67' - description: Risk score calculated by Directory Server (DS). Required for - Cartes Bancaires integrations. - type: string - threeDSVersion: - x-addedInVersion: '40' - description: The version of the 3D Secure protocol. - type: string - tokenAuthenticationVerificationValue: - x-addedInVersion: '68' - description: Network token authentication verification value (TAVV). The - network token cryptogram. - format: byte - type: string - transStatusReason: - x-addedInVersion: '67' - description: Provides information on why the `transStatus` field has the - specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values). - type: string - xid: - description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, - 20 bytes in a decoded form). - format: byte - type: string securitySchemes: ApiKeyAuth: in: header