Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Jun 6, 2024
1 parent ee0f2d9 commit f3816bd
Show file tree
Hide file tree
Showing 12 changed files with 264 additions and 251 deletions.
20 changes: 10 additions & 10 deletions json/BalancePlatformTransferNotification-v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -567,15 +567,15 @@
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The code for this reason code.",
"description" : "The reason code.",
"type" : "string"
},
"description" : {
"description" : "The description for this reason code.",
"description" : "The description of the reason code.",
"type" : "string"
},
"namespace" : {
"description" : "The namespace for this reason code.",
"description" : "The namespace for the reason code.",
"type" : "string"
}
},
Expand Down Expand Up @@ -1013,7 +1013,7 @@
},
"tokenType" : {
"x-addedInVersion" : "3",
"description" : "The type of wallet the network token is associated with.",
"description" : "The type of wallet that the network token is associated with.",
"type" : "string"
}
},
Expand Down Expand Up @@ -1217,7 +1217,7 @@
"properties" : {
"accountHolder" : {
"x-addedInVersion" : "3",
"description" : "The account holder associated with the balance account used in the transfer.",
"description" : "The account holder associated with the balance account involved in the transfer.",
"$ref" : "#/components/schemas/ResourceReference"
},
"amount" : {
Expand Down Expand Up @@ -1252,7 +1252,7 @@
},
"category" : {
"x-addedInVersion" : "3",
"description" : "The category of transfer.\n\nPossible values:\n\n - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: Transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: Fund movements related to payments that are acquired for your users.",
"description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by an Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.",
"enum" : [
"bank",
"internal",
Expand Down Expand Up @@ -1379,7 +1379,7 @@
},
"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). This will be removed in v4 and replaced with a new field.",
"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**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN). This will be removed in v4 and replaced with a new field.",
"enum" : [
"crossBorder",
"fast",
Expand Down Expand Up @@ -1461,7 +1461,7 @@
},
"sequenceNumber" : {
"x-addedInVersion" : "3",
"description" : "The sequence number of the transfer notification. The numbers start from 1 and increase with each new notification for a specific transfer.\n\nIt can help you restore the correct sequence of events even if they arrive out of order.",
"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.",
"format" : "int32",
"type" : "integer"
},
Expand Down Expand Up @@ -1652,7 +1652,7 @@
},
"estimatedArrivalTime" : {
"x-addedInVersion" : "3",
"description" : "The estimated time the beneficiary should have access to the funds.",
"description" : "The estimated time when the beneficiary should have access to the funds.",
"format" : "date-time",
"type" : "string"
},
Expand All @@ -1673,7 +1673,7 @@
},
"mutations" : {
"x-addedInVersion" : "3",
"description" : "The list of the balance mutation per event.",
"description" : "The list of balance mutations per event.",
"items" : {
"$ref" : "#/components/schemas/BalanceMutation"
},
Expand Down
24 changes: 12 additions & 12 deletions json/BalancePlatformTransferNotification-v4.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@
"properties" : {
"priority" : {
"x-addedInVersion" : "4",
"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).",
"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**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).",
"enum" : [
"crossBorder",
"fast",
Expand Down Expand Up @@ -594,15 +594,15 @@
"additionalProperties" : false,
"properties" : {
"code" : {
"description" : "The code for this reason code.",
"description" : "The reason code.",
"type" : "string"
},
"description" : {
"description" : "The description for this reason code.",
"description" : "The description of the reason code.",
"type" : "string"
},
"namespace" : {
"description" : "The namespace for this reason code.",
"description" : "The namespace for the reason code.",
"type" : "string"
}
},
Expand Down Expand Up @@ -786,12 +786,12 @@
},
"schemeTraceId" : {
"x-addedInVersion" : "4",
"description" : "The identifier of the original payment provided by the scheme. The Id could be alphanumeric or numeric depending on the scheme. The schemeTraceID should be referring to an original schemeUniqueTransactionID provided in an earlier payment (not necessarily processed by Adyen). Instances of available schemeTraceId is authAdjustment or recurring payments.",
"description" : "The identifier of the original payment. This ID is provided by the scheme and can be alphanumeric or numeric, depending on the scheme. The `schemeTraceID` should refer to an original `schemeUniqueTransactionID` provided in an earlier payment (not necessarily processed by Adyen). A `schemeTraceId` is typically available for authorization adjustments or recurring payments.",
"type" : "string"
},
"schemeUniqueTransactionId" : {
"x-addedInVersion" : "4",
"description" : "The unique identifier created by the scheme. The ID could be alphanumeric or numeric depending on the scheme.",
"description" : "The unique identifier created by the scheme. This ID can be alphanumeric or numeric depending on the scheme.",
"type" : "string"
},
"type" : {
Expand Down Expand Up @@ -1135,7 +1135,7 @@
},
"tokenType" : {
"x-addedInVersion" : "3",
"description" : "The type of wallet the network token is associated with.",
"description" : "The type of wallet that the network token is associated with.",
"type" : "string"
}
},
Expand Down Expand Up @@ -1408,7 +1408,7 @@
"properties" : {
"accountHolder" : {
"x-addedInVersion" : "3",
"description" : "The account holder associated with the balance account used in the transfer.",
"description" : "The account holder associated with the balance account involved in the transfer.",
"$ref" : "#/components/schemas/ResourceReference"
},
"amount" : {
Expand All @@ -1435,7 +1435,7 @@
},
"category" : {
"x-addedInVersion" : "3",
"description" : "The category of transfer.\n\nPossible values:\n\n - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: Transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: Fund movements related to payments that are acquired for your users.",
"description" : "The category of the transfer.\n\nPossible values:\n\n - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: a transfer initiated by an Adyen-issued card.\n\n- **platformPayment**: funds movements related to payments that are acquired for your users.",
"enum" : [
"bank",
"internal",
Expand Down Expand Up @@ -1541,7 +1541,7 @@
},
"sequenceNumber" : {
"x-addedInVersion" : "3",
"description" : "The sequence number of the transfer notification. The numbers start from 1 and increase with each new notification for a specific transfer.\n\nIt can help you restore the correct sequence of events even if they arrive out of order.",
"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.",
"format" : "int32",
"type" : "integer"
},
Expand Down Expand Up @@ -1713,7 +1713,7 @@
},
"estimatedArrivalTime" : {
"x-addedInVersion" : "3",
"description" : "The estimated time the beneficiary should have access to the funds.",
"description" : "The estimated time when the beneficiary should have access to the funds.",
"format" : "date-time",
"type" : "string"
},
Expand All @@ -1734,7 +1734,7 @@
},
"mutations" : {
"x-addedInVersion" : "3",
"description" : "The list of the balance mutation per event.",
"description" : "The list of balance mutations per event.",
"items" : {
"$ref" : "#/components/schemas/BalanceMutation"
},
Expand Down
2 changes: 1 addition & 1 deletion json/TransferService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -719,7 +719,7 @@
"type" : "string"
},
"priority" : {
"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).",
"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**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.\n\n* **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: for high-value transfers to a recipient in a different country.\n\n* **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).",
"enum" : [
"crossBorder",
"fast",
Expand Down
Loading

0 comments on commit f3816bd

Please sign in to comment.