mirror of
https://github.com/gcatanese/adyen-postman.git
synced 2026-03-10 08:01:18 +00:00
531 lines
29 KiB
JSON
531 lines
29 KiB
JSON
{
|
|
"info": {
|
|
"name": "Transfers API (v2)",
|
|
"description": {
|
|
"content": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version.\n\nThe Transfers API provides endpoints that you can use to transfer funds, whether when paying out to a transfer instrument for [marketplaces](https://docs.adyen.com/marketplaces/payout-to-users/on-demand-payouts) or [platforms](https://docs.adyen.com/platforms/payout-to-users/on-demand-payouts), [sending funds to third parties](https://docs.adyen.com/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/platforms/capital). The API also supports use cases for [getting transactions for business bank accounts](https://docs.adyen.com/platforms/business-accounts/transactions-api) and getting [outstanding balances](https://docs.adyen.com/platforms/capital#get-balances) for one or more grants on your platform. \n\n## Authentication\nEach request to the Transfers API must be signed with an API key. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\nIf you have an Adyen Issuing integration,[generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo 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\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, generate an API key in your [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/) if you have an Adyen Issuing integration.You can then use the API key to send requests to `https://balanceplatform-api-live.adyen.com/btl/v2`.\n\n",
|
|
"type": "text/markdown"
|
|
},
|
|
"version": "2",
|
|
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
|
|
},
|
|
"item": [
|
|
{
|
|
"name": "Transactions",
|
|
"item": [
|
|
{
|
|
"name": "/transactions",
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. ",
|
|
"item": [
|
|
{
|
|
"name": "Get all transactions",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transactions",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transactions"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
{
|
|
"key": "balancePlatform",
|
|
"value": "balancePlatform_example",
|
|
"description": "The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `accountHolderId`.",
|
|
"disabled": true
|
|
},
|
|
{
|
|
"key": "paymentInstrumentId",
|
|
"value": "paymentInstrumentId_example",
|
|
"description": "The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_). To use this parameter, you must also provide a `balanceAccountId`, `accountHolderId`, or `balancePlatform`. The `paymentInstrumentId` must be related to the `balanceAccountId` or `accountHolderId` that you provide.",
|
|
"disabled": true
|
|
},
|
|
{
|
|
"key": "accountHolderId",
|
|
"value": "accountHolderId_example",
|
|
"description": "The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id). Required if you don't provide a `balanceAccountId` or `balancePlatform`. If you provide a `balanceAccountId`, the `accountHolderId` must be related to the `balanceAccountId`.",
|
|
"disabled": true
|
|
},
|
|
{
|
|
"key": "balanceAccountId",
|
|
"value": "balanceAccountId_example",
|
|
"description": "The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id). Required if you don't provide an `accountHolderId` or `balancePlatform`. If you provide an `accountHolderId`, the `balanceAccountId` must be related to the `accountHolderId`.",
|
|
"disabled": true
|
|
},
|
|
{
|
|
"key": "cursor",
|
|
"value": "cursor_example",
|
|
"description": "The `cursor` returned in the links of the previous response.",
|
|
"disabled": true
|
|
},
|
|
{
|
|
"key": "createdSince",
|
|
"value": "2013-10-20T19:20:30+01:00",
|
|
"description": "Only include transactions that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "createdUntil",
|
|
"value": "2013-10-20T19:20:30+01:00",
|
|
"description": "Only include transactions that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "limit",
|
|
"value": "56",
|
|
"description": "The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.",
|
|
"disabled": true
|
|
}
|
|
]
|
|
},
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns all the transactions related to a balance account, account holder, or balance platform. When making this request, you must include at least one of the following: - `balanceAccountId` - `accountHolderId` - `balancePlatform`. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next and previous pages when applicable. You can use the links to page through the results. "
|
|
}
|
|
,"response": [
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "/transactions/:id",
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns a transaction.",
|
|
"item": [
|
|
{
|
|
"name": "Get a transaction",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transactions/:id",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transactions",
|
|
":id"
|
|
],
|
|
"variable": [
|
|
{
|
|
"key": "id",
|
|
"value": "",
|
|
"description": "The unique identifier of the transaction."
|
|
}
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Returns a transaction."
|
|
}
|
|
,"response": [
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "Transfers",
|
|
"item": [
|
|
{
|
|
"name": "/transfers",
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to: - [Balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts) - [Transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) - [Third-party bank accounts](https://docs.adyen.com/payouts/payout-service/pay-out-to-bank-accounts) - [Third-party cards](https://docs.adyen.com/payouts/payout-service/pay-out-to-cards) Adyen sends the outcome of the transfer request through webhooks. To use this endpoint: - Your API credential must have the **TransferService Webservice Initiate** [role](https://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3). - The account holder must have the required [capabilities](https://docs.adyen.com/platforms/verification-overview/capabilities). Reach out to your Adyen contact to set up these permissions.",
|
|
"item": [
|
|
{
|
|
"name": "Make a SEPA funds transfer",
|
|
"request": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "WWW-Authenticate",
|
|
"value": "",
|
|
"description": "Header for authenticating through SCA",
|
|
"disabled": true
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"bankAccount\": {\n \"iban\": \"NL13TEST0123456789\",\n \"ownerName\": {\n \"fullName\": \"A. Klaassen\"\n}\n}\n},\n \"bank\": {\n \"priority\": \"regular\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transfers",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transfers"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to: - [Balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts) - [Transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) - [Third-party bank accounts](https://docs.adyen.com/payouts/payout-service/pay-out-to-bank-accounts) - [Third-party cards](https://docs.adyen.com/payouts/payout-service/pay-out-to-cards) Adyen sends the outcome of the transfer request through webhooks. To use this endpoint: - Your API credential must have the **TransferService Webservice Initiate** [role](https://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3). - The account holder must have the required [capabilities](https://docs.adyen.com/platforms/verification-overview/capabilities). Reach out to your Adyen contact to set up these permissions."
|
|
}
|
|
,"response": [
|
|
{"name": "Accepted - the request has been accepted for processing, but the processing has not been completed.",
|
|
"code": 202,
|
|
"status": "Accepted",
|
|
"header": [{
|
|
"key": "Content-Type",
|
|
"value": "application/json"}
|
|
],
|
|
"_postman_previewlanguage": "json",
|
|
"cookie": [],
|
|
"body" : "{\n \"id\": \"1W1UG35U8A9J5ZLG\",\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"bankAccount\": {\n \"iban\": \"NL13TEST0123456789\",\n \"ownerName\": {\n \"fullName\": \"A. Klaassen\"\n}\n}\n},\n \"bank\": {\n \"priority\": \"regular\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\",\n \"direction\": \"outgoing\",\n \"reason\": \"approved\",\n \"status\": \"authorised\"\n}",
|
|
"originalRequest": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "WWW-Authenticate",
|
|
"value": "",
|
|
"description": "Header for authenticating through SCA",
|
|
"disabled": true
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"bankAccount\": {\n \"iban\": \"NL13TEST0123456789\",\n \"ownerName\": {\n \"fullName\": \"A. Klaassen\"\n}\n}\n},\n \"bank\": {\n \"priority\": \"regular\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transfers",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transfers"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to: - [Balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts) - [Transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) - [Third-party bank accounts](https://docs.adyen.com/payouts/payout-service/pay-out-to-bank-accounts) - [Third-party cards](https://docs.adyen.com/payouts/payout-service/pay-out-to-cards) Adyen sends the outcome of the transfer request through webhooks. To use this endpoint: - Your API credential must have the **TransferService Webservice Initiate** [role](https://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3). - The account holder must have the required [capabilities](https://docs.adyen.com/platforms/verification-overview/capabilities). Reach out to your Adyen contact to set up these permissions."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "Transfer funds to another balance account",
|
|
"request": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "WWW-Authenticate",
|
|
"value": "",
|
|
"description": "Header for authenticating through SCA",
|
|
"disabled": true
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"balanceAccountId\": \"BAB1234567890ABC123456789\"\n},\n \"amount\": {\n \"value\": 10000,\n \"currency\": \"EUR\"\n},\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transfers",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transfers"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to: - [Balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts) - [Transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) - [Third-party bank accounts](https://docs.adyen.com/payouts/payout-service/pay-out-to-bank-accounts) - [Third-party cards](https://docs.adyen.com/payouts/payout-service/pay-out-to-cards) Adyen sends the outcome of the transfer request through webhooks. To use this endpoint: - Your API credential must have the **TransferService Webservice Initiate** [role](https://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3). - The account holder must have the required [capabilities](https://docs.adyen.com/platforms/verification-overview/capabilities). Reach out to your Adyen contact to set up these permissions."
|
|
}
|
|
,"response": [
|
|
{"name": "Accepted - the request has been accepted for processing, but the processing has not been completed.",
|
|
"code": 202,
|
|
"status": "Accepted",
|
|
"header": [{
|
|
"key": "Content-Type",
|
|
"value": "application/json"}
|
|
],
|
|
"_postman_previewlanguage": "json",
|
|
"cookie": [],
|
|
"body" : "{\n \"id\": \"1W1UG35U8A9J5ZLG\",\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 10000\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"balanceAccountId\": \"BA32272223222B5LPRFDW7J9G\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\",\n \"direction\": \"outgoing\",\n \"reason\": \"approved\",\n \"status\": \"authorised\"\n}",
|
|
"originalRequest": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "WWW-Authenticate",
|
|
"value": "",
|
|
"description": "Header for authenticating through SCA",
|
|
"disabled": true
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"balanceAccountId\": \"BAB1234567890ABC123456789\"\n},\n \"amount\": {\n \"value\": 10000,\n \"currency\": \"EUR\"\n},\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transfers",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transfers"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to: - [Balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts) - [Transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) - [Third-party bank accounts](https://docs.adyen.com/payouts/payout-service/pay-out-to-bank-accounts) - [Third-party cards](https://docs.adyen.com/payouts/payout-service/pay-out-to-cards) Adyen sends the outcome of the transfer request through webhooks. To use this endpoint: - Your API credential must have the **TransferService Webservice Initiate** [role](https://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3). - The account holder must have the required [capabilities](https://docs.adyen.com/platforms/verification-overview/capabilities). Reach out to your Adyen contact to set up these permissions."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "Pay out to a transfer instrument",
|
|
"request": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "WWW-Authenticate",
|
|
"value": "",
|
|
"description": "Header for authenticating through SCA",
|
|
"disabled": true
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"amount\": {\n \"value\": 80000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"bank\": {\n \"priority\": \"regular\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transfers",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transfers"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to: - [Balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts) - [Transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) - [Third-party bank accounts](https://docs.adyen.com/payouts/payout-service/pay-out-to-bank-accounts) - [Third-party cards](https://docs.adyen.com/payouts/payout-service/pay-out-to-cards) Adyen sends the outcome of the transfer request through webhooks. To use this endpoint: - Your API credential must have the **TransferService Webservice Initiate** [role](https://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3). - The account holder must have the required [capabilities](https://docs.adyen.com/platforms/verification-overview/capabilities). Reach out to your Adyen contact to set up these permissions."
|
|
}
|
|
,"response": [
|
|
{"name": "Accepted - the request has been accepted for processing, but the processing has not been completed.",
|
|
"code": 202,
|
|
"status": "Accepted",
|
|
"header": [{
|
|
"key": "Content-Type",
|
|
"value": "application/json"}
|
|
],
|
|
"_postman_previewlanguage": "json",
|
|
"cookie": [],
|
|
"body" : "{\n \"id\": \"1W1UG35U8A9J5ZLG\",\n \"amount\": {\n \"value\": 80000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"bank\": {\n \"priority\": \"regular\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\",\n \"direction\": \"outgoing\",\n \"reason\": \"approved\",\n \"status\": \"authorised\"\n}",
|
|
"originalRequest": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"description": "",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "WWW-Authenticate",
|
|
"value": "",
|
|
"description": "Header for authenticating through SCA",
|
|
"disabled": true
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"amount\": {\n \"value\": 80000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"counterparty\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"bank\": {\n \"priority\": \"regular\"\n},\n \"referenceForBeneficiary\": \"Your reference sent to the beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transfers",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transfers"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to: - [Balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts) - [Transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) - [Third-party bank accounts](https://docs.adyen.com/payouts/payout-service/pay-out-to-bank-accounts) - [Third-party cards](https://docs.adyen.com/payouts/payout-service/pay-out-to-cards) Adyen sends the outcome of the transfer request through webhooks. To use this endpoint: - Your API credential must have the **TransferService Webservice Initiate** [role](https://docs.adyen.com/platforms/manage-access/webservice-roles/?tab=transfers_3). - The account holder must have the required [capabilities](https://docs.adyen.com/platforms/verification-overview/capabilities). Reach out to your Adyen contact to set up these permissions."
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"auth": {
|
|
"type": "apikey",
|
|
"apikey": [
|
|
{
|
|
"key": "value",
|
|
"value": "{{X-API-Key}}",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"key": "key",
|
|
"value": "X-API-Key",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"variable": [
|
|
{
|
|
"key": "baseUrl",
|
|
"value": "https://balanceplatform-api-test.adyen.com/btl/v2",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"key": "X-API-Key",
|
|
"value": "",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"key": "clientKey",
|
|
"value": "",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
|