spec release

Adyen · Jul 12, 2023 · c29f29c · c29f29c
1 parent 2151487
commit c29f29c
Show file tree

Hide file tree

Showing 12 changed files with 1,038 additions and 27 deletions.
diff --git a/json/BalancePlatformAcsNotification-v1.json b/json/BalancePlatformAcsNotification-v1.json
diff --git a/json/BalancePlatformPaymentNotification-v1.json b/json/BalancePlatformPaymentNotification-v1.json
@@ -5,7 +5,6 @@
       "x-publicVersion" : true,
       "title" : "Payment webhooks (deprecated)",
       "description" : "The payment webhooks are deprecated. Use the [accounting webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/overview) instead.\n\nAdyen sends webhooks to inform your system about the creation of payment resources and money movements in your platform.\n\nYou can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds.",
-      "x-timestamp" : "2023-06-09T18:25:00Z",
       "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
       "contact" : {
          "name" : "Adyen Developer Experience team",

diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json
@@ -338,6 +338,9 @@
                      {
                         "$ref" : "#/components/schemas/NOLocalAccountIdentification"
                      },
+                     {
+                        "$ref" : "#/components/schemas/NZLocalAccountIdentification"
+                     },
                      {
                         "$ref" : "#/components/schemas/NumberAndBicAccountIdentification"
                      },
@@ -586,6 +589,44 @@
             ],
             "type" : "object"
          },
