diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index 1de320fd..cc5cc4bc 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -3029,6 +3029,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3112,11 +3125,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3140,11 +3153,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3152,23 +3165,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3196,7 +3209,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3204,15 +3217,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3228,7 +3241,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3240,11 +3253,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3252,7 +3265,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3272,19 +3285,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3296,11 +3309,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3394,71 +3407,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3475,7 +3488,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3487,7 +3500,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3503,7 +3516,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -3879,11 +3892,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4021,7 +4034,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6159,10 +6176,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -9569,6 +9582,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index 06bf3ce2..9341b635 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -3187,6 +3187,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3270,11 +3283,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3298,11 +3311,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3310,23 +3323,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3354,7 +3367,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3362,15 +3375,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3386,7 +3399,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3398,11 +3411,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3410,7 +3423,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3430,19 +3443,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3454,11 +3467,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3552,71 +3565,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3633,7 +3646,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3645,7 +3658,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3661,7 +3674,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4037,11 +4050,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4179,7 +4192,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6438,10 +6455,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10001,6 +10014,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index d298501b..2dc18e1b 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -3197,6 +3197,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3280,11 +3293,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3308,11 +3321,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3320,23 +3333,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3364,7 +3377,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3372,15 +3385,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3396,7 +3409,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3408,11 +3421,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3420,7 +3433,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3440,19 +3453,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3464,11 +3477,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3562,71 +3575,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3643,7 +3656,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3655,7 +3668,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3671,7 +3684,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4047,11 +4060,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4189,7 +4202,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6448,10 +6465,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10021,6 +10034,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index 16917f1a..f73e078d 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -3197,6 +3197,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3280,11 +3293,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3308,11 +3321,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3320,23 +3333,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3364,7 +3377,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3372,15 +3385,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3396,7 +3409,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3408,11 +3421,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3420,7 +3433,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3440,19 +3453,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3464,11 +3477,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3562,71 +3575,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3643,7 +3656,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3655,7 +3668,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3671,7 +3684,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4047,11 +4060,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4189,7 +4202,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6448,10 +6465,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10029,6 +10042,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 21de9c7a..5d542f0c 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -3197,6 +3197,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3289,11 +3302,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3317,11 +3330,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3329,23 +3342,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3373,7 +3386,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3381,15 +3394,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3405,7 +3418,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3417,11 +3430,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3429,7 +3442,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3449,19 +3462,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3473,11 +3486,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3571,71 +3584,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3652,7 +3665,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3664,7 +3677,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3680,7 +3693,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4056,11 +4069,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4207,7 +4220,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6891,10 +6908,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10623,6 +10636,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index 8bbe019c..be325935 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -3213,6 +3213,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3305,11 +3318,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3333,11 +3346,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3345,23 +3358,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3389,7 +3402,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3397,15 +3410,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3421,7 +3434,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3433,11 +3446,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3445,7 +3458,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3465,19 +3478,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3489,11 +3502,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3587,71 +3600,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3668,7 +3681,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3680,7 +3693,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3696,7 +3709,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4072,11 +4085,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4223,7 +4236,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6919,10 +6936,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10673,6 +10686,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index 3aeb4c90..664ef6b7 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -3213,6 +3213,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3305,11 +3318,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3333,11 +3346,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3345,23 +3358,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3389,7 +3402,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3397,15 +3410,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3421,7 +3434,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3433,11 +3446,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3445,7 +3458,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3465,19 +3478,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3489,11 +3502,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3587,71 +3600,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3668,7 +3681,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3680,7 +3693,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3696,7 +3709,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4072,11 +4085,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4223,7 +4236,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6931,10 +6948,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10710,6 +10723,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index ad875fa6..5261fb64 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -3213,6 +3213,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3305,11 +3318,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3333,11 +3346,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3345,23 +3358,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3389,7 +3402,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3397,15 +3410,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3421,7 +3434,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3433,11 +3446,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3445,7 +3458,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3465,19 +3478,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3489,11 +3502,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3587,71 +3600,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3668,7 +3681,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3680,7 +3693,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3696,7 +3709,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4072,11 +4085,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4223,7 +4236,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6931,10 +6948,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10720,6 +10733,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index 157569eb..0192a167 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -3213,6 +3213,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3305,11 +3318,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3333,11 +3346,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3345,23 +3358,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3389,7 +3402,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3397,15 +3410,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3421,7 +3434,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3433,11 +3446,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3445,7 +3458,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3465,19 +3478,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3489,11 +3502,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3587,71 +3600,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3668,7 +3681,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3680,7 +3693,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3696,7 +3709,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4072,11 +4085,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4223,7 +4236,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6931,10 +6948,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10742,6 +10755,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index d5be7a04..eb40b42c 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -3213,6 +3213,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3305,11 +3318,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3333,11 +3346,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3345,23 +3358,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3389,7 +3402,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3397,15 +3410,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3421,7 +3434,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3433,11 +3446,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3445,7 +3458,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3465,19 +3478,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3489,11 +3502,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3587,71 +3600,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3668,7 +3681,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3680,7 +3693,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3696,7 +3709,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4072,11 +4085,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4223,7 +4236,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6967,10 +6984,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10811,6 +10824,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index e3f530c4..3af4f7ef 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -3213,6 +3213,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3305,11 +3318,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3333,11 +3346,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3345,23 +3358,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3389,7 +3402,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3397,15 +3410,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3421,7 +3434,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3433,11 +3446,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3445,7 +3458,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3465,19 +3478,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3489,11 +3502,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3587,71 +3600,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3668,7 +3681,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3680,7 +3693,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3696,7 +3709,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4072,11 +4085,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4223,7 +4236,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6975,10 +6992,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10790,6 +10803,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index 59ba42f2..d33a63bb 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -3213,6 +3213,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3305,11 +3318,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3333,11 +3346,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3345,23 +3358,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3389,7 +3402,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3397,15 +3410,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3421,7 +3434,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3433,11 +3446,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3445,7 +3458,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3465,19 +3478,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3489,11 +3502,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3587,71 +3600,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3668,7 +3681,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3680,7 +3693,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3696,7 +3709,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4072,11 +4085,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4223,7 +4236,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6975,10 +6992,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10800,6 +10813,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index fa8417b8..5d767889 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -3208,6 +3208,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3300,11 +3313,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3328,11 +3341,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3340,23 +3353,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3384,7 +3397,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3392,15 +3405,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3416,7 +3429,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3428,11 +3441,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3440,7 +3453,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3460,19 +3473,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3484,11 +3497,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3582,71 +3595,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3663,7 +3676,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3675,7 +3688,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3691,7 +3704,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4067,11 +4080,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4218,7 +4231,11 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", + "type" : "string" + }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", "type" : "string" }, "type" : { @@ -6938,10 +6955,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -10699,6 +10712,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json index 9b6c26d6..b29c1beb 100644 --- a/json/CheckoutService-v68.json +++ b/json/CheckoutService-v68.json @@ -3188,7 +3188,7 @@ "description" : "The `sessionResult` value from the Drop-in or Component.", "name" : "sessionResult", "in" : "query", - "required" : false, + "required" : true, "schema" : { "type" : "string" } @@ -3487,6 +3487,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3584,11 +3597,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3612,11 +3625,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3624,23 +3637,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3668,7 +3681,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3676,15 +3689,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3700,7 +3713,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3712,11 +3725,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3724,7 +3737,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3744,19 +3757,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3768,11 +3781,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3866,71 +3879,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3947,7 +3960,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3959,7 +3972,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3975,7 +3988,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4351,11 +4364,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4507,7 +4520,7 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", "type" : "string" }, "checkoutAttemptId" : { @@ -4515,6 +4528,10 @@ "description" : "The checkout attempt identifier.", "type" : "string" }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", + "type" : "string" + }, "type" : { "default" : "amazonpay", "description" : "**amazonpay**", @@ -8019,10 +8036,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -12012,6 +12025,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json index b3098d08..5e4db736 100644 --- a/json/CheckoutService-v69.json +++ b/json/CheckoutService-v69.json @@ -3188,7 +3188,7 @@ "description" : "The `sessionResult` value from the Drop-in or Component.", "name" : "sessionResult", "in" : "query", - "required" : false, + "required" : true, "schema" : { "type" : "string" } @@ -3487,6 +3487,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3590,11 +3603,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3618,11 +3631,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3630,23 +3643,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3674,7 +3687,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3682,15 +3695,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3706,7 +3719,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3718,11 +3731,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3730,7 +3743,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3750,19 +3763,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3774,11 +3787,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -3872,71 +3885,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -3953,7 +3966,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -3965,7 +3978,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -3981,7 +3994,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4357,11 +4370,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4513,7 +4526,7 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", "type" : "string" }, "checkoutAttemptId" : { @@ -4521,6 +4534,10 @@ "description" : "The checkout attempt identifier.", "type" : "string" }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", + "type" : "string" + }, "type" : { "default" : "amazonpay", "description" : "**amazonpay**", @@ -8117,10 +8134,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -12217,6 +12230,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/json/CheckoutService-v70.json b/json/CheckoutService-v70.json index 8f0b28d5..b518da30 100644 --- a/json/CheckoutService-v70.json +++ b/json/CheckoutService-v70.json @@ -3191,7 +3191,7 @@ "description" : "The `sessionResult` value from the Drop-in or Component.", "name" : "sessionResult", "in" : "query", - "required" : false, + "required" : true, "schema" : { "type" : "string" } @@ -3619,6 +3619,19 @@ "description" : "The bank account number (without separators).", "type" : "string" }, + "bankAccountType" : { + "description" : "The bank account type (checking, savings...).", + "enum" : [ + "balance", + "checking", + "deposit", + "general", + "other", + "payment", + "savings" + ], + "type" : "string" + }, "bankLocationId" : { "description" : "The bank routing number of the account. The field value is `nil` in most cases.", "type" : "string" @@ -3722,11 +3735,11 @@ "type" : "string" }, "airline.airline_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.airline_designator_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\n* Encoding: ASCII\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.boarding_fee" : { @@ -3750,11 +3763,11 @@ "type" : "string" }, "airline.leg.carrier_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.\nThis field is required if the airline data includes leg details.\n* Example: KLM = KL\n* minLength: 2 characters\n* maxLength: 2 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.class_of_travel" : { - "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n* Must not be all zeros", + "description" : "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.date_of_travel" : { @@ -3762,23 +3775,23 @@ "type" : "string" }, "airline.leg.depart_airport" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.\nThis field is required if the airline data includes leg details.\n\n* Encoding: ASCII\n* Example: Amsterdam = AMS\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.depart_tax" : { - "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n* Must not be all zeros", + "description" : "The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Encoding: Numeric\n* minLength: 1\n* maxLength: 12\n*Must not be all zeros.", "type" : "string" }, "airline.leg.destination_code" : { - "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.\nThis field is required if the airline data includes leg details.\n* Example: Amsterdam = AMS\n* Encoding: ASCII\n* minLength: 3 characters\n* maxLength: 3 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.fare_base_code" : { - "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.\n* minLength: 1 character\n* maxLength: 6 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.flight_number" : { - "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The flight identifier.\n* minLength: 1 character\n* maxLength: 5 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.leg.stop_over_code" : { @@ -3806,7 +3819,7 @@ "type" : "string" }, "airline.passenger_name" : { - "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros.", "type" : "string" }, "airline.ticket_issue_address" : { @@ -3814,15 +3827,15 @@ "type" : "string" }, "airline.ticket_number" : { - "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The ticket's unique identifier.\n* minLength: 1 character\n* maxLength: 15 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_code" : { - "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The unique identifier from IATA or ARC for the travel agency that issues the ticket.\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 8 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "airline.travel_agency_name" : { - "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n* Must not be all zeros", + "description" : "The name of the travel agency.\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 25 characters\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" } }, @@ -3838,7 +3851,7 @@ "type" : "string" }, "carRental.customerServiceTollFreeNumber" : { - "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "carRental.daysRented" : { @@ -3850,11 +3863,11 @@ "type" : "string" }, "carRental.insuranceCharges" : { - "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n* Must not be all zeros", + "description" : "Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* Format: Numeric\n* maxLength: 12\n* Must not be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCity" : { - "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car is rented.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.locationCountry" : { @@ -3862,7 +3875,7 @@ "type" : "string" }, "carRental.locationStateProvince" : { - "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car is rented.\n* Format: Alphanumeric\n* maxLength: 2\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.noShowIndicator" : { @@ -3882,19 +3895,19 @@ "type" : "string" }, "carRental.rentalAgreementNumber" : { - "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The rental agreement number for the car rental.\n* Format: Alphanumeric\n* maxLength: 9\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.rentalClassId" : { - "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The classification of the rental car.\n* Format: Alphanumeric\n* maxLength: 4\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.renterName" : { - "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26\n* If you send more than 26 characters, the name is truncated\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCity" : { - "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnCountry" : { @@ -3906,11 +3919,11 @@ "type" : "string" }, "carRental.returnLocationId" : { - "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.returnStateProvince" : { - "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n* Must not be all zeros", + "description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3\n* Must not start with a space or be all spaces\n*Must not be all zeros.", "type" : "string" }, "carRental.taxExemptIndicator" : { @@ -4004,71 +4017,71 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { - "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n\nEncoding: ASCII\n\nFixed length: 3 characters", + "description" : "The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.\n* Encoding: ASCII\n* Fixed length: 3 characters", "type" : "string" }, "enhancedSchemeData.destinationPostalCode" : { - "description" : "The postal code of the destination address.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space", + "description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.destinationStateProvinceCode" : { - "description" : "Destination state or province code.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space", + "description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space", "type" : "string" }, "enhancedSchemeData.dutyAmount" : { - "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.freightAmount" : { - "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n*Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : { - "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n\nEncoding: ASCII\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The [UNSPC commodity code](https://www.unspsc.org/) of the item.\n* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].description" : { - "description" : "A description of the item.\n\nEncoding: ASCII\n\nMax length: 26 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : { - "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].productCode" : { - "description" : "The product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The product code.\n* Encoding: ASCII.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].quantity" : { - "description" : "The number of items. Must be an integer greater than zero.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\n", + "description" : "The number of items. Must be an integer greater than zero.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n\n", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : { - "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : { - "description" : "The unit of measurement for an item.\n\nEncoding: ASCII\n\nMax length: 3 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The unit of measurement for an item.\n* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : { - "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters", + "description" : "The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.orderDate" : { - "description" : "The order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII\n\nMax length: 6 characters", + "description" : "The order date.\n* Format: `ddMMyy`\n* Encoding: ASCII\n* Max length: 6 characters", "type" : "string" }, "enhancedSchemeData.shipFromPostalCode" : { - "description" : "The postal code of the address the item is shipped from.\n\nEncoding: ASCII\n\nMax length: 10 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The postal code of the address the item is shipped from.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.totalTaxAmount" : { - "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nFor example, 2000 means USD 20.00.\n\nEncoding: Numeric\n\nMax length: 12 characters\n\n", + "description" : "The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n* For example, 2000 means USD 20.00.\n*Encoding: Numeric\n*Max length: 12 characters\n* Must not be all zeros.", "type" : "string" } }, @@ -4085,7 +4098,7 @@ "type" : "string" }, "lodging.customerServiceTollFreeNumber" : { - "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The toll-free phone number for the lodging.\n* Format: numeric\n* Max length: 17 characters.\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.fireSafetyActIndicator" : { @@ -4097,7 +4110,7 @@ "type" : "string" }, "lodging.folioNumber" : { - "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n* Must not be all zeros", + "description" : "The card acceptor’s internal invoice or billing ID reference number.\n* Max length: 25 characters.\n* Must not start with a space\n*Must not be all zeros.", "type" : "string" }, "lodging.foodBeverageCharges" : { @@ -4113,7 +4126,7 @@ "type" : "string" }, "lodging.propertyPhoneNumber" : { - "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not be all zeros\n* Must not contain any special characters such as + or -", + "description" : "The lodging property location's phone number.\n* Format: numeric.\n* Min length: 10 characters\n* Max length: 17 characters\n* For US and CA numbers must be 10 characters in length\n* Must not start with a space\n* Must not contain any special characters such as + or -\n*Must not be all zeros.", "type" : "string" }, "lodging.room1.numberOfNights" : { @@ -4489,11 +4502,11 @@ "type" : "string" }, "enhancedSchemeData.employeeName" : { - "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.jobDescription" : { - "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40\n* Must not be all zeros\n* Must not be all spaces", + "description" : "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros.", "type" : "string" }, "enhancedSchemeData.regularHoursRate" : { @@ -4645,7 +4658,7 @@ "additionalProperties" : false, "properties" : { "amazonPayToken" : { - "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.", + "description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.", "type" : "string" }, "checkoutAttemptId" : { @@ -4653,6 +4666,10 @@ "description" : "The checkout attempt identifier.", "type" : "string" }, + "checkoutSessionId" : { + "description" : "The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.", + "type" : "string" + }, "type" : { "default" : "amazonpay", "description" : "**amazonpay**", @@ -8308,10 +8325,6 @@ }, "subtype" : { "description" : "The type of flow to initiate.", - "enum" : [ - "redirect", - "sdk" - ], "type" : "string" }, "type" : { @@ -12525,6 +12538,7 @@ "Remainder", "Surcharge", "Tip", + "TopUp", "VAT", "Verification" ], diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index d5d70004..c3280a50 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -2013,6 +2013,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2149,7 +2160,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2165,7 +2176,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2235,14 +2246,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2266,7 +2276,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2278,7 +2288,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2296,7 +2306,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2308,7 +2318,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2319,7 +2329,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2378,21 +2388,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2410,7 +2410,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2424,7 +2424,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2438,7 +2438,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2461,9 +2461,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2491,7 +2491,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2502,7 +2502,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2521,7 +2521,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2559,7 +2559,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2570,7 +2570,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2583,7 +2583,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2594,7 +2594,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2620,7 +2620,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2631,7 +2631,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -2831,145 +2831,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -2977,85 +2941,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3081,9 +3027,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3103,7 +3049,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3138,9 +3084,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3590,22 +3536,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3752,7 +3688,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -5750,9 +5691,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -9405,6 +9343,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index 7c1e59dc..0c585b30 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -2196,6 +2196,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2332,7 +2343,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2348,7 +2359,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2418,14 +2429,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2449,7 +2459,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2461,7 +2471,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2479,7 +2489,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2491,7 +2501,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2502,7 +2512,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2561,21 +2571,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2593,7 +2593,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2607,7 +2607,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2621,7 +2621,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2644,9 +2644,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2674,7 +2674,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2685,7 +2685,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2704,7 +2704,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2742,7 +2742,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2753,7 +2753,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2766,7 +2766,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2777,7 +2777,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2803,7 +2803,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2814,7 +2814,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3014,145 +3014,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3160,85 +3124,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3264,9 +3210,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3286,7 +3232,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3321,9 +3267,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3773,22 +3719,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3935,7 +3871,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6080,9 +6021,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -9892,6 +9830,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index 1a4c328d..9c1892f0 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -2203,6 +2203,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2339,7 +2350,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2355,7 +2366,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2425,14 +2436,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2456,7 +2466,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2468,7 +2478,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2498,7 +2508,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2509,7 +2519,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2568,21 +2578,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2600,7 +2600,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2614,7 +2614,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2628,7 +2628,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2651,9 +2651,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2681,7 +2681,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2692,7 +2692,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2711,7 +2711,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2749,7 +2749,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2760,7 +2760,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2773,7 +2773,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2784,7 +2784,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2810,7 +2810,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2821,7 +2821,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3021,145 +3021,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3167,85 +3131,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3271,9 +3217,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3293,7 +3239,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3328,9 +3274,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3780,22 +3726,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3942,7 +3878,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6087,9 +6028,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -9907,6 +9845,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 54ed268d..d74a653b 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -2203,6 +2203,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2339,7 +2350,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2355,7 +2366,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2425,14 +2436,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2456,7 +2466,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2468,7 +2478,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2498,7 +2508,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2509,7 +2519,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2568,21 +2578,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2600,7 +2600,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2614,7 +2614,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2628,7 +2628,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2651,9 +2651,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2681,7 +2681,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2692,7 +2692,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2711,7 +2711,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2749,7 +2749,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2760,7 +2760,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2773,7 +2773,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2784,7 +2784,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2810,7 +2810,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2821,7 +2821,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3021,145 +3021,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3167,85 +3131,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3271,9 +3217,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3293,7 +3239,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3328,9 +3274,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3780,22 +3726,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3942,7 +3878,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6087,9 +6028,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -9915,6 +9853,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index 79c12a9f..beec3fd4 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -2203,6 +2203,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2348,7 +2359,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2364,7 +2375,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2434,14 +2445,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2465,7 +2475,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2477,7 +2487,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2495,7 +2505,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2507,7 +2517,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2518,7 +2528,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2577,21 +2587,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2609,7 +2609,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2623,7 +2623,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2637,7 +2637,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2660,9 +2660,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2690,7 +2690,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2701,7 +2701,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2720,7 +2720,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2758,7 +2758,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2769,7 +2769,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2782,7 +2782,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2793,7 +2793,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2819,7 +2819,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2830,7 +2830,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3030,145 +3030,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3176,85 +3140,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3280,9 +3226,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3302,7 +3248,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3337,9 +3283,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3789,22 +3735,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3960,7 +3896,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6451,9 +6392,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10409,6 +10347,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index 40ee99d0..c0f08447 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -2224,6 +2224,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2369,7 +2380,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2385,7 +2396,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2455,14 +2466,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2498,7 +2508,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2516,7 +2526,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2528,7 +2538,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2539,7 +2549,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2598,21 +2608,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2630,7 +2630,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2644,7 +2644,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2658,7 +2658,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2681,9 +2681,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2711,7 +2711,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2722,7 +2722,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2741,7 +2741,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2779,7 +2779,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2790,7 +2790,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2803,7 +2803,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2814,7 +2814,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2840,7 +2840,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2851,7 +2851,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3051,145 +3051,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3197,85 +3161,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3301,9 +3247,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3323,7 +3269,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3358,9 +3304,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3810,22 +3756,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3981,7 +3917,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6484,9 +6425,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10464,6 +10402,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index a18bb09f..44b76015 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -2224,6 +2224,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2369,7 +2380,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2385,7 +2396,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2455,14 +2466,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2498,7 +2508,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2516,7 +2526,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2528,7 +2538,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2539,7 +2549,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2598,21 +2608,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2630,7 +2630,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2644,7 +2644,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2658,7 +2658,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2681,9 +2681,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2711,7 +2711,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2722,7 +2722,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2741,7 +2741,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2779,7 +2779,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2790,7 +2790,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2803,7 +2803,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2814,7 +2814,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2840,7 +2840,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2851,7 +2851,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3051,145 +3051,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3197,85 +3161,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3301,9 +3247,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3323,7 +3269,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3358,9 +3304,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3810,22 +3756,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3981,7 +3917,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6496,9 +6437,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10500,6 +10438,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 2e3f30a2..e5e1b5f6 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -2224,6 +2224,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2369,7 +2380,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2385,7 +2396,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2455,14 +2466,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2498,7 +2508,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2516,7 +2526,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2528,7 +2538,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2539,7 +2549,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2598,21 +2608,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2630,7 +2630,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2644,7 +2644,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2658,7 +2658,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2681,9 +2681,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2711,7 +2711,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2722,7 +2722,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2741,7 +2741,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2779,7 +2779,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2790,7 +2790,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2803,7 +2803,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2814,7 +2814,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2840,7 +2840,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2851,7 +2851,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3051,145 +3051,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3197,85 +3161,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3301,9 +3247,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3323,7 +3269,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3358,9 +3304,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3810,22 +3756,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3981,7 +3917,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6496,9 +6437,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10508,6 +10446,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index 33adb7d5..9d2a345f 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -2224,6 +2224,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2369,7 +2380,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2385,7 +2396,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2455,14 +2466,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2498,7 +2508,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2516,7 +2526,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2528,7 +2538,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2539,7 +2549,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2598,21 +2608,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2630,7 +2630,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2644,7 +2644,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2658,7 +2658,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2681,9 +2681,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2711,7 +2711,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2722,7 +2722,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2741,7 +2741,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2779,7 +2779,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2790,7 +2790,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2803,7 +2803,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2814,7 +2814,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2840,7 +2840,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2851,7 +2851,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3051,145 +3051,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3197,85 +3161,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3301,9 +3247,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3323,7 +3269,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3358,9 +3304,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3810,22 +3756,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3981,7 +3917,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6496,9 +6437,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10526,6 +10464,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index 9609ab3a..ca003f31 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -2224,6 +2224,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2369,7 +2380,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2385,7 +2396,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2455,14 +2466,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2498,7 +2508,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2516,7 +2526,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2528,7 +2538,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2539,7 +2549,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2598,21 +2608,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2630,7 +2630,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2644,7 +2644,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2658,7 +2658,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2681,9 +2681,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2711,7 +2711,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2722,7 +2722,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2741,7 +2741,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2779,7 +2779,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2790,7 +2790,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2803,7 +2803,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2814,7 +2814,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2840,7 +2840,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2851,7 +2851,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3051,145 +3051,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3197,85 +3161,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3301,9 +3247,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3323,7 +3269,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3358,9 +3304,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3810,22 +3756,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3981,7 +3917,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6542,9 +6483,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10604,6 +10542,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 0f26febf..88b00eba 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -2224,6 +2224,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2369,7 +2380,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2385,7 +2396,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2455,14 +2466,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2498,7 +2508,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2516,7 +2526,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2528,7 +2538,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2539,7 +2549,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2598,21 +2608,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2630,7 +2630,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2644,7 +2644,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2658,7 +2658,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2681,9 +2681,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2711,7 +2711,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2722,7 +2722,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2741,7 +2741,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2779,7 +2779,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2790,7 +2790,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2803,7 +2803,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2814,7 +2814,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2840,7 +2840,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2851,7 +2851,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3051,145 +3051,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3197,85 +3161,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3301,9 +3247,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3323,7 +3269,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3358,9 +3304,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3810,22 +3756,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3981,7 +3917,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6547,9 +6488,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10586,6 +10524,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index 3f352801..bb2d0b79 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -2224,6 +2224,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2369,7 +2380,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2385,7 +2396,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2455,14 +2466,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2486,7 +2496,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2498,7 +2508,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2516,7 +2526,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2528,7 +2538,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2539,7 +2549,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2598,21 +2608,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2630,7 +2630,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2644,7 +2644,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2658,7 +2658,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2681,9 +2681,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2711,7 +2711,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2722,7 +2722,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2741,7 +2741,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2779,7 +2779,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2790,7 +2790,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2803,7 +2803,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2814,7 +2814,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2840,7 +2840,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2851,7 +2851,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3051,145 +3051,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3197,85 +3161,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3301,9 +3247,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3323,7 +3269,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3358,9 +3304,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3810,22 +3756,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3981,7 +3917,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6547,9 +6488,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10594,6 +10532,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index fa67c5cd..887b8adb 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -2221,6 +2221,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2366,7 +2377,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2382,7 +2393,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2452,14 +2463,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2483,7 +2493,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2495,7 +2505,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2513,7 +2523,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2525,7 +2535,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2536,7 +2546,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2595,21 +2605,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2627,7 +2627,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2641,7 +2641,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2655,7 +2655,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2678,9 +2678,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2708,7 +2708,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2719,7 +2719,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2738,7 +2738,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -2776,7 +2776,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -2787,7 +2787,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -2800,7 +2800,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -2811,7 +2811,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -2837,7 +2837,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -2848,7 +2848,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3048,145 +3048,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3194,85 +3158,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3298,9 +3244,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3320,7 +3266,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3355,9 +3301,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -3807,22 +3753,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -3978,7 +3914,12 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. + type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. type: string type: default: amazonpay @@ -6518,9 +6459,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -10526,6 +10464,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml index 05820d1d..b026242f 100644 --- a/yaml/CheckoutService-v68.yaml +++ b/yaml/CheckoutService-v68.yaml @@ -2124,7 +2124,7 @@ paths: - description: The `sessionResult` value from the Drop-in or Component. name: sessionResult in: query - required: false + required: true schema: type: string responses: @@ -2467,6 +2467,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2616,7 +2627,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2632,7 +2643,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2702,14 +2713,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2733,7 +2743,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2745,7 +2755,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2763,7 +2773,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2775,7 +2785,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2786,7 +2796,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2845,21 +2855,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2877,7 +2877,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2891,7 +2891,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2905,7 +2905,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2928,9 +2928,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2958,7 +2958,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2969,7 +2969,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2988,7 +2988,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -3026,7 +3026,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -3037,7 +3037,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -3050,7 +3050,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -3061,7 +3061,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -3087,7 +3087,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -3098,7 +3098,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3298,145 +3298,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3444,85 +3408,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3548,9 +3494,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3570,7 +3516,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3605,9 +3551,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -4057,22 +4003,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -4232,12 +4168,17 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. type: string checkoutAttemptId: x-addedInVersion: '68' description: The checkout attempt identifier. type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. + type: string type: default: amazonpay description: '**amazonpay**' @@ -7673,9 +7614,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -11937,6 +11875,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v69.yaml b/yaml/CheckoutService-v69.yaml index 59567a29..7d2b3d06 100644 --- a/yaml/CheckoutService-v69.yaml +++ b/yaml/CheckoutService-v69.yaml @@ -2124,7 +2124,7 @@ paths: - description: The `sessionResult` value from the Drop-in or Component. name: sessionResult in: query - required: false + required: true schema: type: string responses: @@ -2467,6 +2467,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2624,7 +2635,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2640,7 +2651,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2710,14 +2721,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2741,7 +2751,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2753,7 +2763,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2771,7 +2781,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2783,7 +2793,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2794,7 +2804,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2853,21 +2863,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2885,7 +2885,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2899,7 +2899,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -2913,7 +2913,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -2936,9 +2936,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -2966,7 +2966,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -2977,7 +2977,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -2996,7 +2996,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -3034,7 +3034,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -3045,7 +3045,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -3058,7 +3058,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -3069,7 +3069,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -3095,7 +3095,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -3106,7 +3106,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3306,145 +3306,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3452,85 +3416,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + *Encoding: Numeric + *Max length: 12 characters - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3556,9 +3502,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3578,7 +3524,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3613,9 +3559,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -4065,22 +4011,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -4240,12 +4176,17 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. type: string checkoutAttemptId: x-addedInVersion: '68' description: The checkout attempt identifier. type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. + type: string type: default: amazonpay description: '**amazonpay**' @@ -7772,9 +7713,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -12145,6 +12083,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string diff --git a/yaml/CheckoutService-v70.yaml b/yaml/CheckoutService-v70.yaml index 41c5e49b..d3e1c98c 100644 --- a/yaml/CheckoutService-v70.yaml +++ b/yaml/CheckoutService-v70.yaml @@ -2125,7 +2125,7 @@ paths: - description: The `sessionResult` value from the Drop-in or Component. name: sessionResult in: query - required: false + required: true schema: type: string responses: @@ -2562,6 +2562,17 @@ components: bankAccountNumber: description: The bank account number (without separators). type: string + bankAccountType: + description: The bank account type (checking, savings...). + enum: + - balance + - checking + - deposit + - general + - other + - payment + - savings + type: string bankLocationId: description: The bank routing number of the account. The field value is `nil` in most cases. @@ -2719,7 +2730,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2735,7 +2746,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2805,14 +2816,13 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are\ \ common:\n * F: first class\n* J: business class\n* Y: economy class\n\ * W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n\ - * maxLength: 1 character\n* Must not be all spaces\n* Must not be all\ - \ zeros" + * maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\ @@ -2836,7 +2846,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) @@ -2848,7 +2858,7 @@ components: * maxLength: 12 - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) @@ -2866,7 +2876,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), @@ -2878,7 +2888,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. @@ -2889,7 +2899,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is @@ -2948,21 +2958,11 @@ components: * maxLength: 6 characters' type: string airline.passenger_name: - description: 'The passenger''s name, initials, and title. - - * Format: last name + first name or initials + title - - * Example: *FLYER / MARY MS* - - * minLength: 1 character - - * maxLength: 20 characters - - * If you send more than 20 characters, the name is truncated - - * Must not be all spaces - - * Must not be all zeros' + description: "The passenger's name, initials, and title.\n* Format: last\ + \ name + first name or initials + title\n* Example: *FLYER / MARY MS*\n\ + * minLength: 1 character\n* maxLength: 20 characters\n* If you send more\ + \ than 20 characters, the name is truncated\n* Must not be all spaces\ + \ \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. @@ -2980,7 +2980,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency @@ -2994,7 +2994,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. @@ -3008,7 +3008,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string required: - airline.passenger_name @@ -3031,9 +3031,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. @@ -3061,7 +3061,7 @@ components: * Must not be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. @@ -3072,7 +3072,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) @@ -3091,7 +3091,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. @@ -3129,7 +3129,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. @@ -3140,7 +3140,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. @@ -3153,7 +3153,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. @@ -3164,7 +3164,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 @@ -3190,7 +3190,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. @@ -3201,7 +3201,7 @@ components: * Must not start with a space or be all spaces - * Must not be all zeros' + *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if @@ -3401,145 +3401,109 @@ components: enhancedSchemeData.customerReference: description: 'The customer code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 25 characters - - - Must not start with a space or be all spaces + * Max length: 25 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Fixed length: 3 characters' + * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - + * Max length: 10 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 3 characters - + * Max length: 3 characters - Must not start with a space' + * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 26 characters - - - Must not start with a space or be all spaces + * Max length: 26 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric - + * Encoding: Numeric - Max length: 12 characters' + * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. + * Encoding: ASCII. - Encoding: ASCII. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. + * Encoding: Numeric - Encoding: Numeric - - - Max length: 12 characters - + * Max length: 12 characters - Must not start with a space or be all spaces + * Must not start with a space or be all spaces ' @@ -3547,85 +3511,67 @@ components: enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Max length: 12 characters - - - Must not start with a space or be all spaces + * Max length: 12 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. - - Encoding: ASCII + * Encoding: ASCII Max length: 3 characters + * Must not start with a space or be all spaces - Must not start with a space or be all spaces - - - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - - - Encoding: Numeric + * Encoding: Numeric + * Max length: 12 characters - Max length: 12 characters' + * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` + * Encoding: ASCII - Encoding: ASCII - - - Max length: 6 characters' + * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. + * Encoding: ASCII - Encoding: ASCII - - - Max length: 10 characters - - - Must not start with a space or be all spaces + * Max length: 10 characters + * Must not start with a space or be all spaces - Must not be all zeros' + * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * For example, 2000 means USD 20.00. - For example, 2000 means USD 20.00. - + *Encoding: Numeric - Encoding: Numeric + *Max length: 12 characters - - Max length: 12 characters - - - ' + * Must not be all zeros.' type: string type: object AdditionalDataLodging: @@ -3651,9 +3597,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel @@ -3673,7 +3619,7 @@ components: lodging.folioNumber: description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters.\n* Must not start with a space\n\ - * Must not be all zeros" + *Must not be all zeros." type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, @@ -3708,9 +3654,9 @@ components: * Must not start with a space - * Must not be all zeros + * Must not contain any special characters such as + or - - * Must not contain any special characters such as + or -' + *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. @@ -4160,22 +4106,12 @@ components: * maxLength: 25' type: string enhancedSchemeData.employeeName: - description: 'The name or ID of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The name or ID of the person working in a temporary capacity.\n\ + * maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: - description: 'The job description of the person working in a temporary capacity. - - * maxLength: 40 - - * Must not be all zeros - - * Must not be all spaces' + description: "The job description of the person working in a temporary capacity.\n\ + * maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -4335,12 +4271,17 @@ components: amazonPayToken: description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) - response. + response. This token is used for API only integration specifically. type: string checkoutAttemptId: x-addedInVersion: '68' description: The checkout attempt identifier. type: string + checkoutSessionId: + description: The `checkoutSessionId` is used to identify the checkout session + at the Amazon Pay side. This field is required only for drop-in and components + integration, where it replaces the amazonPayToken. + type: string type: default: amazonpay description: '**amazonpay**' @@ -7938,9 +7879,6 @@ components: type: string subtype: description: The type of flow to initiate. - enum: - - redirect - - sdk type: string type: default: klarna @@ -12421,6 +12359,7 @@ components: - Remainder - Surcharge - Tip + - TopUp - VAT - Verification type: string