spec release

Adyen · Oct 10, 2024 · 07d07d2 · 07d07d2
1 parent b4c0540
commit 07d07d2
Show file tree

Hide file tree

Showing 10 changed files with 2,409 additions and 173 deletions.
diff --git a/json/BalancePlatformTransferNotification-v3.json b/json/BalancePlatformTransferNotification-v3.json
@@ -607,6 +607,30 @@
             ],
             "type" : "object"
          },
+         "DirectDebitInformation" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "dateOfSignature" : {
+                  "description" : "The date when the direct debit mandate was accepted by your user, in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format.",
+                  "format" : "date-time",
+                  "type" : "string"
+               },
+               "dueDate" : {
+                  "description" : "The date when the funds are deducted from your user's balance account.",
+                  "format" : "date-time",
+                  "type" : "string"
+               },
+               "mandateId" : {
+                  "description" : "Your unique identifier for the direct debit mandate.",
+                  "type" : "string"
+               },
+               "sequenceType" : {
+                  "description" : "Identifies the direct debit transfer's type.\nPossible values: **OneOff**, **First**, **Recurring**, **Final**.",
+                  "type" : "string"
+               }
+            },
+            "type" : "object"
+         },
          "EstimationTrackingData" : {
             "additionalProperties" : false,
             "properties" : {
@@ -858,6 +882,7 @@
                      "paymentCost",
                      "paymentCostPending",
                      "pendingApproval",
+                     "pendingExecution",
                      "received",
                      "refundPending",
                      "refundReversalPending",
@@ -1343,6 +1368,11 @@
                   "description" : "Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.\n\nSupported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , ' + Space**\n\nSupported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ ' \" ! ?**",
                   "type" : "string"
                },
+               "directDebitInformation" : {
+                  "x-addedInVersion" : "3",
+                  "description" : "The details of the direct debit.",
+                  "$ref" : "#/components/schemas/DirectDebitInformation"
+               },
                "direction" : {
                   "x-addedInVersion" : "2",
                   "description" : "The direction of the transfer.\n\nPossible values: **incoming**, **outgoing**.",
@@ -1486,6 +1516,7 @@
                   "x-addedInVersion" : "2",
                   "description" : "Additional information about the status of the transfer.",
                   "enum" : [
+                     "accountHierarchyNotActive",
                      "amountLimitExceeded",
                      "approved",
                      "balanceAccountTemporarilyBlockedByTransactionRule",
@@ -1497,12 +1528,15 @@
                      "counterpartyBankUnavailable",
                      "declined",
                      "declinedByTransactionRule",
+                     "directDebitNotSupported",
                      "error",
                      "notEnoughBalance",
                      "pendingApproval",
+                     "pendingExecution",
                      "refusedByCounterpartyBank",
                      "routeNotFound",
                      "scaFailed",
+                     "transferInstrumentDoesNotExist",
                      "unknown"
                   ],
                   "type" : "string"
@@ -1526,6 +1560,11 @@
                   "description" : "If you are using relayed authorisation, this object contains information from the relayed authorisation response from your server.",
                   "$ref" : "#/components/schemas/RelayedAuthorisationData"
                },
+               "review" : {
+                  "x-addedInVersion" : "3",
+                  "description" : "Contains status updates related to additional reviews.",
+                  "$ref" : "#/components/schemas/TransferReview"
+               },
                "sequenceNumber" : {
                   "x-addedInVersion" : "3",
                   "description" : "The sequence number of the transfer webhook. The numbers start from 1 and increase with each new webhook for a specific transfer.\n\nThe sequence number can help you restore the correct sequence of events even if they arrive out of order.",
@@ -1588,6 +1627,7 @@
                      "paymentCost",
                      "paymentCostPending",
                      "pendingApproval",
+                     "pendingExecution",
                      "received",
                      "refundPending",
                      "refundReversalPending",
@@ -1757,6 +1797,7 @@
                   "x-addedInVersion" : "3",
                   "description" : "The reason for the transfer status.",
                   "enum" : [
+                     "accountHierarchyNotActive",
                      "amountLimitExceeded",
                      "approved",
                      "balanceAccountTemporarilyBlockedByTransactionRule",
@@ -1768,12 +1809,15 @@
                      "counterpartyBankUnavailable",
                      "declined",
                      "declinedByTransactionRule",
+                     "directDebitNotSupported",
                      "error",
                      "notEnoughBalance",
                      "pendingApproval",
+                     "pendingExecution",
                      "refusedByCounterpartyBank",
                      "routeNotFound",
                      "scaFailed",
+                     "transferInstrumentDoesNotExist",
                      "unknown"
                   ],
                   "type" : "string"
@@ -1844,6 +1888,7 @@
                      "paymentCost",
                      "paymentCostPending",
                      "pendingApproval",
+                     "pendingExecution",
                      "received",
                      "refundPending",
                      "refundReversalPending",
@@ -2005,6 +2050,31 @@
             },
             "type" : "object"
          },
+         "TransferReview" : {
+            "additionalProperties" : false,
+            "properties" : {
+               "numberOfApprovalsCompleted" : {
+                  "description" : "Shows the number of approvals completed for the transfer.",
+                  "format" : "int32",
+                  "type" : "integer"
+               },
+               "numberOfApprovalsRequired" : {
+                  "description" : "Shows the number of [approvals](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers/approve) required to process the transfer.",
+                  "format" : "int32",
+                  "type" : "integer"
+               },
+               "scaOnApproval" : {
+                  "description" : "Shows the status of the Strong Customer Authentication (SCA) process.\n\nPossible values: **required**, **completed**, **notApplicable**.",
+                  "enum" : [
+                     "completed",
+                     "notApplicable",
+                     "required"
+                  ],
+                  "type" : "string"
+               }
+            },
+            "type" : "object"
+         },
          "UKLocalAccountIdentification" : {
             "additionalProperties" : false,
             "properties" : {