jlengrand/adyen-postman
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-postman.git synced 2026-03-10 08:01:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ae7ebb43b0a0c3a80ef8e95290253afc9daf7ce0
adyen-postman/postman/TransferService-v4.json
AdyenAutomationBot ae7ebb43b0 Update latest definitions files
2024-08-26 09:20:23 +00:00

1228 lines
58 KiB
JSON
Raw Blame History

{
"info": {
"name": "Transfers API (v4)",
"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/v4/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/v4`.\n\n",
"type": "text/markdown"
},
"version": "4",
"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": "Returns all the transfers 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 transfers",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transfers",
"host": [
"{{baseUrl}}"
],
"path": [
"transfers"
],
"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": "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": "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": "reference",
"value": "reference_example",
"description": "The reference you provided in the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) request",
"disabled": true
},
{
"key": "category",
"value": "category_example",
"description": "The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: Transfer initiated by a Adyen-issued card. - **platformPayment**: Fund movements related to payments that are acquired for your users.",
"disabled": true
},
{
"key": "createdSince",
"value": "2013-10-20T19:20:30+01:00",
"description": "Only include transfers 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 transfers 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": "cursor",
"value": "cursor_example",
"description": "The `cursor` returned in the links of the previous response.",
"disabled": true
},
{
"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": "Returns all the transfers 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": "/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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.",
"item": [
{
"name": "Make a cross-border 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 \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\",\n \"address\": {\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"postalCode\": \"94678\",\n \"stateOrProvince\": \"CA\",\n \"line1\": \"274\",\n \"line2\": \"Brannan Street\"\n}\n},\n \"accountIdentification\": {\n \"type\": \"numberAndBic\",\n \"accountNumber\": \"123456789\",\n \"bic\": \"BOFAUS3NXXX\"\n}\n}\n},\n \"priority\": \"crossBorder\",\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
,"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 \"accountHolder\": {\n \"description\": \"Your account holder description\",\n \"id\": \"AH3227C223222C5GXQXF658WB\",\n \"reference\": \"Your account holder reference\"\n},\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"EUR\"\n},\n \"balanceAccount\": {\n \"description\": \"Your balance account description\",\n \"id\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\": \"Your balance account reference\"\n},\n \"category\": \"bank\",\n \"categoryData\": {\n \"priority\": \"crossBorder\",\n \"type\": \"bank\"\n},\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\",\n \"address\": {\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"postalCode\": \"94678\",\n \"stateOrProvince\": \"CA\",\n \"line1\": \"274\",\n \"line2\": \"Brannan Street\"\n}\n},\n \"accountIdentification\": {\n \"type\": \"numberAndBic\",\n \"accountNumber\": \"123456789\",\n \"bic\": \"BOFAUS3NXXX\"\n}\n}\n},\n \"paymentInstrument\": {\n \"description\": \"Your payment instrument description\",\n \"id\": \"PI3222G223222G59347DAA265\",\n \"reference\": \"Your payment instrument reference\"\n},\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\",\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 \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\",\n \"address\": {\n \"city\": \"San Francisco\",\n \"country\": \"US\",\n \"postalCode\": \"94678\",\n \"stateOrProvince\": \"CA\",\n \"line1\": \"274\",\n \"line2\": \"Brannan Street\"\n}\n},\n \"accountIdentification\": {\n \"type\": \"numberAndBic\",\n \"accountNumber\": \"123456789\",\n \"bic\": \"BOFAUS3NXXX\"\n}\n}\n},\n \"priority\": \"crossBorder\",\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
}
]
},
{
"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 \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\"\n},\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL91ABNA0417164300\"\n}\n}\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
,"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 \"accountHolder\": {\n \"description\": \"Your account holder description\",\n \"id\": \"AH3227C223222C5GXQXF658WB\",\n \"reference\": \"Your account holder reference\"\n},\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"EUR\"\n},\n \"balanceAccount\": {\n \"description\": \"Your balance account description\",\n \"id\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\": \"Your balance account reference\"\n},\n \"category\": \"bank\",\n \"categoryData\": {\n \"priority\": \"regular\",\n \"type\": \"bank\"\n},\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\"\n},\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL91ABNA0417164300\"\n}\n}\n},\n \"paymentInstrument\": {\n \"description\": \"Your payment instrument description\",\n \"id\": \"PI3222G223222G59347DAA265\",\n \"reference\": \"Your payment instrument reference\"\n},\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\",\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 \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\"\n},\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL91ABNA0417164300\"\n}\n}\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
}
]
},
{
"name": "Make a US local 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\": \"USD\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\"\n},\n \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"123456789\",\n \"routingNumber\": \"011000138\"\n}\n}\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
,"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 \"accountHolder\": {\n \"description\": \"Your account holder description\",\n \"id\": \"AH3227C223222C5GXQXF658WB\",\n \"reference\": \"Your account holder reference\"\n},\n \"amount\": {\n \"value\": 110000,\n \"currency\": \"USD\"\n},\n \"balanceAccount\": {\n \"description\": \"Your balance account description\",\n \"id\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\": \"Your balance account reference\"\n},\n \"category\": \"bank\",\n \"categoryData\": {\n \"priority\": \"regular\",\n \"type\": \"bank\"\n},\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\"\n},\n \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"123456789\",\n \"routingNumber\": \"011000138\"\n}\n}\n},\n \"paymentInstrument\": {\n \"description\": \"Your payment instrument description\",\n \"id\": \"PI3222G223222G59347DAA265\",\n \"reference\": \"Your payment instrument reference\"\n},\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\",\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\": \"USD\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountHolder\": {\n \"fullName\": \"A. Klaassen\"\n},\n \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"123456789\",\n \"routingNumber\": \"011000138\"\n}\n}\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
}
]
},
{
"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 \"amount\": {\n \"value\": 10000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"internal\",\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 for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
,"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 \"accountHolder\": {\n \"description\": \"Your account holder description\",\n \"id\": \"AH3227C223222C5GXQXF658WB\",\n \"reference\": \"Your account holder reference\"\n},\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 10000\n},\n \"balanceAccount\": {\n \"description\": \"Your balance account description\",\n \"id\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\": \"Your balance account reference\"\n},\n \"category\": \"internal\",\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 for the transfer\",\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\": 10000,\n \"currency\": \"EUR\"\n},\n \"balanceAccountId\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"category\": \"internal\",\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 for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
}
]
},
{
"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 \"category\": \"bank\",\n \"counterparty\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
,"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 \"accountHolder\": {\n \"description\": \"Your account holder description\",\n \"id\": \"AH3227C223222C5GXQXF658WB\",\n \"reference\": \"Your account holder reference\"\n},\n \"amount\": {\n \"value\": 80000,\n \"currency\": \"EUR\"\n},\n \"balanceAccount\": {\n \"description\": \"Your balance account description\",\n \"id\": \"BAB8B2C3D4E5F6G7H8D9J6GD4\",\n \"reference\": \"Your balance account reference\"\n},\n \"category\": \"bank\",\n \"categoryData\": {\n \"priority\": \"regular\",\n \"type\": \"bank\"\n},\n \"counterparty\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"paymentInstrument\": {\n \"description\": \"Your payment instrument description\",\n \"id\": \"PI3222G223222G59347DAA265\",\n \"reference\": \"Your payment instrument reference\"\n},\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\",\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 \"category\": \"bank\",\n \"counterparty\": {\n \"transferInstrumentId\": \"SE1234567890ABC1234567890\"\n},\n \"priority\": \"regular\",\n \"referenceForBeneficiary\": \"Your-reference-sent-to-the-beneficiary\",\n \"reference\": \"Your internal reference for the transfer\",\n \"description\": \"Your description for the transfer\"\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), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you."
}
}
]
}
]
},
{
"name": "/transfers/:id",
"description": "Returns a transfer.",
"item": [
{
"name": "Get a transfer",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transfers/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"transfers",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "Unique identifier of the transfer."
}
],
"query": [
]
},
"description": "Returns a transfer."
}
,"response": [
]
}
]
},
{
"name": "/transfers/:transferId/returns",
"description": "Initiates the return of previously transferred funds without creating a new `transferId`.",
"item": [
{
"name": "Return an incoming internal transfer",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"value\": 189,\n \"currency\": \"EUR\"\n},\n \"reference\": \"Your internal reference for the return\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transfers/:transferId/returns",
"host": [
"{{baseUrl}}"
],
"path": [
"transfers",
":transferId",
"returns"
],
"variable": [
{
"key": "transferId",
"value": "",
"description": "The unique identifier of the transfer to be returned."
}
],
"query": [
]
},
"description": "Initiates the return of previously transferred funds without creating a new `transferId`."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"id\": \"1W1UG35QQEBJLHZ8\",\n \"reference\": \"Your internal reference for the return\",\n \"status\": \"Authorised\",\n \"transferId\": \"1W1UG35U8A9J5ZLG\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": {\n \"value\": 189,\n \"currency\": \"EUR\"\n},\n \"reference\": \"Your internal reference for the return\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transfers/:transferId/returns",
"host": [
"{{baseUrl}}"
],
"path": [
"transfers",
":transferId",
"returns"
],
"variable": [
{
"key": "transferId",
"value": "",
"description": "The unique identifier of the transfer to be returned."
}
],
"query": [
]
},
"description": "Initiates the return of previously transferred funds without creating a new `transferId`."
}
}
]
}
]
}
]
},
{
"name": "Capital",
"item": [
{
"name": "/grants",
"description": "Returns a list of grants with status and outstanding balances.",
"item": [
{
"name": "Get a capital account",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/grants",
"host": [
"{{baseUrl}}"
],
"path": [
"grants"
],
"variable": [
],
"query": [
{
"key": "counterpartyAccountHolderId",
"value": "counterpartyAccountHolderId_example",
"description": "The counterparty account holder id.",
"disabled": true
}
]
},
"description": "Returns a list of grants with status and outstanding balances."
}
,"response": [
]
}
]
},
{
"name": "/grants",
"description": "Requests the payout of the selected grant offer.",
"item": [
{
"name": "Request grant payout to a balance account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"grantAccountId\": \"CG00000000000000000000001\",\n \"grantOfferId\": \"0000000000000001\",\n \"counterparty\": {\n \"accountHolderId\": \"AH00000000000000000000001\",\n \"balanceAccountId\": \"BA00000000000000000000001\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/grants",
"host": [
"{{baseUrl}}"
],
"path": [
"grants"
],
"variable": [
],
"query": [
]
},
"description": "Requests the payout of the selected grant offer."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"id\": \"GR00000000000000000000001\",\n \"grantAccountId\": \"CG00000000000000000000001\",\n \"grantOfferId\": \"0000000000000001\",\n \"counterparty\": {\n \"accountHolderId\": \"AH00000000000000000000001\",\n \"balanceAccountId\": \"BA00000000000000000000001\"\n},\n \"amount\": {\n \"currency\": \"EUR\",\n \"value\": 1000000\n},\n \"fee\": {\n \"amount\": {\n \"value\": 120000,\n \"currency\": \"EUR\"\n}\n},\n \"balances\": {\n \"currency\": \"EUR\",\n \"fee\": 120000,\n \"principal\": 1000000,\n \"total\": 1120000\n},\n \"repayment\": {\n \"basisPoints\": 1400\n},\n \"status\": \"Pending\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"grantAccountId\": \"CG00000000000000000000001\",\n \"grantOfferId\": \"0000000000000001\",\n \"counterparty\": {\n \"accountHolderId\": \"AH00000000000000000000001\",\n \"balanceAccountId\": \"BA00000000000000000000001\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/grants",
"host": [
"{{baseUrl}}"
],
"path": [
"grants"
],
"variable": [
],
"query": [
]
},
"description": "Requests the payout of the selected grant offer."
}
}
]
}
]
},
{
"name": "/grants/:id",
"description": "Returns the details of a capital account specified in the path.",
"item": [
{
"name": "Get grant reference details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/grants/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"grants",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the grant."
}
],
"query": [
]
},
"description": "Returns the details of a capital account specified in the path."
}
,"response": [
]
}
]
}
]
}
],
"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/v4",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
},
{
"key": "clientKey",
"value": "",
"type": "string"
}
]
}
Reference in New Issue View Git Blame Copy Permalink