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
f2f067f0935d237fcd6bd05ed81602722bdbc06e
adyen-postman/postman/BalancePlatformService-v1.json
gcatanese 61847e74bb Update latest definitions files
2024-03-28 08:16:48 +00:00

3490 lines
120 KiB
JSON
Raw Blame History

{
"info": {
"name": "Configuration API (v1)",
"description": {
"content": "The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts.\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## Versioning\nThe Configuration 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/bcl/v1/accountHolders\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v1`.",
"type": "text/markdown"
},
"version": "1",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Legal entities",
"item": [
{
"name": "/legalEntities",
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. ",
"item": [
{
"name": "Create a legal entity for an individual residing in the Netherlands",
"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 \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"query": [
]
},
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"individual\": {\n \"email\": \"s.eller@example.com\",\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n}\n},\n \"type\": \"individual\",\n \"id\": \"LE322JV223222D5GG42KN6869\"\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 \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"query": [
]
},
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. "
}
}
]
},
{
"name": "Create a legal entity for an individual residing in the US",
"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 \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n},\n \"phone\": {\n \"number\": \"+14153671502\",\n \"type\": \"mobile\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"query": [
]
},
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"individual\": {\n \"email\": \"s.eller@example.com\",\n \"phone\": {\n \"number\": \"+14153671502\",\n \"type\": \"mobile\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"residentialAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n},\n \"type\": \"individual\",\n \"id\": \"LE322JV223222D5GGMHPC2FPL\"\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 \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n},\n \"phone\": {\n \"number\": \"+14153671502\",\n \"type\": \"mobile\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"query": [
]
},
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. "
}
}
]
},
{
"name": "Create a legal entity for a Dutch organization",
"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 \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in NL\",\n \"doingBusinessAs\": \"API Company Trading\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"34179503\",\n \"email\": \"organization@example.com\"\n},\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"type\": \"signatory\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"query": [
]
},
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"organization\": {\n \"legalName\": \"Explorer Company based in NL\",\n \"doingBusinessAs\": \"API Company Trading\",\n \"registrationNumber\": \"34179503\",\n \"email\": \"organization@example.com\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"taxExempt\": false,\n \"type\": \"privateCompany\"\n},\n \"type\": \"organization\",\n \"id\": \"LE322JV223222D5FZ9N74BSGM\"\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 \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in NL\",\n \"doingBusinessAs\": \"API Company Trading\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"34179503\",\n \"email\": \"organization@example.com\"\n},\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"type\": \"signatory\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"query": [
]
},
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. "
}
}
]
},
{
"name": "Create a legal entity for an organization in the US",
"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 \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in US\",\n \"registrationNumber\": \"101002749\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"query": [
]
},
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"organization\": {\n \"legalName\": \"Explorer Company based in US\",\n \"registrationNumber\": \"101002749\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n},\n \"taxExempt\": false,\n \"type\": \"privateCompany\"\n},\n \"type\": \"organization\",\n \"id\": \"LE322JV223222D5FZ9N74BSGM\"\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 \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in US\",\n \"registrationNumber\": \"101002749\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"query": [
]
},
"description": "Creates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. "
}
}
]
}
]
},
{
"name": "/legalEntities/:id",
"description": "Returns a legal entity.",
"item": [
{
"name": "Get a legal entity",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Returns a legal entity."
}
,"response": [
]
}
]
},
{
"name": "/legalEntities/:id",
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.",
"item": [
{
"name": "Change a legal entity from an organization to an individual",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"individual\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"individual\": {\n \"name\": {\n \"firstName\": \"Explorer\",\n \"lastName\": \"Company based in US\"\n},\n \"residentialAddress\": {\n \"country\": \"US\"\n}\n},\n \"type\": \"individual\",\n \"id\": \"LE322JV223222J5HD8HZS2C8B\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"individual\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
}
]
},
{
"name": "Add entity associations to an organization",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322KH223222F5GV2SL953Z3\",\n \"type\": \"uboThroughControl\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"entityAssociations\": [{\n \"associatorId\": \"LE322KH223222F5GVGNMJ3XC5\",\n \"entityType\": \"individual\",\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322KH223222F5GV2SL953Z3\",\n \"name\": \"Simone Hopper\",\n \"type\": \"uboThroughControl\"\n}],\n \"organization\": {\n \"email\": \"john.doe@adyen.com\",\n \"phone\": {\n \"countryCode\": \"NL\",\n \"number\": \"646467363\",\n \"type\": \"mobile\"\n},\n \"description\": \"FinTech\",\n \"doingBusinessAs\": \"Adyen BV\",\n \"legalName\": \"Adyen BV\",\n \"registeredAddress\": {\n \"city\": \"AMS\",\n \"country\": \"NL\",\n \"postalCode\": \"1234EE\",\n \"stateOrProvince\": \"NH\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"\",\n \"stockData\": {\n \"marketIdentifier\": \"ADYN\",\n \"stockNumber\": \"NL012345ABC4\",\n \"tickerSymbol\": \"ADYN.M\"\n},\n \"taxExempt\": \"false\",\n \"type\": \"listedPublicCompany\"\n},\n \"type\": \"organization\",\n \"id\": \"LE322KH223222F5GVGNMJ3XC5\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE322KH223222F5GV2SL953Z3\",\n \"type\": \"uboThroughControl\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
}
]
}
]
}
]
},
{
"name": "Platform",
"item": [
{
"name": "/balancePlatforms/:id",
"description": "Returns a balance platform.",
"item": [
{
"name": "Get a balance platform",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balancePlatforms/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"balancePlatforms",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the balance platform."
}
],
"query": [
]
},
"description": "Returns a balance platform."
}
,"response": [
]
}
]
},
{
"name": "/balancePlatforms/:id/accountHolders",
"description": "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.",
"item": [
{
"name": "Get all account holders under a balance platform",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balancePlatforms/:id/accountHolders",
"host": [
"{{baseUrl}}"
],
"path": [
"balancePlatforms",
":id",
"accountHolders"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the balance platform."
}
],
"query": [
{
"key": "offset",
"value": "56",
"description": "The number of items that you want to skip.",
"disabled": true
},
{
"key": "limit",
"value": "56",
"description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.",
"disabled": true
}
]
},
"description": "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`."
}
,"response": [
]
}
]
}
]
},
{
"name": "Payment instrument groups",
"item": [
{
"name": "/paymentInstrumentGroups",
"description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.",
"item": [
{
"name": "Create a payment instrument group",
"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 \"balancePlatform\": \"{{YOUR_BALANCE_PLATFORM}}\",\n \"txVariant\": \"mc\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstrumentGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstrumentGroups"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group."
}
,"response": [
]
}
]
},
{
"name": "/paymentInstrumentGroups/:id",
"description": "Returns the details of a payment instrument group.",
"item": [
{
"name": "Get a payment instrument group",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstrumentGroups/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstrumentGroups",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument group."
}
],
"query": [
]
},
"description": "Returns the details of a payment instrument group."
}
,"response": [
]
}
]
},
{
"name": "/paymentInstrumentGroups/:id/transactionRules",
"description": "Returns a list of all the transaction rules associated with a payment instrument group.",
"item": [
{
"name": "Get all transaction rules for a payment instrument group",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstrumentGroups/:id/transactionRules",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstrumentGroups",
":id",
"transactionRules"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument group."
}
],
"query": [
]
},
"description": "Returns a list of all the transaction rules associated with a payment instrument group."
}
,"response": [
]
}
]
}
]
},
{
"name": "Documents",
"item": [
{
"name": "/documents",
"description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. ",
"item": [
{
"name": "Upload a document",
"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 \"type\": \"registrationDocument\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n}],\n \"description\": \"Registration doc for Example Company\",\n \"owner\": {\n \"id\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"legalEntity\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents",
"host": [
"{{baseUrl}}"
],
"path": [
"documents"
],
"variable": [
],
"query": [
]
},
"description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"type\": \"registrationDocument\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n}],\n \"description\": \"Registration doc for Example Company\",\n \"fileName\": \"Registration doc for Example Company\",\n \"owner\": {\n \"id\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"legalEntity\"\n},\n \"id\": \"SE322JV223222F5GV2N9L8GDK\"\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 \"type\": \"registrationDocument\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC...==\"\n}],\n \"description\": \"Registration doc for Example Company\",\n \"owner\": {\n \"id\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"legalEntity\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents",
"host": [
"{{baseUrl}}"
],
"path": [
"documents"
],
"variable": [
],
"query": [
]
},
"description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. "
}
}
]
}
]
},
{
"name": "/documents/:id",
"description": "Deletes a document.",
"item": [
{
"name": "Delete a document",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the document to be deleted."
}
],
"query": [
]
},
"description": "Deletes a document."
}
,"response": [
]
}
]
},
{
"name": "/documents/:id",
"description": "Returns a document.",
"item": [
{
"name": "Get a document",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the document."
}
],
"query": [
]
},
"description": "Returns a document."
}
,"response": [
]
}
]
},
{
"name": "/documents/:id",
"description": "Updates a document.",
"item": [
{
"name": "Update a document",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"proofOfIndustry\",\n \"description\": \"Proof of industry doc for Example Company\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the document to be updated."
}
],
"query": [
]
},
"description": "Updates a document."
}
,"response": [
]
}
]
}
]
},
{
"name": "Account holders",
"item": [
{
"name": "/accountHolders",
"description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). ",
"item": [
{
"name": "Create an account holder",
"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 \"description\": \"Liable account holder used for international payments and payouts\",\n \"reference\": \"S.Eller-001\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/accountHolders",
"host": [
"{{baseUrl}}"
],
"path": [
"accountHolders"
],
"variable": [
],
"query": [
]
},
"description": "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). "
}
,"response": [
]
}
]
},
{
"name": "/accountHolders/:id",
"description": "Returns an account holder.",
"item": [
{
"name": "Get an account holder",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/accountHolders/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"accountHolders",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the account holder."
}
],
"query": [
]
},
"description": "Returns an account holder."
}
,"response": [
]
}
]
},
{
"name": "/accountHolders/:id",
"description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.",
"item": [
{
"name": "Request account holder capability",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Liable account holder used for international payments and payouts\",\n \"reference\": \"S.Eller-001\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"capabilities\": {\n \"receivePayments\": {\n \"requested\": true\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/accountHolders/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"accountHolders",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the account holder."
}
],
"query": [
]
},
"description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balancePlatform\": \"APIExplorer\",\n \"description\": \"Liable account holder used for international payments and payouts\",\n \"legalEntityId\": \"LE322JV223222F5GKQZZ9DS99\",\n \"reference\": \"S.Eller-001\",\n \"capabilities\": {\n \"receivePayments\": {\n \"enabled\": false,\n \"requested\": true,\n \"allowed\": false,\n \"verificationStatus\": \"pending\"\n}\n},\n \"id\": \"AH3227C223222C5GKR23686TF\",\n \"status\": \"Active\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Liable account holder used for international payments and payouts\",\n \"reference\": \"S.Eller-001\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"capabilities\": {\n \"receivePayments\": {\n \"requested\": true\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/accountHolders/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"accountHolders",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the account holder."
}
],
"query": [
]
},
"description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged."
}
}
]
},
{
"name": "Deactivate account holder",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"Closed\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/accountHolders/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"accountHolders",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the account holder."
}
],
"query": [
]
},
"description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balancePlatform\": \"APIExplorer\",\n \"description\": \"Liable account holder used for international payments and payouts\",\n \"legalEntityId\": \"LE322JV223222F5GKQZZ9DS99\",\n \"reference\": \"S.Eller-001\",\n \"id\": \"AH3227C223222C5GKR23686TF\",\n \"status\": \"Closed\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"Closed\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/accountHolders/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"accountHolders",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the account holder."
}
],
"query": [
]
},
"description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged."
}
}
]
}
]
},
{
"name": "/accountHolders/:id/balanceAccounts",
"description": "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.",
"item": [
{
"name": "Get all balance accounts of an account holder",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/accountHolders/:id/balanceAccounts",
"host": [
"{{baseUrl}}"
],
"path": [
"accountHolders",
":id",
"balanceAccounts"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the account holder."
}
],
"query": [
{
"key": "offset",
"value": "56",
"description": "The number of items that you want to skip.",
"disabled": true
},
{
"key": "limit",
"value": "56",
"description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.",
"disabled": true
}
]
},
"description": "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`."
}
,"response": [
]
}
]
}
]
},
{
"name": "Payment instruments",
"item": [
{
"name": "/paymentInstruments",
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts).",
"item": [
{
"name": "Create a business account in NL",
"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 \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"NL\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"NL\",\n \"status\": \"Active\",\n \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"bankAccount\": {\n \"iban\": \"NL20ADYB2017000035\"\n},\n \"id\": \"PI322LJ223222B5DJS7CD9LWL\"\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 \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"NL\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
}
}
]
},
{
"name": "Create a business account in the US",
"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 \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"US\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"US\",\n \"status\": \"Active\",\n \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"bankAccount\": {\n \"accountNumber\": \"333720756\",\n \"routingNumber\": \"21000021\",\n \"accountType\": \"checking\"\n},\n \"id\": \"PI322LJ223222B5DJS7CD9LWL\"\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 \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"US\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
}
}
]
},
{
"name": "Create a physical card",
"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 \"type\": \"card\",\n \"issuingCountryCode\": \"NL\",\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"description\": \"S.Hopper - Main card\",\n \"status\": \"Inactive\",\n \"card\": {\n \"formFactor\": \"physical\",\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"cardholderName\": \"Sam Hopper\",\n \"deliveryContact\": {\n \"address\": {\n \"houseNumberOrName\": \"64\",\n \"street\": \"Brannan Street\",\n \"postalCode\": \"1020CD\",\n \"city\": \"Amsterdam\",\n \"country\": \"NL\"\n},\n \"name\": {\n \"firstName\": \"Sam\",\n \"lastName\": \"Hopper\"\n}\n},\n \"configuration\": {\n \"configurationProfileId\": \"CP123AB45678C91ABCD2ABCDE\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"description\": \"S. Hopper - Main card\",\n \"issuingCountryCode\": \"NL\",\n \"status\": \"Inactive\",\n \"type\": \"card\",\n \"card\": {\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"cardholderName\": \"Sam Hopper\",\n \"formFactor\": \"physical\",\n \"number\": \"************5785\",\n \"bin\": \"555544\",\n \"expiration\": {\n \"month\": \"08\",\n \"year\": \"2024\"\n},\n \"lastFour\": \"2765\",\n \"authentication\": {\n \"password\": \"******\",\n \"phone\": {\n \"number\": \"+123456789\",\n \"type\": \"mobile\"\n}\n},\n \"deliveryContact\": {\n \"address\": {\n \"houseNumberOrName\": \"64\",\n \"street\": \"Brannan Street\",\n \"postalCode\": \"1020CD\",\n \"city\": \"Amsterdam\",\n \"country\": \"NL\"\n},\n \"name\": {\n \"firstName\": \"Sam\",\n \"lastName\": \"Hopper\"\n}\n},\n \"configuration\": {\n \"configurationProfileId\": \"CP123AB45678C91ABCD2ABCDE\"\n}\n},\n \"id\": \"PI3227C223222B5BPCMFXD2XG\"\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 \"type\": \"card\",\n \"issuingCountryCode\": \"NL\",\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"description\": \"S.Hopper - Main card\",\n \"status\": \"Inactive\",\n \"card\": {\n \"formFactor\": \"physical\",\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"cardholderName\": \"Sam Hopper\",\n \"deliveryContact\": {\n \"address\": {\n \"houseNumberOrName\": \"64\",\n \"street\": \"Brannan Street\",\n \"postalCode\": \"1020CD\",\n \"city\": \"Amsterdam\",\n \"country\": \"NL\"\n},\n \"name\": {\n \"firstName\": \"Sam\",\n \"lastName\": \"Hopper\"\n}\n},\n \"configuration\": {\n \"configurationProfileId\": \"CP123AB45678C91ABCD2ABCDE\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
}
}
]
},
{
"name": "Create a virtual card",
"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 \"type\": \"card\",\n \"description\": \"S. Hopper - Main card\",\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"issuingCountryCode\": \"NL\",\n \"card\": {\n \"cardholderName\": \"Sam Hopper\",\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"formFactor\": \"virtual\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"description\": \"S.Hopper - Virtual card\",\n \"issuingCountryCode\": \"NL\",\n \"status\": \"Active\",\n \"type\": \"card\",\n \"card\": {\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"cardholderName\": \"Sam Hopper\",\n \"formFactor\": \"virtual\",\n \"bin\": \"555544\",\n \"cvc\": \"613\",\n \"expiration\": {\n \"month\": \"03\",\n \"year\": \"2025\"\n},\n \"lastFour\": \"9883\",\n \"number\": \"5555444411209883\"\n},\n \"id\": \"PI32272223222B5FR7Z5CFDW4\"\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 \"type\": \"card\",\n \"description\": \"S. Hopper - Main card\",\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"issuingCountryCode\": \"NL\",\n \"card\": {\n \"cardholderName\": \"Sam Hopper\",\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"formFactor\": \"virtual\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
}
}
]
}
]
},
{
"name": "/paymentInstruments/:id",
"description": "Returns the details of a payment instrument.",
"item": [
{
"name": "Get a payment instrument",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument."
}
],
"query": [
]
},
"description": "Returns the details of a payment instrument."
}
,"response": [
]
}
]
},
{
"name": "/paymentInstruments/:id",
"description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card.",
"item": [
{
"name": "Update the balance account linked to a payment instrument",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"balanceAccountId\": \"BA32272223222B5CM82WL892M\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument."
}
],
"query": [
]
},
"description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balanceAccountId\": \"BA32272223222B5CM82WL892M\",\n \"description\": \"S. Hopper - Main card\",\n \"issuingCountryCode\": \"GB\",\n \"status\": \"Inactive\",\n \"type\": \"card\",\n \"card\": {\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"cardholderName\": \"Simon Hopper\",\n \"formFactor\": \"virtual\",\n \"bin\": \"555544\",\n \"expiration\": {\n \"month\": \"01\",\n \"year\": \"2024\"\n},\n \"lastFour\": \"5785\",\n \"number\": \"************5785\"\n},\n \"id\": \"PI3227C223222B5CMD278FKGS\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"balanceAccountId\": \"BA32272223222B5CM82WL892M\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument."
}
],
"query": [
]
},
"description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card."
}
}
]
},
{
"name": "Update the status of a payment instrument",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"Suspended\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument."
}
],
"query": [
]
},
"description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"description\": \"S. Hopper - Main card\",\n \"issuingCountryCode\": \"GB\",\n \"status\": \"Suspended\",\n \"type\": \"card\",\n \"card\": {\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"cardholderName\": \"Simon Hopper\",\n \"formFactor\": \"virtual\",\n \"bin\": \"555544\",\n \"expiration\": {\n \"month\": \"01\",\n \"year\": \"2024\"\n},\n \"lastFour\": \"5785\",\n \"number\": \"************5785\"\n},\n \"id\": \"PI3227C223222B5CMD278FKGS\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"Suspended\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument."
}
],
"query": [
]
},
"description": "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card."
}
}
]
}
]
},
{
"name": "/paymentInstruments/:id/reveal",
"description": "Returns the primary account number (PAN) of a payment instrument. To make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions): * Balance Platform BCL PCI role",
"item": [
{
"name": "Get the PAN of a payment instrument",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments/:id/reveal",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
":id",
"reveal"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument."
}
],
"query": [
]
},
"description": "Returns the primary account number (PAN) of a payment instrument. To make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions): * Balance Platform BCL PCI role"
}
,"response": [
]
}
]
},
{
"name": "/paymentInstruments/:id/transactionRules",
"description": "Returns a list of transaction rules associated with a payment instrument.",
"item": [
{
"name": "Get all transaction rules for a payment instrument",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments/:id/transactionRules",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
":id",
"transactionRules"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument."
}
],
"query": [
]
},
"description": "Returns a list of transaction rules associated with a payment instrument."
}
,"response": [
]
}
]
}
]
},
{
"name": "Bank account validation",
"item": [
{
"name": "/validateBankAccountIdentification",
"description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments).",
"item": [
{
"name": "Validate an IBAN",
"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 \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"1001001234\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/validateBankAccountIdentification",
"host": [
"{{baseUrl}}"
],
"path": [
"validateBankAccountIdentification"
],
"variable": [
],
"query": [
]
},
"description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)."
}
,"response": [
{"name": "Unprocessable Entity - a request validation error.",
"code": 422,
"status": "Unprocessable Entity",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"type\": \"https://docs.adyen.com/errors/validation\",\n \"title\": \"Invalid bank account identification details provided\",\n \"status\": 422,\n \"invalidFields\": [{\n \"name\": \"iban\",\n \"message\": \"Invalid IBAN.\"\n}],\n \"errorCode\": \"33_01\"\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 \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"1001001234\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/validateBankAccountIdentification",
"host": [
"{{baseUrl}}"
],
"path": [
"validateBankAccountIdentification"
],
"variable": [
],
"query": [
]
},
"description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)."
}
}
]
},
{
"name": "Validate a US bank 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 \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"12345JHDhjkf67890\",\n \"routingNumber\": \"121000cxhgjhzxg248\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/validateBankAccountIdentification",
"host": [
"{{baseUrl}}"
],
"path": [
"validateBankAccountIdentification"
],
"variable": [
],
"query": [
]
},
"description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)."
}
,"response": [
{"name": "Unprocessable Entity - a request validation error.",
"code": 422,
"status": "Unprocessable Entity",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"type\": \"https://docs.adyen.com/errors/validation\",\n \"title\": \"Invalid bank account identification details provided\",\n \"status\": 422,\n \"invalidFields\": [{\n \"name\": \"accountNumber\",\n \"message\": \"Invalid account number.\"\n}, {\n \"name\": \"routingNumber\",\n \"message\": \"Invalid routing number.\"\n}],\n \"errorCode\": \"33_01\"\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 \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"12345JHDhjkf67890\",\n \"routingNumber\": \"121000cxhgjhzxg248\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/validateBankAccountIdentification",
"host": [
"{{baseUrl}}"
],
"path": [
"validateBankAccountIdentification"
],
"variable": [
],
"query": [
]
},
"description": "Validates bank account identification details. You can use this endpoint to validate bank account details before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) or [create a transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments)."
}
}
]
}
]
}
]
},
{
"name": "Transfer instruments",
"item": [
{
"name": "/transferInstruments",
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).",
"item": [
{
"name": "Add a EUR bank 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 \"legalEntityId\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"countryCode\": \"NL\",\n \"currencyCode\": \"EUR\",\n \"iban\": \"NL62ABNA0000000123\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"bankAccount\": {\n \"countryCode\": \"NL\",\n \"currencyCode\": \"EUR\",\n \"iban\": \"NL62ABNA0000000123\"\n},\n \"legalEntityId\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"bankAccount\",\n \"id\": \"SE576BH223222F5GJVKHH6BDT\"\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 \"legalEntityId\": \"LE322KH223222D5GG4C9J83RN\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"countryCode\": \"NL\",\n \"currencyCode\": \"EUR\",\n \"iban\": \"NL62ABNA0000000123\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)."
}
}
]
},
{
"name": "Add a USD bank 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 \"legalEntityId\": \"LE322JV223222D5GGMHPC2FPL\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"countryCode\": \"US\",\n \"currencyCode\": \"USD\",\n \"accountNumber\": \"0000000123\",\n \"branchCode\": \"121202211\",\n \"accountType\": \"checking\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"bankAccount\": {\n \"accountNumber\": \"0000000123\",\n \"accountType\": \"checking\",\n \"branchCode\": \"121202211\",\n \"countryCode\": \"US\",\n \"currencyCode\": \"USD\"\n},\n \"legalEntityId\": \"LE322JV223222D5GGMHPC2FPL\",\n \"type\": \"bankAccount\",\n \"id\": \"SE322JV223222F5GJVKHH8DTC\"\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 \"legalEntityId\": \"LE322JV223222D5GGMHPC2FPL\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"countryCode\": \"US\",\n \"currencyCode\": \"USD\",\n \"accountNumber\": \"0000000123\",\n \"branchCode\": \"121202211\",\n \"accountType\": \"checking\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)."
}
}
]
}
]
},
{
"name": "/transferInstruments/:id",
"description": "Deletes a transfer instrument.",
"item": [
{
"name": "Delete a transfer instrument",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the transfer instrument to be deleted."
}
],
"query": [
]
},
"description": "Deletes a transfer instrument."
}
,"response": [
]
}
]
},
{
"name": "/transferInstruments/:id",
"description": "Returns the details of a transfer instrument.",
"item": [
{
"name": "Get a transfer instrument",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the transfer instrument."
}
],
"query": [
]
},
"description": "Returns the details of a transfer instrument."
}
,"response": [
]
}
]
},
{
"name": "/transferInstruments/:id",
"description": "Updates a transfer instrument.",
"item": [
{
"name": "Update a transfer instrument",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"bankAccount\": \"<string>\",\n \"legalEntityId\": \"<string>\",\n \"type\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the transfer instrument."
}
],
"query": [
]
},
"description": "Updates a transfer instrument."
}
,"response": [
]
}
]
}
]
},
{
"name": "Balance accounts",
"item": [
{
"name": "/balanceAccounts",
"description": "Creates a balance account that holds the funds of the associated account holder.",
"item": [
{
"name": "Create 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 \"accountHolderId\": \"AH32272223222C5GXTD343TKP\",\n \"description\": \"S.Hopper - Main balance account\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts"
],
"variable": [
],
"query": [
]
},
"description": "Creates a balance account that holds the funds of the associated account holder."
}
,"response": [
]
}
]
},
{
"name": "/balanceAccounts/:id",
"description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.",
"item": [
{
"name": "Get a balance account",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
]
},
"description": "Returns a balance account and its balances for the default currency and other currencies with a non-zero balance."
}
,"response": [
]
}
]
},
{
"name": "/balanceAccounts/:id",
"description": "Updates a balance account.",
"item": [
{
"name": "Update a balance account",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"accountHolderId\": \"<string>\",\n \"defaultCurrencyCode\": \"<string>\",\n \"description\": \"<string>\",\n \"reference\": \"<string>\",\n \"status\": \"<string>\",\n \"sweepConfigurations\": \"<string>\",\n \"timeZone\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
]
},
"description": "Updates a balance account."
}
,"response": [
]
}
]
},
{
"name": "/balanceAccounts/:id/paymentInstruments",
"description": "Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`.",
"item": [
{
"name": "Get all payment instruments for a balance account",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:id/paymentInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":id",
"paymentInstruments"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
{
"key": "offset",
"value": "56",
"description": "The number of items that you want to skip.",
"disabled": true
},
{
"key": "limit",
"value": "56",
"description": "The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.",
"disabled": true
}
]
},
"description": "Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`."
}
,"response": [
]
}
]
}
]
},
{
"name": "Transaction rules",
"item": [
{
"name": "/transactionRules",
"description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples).",
"item": [
{
"name": "Create a transaction rule",
"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 \"description\": \"Allow transactions only from NL\",\n \"reference\": \"{{$guid}}_1738A\",\n \"paymentInstrumentId\": \"PI32272223222B5FN64HK3KLM\",\n \"type\": \"allowList\",\n \"countries\": [\"NL\"],\n \"status\": \"active\",\n \"interval\": {\n \"type\": \"perTransaction\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transactionRules",
"host": [
"{{baseUrl}}"
],
"path": [
"transactionRules"
],
"variable": [
],
"query": [
]
},
"description": "Creates a [transaction rule](https://docs.adyen.com/issuing/transaction-rules). When your user makes a transaction with their Adyen-issued card, the transaction is allowed or declined based on the conditions and outcome defined in the transaction rule. You can apply the transaction rule to several cards, such as all the cards in your platform, or to a specific card. For use cases, see [examples](https://docs.adyen.com/issuing/transaction-rules/examples)."
}
,"response": [
]
}
]
},
{
"name": "/transactionRules/:transactionRuleId",
"description": "Deletes a transaction rule.",
"item": [
{
"name": "Delete a transaction rule",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transactionRules/:transactionRuleId",
"host": [
"{{baseUrl}}"
],
"path": [
"transactionRules",
":transactionRuleId"
],
"variable": [
{
"key": "transactionRuleId",
"value": "",
"description": "The unique identifier of the transaction rule."
}
],
"query": [
]
},
"description": "Deletes a transaction rule."
}
,"response": [
]
}
]
},
{
"name": "/transactionRules/:transactionRuleId",
"description": "Returns the details of a transaction rule.",
"item": [
{
"name": "Get a transaction rule",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transactionRules/:transactionRuleId",
"host": [
"{{baseUrl}}"
],
"path": [
"transactionRules",
":transactionRuleId"
],
"variable": [
{
"key": "transactionRuleId",
"value": "",
"description": "The unique identifier of the transaction rule."
}
],
"query": [
]
},
"description": "Returns the details of a transaction rule."
}
,"response": [
]
}
]
},
{
"name": "/transactionRules/:transactionRuleId",
"description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.",
"item": [
{
"name": "Update the status of transaction rule",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"inactive\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transactionRules/:transactionRuleId",
"host": [
"{{baseUrl}}"
],
"path": [
"transactionRules",
":transactionRuleId"
],
"variable": [
{
"key": "transactionRuleId",
"value": "",
"description": "The unique identifier of the transaction rule."
}
],
"query": [
]
},
"description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"description\": \"Allow 5 transactions per month\",\n \"interval\": {\n \"type\": \"monthly\"\n},\n \"maxTransactions\": 5,\n \"paymentInstrumentId\": \"PI3227C223222B59KGTXP884R\",\n \"reference\": \"myRule12345\",\n \"startDate\": \"2021-01-21T12:46:35\",\n \"status\": \"inactive\",\n \"type\": \"velocity\",\n \"id\": \"TR3227C223222B5B85CDV4DRS\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"inactive\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transactionRules/:transactionRuleId",
"host": [
"{{baseUrl}}"
],
"path": [
"transactionRules",
":transactionRuleId"
],
"variable": [
{
"key": "transactionRuleId",
"value": "",
"description": "The unique identifier of the transaction rule."
}
],
"query": [
]
},
"description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource."
}
}
]
}
]
}
]
}
],
"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/bcl/v1",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
},
{
"key": "YOUR_BALANCE_PLATFORM",
"value": "",
"type": "string"
}
]
}
Reference in New Issue View Git Blame Copy Permalink