spec release

This commit is contained in:
Adyen Automation
2025-03-04 09:35:09 +01:00
parent 929b45eeae
commit ac576dec87
22 changed files with 979 additions and 791 deletions

View File

@@ -1445,7 +1445,7 @@
"additionalProperties" : false,
"properties" : {
"enhancedSchemeData.customerReference" : {
"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.",
"description" : "The reference number to identify the customer and their order. \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" : {
@@ -1453,27 +1453,27 @@
"type" : "string"
},
"enhancedSchemeData.destinationPostalCode" : {
"description" : "The postal code of the destination address.\n* Encoding: ASCII\n* Max length: 10 characters\n* Must 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.\n* For the US, it must be in five or nine digits format. For example, 10001 or 10001-0000.\n* For Canada, it must be in 6 digits format. For example, M4B 1G5.",
"type" : "string"
},
"enhancedSchemeData.destinationStateProvinceCode" : {
"description" : "Destination state or province code.\n* Encoding: ASCII\n* Max length: 3 characters\n* Must not start with a space",
"description" : "The state or province code of the destination address.\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* For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max length: 12 characters",
"description" : "The duty 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",
"type" : "string"
},
"enhancedSchemeData.freightAmount" : {
"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",
"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* Encoding: ASCII\n* Max length: 12 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
"description" : "The code that identifies the item in a standardized commodity coding scheme. There are different commodity coding schemes:\n* [UNSPSC commodity codes](https://www.unspsc.org/)\n* [HS commodity codes](https://www.wcoomd.org/en/topics/nomenclature/overview.aspx)\n* [NAICS commodity codes](https://www.census.gov/naics/)\n* [NAPCS commodity codes](https://www.census.gov/naics/napcs/)\n\n\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* Encoding: ASCII\n* Max length: 26 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
"description" : "A description of the item.\n* Encoding: ASCII\n* Max length: 26 characters\n* Must not be a single character.\n* Must not be blank.\n* Must not start with a space or be all spaces.\n* Must not be all zeros.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : {
@@ -1481,19 +1481,19 @@
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].productCode" : {
"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.",
"description" : "The product code. Must be a unique product code associated with the item or service. This can be your unique code for the item, or the manufacturer's 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* Encoding: Numeric\n* Max length: 12 characters\n* Must 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.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : {
"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.",
"description" : "The total amount for the line item, in [minor units](https://docs.adyen.com/development-resources/currency-codes). See [Amount requirements for level 2/3 ESD](https://docs.adyen.com//payment-methods/cards/enhanced-scheme-data/l2-l3#amount-requirements) to learn more about how to calculate the line item total.\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* Encoding: ASCII\n\nMax length: 3 characters\n* Must not start with a space or be all spaces\n* Must not be all zeros.",
"description" : "The unit of measurement for an item.\n* Encoding: ASCII\n* Max 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" : {
@@ -1505,11 +1505,11 @@
"type" : "string"
},
"enhancedSchemeData.shipFromPostalCode" : {
"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.",
"description" : "The postal code of the address where 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.For the US, it must be in five or nine digits format. For example, 10001 or 10001-0000.\n* For Canada, it must be in 6 digits format. For example, M4B 1G5.",
"type" : "string"
},
"enhancedSchemeData.totalTaxAmount" : {
"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.",
"description" : "The amount of state or provincial [tax included in the total transaction amount](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/l2-l3#requirements-to-send-level-2-3-esd), 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"
}
},
@@ -3921,15 +3921,15 @@
"type" : "string"
},
"tokenization.shopperReference" : {
"description" : "The provided reference of the shopper.",
"description" : "The reference for the shopper that you sent when tokenizing the payment details.",
"type" : "string"
},
"tokenization.store.operationType" : {
"description" : "The store operation performed on the token.",
"description" : "The operation performed on the token. Possible values:\n\n* **created**: the token has been created.\n* **updated**: the existing token has been updated.\n* **alreadyExisting**: the details have already been stored.\n",
"enum" : [
"created",
"updated",
"alreadyStored"
"alreadyExisting"
],
"type" : "string"
},