mirror of
https://github.com/gcatanese/adyen-postman.git
synced 2026-03-10 08:01:18 +00:00
303 lines
20 KiB
JSON
303 lines
20 KiB
JSON
{
|
|
"info": {
|
|
"name": "Transfers API (v2)",
|
|
"description": {
|
|
"content": "This API provides endpoints that you can use to transfer funds, whether when [paying out to a transfer instrument](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/on-demand-payouts), [sending funds to third parties](https://docs.adyen.com/marketplaces-and-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/marketplaces-and-platforms/capital). The API also supports use cases for [getting transactions for business bank accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts/transactions-api) and getting [grants and its outstanding balances](https://docs.adyen.com/marketplaces-and-platforms/capital#get-balances). .\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",
|
|
"type": "text/markdown"
|
|
},
|
|
"version": "2",
|
|
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
|
|
},
|
|
"item": [
|
|
{
|
|
"name": "Transactions",
|
|
"item": [
|
|
{
|
|
"name": "/transactions",
|
|
"description": "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable. Provide either `balanceAccountId`, `accountHolderId`, or `balancePlatform` when using this endpoint.",
|
|
"item": [
|
|
{
|
|
"name": "Get all transactions",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"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"
|
|
},
|
|
{
|
|
"key": "paymentInstrumentId",
|
|
"value": "paymentInstrumentId_example"
|
|
},
|
|
{
|
|
"key": "accountHolderId",
|
|
"value": "accountHolderId_example"
|
|
},
|
|
{
|
|
"key": "balanceAccountId",
|
|
"value": "balanceAccountId_example"
|
|
},
|
|
{
|
|
"key": "cursor",
|
|
"value": "cursor_example"
|
|
},
|
|
{
|
|
"key": "createdSince",
|
|
"value": "2013-10-20T19:20:30+01:00"
|
|
},
|
|
{
|
|
"key": "createdUntil",
|
|
"value": "2013-10-20T19:20:30+01:00"
|
|
},
|
|
{
|
|
"key": "limit",
|
|
"value": "56"
|
|
}
|
|
]
|
|
},
|
|
"description": "Returns all transactions related to a balance account with a payment instrument of type **bankAccount**. This endpoint supports cursor-based pagination. The response returns the first page of results, and returns links to the next page when applicable. You can use the links to page through the results. The response also returns links to the previous page when applicable. Provide either `balanceAccountId`, `accountHolderId`, or `balancePlatform` when using this endpoint."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "/transactions/{id}",
|
|
"description": "Returns a transaction.",
|
|
"item": [
|
|
{
|
|
"name": "Get a transaction",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"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": "Unique identifier of the transaction."
|
|
}
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": "Returns a transaction."
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "Transfers",
|
|
"item": [
|
|
{
|
|
"name": "/transfers",
|
|
"description": "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 SEPA funds transfer",
|
|
"request": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"disabled": false
|
|
}
|
|
],
|
|
"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": "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",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"disabled": false
|
|
}
|
|
],
|
|
"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": "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",
|
|
"disabled": false
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json",
|
|
"disabled": false
|
|
}
|
|
],
|
|
"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": "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."
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"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"
|
|
}
|
|
]
|
|
}
|
|
|