+         "NZLocalAccountIdentification" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "accountNumber" : {
+                  "description" : "The 7-digit bank account number, without separators or whitespace.",
+                  "maxLength" : 7,
+                  "minLength" : 7,
+                  "type" : "string"
+               },
+               "accountSuffix" : {
+                  "description" : "The 2- to 3-digit account suffix, without separators or whitespace.",
+                  "maxLength" : 3,
+                  "minLength" : 2,
+                  "type" : "string"
+               },
+               "bankCode" : {
+                  "description" : "The 6-digit bank code including the 2-digit bank code and 4-digit branch code, without separators or whitespace.",
+                  "maxLength" : 6,
+                  "minLength" : 6,
+                  "type" : "string"
+               },
+               "type" : {
+                  "default" : "nzLocal",
+                  "description" : "**nzLocal**",
+                  "enum" : [
+                     "nzLocal"
+                  ],
+                  "type" : "string"
+               }
+            },
+            "required" : [
+               "type",
+               "accountNumber",
+               "accountSuffix",
+               "bankCode"
+            ],
+            "type" : "object"
+         },
          "NameLocation" : {
             "properties" : {
                "city" : {
@@ -680,7 +721,7 @@
                   "$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**. Should not be before 1st January 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**. Should not be before January 1, 1900.\n\nAllowed only when `type` is **individual**.",
                   "format" : "date",
                   "type" : "string"
                },
@@ -697,7 +738,7 @@
                   "type" : "string"
                },
                "reference" : {
-                  "description" : "Your unique reference of the party. This should be consistent for all transfers initiated to/from the same party/counterparty. e.g Your client's unique wallet or payee ID",
+                  "description" : "A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID.",
                   "type" : "string"
                },
                "type" : {
@@ -1063,6 +1104,21 @@
                   "description" : "The payment's merchant reference included in the transfer.",
                   "type" : "string"
                },
+               "platformPaymentType" : {
+                  "x-addedInVersion" : "3",
+                  "deprecated" : true,
+                  "x-deprecatedInVersion" : "3",
+                  "x-deprecatedMessage" : "This will be removed in v4 and replaced with a new field.",
+                  "description" : "The type of the related split.",
+                  "enum" : [
+                     "BalanceAccount",
+                     "Commission",
+                     "Default",
+                     "PaymentFee",
+                     "VAT"
+                  ],
+                  "type" : "string"
+               },
                "priority" : {
                   "x-addedInVersion" : "3",
                   "description" : "The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**.\n\nPossible values:\n\n* **regular**: For normal, low-value transactions.\n\n* **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.\n\n* **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: High-value transfer to a recipient in a different country.\n\n* **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).",
@@ -1252,6 +1308,7 @@
                      "bankTransfer",
                      "capture",
                      "captureReversal",
+                     "cardTransfer",
                      "chargeback",
                      "chargebackReversal",
                      "depositCorrection",

diff --git a/json/TransferService-v1.json b/json/TransferService-v1.json
@@ -10,7 +10,6 @@
       "x-publicVersion" : true,
       "title" : "Transfers API",
       "description" : "This API provides endpoints that you can use to transfer funds, whether when [paying out to a transfer instrument](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/on-demand-payouts), [sending funds to third parties](https://docs.adyen.com/marketplaces-and-platforms/business-accounts/send-receive-funds) for users with business bank accounts, or to [request a payout for a grant offer](https://docs.adyen.com/marketplaces-and-platforms/capital). The API also supports use cases for [getting transactions for business bank accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts/transactions-api) and getting [grants and its outstanding balances](https://docs.adyen.com/marketplaces-and-platforms/capital#get-balances). .\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"[email protected]_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Transfers API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/v1/transfers\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v1`.\n\n",
-      "x-timestamp" : "2023-06-12T13:25:58Z",
       "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
       "contact" : {
          "name" : "Adyen Developer Experience team",
@@ -797,6 +796,7 @@
                      "bankTransfer",
                      "capture",
                      "captureReversal",
+                     "cardTransfer",
                      "chargeback",
                      "chargebackReversal",
                      "depositCorrection",

diff --git a/json/TransferService-v2.json b/json/TransferService-v2.json
@@ -10,7 +10,6 @@
       "x-publicVersion" : true,
       "title" : "Transfers API",
       "description" : "This API provides endpoints that you can use to transfer funds, whether when [paying out to a transfer instrument](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/on-demand-payouts), [sending funds to third parties](https://docs.adyen.com/marketplaces-and-platforms/business-accounts/send-receive-funds) for users with business bank accounts, or to [request a payout for a grant offer](https://docs.adyen.com/marketplaces-and-platforms/capital). The API also supports use cases for [getting transactions for business bank accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts/transactions-api) and getting [grants and its outstanding balances](https://docs.adyen.com/marketplaces-and-platforms/capital#get-balances). .\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"[email protected]_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Roles and permissions\nTo use the Transfers API, you need an additional role for your API credential. Transfers must also be enabled for the source balance account. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Transfers API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/v2/transfers\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v2`.\n\n",
-      "x-timestamp" : "2023-06-12T13:25:58Z",
       "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
       "contact" : {
          "name" : "Adyen Developer Experience team",
@@ -833,6 +832,7 @@
                      "bankTransfer",
                      "capture",
                      "captureReversal",
+                     "cardTransfer",
                      "chargeback",
                      "chargebackReversal",
                      "depositCorrection",

diff --git a/json/TransferService-v3.json b/json/TransferService-v3.json
@@ -913,6 +913,9 @@
                      {
                         "$ref" : "#/components/schemas/NOLocalAccountIdentification"
                      },
+                     {
+                        "$ref" : "#/components/schemas/NZLocalAccountIdentification"
+                     },
                      {
                         "$ref" : "#/components/schemas/NumberAndBicAccountIdentification"
                      },
@@ -1394,6 +1397,44 @@
             ],
             "type" : "object"
          },
+         "NZLocalAccountIdentification" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "accountNumber" : {
+                  "description" : "The 7-digit bank account number, without separators or whitespace.",
+                  "maxLength" : 7,
+                  "minLength" : 7,
+                  "type" : "string"
+               },
+               "accountSuffix" : {
+                  "description" : "The 2- to 3-digit account suffix, without separators or whitespace.",
+                  "maxLength" : 3,
+                  "minLength" : 2,
+                  "type" : "string"
+               },
+               "bankCode" : {
+                  "description" : "The 6-digit bank code including the 2-digit bank code and 4-digit branch code, without separators or whitespace.",
+                  "maxLength" : 6,
+                  "minLength" : 6,
+                  "type" : "string"
+               },
+               "type" : {
+                  "default" : "nzLocal",
+                  "description" : "**nzLocal**",
+                  "enum" : [
+                     "nzLocal"
+                  ],
+                  "type" : "string"
+               }
+            },
+            "required" : [
+               "type",
+               "accountNumber",
+               "accountSuffix",
+               "bankCode"
+            ],
+            "type" : "object"
+         },
          "NameLocation" : {
             "properties" : {
                "city" : {
@@ -1488,7 +1529,7 @@
                   "$ref" : "#/components/schemas/Address-2"
                },
                "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**. Should not be before 1st January 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**. Should not be before January 1, 1900.\n\nAllowed only when `type` is **individual**.",
                   "format" : "date",
                   "type" : "string"
                },
@@ -1505,7 +1546,7 @@
                   "type" : "string"
                },
                "reference" : {
-                  "description" : "Your unique reference of the party. This should be consistent for all transfers initiated to/from the same party/counterparty. e.g Your client's unique wallet or payee ID",
+                  "description" : "A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID.",
                   "type" : "string"
                },
                "type" : {
@@ -1835,6 +1876,7 @@
                      "bankTransfer",
                      "capture",
                      "captureReversal",
+                     "cardTransfer",
                      "chargeback",
                      "chargebackReversal",
                      "depositCorrection",
@@ -2257,7 +2299,7 @@
                   "$ref" : "#/components/schemas/Address-2"
                },
                "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**. Should not be before 1st January 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**. Should not be before January 1, 1900.\n\nAllowed only when `type` is **individual**.",
                   "format" : "date",
                   "type" : "string"
                },
@@ -2274,7 +2316,7 @@
                   "type" : "string"
                },
                "reference" : {
-                  "description" : "Your unique reference of the party. This should be consistent for all transfers initiated to/from the same party/counterparty. e.g Your client's unique wallet or payee ID",
+                  "description" : "A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID.",
                   "type" : "string"
                },
                "type" : {