mirror of
https://github.com/gcatanese/adyen-openapi.git
synced 2026-03-10 08:01:24 +00:00
spec release
This commit is contained in:
@@ -5,7 +5,7 @@
|
|||||||
"x-publicVersion" : true,
|
"x-publicVersion" : true,
|
||||||
"title" : "Accounting notifications",
|
"title" : "Accounting notifications",
|
||||||
"description" : "Adyen sends notifications through webhooks to inform your system about incoming and outgoing transfers 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.",
|
"description" : "Adyen sends notifications through webhooks to inform your system about incoming and outgoing transfers 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-02-01T15:28:04Z",
|
"x-timestamp" : "2023-02-10T11:25:40Z",
|
||||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||||
"contact" : {
|
"contact" : {
|
||||||
"name" : "Adyen Developer Experience team",
|
"name" : "Adyen Developer Experience team",
|
||||||
@@ -837,7 +837,7 @@
|
|||||||
},
|
},
|
||||||
"transactionRule" : {
|
"transactionRule" : {
|
||||||
"description" : "Contains information about the transaction rule.",
|
"description" : "Contains information about the transaction rule.",
|
||||||
"$ref" : "#/components/schemas/ResourceReference"
|
"$ref" : "#/components/schemas/TransactionRuleReference"
|
||||||
},
|
},
|
||||||
"transactionRuleSource" : {
|
"transactionRuleSource" : {
|
||||||
"description" : "Contains the type and ID of the resource to which the transaction rule is linked.",
|
"description" : "Contains the type and ID of the resource to which the transaction rule is linked.",
|
||||||
@@ -845,6 +845,22 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"TransactionRuleReference" : {
|
||||||
|
"properties" : {
|
||||||
|
"description" : {
|
||||||
|
"description" : "The description of the resource.",
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"id" : {
|
||||||
|
"description" : "The unique identifier of the resource.",
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"reference" : {
|
||||||
|
"description" : "The reference for the resource.",
|
||||||
|
"type" : "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"TransactionRuleSource" : {
|
"TransactionRuleSource" : {
|
||||||
"properties" : {
|
"properties" : {
|
||||||
"id" : {
|
"id" : {
|
||||||
@@ -1004,7 +1020,7 @@
|
|||||||
},
|
},
|
||||||
"transactionId" : {
|
"transactionId" : {
|
||||||
"x-addedInVersion" : "3",
|
"x-addedInVersion" : "3",
|
||||||
"description" : "The id of the transaction that is related to this accounting event. Only sent for events of type accounting where the balance changes",
|
"description" : "The id of the transaction that is related to this accounting event. Only sent for events of type **accounting** where the balance changes.",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"type" : {
|
"type" : {
|
||||||
@@ -1048,6 +1064,10 @@
|
|||||||
"$ref" : "#/components/schemas/ResourceReference"
|
"$ref" : "#/components/schemas/ResourceReference"
|
||||||
},
|
},
|
||||||
"balanceAccountId" : {
|
"balanceAccountId" : {
|
||||||
|
"x-addedInVersion" : "3",
|
||||||
|
"deprecated" : true,
|
||||||
|
"x-deprecatedInVersion" : "3",
|
||||||
|
"x-deprecatedMessage" : "Use the [id](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-balanceAccount-id) in the `balanceAccount` object instead.",
|
||||||
"description" : "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).",
|
"description" : "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
@@ -1141,8 +1161,9 @@
|
|||||||
},
|
},
|
||||||
"priority" : {
|
"priority" : {
|
||||||
"x-addedInVersion" : "3",
|
"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).",
|
"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 receipt in a different country. ",
|
||||||
"enum" : [
|
"enum" : [
|
||||||
|
"crossBorder",
|
||||||
"directDebit",
|
"directDebit",
|
||||||
"fast",
|
"fast",
|
||||||
"instant",
|
"instant",
|
||||||
@@ -1288,7 +1309,10 @@
|
|||||||
},
|
},
|
||||||
"transactionId" : {
|
"transactionId" : {
|
||||||
"x-addedInVersion" : "3",
|
"x-addedInVersion" : "3",
|
||||||
"description" : "The ID of the transaction that is created based on the transfer. Deprecated; use the transactionId in the events instead.",
|
"deprecated" : true,
|
||||||
|
"x-deprecatedInVersion" : "3",
|
||||||
|
"x-deprecatedMessage" : "Use the [transactionId](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-events-transactionId) in the `events` array instead.",
|
||||||
|
"description" : "The ID of the transaction that is created based on the transfer.",
|
||||||
"type" : "string"
|
"type" : "string"
|
||||||
},
|
},
|
||||||
"transactionRulesResult" : {
|
"transactionRulesResult" : {
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
"x-publicVersion" : true,
|
"x-publicVersion" : true,
|
||||||
"title" : "Payment notifications (deprecated)",
|
"title" : "Payment notifications (deprecated)",
|
||||||
"description" : "The payment notification webhooks are deprecated. Use the [accounting webhooks](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/overview) instead.\n\nAdyen sends notifications through 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.",
|
"description" : "The payment notification webhooks are deprecated. Use the [accounting webhooks](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/overview) instead.\n\nAdyen sends notifications through 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-02-03T12:25:07Z",
|
"x-timestamp" : "2023-02-10T11:25:38Z",
|
||||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||||
"contact" : {
|
"contact" : {
|
||||||
"name" : "Adyen Developer Experience team",
|
"name" : "Adyen Developer Experience team",
|
||||||
@@ -1027,7 +1027,7 @@
|
|||||||
},
|
},
|
||||||
"transactionRule" : {
|
"transactionRule" : {
|
||||||
"description" : "Contains information about the transaction rule.",
|
"description" : "Contains information about the transaction rule.",
|
||||||
"$ref" : "#/components/schemas/ResourceReference"
|
"$ref" : "#/components/schemas/TransactionRuleReference"
|
||||||
},
|
},
|
||||||
"transactionRuleSource" : {
|
"transactionRuleSource" : {
|
||||||
"description" : "Contains the type and ID of the resource to which the transaction rule is linked.",
|
"description" : "Contains the type and ID of the resource to which the transaction rule is linked.",
|
||||||
@@ -1156,6 +1156,22 @@
|
|||||||
"counterparty"
|
"counterparty"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"TransactionRuleReference" : {
|
||||||
|
"properties" : {
|
||||||
|
"description" : {
|
||||||
|
"description" : "The description of the resource.",
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"id" : {
|
||||||
|
"description" : "The unique identifier of the resource.",
|
||||||
|
"type" : "string"
|
||||||
|
},
|
||||||
|
"reference" : {
|
||||||
|
"description" : "The reference for the resource.",
|
||||||
|
"type" : "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"TransactionRuleSource" : {
|
"TransactionRuleSource" : {
|
||||||
"properties" : {
|
"properties" : {
|
||||||
"id" : {
|
"id" : {
|
||||||
|
|||||||
1485
json/BalancePlatformTransferNotification-v3.json
Normal file
1485
json/BalancePlatformTransferNotification-v3.json
Normal file
File diff suppressed because it is too large
Load Diff
@@ -10,7 +10,7 @@
|
|||||||
"x-publicVersion" : true,
|
"x-publicVersion" : true,
|
||||||
"title" : "Transfers API",
|
"title" : "Transfers API",
|
||||||
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\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 \"ws@BalancePlatform.YOUR_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",
|
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\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 \"ws@BalancePlatform.YOUR_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-02-01T15:28:04Z",
|
"x-timestamp" : "2023-02-09T22:20:55Z",
|
||||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||||
"contact" : {
|
"contact" : {
|
||||||
"name" : "Adyen Developer Experience team",
|
"name" : "Adyen Developer Experience team",
|
||||||
@@ -59,6 +59,15 @@
|
|||||||
"type" : "string"
|
"type" : "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description" : "Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).",
|
||||||
|
"name" : "paymentInstrumentId",
|
||||||
|
"in" : "query",
|
||||||
|
"required" : false,
|
||||||
|
"schema" : {
|
||||||
|
"type" : "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).",
|
"description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).",
|
||||||
"name" : "accountHolderId",
|
"name" : "accountHolderId",
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
"x-publicVersion" : true,
|
"x-publicVersion" : true,
|
||||||
"title" : "Transfers API",
|
"title" : "Transfers API",
|
||||||
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\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 \"ws@BalancePlatform.YOUR_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",
|
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\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 \"ws@BalancePlatform.YOUR_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-02-01T15:28:04Z",
|
"x-timestamp" : "2023-02-09T22:20:55Z",
|
||||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||||
"contact" : {
|
"contact" : {
|
||||||
"name" : "Adyen Developer Experience team",
|
"name" : "Adyen Developer Experience team",
|
||||||
@@ -59,6 +59,15 @@
|
|||||||
"type" : "string"
|
"type" : "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description" : "Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).",
|
||||||
|
"name" : "paymentInstrumentId",
|
||||||
|
"in" : "query",
|
||||||
|
"required" : false,
|
||||||
|
"schema" : {
|
||||||
|
"type" : "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).",
|
"description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).",
|
||||||
"name" : "accountHolderId",
|
"name" : "accountHolderId",
|
||||||
@@ -441,8 +450,9 @@
|
|||||||
"properties" : {
|
"properties" : {
|
||||||
"priority" : {
|
"priority" : {
|
||||||
"x-addedInVersion" : "1",
|
"x-addedInVersion" : "1",
|
||||||
"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. If you don't provide this in the request, Adyen sets the optimal priority.\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).",
|
"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. If you don't provide this in the request, Adyen sets the optimal priority.\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 receipt in a different country. ",
|
||||||
"enum" : [
|
"enum" : [
|
||||||
|
"crossBorder",
|
||||||
"directDebit",
|
"directDebit",
|
||||||
"fast",
|
"fast",
|
||||||
"instant",
|
"instant",
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
"x-publicVersion" : true,
|
"x-publicVersion" : true,
|
||||||
"title" : "Transfers API",
|
"title" : "Transfers API",
|
||||||
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\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 \"ws@BalancePlatform.YOUR_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/v3/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/v3`.\n\n",
|
"description" : "The Transfers API provides endpoints that you can use to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments).\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 \"ws@BalancePlatform.YOUR_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/v3/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/v3`.\n\n",
|
||||||
"x-timestamp" : "2023-02-01T15:28:04Z",
|
"x-timestamp" : "2023-02-09T22:20:55Z",
|
||||||
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
|
||||||
"contact" : {
|
"contact" : {
|
||||||
"name" : "Adyen Developer Experience team",
|
"name" : "Adyen Developer Experience team",
|
||||||
@@ -59,6 +59,15 @@
|
|||||||
"type" : "string"
|
"type" : "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description" : "Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).",
|
||||||
|
"name" : "paymentInstrumentId",
|
||||||
|
"in" : "query",
|
||||||
|
"required" : false,
|
||||||
|
"schema" : {
|
||||||
|
"type" : "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).",
|
"description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).",
|
||||||
"name" : "accountHolderId",
|
"name" : "accountHolderId",
|
||||||
@@ -1309,8 +1318,9 @@
|
|||||||
},
|
},
|
||||||
"priority" : {
|
"priority" : {
|
||||||
"x-addedInVersion" : "3",
|
"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).",
|
"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 receipt in a different country. ",
|
||||||
"enum" : [
|
"enum" : [
|
||||||
|
"crossBorder",
|
||||||
"directDebit",
|
"directDebit",
|
||||||
"fast",
|
"fast",
|
||||||
"instant",
|
"instant",
|
||||||
@@ -1468,8 +1478,9 @@
|
|||||||
},
|
},
|
||||||
"priority" : {
|
"priority" : {
|
||||||
"x-addedInVersion" : "3",
|
"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).",
|
"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 receipt in a different country. ",
|
||||||
"enum" : [
|
"enum" : [
|
||||||
|
"crossBorder",
|
||||||
"directDebit",
|
"directDebit",
|
||||||
"fast",
|
"fast",
|
||||||
"instant",
|
"instant",
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ info:
|
|||||||
You can use these webhooks to build your implementation. For example, you can
|
You 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
|
use this information to update balances in your own dashboards or to keep track
|
||||||
of incoming funds.'
|
of incoming funds.'
|
||||||
x-timestamp: '2023-02-01T15:28:04Z'
|
x-timestamp: '2023-02-10T11:25:40Z'
|
||||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||||
contact:
|
contact:
|
||||||
name: Adyen Developer Experience team
|
name: Adyen Developer Experience team
|
||||||
@@ -648,11 +648,22 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
transactionRule:
|
transactionRule:
|
||||||
description: Contains information about the transaction rule.
|
description: Contains information about the transaction rule.
|
||||||
$ref: '#/components/schemas/ResourceReference'
|
$ref: '#/components/schemas/TransactionRuleReference'
|
||||||
transactionRuleSource:
|
transactionRuleSource:
|
||||||
description: Contains the type and ID of the resource to which the transaction
|
description: Contains the type and ID of the resource to which the transaction
|
||||||
rule is linked.
|
rule is linked.
|
||||||
$ref: '#/components/schemas/TransactionRuleSource'
|
$ref: '#/components/schemas/TransactionRuleSource'
|
||||||
|
TransactionRuleReference:
|
||||||
|
properties:
|
||||||
|
description:
|
||||||
|
description: The description of the resource.
|
||||||
|
type: string
|
||||||
|
id:
|
||||||
|
description: The unique identifier of the resource.
|
||||||
|
type: string
|
||||||
|
reference:
|
||||||
|
description: The reference for the resource.
|
||||||
|
type: string
|
||||||
TransactionRuleSource:
|
TransactionRuleSource:
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
@@ -797,7 +808,7 @@ components:
|
|||||||
transactionId:
|
transactionId:
|
||||||
x-addedInVersion: '3'
|
x-addedInVersion: '3'
|
||||||
description: The id of the transaction that is related to this accounting
|
description: The id of the transaction that is related to this accounting
|
||||||
event. Only sent for events of type accounting where the balance changes
|
event. Only sent for events of type **accounting** where the balance changes.
|
||||||
type: string
|
type: string
|
||||||
type:
|
type:
|
||||||
x-addedInVersion: '3'
|
x-addedInVersion: '3'
|
||||||
@@ -835,6 +846,11 @@ components:
|
|||||||
the transfer.
|
the transfer.
|
||||||
$ref: '#/components/schemas/ResourceReference'
|
$ref: '#/components/schemas/ResourceReference'
|
||||||
balanceAccountId:
|
balanceAccountId:
|
||||||
|
x-addedInVersion: '3'
|
||||||
|
deprecated: true
|
||||||
|
x-deprecatedInVersion: '3'
|
||||||
|
x-deprecatedMessage: Use the [id](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-balanceAccount-id)
|
||||||
|
in the `balanceAccount` object instead.
|
||||||
description: The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
|
description: The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
|
||||||
type: string
|
type: string
|
||||||
balances:
|
balances:
|
||||||
@@ -945,8 +961,12 @@ components:
|
|||||||
for high-priority, high-value transactions.
|
for high-priority, high-value transactions.
|
||||||
|
|
||||||
|
|
||||||
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).'
|
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html)
|
||||||
|
|
||||||
|
|
||||||
|
.* **crossBorder**: High value transfer to receipt in a different country. '
|
||||||
enum:
|
enum:
|
||||||
|
- crossBorder
|
||||||
- directDebit
|
- directDebit
|
||||||
- fast
|
- fast
|
||||||
- instant
|
- instant
|
||||||
@@ -1094,8 +1114,11 @@ components:
|
|||||||
$ref: '#/components/schemas/TransferNotificationTransferTracking'
|
$ref: '#/components/schemas/TransferNotificationTransferTracking'
|
||||||
transactionId:
|
transactionId:
|
||||||
x-addedInVersion: '3'
|
x-addedInVersion: '3'
|
||||||
|
deprecated: true
|
||||||
|
x-deprecatedInVersion: '3'
|
||||||
|
x-deprecatedMessage: Use the [transactionId](https://docs.adyen.com/api-explorer/accounting-webhooks/latest/post/balancePlatform.transfer.created#request-data-events-transactionId)
|
||||||
|
in the `events` array instead.
|
||||||
description: The ID of the transaction that is created based on the transfer.
|
description: The ID of the transaction that is created based on the transfer.
|
||||||
Deprecated; use the transactionId in the events instead.
|
|
||||||
type: string
|
type: string
|
||||||
transactionRulesResult:
|
transactionRulesResult:
|
||||||
x-addedInVersion: '3'
|
x-addedInVersion: '3'
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ info:
|
|||||||
You can use these webhooks to build your implementation. For example, you can
|
You 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
|
use this information to update balances in your own dashboards or to keep track
|
||||||
of incoming funds.'
|
of incoming funds.'
|
||||||
x-timestamp: '2023-02-03T12:25:07Z'
|
x-timestamp: '2023-02-10T11:25:38Z'
|
||||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||||
contact:
|
contact:
|
||||||
name: Adyen Developer Experience team
|
name: Adyen Developer Experience team
|
||||||
@@ -905,7 +905,7 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
transactionRule:
|
transactionRule:
|
||||||
description: Contains information about the transaction rule.
|
description: Contains information about the transaction rule.
|
||||||
$ref: '#/components/schemas/ResourceReference'
|
$ref: '#/components/schemas/TransactionRuleReference'
|
||||||
transactionRuleSource:
|
transactionRuleSource:
|
||||||
description: Contains the type and ID of the resource to which the transaction
|
description: Contains the type and ID of the resource to which the transaction
|
||||||
rule is linked.
|
rule is linked.
|
||||||
@@ -1039,6 +1039,17 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
required:
|
required:
|
||||||
- counterparty
|
- counterparty
|
||||||
|
TransactionRuleReference:
|
||||||
|
properties:
|
||||||
|
description:
|
||||||
|
description: The description of the resource.
|
||||||
|
type: string
|
||||||
|
id:
|
||||||
|
description: The unique identifier of the resource.
|
||||||
|
type: string
|
||||||
|
reference:
|
||||||
|
description: The reference for the resource.
|
||||||
|
type: string
|
||||||
TransactionRuleSource:
|
TransactionRuleSource:
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
|
|||||||
1261
yaml/BalancePlatformTransferNotification-v3.yaml
Normal file
1261
yaml/BalancePlatformTransferNotification-v3.yaml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -23,7 +23,7 @@ info:
|
|||||||
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
|
```\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\
|
\ 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"
|
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v1`.\n\n"
|
||||||
x-timestamp: '2023-02-01T15:28:04Z'
|
x-timestamp: '2023-02-09T22:20:55Z'
|
||||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||||
contact:
|
contact:
|
||||||
name: Adyen Developer Experience team
|
name: Adyen Developer Experience team
|
||||||
@@ -63,6 +63,12 @@ paths:
|
|||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
|
- description: Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).
|
||||||
|
name: paymentInstrumentId
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
- description: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).
|
- description: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).
|
||||||
name: accountHolderId
|
name: accountHolderId
|
||||||
in: query
|
in: query
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ info:
|
|||||||
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
|
```\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\
|
\ 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"
|
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v2`.\n\n"
|
||||||
x-timestamp: '2023-02-01T15:28:04Z'
|
x-timestamp: '2023-02-09T22:20:55Z'
|
||||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||||
contact:
|
contact:
|
||||||
name: Adyen Developer Experience team
|
name: Adyen Developer Experience team
|
||||||
@@ -63,6 +63,12 @@ paths:
|
|||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
|
- description: Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).
|
||||||
|
name: paymentInstrumentId
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
- description: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).
|
- description: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).
|
||||||
name: accountHolderId
|
name: accountHolderId
|
||||||
in: query
|
in: query
|
||||||
@@ -350,8 +356,12 @@ components:
|
|||||||
for high-priority, high-value transactions.
|
for high-priority, high-value transactions.
|
||||||
|
|
||||||
|
|
||||||
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).'
|
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html)
|
||||||
|
|
||||||
|
|
||||||
|
.* **crossBorder**: High value transfer to receipt in a different country. '
|
||||||
enum:
|
enum:
|
||||||
|
- crossBorder
|
||||||
- directDebit
|
- directDebit
|
||||||
- fast
|
- fast
|
||||||
- instant
|
- instant
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ info:
|
|||||||
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
|
```\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\
|
\ credential for the live environment. You can then use the username and password\
|
||||||
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v3`.\n\n"
|
\ to send requests to `https://balanceplatform-api-live.adyen.com/btl/v3`.\n\n"
|
||||||
x-timestamp: '2023-02-01T15:28:04Z'
|
x-timestamp: '2023-02-09T22:20:55Z'
|
||||||
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
termsOfService: https://www.adyen.com/legal/terms-and-conditions
|
||||||
contact:
|
contact:
|
||||||
name: Adyen Developer Experience team
|
name: Adyen Developer Experience team
|
||||||
@@ -63,6 +63,12 @@ paths:
|
|||||||
required: false
|
required: false
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
|
- description: Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).
|
||||||
|
name: paymentInstrumentId
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
- description: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).
|
- description: Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).
|
||||||
name: accountHolderId
|
name: accountHolderId
|
||||||
in: query
|
in: query
|
||||||
@@ -1049,8 +1055,12 @@ components:
|
|||||||
for high-priority, high-value transactions.
|
for high-priority, high-value transactions.
|
||||||
|
|
||||||
|
|
||||||
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).'
|
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html)
|
||||||
|
|
||||||
|
|
||||||
|
.* **crossBorder**: High value transfer to receipt in a different country. '
|
||||||
enum:
|
enum:
|
||||||
|
- crossBorder
|
||||||
- directDebit
|
- directDebit
|
||||||
- fast
|
- fast
|
||||||
- instant
|
- instant
|
||||||
@@ -1225,8 +1235,12 @@ components:
|
|||||||
for high-priority, high-value transactions.
|
for high-priority, high-value transactions.
|
||||||
|
|
||||||
|
|
||||||
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).'
|
* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html)
|
||||||
|
|
||||||
|
|
||||||
|
.* **crossBorder**: High value transfer to receipt in a different country. '
|
||||||
enum:
|
enum:
|
||||||
|
- crossBorder
|
||||||
- directDebit
|
- directDebit
|
||||||
- fast
|
- fast
|
||||||
- instant
|
- instant
|
||||||
|
|||||||
Reference in New Issue
Block a user