spec release

Adyen · Aug 7, 2024 · d390818 · d390818
1 parent 48368bb
commit d390818
Show file tree

Hide file tree

Showing 8 changed files with 947 additions and 148 deletions.
diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json
@@ -483,13 +483,13 @@
             "additionalProperties" : false,
             "properties" : {
                "expiryMonth" : {
-                  "description" : "The expiry month of the card.\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November",
+                  "description" : "The expiry month of the card.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November",
                   "maxLength" : 2,
                   "minLength" : 2,
                   "type" : "string"
                },
                "expiryYear" : {
-                  "description" : "The expiry year of the card.\nFormat: 4 digits. For example: 2020",
+                  "description" : "The expiry year of the card.\n\nFormat: four digits. For example: 2020",
                   "maxLength" : 4,
                   "minLength" : 4,
                   "type" : "string"
@@ -501,19 +501,19 @@
                   "type" : "string"
                },
                "number" : {
-                  "description" : "The card number without any separators.\n\nWhen this value is returned in a response, it only includes the last 4 digits of the card number.",
+                  "description" : "The card number without any separators.\n\nFor security, the response only includes the last four digits of the card number.",
                   "maxLength" : 19,
                   "minLength" : 4,
                   "type" : "string"
                },
                "startMonth" : {
-                  "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November",
+                  "description" : "The month when the card was issued. Applies only to some UK debit cards.\n\nFormat: two digits. Add a leading zero for single-digit months. For example:\n* 03 = March\n* 11 = November",
                   "maxLength" : 2,
                   "minLength" : 2,
                   "type" : "string"
                },
                "startYear" : {
-                  "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: 4 digits. For example: 2020",
+                  "description" : "The year when the card was issued. Applies only to some UK debit cards.\n\nFormat: four digits. For example: 2020",
                   "maxLength" : 4,
                   "minLength" : 4,
                   "type" : "string"
@@ -554,7 +554,7 @@
             "additionalProperties" : false,
             "properties" : {
                "balanceAccountId" : {
-                  "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).",
+                  "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).",
                   "type" : "string"
                },
                "bankAccount" : {
@@ -570,7 +570,7 @@
                   "$ref" : "#/components/schemas/MerchantData"
                },
                "transferInstrumentId" : {
-                  "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).",
+                  "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).",
                   "type" : "string"
                }
             },
@@ -1027,20 +1027,20 @@
                   "$ref" : "#/components/schemas/Address"
                },
                "dateOfBirth" : {
-                  "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nThe date must be later than January 1, 1900.\n\nAllowed only when `type` is **individual**.",
+                  "description" : "The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**.\n\nAllowed only when `type` is **individual**.",
                   "format" : "date",
                   "type" : "string"
                },
                "firstName" : {
-                  "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.",
+                  "description" : "The first name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.",
                   "type" : "string"
                },
                "fullName" : {
-                  "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and Space.\n\nRequired when `category` is **bank**.",
+                  "description" : "The full name of the entity that owns the bank account or card.\n\nSupported characters: [a-z] [A-Z] [0-9] , . ; : - — / \\ + & ! ? @ ( ) \" ' and space.\n\nRequired when `category` is **bank**.",
                   "type" : "string"
                },
                "lastName" : {
-                  "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and Space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.",
+                  "description" : "The last name of the individual.\n\nSupported characters: [a-z] [A-Z] - . / — and space.\n\nThis parameter is:\n- Allowed only when `type` is **individual**.\n- Required when `category` is **card**.",
                   "type" : "string"
                },
                "reference" : {
@@ -1909,7 +1909,7 @@
             "additionalProperties" : false,
             "properties" : {
                "balanceAccountId" : {
-                  "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/2/post/balanceAccounts#responses-200-id).",
+                  "description" : "The unique identifier of the counterparty [balance account](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/balanceAccounts#responses-200-id).",
                   "type" : "string"
                },
                "bankAccount" : {
@@ -1925,7 +1925,7 @@
                   "$ref" : "#/components/schemas/TransferNotificationMerchantData"
                },
                "transferInstrumentId" : {
-                  "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/3/post/transferInstruments#responses-200-id).",
+                  "description" : "The unique identifier of the counterparty [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).",
                   "type" : "string"
                }
             },