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
ed800bf99e55fced24926419b1a3fb8bd7acdd3e
adyen-postman/postman/TransferService-v3.json
AdyenAutomationBot ed800bf99e Update latest definitions files
2023-10-27 12:05:26 +00:00

610 lines
39 KiB
JSON
Raw Blame History

{
"info": {
"name": "Transfers API (v3)",
"description": {
"content": ">Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version.\n\nThis 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/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",
"type": "text/markdown"
},
"version": "3",
"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",
"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": ">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. "
}
}
]
},
{
"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",
"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."
}
}
]
}
]
},
{
"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), 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",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
},
{
"key": "WWW-Authenticate",
"value": "",
"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",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
},
{
"key": "WWW-Authenticate",
"value": "",
"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",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
},
{
"key": "WWW-Authenticate",
"value": "",
"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",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
},
{
"key": "WWW-Authenticate",
"value": "",
"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",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"disabled": false
},
{
"key": "WWW-Authenticate",
"value": "",
"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/:transferId/returns",
"description": "Returns previously transferred funds without creating a new `transferId`.",
"item": [
{
"name": "Return a 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\": \"<string>\",\n \"reference\": \"<string>\"\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": "Returns 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",
"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": "Returns a list of grants with status and outstanding balances."
}
}
]
},
{
"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",
"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."
}
}
]
},
{
"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",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"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."
}
}
]
}
]
}
],
"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/v3",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
}
]
}
Reference in New Issue View Git Blame Copy Permalink