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
main
adyen-postman/postman/BalancePlatformService-v2.json
AdyenAutomationBot cf135533b0 Update latest definitions files
2024-10-10 11:38:56 +00:00

4927 lines
172 KiB
JSON
Raw Permalink Blame History

{
"info": {
"name": "Configuration API (v2)",
"description": {
"content": "The Configuration API allows you to manage your balance platform where you can create account holders, balance accounts, cards, and business accounts.\n\n## Authentication\nEach request to the Configuration API must be signed with an API key. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\n## 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/v2/accountHolders\n```\n## Going live\nWhen going live, generate an API key in your [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/) if you have an Adyen Issuing integration.You can then use the API key to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v2`.",
"type": "text/markdown"
},
"version": "2",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"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": "Grant offers",
"item": [
{
"name": "/grantOffers",
"description": "Returns a list of all [grant offers](https://docs.adyen.com/platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter.",
"item": [
{
"name": "Get all available grant offers",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/grantOffers",
"host": [
"{{baseUrl}}"
],
"path": [
"grantOffers"
],
"variable": [
],
"query": [
{
"key": "accountHolderId",
"value": "accountHolderId_example",
"description": "The unique identifier of the grant account.",
"disabled": false
}
]
},
"description": "Returns a list of all [grant offers](https://docs.adyen.com/platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter."
}
,"response": [
]
}
]
},
{
"name": "/grantOffers/:grantOfferId",
"description": "Returns the details of a single grant offer.",
"item": [
{
"name": "Get a grant offer",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/grantOffers/:grantOfferId",
"host": [
"{{baseUrl}}"
],
"path": [
"grantOffers",
":grantOfferId"
],
"variable": [
{
"key": "grantOfferId",
"value": "",
"description": "The unique identifier of the grant offer."
}
],
"query": [
]
},
"description": "Returns the details of a single grant offer."
}
,"response": [
]
}
]
}
]
},
{
"name": "Network tokens",
"item": [
{
"name": "/networkTokens/:networkTokenId",
"description": "Returns the details of a network token.",
"item": [
{
"name": "Get a network token",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/networkTokens/:networkTokenId",
"host": [
"{{baseUrl}}"
],
"path": [
"networkTokens",
":networkTokenId"
],
"variable": [
{
"key": "networkTokenId",
"value": "",
"description": "The unique identifier of the network token."
}
],
"query": [
]
},
"description": "Returns the details of a network token."
}
,"response": [
]
}
]
},
{
"name": "/networkTokens/:networkTokenId",
"description": "Updates the status of the network token.",
"item": [
{
"name": "Update a network token",
"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\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/networkTokens/:networkTokenId",
"host": [
"{{baseUrl}}"
],
"path": [
"networkTokens",
":networkTokenId"
],
"variable": [
{
"key": "networkTokenId",
"value": "",
"description": "The unique identifier of the network token."
}
],
"query": [
]
},
"description": "Updates the status of the network token."
}
,"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": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balancePlatform\": \"YOUR_BALANCE_PLATFORM\",\n \"description\": \"Liable account holder used for international payments and payouts\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"reference\": \"S.Eller-001\",\n \"capabilities\": {\n \"receiveFromPlatformPayments\": {\n \"enabled\": true,\n \"requested\": true,\n \"allowed\": false,\n \"verificationStatus\": \"pending\"\n},\n \"receiveFromBalanceAccount\": {\n \"enabled\": true,\n \"requested\": true,\n \"allowed\": false,\n \"verificationStatus\": \"pending\"\n},\n \"sendToBalanceAccount\": {\n \"enabled\": true,\n \"requested\": true,\n \"allowed\": false,\n \"verificationStatus\": \"pending\"\n},\n \"sendToTransferInstrument\": {\n \"enabled\": true,\n \"requested\": true,\n \"allowed\": false,\n \"requestedSettings\": {\n \"interval\": \"daily\",\n \"maxAmount\": {\n \"currency\": \"EUR\",\n \"value\": 0\n}\n},\n \"verificationStatus\": \"pending\"\n}\n},\n \"id\": \"AH3227C223222H5J4DCLW9VBV\",\n \"status\": \"active\"\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 \"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). "
}
}
]
}
]
},
{
"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 \"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\": \"YOUR_BALANCE_PLATFORM\",\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 \"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 an 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\": \"YOUR_BALANCE_PLATFORM\",\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": "/accountHolders/:id/taxForms",
"description": "Generates a tax form for account holders operating in the US. For more information, refer to US tax forms for [marketplaces](https://docs.adyen.com/marketplaces/us-tax-forms/) or [platforms](https://docs.adyen.com/platforms/us-tax-forms/) .",
"item": [
{
"name": "Get a tax form",
"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/taxForms",
"host": [
"{{baseUrl}}"
],
"path": [
"accountHolders",
":id",
"taxForms"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the account holder."
}
],
"query": [
{
"key": "formType",
"value": "formType_example",
"description": "The type of tax form you want to retrieve. Accepted values are **US1099k** and **US1099nec**",
"disabled": false
},
{
"key": "year",
"value": "56",
"description": "The tax year in YYYY format for the tax form you want to retrieve",
"disabled": false
}
]
},
"description": "Generates a tax form for account holders operating in the US. For more information, refer to US tax forms for [marketplaces](https://docs.adyen.com/marketplaces/us-tax-forms/) or [platforms](https://docs.adyen.com/platforms/us-tax-forms/) ."
}
,"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/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/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 \"formFactor\": \"physical\",\n \"type\": \"iban\",\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/platforms/business-accounts)."
}
}
]
},
{
"name": "Create a local IBAN in DE (first create an NL business 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 \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"DE\",\n \"bankAccount\": {\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/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 \"description\": \"YOUR_DESCRIPTION\",\n \"issuingCountryCode\": \"DE\",\n \"status\": \"active\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"type\": \"iban\",\n \"iban\": \"DE20100190002300001206\",\n \"formFactor\": \"virtual\"\n},\n \"id\": \"PI3227C223226C5JW49ZHBQMS\"\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\": \"DE\",\n \"bankAccount\": {\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/platforms/business-accounts)."
}
}
]
},
{
"name": "Create a local IBAN in FR (first create an NL business 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 \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"FR\",\n \"bankAccount\": {\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/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 \"description\": \"YOUR_DESCRIPTION\",\n \"issuingCountryCode\": \"FR\",\n \"status\": \"active\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"type\": \"iban\",\n \"iban\": \"FR7621733712350230000110741\",\n \"formFactor\": \"virtual\"\n},\n \"id\": \"PI3227C223226C5JW49ZAHSYD\"\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\": \"FR\",\n \"bankAccount\": {\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/platforms/business-accounts)."
}
}
]
},
{
"name": "Create a business account in the UK",
"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\": \"BA328R4223227F5KMH9NJB2S4\",\n \"issuingCountryCode\": \"GB\"\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/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\": \"BA328R4223227F5KMH9NJB2S4\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"issuingCountryCode\": \"GB\",\n \"status\": \"active\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"accountNumber\": \"20010731\",\n \"formFactor\": \"physical\",\n \"iban\": \"GB68ADYX04295720010731\",\n \"sortCode\": \"042957\",\n \"type\": \"ukLocal\"\n},\n \"id\": \"PI328Q9223227F5KMH9P92MDG\"\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\": \"BA328R4223227F5KMH9NJB2S4\",\n \"issuingCountryCode\": \"GB\"\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/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/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 \"accountType\": \"checking\",\n \"formFactor\": \"physical\",\n \"routingNumber\": \"210000210\",\n \"type\": \"usLocal\"\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/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 \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"stateOrProvince\": \"NH\",\n \"line1\": \"Brannan Street\",\n \"line2\": \"274\",\n \"postalCode\": \"1020CD\"\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/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 \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"stateOrProvince\": \"NH\",\n \"line1\": \"Brannan Street\",\n \"line2\": \"274\",\n \"postalCode\": \"1020CD\"\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 \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"stateOrProvince\": \"NH\",\n \"line1\": \"Brannan Street\",\n \"line2\": \"274\",\n \"postalCode\": \"1020CD\"\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/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\": \"My test card\",\n \"balanceAccountId\": \"BA3227C223222B5FG88S28BGN\",\n \"issuingCountryCode\": \"NL\",\n \"card\": {\n \"cardholderName\": \"Simon 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/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\": \"BA3227C223222B5FG88S28BGN\",\n \"description\": \"My test card\",\n \"issuingCountryCode\": \"NL\",\n \"status\": \"active\",\n \"type\": \"card\",\n \"card\": {\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"cardholderName\": \"Simon Hopper\",\n \"formFactor\": \"virtual\",\n \"bin\": \"555544\",\n \"cvc\": \"136\",\n \"expiration\": {\n \"month\": \"11\",\n \"year\": \"2025\"\n},\n \"lastFour\": \"3703\",\n \"number\": \"5555444411213703\"\n},\n \"id\": \"PI32272223222C5GXTDWH3TTN\"\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\": \"My test card\",\n \"balanceAccountId\": \"BA3227C223222B5FG88S28BGN\",\n \"issuingCountryCode\": \"NL\",\n \"card\": {\n \"cardholderName\": \"Simon 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/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/networkTokens",
"description": "List the network tokens connected to a payment instrument.",
"item": [
{
"name": "List network tokens",
"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/networkTokens",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
":id",
"networkTokens"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the payment instrument."
}
],
"query": [
]
},
"description": "List the network tokens connected to a payment instrument."
}
,"response": [
]
}
]
},
{
"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": "/paymentInstruments/reveal",
"description": "Returns the encrypted data of a specified payment instrument. These data include: - The primary account number (PAN) - The card verification code (CVC) - The expiry date You can decrypt the data to reveal it in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PAN Reveal Webservice role",
"item": [
{
"name": "Reveal the data of a payment instrument",
"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 \"encryptedKey\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/paymentInstruments/reveal",
"host": [
"{{baseUrl}}"
],
"path": [
"paymentInstruments",
"reveal"
],
"variable": [
],
"query": [
]
},
"description": "Returns the encrypted data of a specified payment instrument. These data include: - The primary account number (PAN) - The card verification code (CVC) - The expiry date You can decrypt the data to reveal it in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PAN Reveal Webservice role"
}
,"response": [
]
}
]
}
]
},
{
"name": "Grant accounts",
"item": [
{
"name": "/grantAccounts/:id",
"description": "Returns the details of the [grant account](https://docs.adyen.com/platforms/capital#grant-account).",
"item": [
{
"name": "Get a grant account",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/grantAccounts/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"grantAccounts",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the grant account."
}
],
"query": [
]
},
"description": "Returns the details of the [grant account](https://docs.adyen.com/platforms/capital#grant-account)."
}
,"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": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"accountHolderId\": \"AH32272223222C5GXTD343TKP\",\n \"defaultCurrencyCode\": \"EUR\",\n \"description\": \"S.Hopper - Main balance account\",\n \"timeZone\": \"Europe/Amsterdam\",\n \"balances\": [{\n \"available\": 0,\n \"balance\": 0,\n \"currency\": \"EUR\",\n \"reserved\": 0\n}],\n \"id\": \"BA3227C223222H5J4DCGQ9V9L\",\n \"status\": \"active\"\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 \"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."
}
}
]
}
]
},
{
"name": "/balanceAccounts/:balanceAccountId/sweeps",
"description": "Returns a list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`.",
"item": [
{
"name": "Get all sweeps 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/:balanceAccountId/sweeps",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps"
],
"variable": [
{
"key": "balanceAccountId",
"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 list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`."
}
,"response": [
]
}
]
},
{
"name": "/balanceAccounts/:balanceAccountId/sweeps",
"description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.",
"item": [
{
"name": "Create a sweep to pull funds in to a balance account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"counterparty\": {\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"balance\"\n},\n \"type\": \"pull\",\n \"status\": \"active\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
]
},
"description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"id\": \"SWPC4227C224555B5FTD2NT2JV4WN5\",\n \"counterparty\": {\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"balance\"\n},\n \"type\": \"pull\",\n \"status\": \"active\"\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 \"counterparty\": {\n \"merchantAccount\": \"{{YOUR_MERCHANT_ACCOUNT}}\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"balance\"\n},\n \"type\": \"pull\",\n \"status\": \"active\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
]
},
"description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination."
}
}
]
},
{
"name": "Create a sweep to push funds out of 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 \"counterparty\": {\n \"balanceAccountId\": \"BA32278887611B5FTD2KR6TJD\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"weekly\"\n},\n \"type\": \"push\",\n \"status\": \"active\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
]
},
"description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"id\": \"SWPC4227C224555B5FTD2NT2JV4WN5\",\n \"counterparty\": {\n \"balanceAccountId\": \"BA32278887611B5FTD2KR6TJD\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"weekly\"\n},\n \"type\": \"push\",\n \"status\": \"active\"\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 \"counterparty\": {\n \"balanceAccountId\": \"BA32278887611B5FTD2KR6TJD\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"weekly\"\n},\n \"type\": \"push\",\n \"status\": \"active\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
]
},
"description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination."
}
}
]
},
{
"name": "Create a sweep to push funds out of a balance account with set priorities",
"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 \"counterparty\": {\n \"transferInstrumentId\": \"SE322JV223222J5HGLCGF2WDV\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"priorities\": [\"fast\", \"instant\"],\n \"category\": \"bank\",\n \"schedule\": {\n \"type\": \"weekly\"\n},\n \"type\": \"push\",\n \"status\": \"active\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
]
},
"description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"id\": \"SWPC4227C224555B5FTD2NT2JV4WN9\",\n \"counterparty\": {\n \"transferInstrumentId\": \"SE322JV223222J5HGLCGF2WDV\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"priorities\": [\"fast\", \"instant\"],\n \"category\": \"bank\",\n \"schedule\": {\n \"type\": \"weekly\"\n},\n \"type\": \"push\",\n \"status\": \"active\"\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 \"counterparty\": {\n \"transferInstrumentId\": \"SE322JV223222J5HGLCGF2WDV\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"priorities\": [\"fast\", \"instant\"],\n \"category\": \"bank\",\n \"schedule\": {\n \"type\": \"weekly\"\n},\n \"type\": \"push\",\n \"status\": \"active\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
}
],
"query": [
]
},
"description": "Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination."
}
}
]
}
]
},
{
"name": "/balanceAccounts/:balanceAccountId/sweeps/:sweepId",
"description": "Deletes a sweep for a balance account.",
"item": [
{
"name": "Delete a sweep",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps",
":sweepId"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
},
{
"key": "sweepId",
"value": "",
"description": "The unique identifier of the sweep."
}
],
"query": [
]
},
"description": "Deletes a sweep for a balance account."
}
,"response": [
]
}
]
},
{
"name": "/balanceAccounts/:balanceAccountId/sweeps/:sweepId",
"description": "Returns a sweep.",
"item": [
{
"name": "Get a sweep",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps",
":sweepId"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
},
{
"key": "sweepId",
"value": "",
"description": "The unique identifier of the sweep."
}
],
"query": [
]
},
"description": "Returns a sweep."
}
,"response": [
]
}
]
},
{
"name": "/balanceAccounts/:balanceAccountId/sweeps/:sweepId",
"description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged.",
"item": [
{
"name": "Update the status of a sweep",
"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}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps",
":sweepId"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
},
{
"key": "sweepId",
"value": "",
"description": "The unique identifier of the sweep."
}
],
"query": [
]
},
"description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter 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 \"id\": \"SWPC4227C224555B5FTD2NT2JV4WN5\",\n \"counterparty\": {\n \"merchantAccount\": \"YOUR_MERCHANT_ACCOUNT\"\n},\n \"triggerAmount\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n},\n \"currency\": \"EUR\",\n \"schedule\": {\n \"type\": \"balance\"\n},\n \"type\": \"pull\",\n \"status\": \"inactive\"\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}}/balanceAccounts/:balanceAccountId/sweeps/:sweepId",
"host": [
"{{baseUrl}}"
],
"path": [
"balanceAccounts",
":balanceAccountId",
"sweeps",
":sweepId"
],
"variable": [
{
"key": "balanceAccountId",
"value": "",
"description": "The unique identifier of the balance account."
},
{
"key": "sweepId",
"value": "",
"description": "The unique identifier of the sweep."
}
],
"query": [
]
},
"description": "Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged."
}
}
]
}
]
},
{
"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 the time zone of 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 \"timeZone\": \"Europe/Amsterdam\"\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": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"accountHolderId\": \"AH32272223222B5GFSNVGFFM7\",\n \"defaultCurrencyCode\": \"EUR\",\n \"timeZone\": \"Europe/Amsterdam\",\n \"balances\": [{\n \"available\": 0,\n \"balance\": 0,\n \"currency\": \"EUR\",\n \"reserved\": 0\n}],\n \"id\": \"BA32272223222B59K6ZXHBFN6\",\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 \"timeZone\": \"Europe/Amsterdam\"\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."
}
}
]
}
]
},
{
"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 which are in active status and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active`.",
"item": [
{
"name": "Get payment instruments linked to 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
},
{
"key": "status",
"value": "status_example",
"description": "The status of the payment instruments that you want to get. By default, the response includes payment instruments with any status.",
"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 which are in active status and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active`."
}
,"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": "Allow only point-of-sale transactions",
"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 only point-of-sale transactions\",\n \"reference\": \"{{$guid}}_4F7346\",\n \"entityKey\": {\n \"entityType\": \"paymentInstrument\",\n \"entityReference\": \"PI3227C223222B5FG88SB8BHR\"\n},\n \"status\": \"active\",\n \"interval\": {\n \"type\": \"perTransaction\"\n},\n \"ruleRestrictions\": {\n \"processingTypes\": {\n \"operation\": \"noneMatch\",\n \"value\": [\"pos\"]\n}\n},\n \"type\": \"blockList\"\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": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"description\": \"Allow only point-of-sale transactions\",\n \"entityKey\": {\n \"entityReference\": \"PI3227C223222B5FG88SB8BHR\",\n \"entityType\": \"paymentInstrument\"\n},\n \"interval\": {\n \"timeZone\": \"UTC\",\n \"type\": \"perTransaction\"\n},\n \"outcomeType\": \"hardBlock\",\n \"reference\": \"YOUR_REFERENCE_4F7346\",\n \"requestType\": \"authorization\",\n \"ruleRestrictions\": {\n \"processingTypes\": {\n \"operation\": \"noneMatch\",\n \"value\": [\"pos\"]\n}\n},\n \"startDate\": \"2023-06-29T22:34:36.173226192+02:00\",\n \"status\": \"active\",\n \"type\": \"blockList\",\n \"id\": \"TR3227C223222H5J4D9ML9V4D\"\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 \"description\": \"Allow only point-of-sale transactions\",\n \"reference\": \"{{$guid}}_4F7346\",\n \"entityKey\": {\n \"entityType\": \"paymentInstrument\",\n \"entityReference\": \"PI3227C223222B5FG88SB8BHR\"\n},\n \"status\": \"active\",\n \"interval\": {\n \"type\": \"perTransaction\"\n},\n \"ruleRestrictions\": {\n \"processingTypes\": {\n \"operation\": \"noneMatch\",\n \"value\": [\"pos\"]\n}\n},\n \"type\": \"blockList\"\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)."
}
}
]
},
{
"name": "Increase the score of a 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 \"description\": \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\": {\n \"entityType\": \"paymentInstrument\",\n \"entityReference\": \"PI3227C223222B5FG88SB8BHR\"\n},\n \"interval\": {\n \"type\": \"sliding\",\n \"duration\": {\n \"value\": 2,\n \"unit\": \"hours\"\n}\n},\n \"outcomeType\": \"scoreBased\",\n \"reference\": \"myRule11789\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n}\n}\n},\n \"score\": 20,\n \"type\": \"velocity\"\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": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"description\": \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\": {\n \"entityReference\": \"PI3227C223222B5FG88SB8BHR\",\n \"entityType\": \"paymentInstrument\"\n},\n \"interval\": {\n \"duration\": {\n \"unit\": \"hours\",\n \"value\": 2\n},\n \"timeZone\": \"UTC\",\n \"type\": \"sliding\"\n},\n \"outcomeType\": \"scoreBased\",\n \"reference\": \"myRule11789\",\n \"requestType\": \"authorization\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n}\n}\n},\n \"score\": 20,\n \"status\": \"inactive\",\n \"type\": \"velocity\",\n \"id\": \"TR3227C223222H5J4D9S39V59\"\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 \"description\": \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\": {\n \"entityType\": \"paymentInstrument\",\n \"entityReference\": \"PI3227C223222B5FG88SB8BHR\"\n},\n \"interval\": {\n \"type\": \"sliding\",\n \"duration\": {\n \"value\": 2,\n \"unit\": \"hours\"\n}\n},\n \"outcomeType\": \"scoreBased\",\n \"reference\": \"myRule11789\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 50000\n}\n}\n},\n \"score\": 20,\n \"type\": \"velocity\"\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)."
}
}
]
},
{
"name": "Limit total amount in the last 12 hours",
"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\": \"Up to 1000 EUR per card for the last 12 hours\",\n \"reference\": \"{{$guid}}_2918A\",\n \"status\": \"active\",\n \"entityKey\": {\n \"entityReference\": \"BA3227C223222B5FN65355NR3\",\n \"entityType\": \"balanceAccount\"\n},\n \"aggregationLevel\": \"paymentInstrument\",\n \"interval\": {\n \"type\": \"sliding\",\n \"duration\": {\n \"value\": 12,\n \"unit\": \"hours\"\n}\n},\n \"outcomeType\": \"hardBlock\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"value\": 100000,\n \"currency\": \"EUR\"\n}\n}\n},\n \"type\": \"velocity\"\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": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"aggregationLevel\": \"paymentInstrument\",\n \"description\": \"Up to 1000 EUR per card for the last 12 hours\",\n \"entityKey\": {\n \"entityReference\": \"BA3227C223222B5FN65355NR3\",\n \"entityType\": \"balanceAccount\"\n},\n \"interval\": {\n \"duration\": {\n \"unit\": \"hours\",\n \"value\": 12\n},\n \"timeZone\": \"UTC\",\n \"type\": \"sliding\"\n},\n \"outcomeType\": \"hardBlock\",\n \"reference\": \"YOUR_REFERENCE_2918A\",\n \"requestType\": \"authorization\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 100000\n}\n}\n},\n \"startDate\": \"2023-06-29T22:39:06.887628679+02:00\",\n \"status\": \"active\",\n \"type\": \"velocity\",\n \"id\": \"TR32272223222H5J4D9Z8C97H\"\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 \"description\": \"Up to 1000 EUR per card for the last 12 hours\",\n \"reference\": \"{{$guid}}_2918A\",\n \"status\": \"active\",\n \"entityKey\": {\n \"entityReference\": \"BA3227C223222B5FN65355NR3\",\n \"entityType\": \"balanceAccount\"\n},\n \"aggregationLevel\": \"paymentInstrument\",\n \"interval\": {\n \"type\": \"sliding\",\n \"duration\": {\n \"value\": 12,\n \"unit\": \"hours\"\n}\n},\n \"outcomeType\": \"hardBlock\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"value\": 100000,\n \"currency\": \"EUR\"\n}\n}\n},\n \"type\": \"velocity\"\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)."
}
}
]
},
{
"name": "Limit international payments",
"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\": \"Up to 50 EUR international transactions\",\n \"reference\": \"{{$guid}}_B2634\",\n \"status\": \"active\",\n \"entityKey\": {\n \"entityType\": \"balanceAccount\",\n \"entityReference\": \"BA3227C223222B5FN65355NR3\"\n},\n \"interval\": {\n \"type\": \"daily\"\n},\n \"outcomeType\": \"hardBlock\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 5000\n}\n},\n \"internationalTransaction\": {\n \"operation\": \"equals\",\n \"value\": true\n}\n},\n \"type\": \"velocity\"\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": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"description\": \"Up to 50 EUR international transactions\",\n \"entityKey\": {\n \"entityReference\": \"BA3227C223222B5FN65355NR3\",\n \"entityType\": \"balanceAccount\"\n},\n \"interval\": {\n \"timeOfDay\": \"00:00:00\",\n \"timeZone\": \"UTC\",\n \"type\": \"daily\"\n},\n \"outcomeType\": \"hardBlock\",\n \"reference\": \"YOUR_REFERENCE_B2634\",\n \"requestType\": \"authorization\",\n \"ruleRestrictions\": {\n \"internationalTransaction\": {\n \"operation\": \"equals\",\n \"value\": true\n},\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 5000\n}\n}\n},\n \"startDate\": \"2023-06-29T22:39:54.068487152+02:00\",\n \"status\": \"active\",\n \"type\": \"velocity\",\n \"id\": \"TR3227C223222H5J4DB2X9V65\"\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 \"description\": \"Up to 50 EUR international transactions\",\n \"reference\": \"{{$guid}}_B2634\",\n \"status\": \"active\",\n \"entityKey\": {\n \"entityType\": \"balanceAccount\",\n \"entityReference\": \"BA3227C223222B5FN65355NR3\"\n},\n \"interval\": {\n \"type\": \"daily\"\n},\n \"outcomeType\": \"hardBlock\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 5000\n}\n},\n \"internationalTransaction\": {\n \"operation\": \"equals\",\n \"value\": true\n}\n},\n \"type\": \"velocity\"\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)."
}
}
]
}
]
},
{
"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 interval 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 \"description\": \"Allow only point-of-sale transactions\",\n \"reference\": \"{{$guid}}_4F7346\",\n \"entityKey\": {\n \"entityType\": \"paymentInstrument\",\n \"entityReference\": \"PI3227C223222B5FG88SB8BHR\"\n},\n \"status\": \"inactive\",\n \"interval\": {\n \"type\": \"weekly\"\n},\n \"ruleRestrictions\": {\n \"processingTypes\": {\n \"operation\": \"noneMatch\",\n \"value\": [\"pos\"]\n}\n},\n \"type\": \"blockList\"\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 \"aggregationLevel\": \"paymentInstrument\",\n \"description\": \"Up to 1000 EUR per card for the last 12 hours\",\n \"entityKey\": {\n \"entityReference\": \"PG3227C223222C5GXR3M5592Q\",\n \"entityType\": \"paymentInstrumentGroup\"\n},\n \"interval\": {\n \"duration\": {\n \"unit\": \"hours\",\n \"value\": 12\n},\n \"timeZone\": \"UTC\",\n \"type\": \"sliding\"\n},\n \"outcomeType\": \"hardBlock\",\n \"reference\": \"YOUR_REFERENCE_2918A\",\n \"requestType\": \"authorization\",\n \"ruleRestrictions\": {\n \"totalAmount\": {\n \"operation\": \"greaterThan\",\n \"value\": {\n \"currency\": \"EUR\",\n \"value\": 100000\n}\n}\n},\n \"startDate\": \"2022-11-17T00:07:09.10057663+01:00\",\n \"status\": \"inactive\",\n \"type\": \"velocity\",\n \"id\": \"TR3227C223222C5GXR3XP596N\"\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\": \"Allow only point-of-sale transactions\",\n \"reference\": \"{{$guid}}_4F7346\",\n \"entityKey\": {\n \"entityType\": \"paymentInstrument\",\n \"entityReference\": \"PI3227C223222B5FG88SB8BHR\"\n},\n \"status\": \"inactive\",\n \"interval\": {\n \"type\": \"weekly\"\n},\n \"ruleRestrictions\": {\n \"processingTypes\": {\n \"operation\": \"noneMatch\",\n \"value\": [\"pos\"]\n}\n},\n \"type\": \"blockList\"\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."
}
}
]
}
]
}
]
},
{
"name": "Card orders",
"item": [
{
"name": "/cardorders",
"description": "Returns a paginated list of card orders.",
"item": [
{
"name": "Get a list of card orders",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/cardorders",
"host": [
"{{baseUrl}}"
],
"path": [
"cardorders"
],
"variable": [
],
"query": [
{
"key": "id",
"value": "id_example",
"description": "The unique identifier of the card order. ",
"disabled": true
},
{
"key": "cardManufacturingProfileId",
"value": "cardManufacturingProfileId_example",
"description": "The unique identifier of the card manufacturer profile.",
"disabled": true
},
{
"key": "status",
"value": "status_example",
"description": "The status of the card order.",
"disabled": true
},
{
"key": "txVariantCode",
"value": "txVariantCode_example",
"description": "The unique code of the card manufacturer profile. Possible values: **mcmaestro**, **mc**, **visa**, **mcdebit**. ",
"disabled": true
},
{
"key": "createdSince",
"value": "2013-10-20T19:20:30+01:00",
"description": "Only include card orders that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.",
"disabled": true
},
{
"key": "createdUntil",
"value": "2013-10-20T19:20:30+01:00",
"description": "Only include card orders that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.",
"disabled": true
},
{
"key": "lockedSince",
"value": "2013-10-20T19:20:30+01:00",
"description": "Only include card orders that have been locked on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.",
"disabled": true
},
{
"key": "lockedUntil",
"value": "2013-10-20T19:20:30+01:00",
"description": "Only include card orders that have been locked on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.",
"disabled": true
},
{
"key": "serviceCenter",
"value": "serviceCenter_example",
"description": "The service center at which the card is issued. The value is case-sensitive. ",
"disabled": true
},
{
"key": "offset",
"value": "56",
"description": "Specifies the position of an element in a list of card orders. The response includes a list of card orders that starts at the specified offset. **Default:** 0, which means that the response contains all the elements in the list of card orders.",
"disabled": true
},
{
"key": "limit",
"value": "56",
"description": "The number of card orders returned per page. **Default:** 10.",
"disabled": true
}
]
},
"description": "Returns a paginated list of card orders."
}
,"response": [
]
}
]
},
{
"name": "/cardorders/:id/items",
"description": "Returns the item list of a specific card order.",
"item": [
{
"name": "Get card order items",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/cardorders/:id/items",
"host": [
"{{baseUrl}}"
],
"path": [
"cardorders",
":id",
"items"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the card order."
}
],
"query": [
{
"key": "offset",
"value": "56",
"description": "Specifies the position of an element in a list of card orders. The response includes a list of card order items that starts at the specified offset. **Default:** 0, which means that the response contains all the elements in the list of card order items.",
"disabled": true
},
{
"key": "limit",
"value": "56",
"description": "The number of card order items returned per page. **Default:** 10.",
"disabled": true
}
]
},
"description": "Returns the item list of a specific card order."
}
,"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": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"balancePlatform\": \"YOUR_BALANCE_PLATFORM\",\n \"txVariant\": \"mc\",\n \"id\": \"PG32272223222H5J4DCRVC9DH\"\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 \"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."
}
}
]
}
]
},
{
"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": "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 \"detail\": \"Provided IBAN is incorrect\",\n \"status\": 422,\n \"invalidFields\": [{\n \"name\": \"iban\",\n \"value\": \"1001001234\",\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 \"accountType\": \"checking\",\n \"routingNumber\": \"121000567\"\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 \"detail\": \"Provided account number and the routing number are incorrect\",\n \"status\": 422,\n \"invalidFields\": [{\n \"name\": \"accountNumber\",\n \"value\": \"12345JHDhjkf67890\",\n \"message\": \"Invalid account number.\"\n}, {\n \"name\": \"routingNumber\",\n \"value\": \"121000567\",\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 \"accountType\": \"checking\",\n \"routingNumber\": \"121000567\"\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": "Manage card PIN",
"item": [
{
"name": "/pins/change",
"description": "Changes the personal identification number (PIN) of a specified card. To make this request, your API credential must have the following role: * Bank Issuing PIN Change Webservice role",
"item": [
{
"name": "Request a PIN change",
"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 \"paymentInstrumentId\": \"PI6789678967896789\",\n \"encryptedKey\": \"75989E8881284D10153ABACF022EEA09F5...\",\n \"encryptedPinBlock\": \"63E5060591EF65F48DD1D4FECD0FECD5\",\n \"token\": \"5555341244441115\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pins/change",
"host": [
"{{baseUrl}}"
],
"path": [
"pins",
"change"
],
"variable": [
],
"query": [
]
},
"description": "Changes the personal identification number (PIN) of a specified card. To make this request, your API credential must have the following role: * Bank Issuing PIN Change Webservice role"
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"status\": \"completed\"\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 \"paymentInstrumentId\": \"PI6789678967896789\",\n \"encryptedKey\": \"75989E8881284D10153ABACF022EEA09F5...\",\n \"encryptedPinBlock\": \"63E5060591EF65F48DD1D4FECD0FECD5\",\n \"token\": \"5555341244441115\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pins/change",
"host": [
"{{baseUrl}}"
],
"path": [
"pins",
"change"
],
"variable": [
],
"query": [
]
},
"description": "Changes the personal identification number (PIN) of a specified card. To make this request, your API credential must have the following role: * Bank Issuing PIN Change Webservice role"
}
}
]
}
]
},
{
"name": "/pins/reveal",
"description": "Returns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PIN Reveal Webservice role",
"item": [
{
"name": "Request a PIN block",
"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 \"paymentInstrumentId\": \"PI3227C223222B5BPCMFXD2XG\",\n \"encryptedKey\": \"75989E8881284D10153ABACF022EEA09F5...\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pins/reveal",
"host": [
"{{baseUrl}}"
],
"path": [
"pins",
"reveal"
],
"variable": [
],
"query": [
]
},
"description": "Returns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PIN Reveal Webservice role"
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"encryptedPinBlock\": \"63E5060591EF65F48DD1D4FECD0FECD5\",\n \"token\": \"5555341244441115\"\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 \"paymentInstrumentId\": \"PI3227C223222B5BPCMFXD2XG\",\n \"encryptedKey\": \"75989E8881284D10153ABACF022EEA09F5...\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pins/reveal",
"host": [
"{{baseUrl}}"
],
"path": [
"pins",
"reveal"
],
"variable": [
],
"query": [
]
},
"description": "Returns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface. To make this request, your API credential must have the following role: * Bank Issuing PIN Reveal Webservice role"
}
}
]
}
]
},
{
"name": "/publicKey",
"description": "Get an [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)) public key to encrypt or decrypt card data. You need the RSA public key to generate the `encryptedKey` required to: - [Change a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/change). - [Reveal a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/reveal). - [Reveal a PAN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments/reveal).",
"item": [
{
"name": "Get an RSA public key",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/publicKey",
"host": [
"{{baseUrl}}"
],
"path": [
"publicKey"
],
"variable": [
],
"query": [
{
"key": "purpose",
"value": "purpose_example",
"description": "The purpose of the public key. Possible values: **pinChange**, **pinReveal**, **panReveal**. Default value: **pinReveal**.",
"disabled": true
},
{
"key": "format",
"value": "format_example",
"description": "The encoding format of public key. Possible values: **jwk**, **pem**. Default value: **pem**.",
"disabled": true
}
]
},
"description": "Get an [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)) public key to encrypt or decrypt card data. You need the RSA public key to generate the `encryptedKey` required to: - [Change a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/change). - [Reveal a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/reveal). - [Reveal a PAN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments/reveal)."
}
,"response": [
]
}
]
}
]
},
{
"name": "Transfer routes",
"item": [
{
"name": "/transferRoutes/calculate",
"description": "Returns available transfer routes based on a combination of transfer `country`, `currency`, `counterparty`, and `priorities`. Use this endpoint to find optimal transfer priorities and associated requirements before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers).",
"item": [
{
"name": "Calculate transfer routes",
"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 \"currency\": \"USD\",\n \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL91ABNA0417164300\"\n}\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferRoutes/calculate",
"host": [
"{{baseUrl}}"
],
"path": [
"transferRoutes",
"calculate"
],
"variable": [
],
"query": [
]
},
"description": "Returns available transfer routes based on a combination of transfer `country`, `currency`, `counterparty`, and `priorities`. Use this endpoint to find optimal transfer priorities and associated requirements before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"transferRoutes\": [{\n \"country\": \"NL\",\n \"currency\": \"USD\",\n \"priority\": \"crossBorder\",\n \"requirements\": [{\n \"description\": \"Amount of transfer must be at least 100, and no greater than 99999999999\",\n ,\n \"min\": 100,\n \"type\": \"amountMinMaxRequirement\"\n}, {\n \"description\": \"Country, street and city is required.\",\n \"requiredAddressFields\": [\"line1\", \"city\", \"country\"],\n \"type\": \"addressRequirement\"\n}, {\n \"description\": \"Bank account identification type must be iban or numberAndBic\",\n \"bankAccountIdentificationTypes\": [\"iban\", \"numberAndBic\"],\n \"type\": \"bankAccountIdentificationTypeRequirement\"\n}, {\n \"issuingCountryCode\": \"NL\",\n \"paymentInstrumentType\": \"BankAccount\",\n \"type\": \"paymentInstrumentRequirement\"\n}]\n}, {\n \"country\": \"NL\",\n \"currency\": \"USD\",\n \"priority\": \"wire\",\n \"requirements\": [{\n \"description\": \"Amount of transfer must be at least 100, and no greater than 99999999999\",\n ,\n \"min\": 100,\n \"type\": \"amountMinMaxRequirement\"\n}, {\n \"description\": \"Country, street and city is required.\",\n \"requiredAddressFields\": [\"line1\", \"city\", \"country\"],\n \"type\": \"addressRequirement\"\n}, {\n \"description\": \"Bank account identification type must be iban or numberAndBic\",\n \"bankAccountIdentificationTypes\": [\"iban\", \"numberAndBic\"],\n \"type\": \"bankAccountIdentificationTypeRequirement\"\n}, {\n \"issuingCountryCode\": \"NL\",\n \"paymentInstrumentType\": \"BankAccount\",\n \"type\": \"paymentInstrumentRequirement\"\n}]\n}]\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 \"balancePlatform\": \"{{YOUR_BALANCE_PLATFORM}}\",\n \"currency\": \"USD\",\n \"category\": \"bank\",\n \"counterparty\": {\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL91ABNA0417164300\"\n}\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferRoutes/calculate",
"host": [
"{{baseUrl}}"
],
"path": [
"transferRoutes",
"calculate"
],
"variable": [
],
"query": [
]
},
"description": "Returns available transfer routes based on a combination of transfer `country`, `currency`, `counterparty`, and `priorities`. Use this endpoint to find optimal transfer priorities and associated requirements before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)."
}
}
]
}
]
}
]
},
{
"name": "Manage SCA devices",
"item": [
{
"name": "/registeredDevices",
"description": "Get a paginated list of the SCA devices you have currently registered for a specific payment instrument.",
"item": [
{
"name": "Get a list of registered SCA devices",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/registeredDevices",
"host": [
"{{baseUrl}}"
],
"path": [
"registeredDevices"
],
"variable": [
],
"query": [
{
"key": "paymentInstrumentId",
"value": "paymentInstrumentId_example",
"description": "The unique identifier of a payment instrument. It limits the returned list to SCA devices associated to this payment instrument.",
"disabled": false
},
{
"key": "pageNumber",
"value": "56",
"description": "The index of the page to retrieve. The index of the first page is 0 (zero). Default: 0.",
"disabled": true
},
{
"key": "pageSize",
"value": "56",
"description": "The number of items to have on a page. Default: 20. Maximum: 100.",
"disabled": true
}
]
},
"description": "Get a paginated list of the SCA devices you have currently registered for a specific payment instrument."
}
,"response": [
]
}
]
},
{
"name": "/registeredDevices",
"description": "Initiates the registration of a user's device for Strong Customer Authentication (SCA). You can register SCA devices for [business accounts](https://docs.adyen.com/platforms/business-accounts/sca/register-devices) or [Adyen-issued cards](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/register-devices). For a successful request, the device must be eligible for SCA.",
"item": [
{
"name": "Initiate the registration of an SCA device",
"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 \"name\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\",\n \"strongCustomerAuthentication\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/registeredDevices",
"host": [
"{{baseUrl}}"
],
"path": [
"registeredDevices"
],
"variable": [
],
"query": [
]
},
"description": "Initiates the registration of a user's device for Strong Customer Authentication (SCA). You can register SCA devices for [business accounts](https://docs.adyen.com/platforms/business-accounts/sca/register-devices) or [Adyen-issued cards](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk/register-devices). For a successful request, the device must be eligible for SCA."
}
,"response": [
]
}
]
},
{
"name": "/registeredDevices/:id",
"description": "Deletes an SCA device from the list of registered devices of a specific payment instrument.",
"item": [
{
"name": "Delete a registration of an SCA device",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/registeredDevices/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"registeredDevices",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the SCA device."
}
],
"query": [
{
"key": "paymentInstrumentId",
"value": "paymentInstrumentId_example",
"description": "The unique identifier of the payment instrument linked to the SCA device.",
"disabled": false
}
]
},
"description": "Deletes an SCA device from the list of registered devices of a specific payment instrument."
}
,"response": [
]
}
]
},
{
"name": "/registeredDevices/:id",
"description": "Completes the registration of an SCA device by validating the authentication data of the device. You can register SCA devices for [business accounts](https://docs.adyen.com/platforms/business-accounts/sca) or [Adyen-issued cards](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk). ",
"item": [
{
"name": "Complete the registration of an SCA device",
"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 \"name\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\",\n \"strongCustomerAuthentication\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/registeredDevices/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"registeredDevices",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the SCA device. You obtain this `id` in the response of a POST&nbsp;[/registeredDevices](https://docs.adyen.com/api-explorer/balanceplatform/2/post/registeredDevices#responses-200-id) request."
}
],
"query": [
]
},
"description": "Completes the registration of an SCA device by validating the authentication data of the device. You can register SCA devices for [business accounts](https://docs.adyen.com/platforms/business-accounts/sca) or [Adyen-issued cards](https://docs.adyen.com/issuing/3d-secure/oob-auth-sdk). "
}
,"response": [
]
}
]
}
]
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{X-API-Key}}",
"type": "string"
},
{
"key": "key",
"value": "X-API-Key",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "https://balanceplatform-api-test.adyen.com/bcl/v2",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
},
{
"key": "clientKey",
"value": "",
"type": "string"
},
{
"key": "YOUR_BALANCE_PLATFORM",
"value": "",
"type": "string"
},
{
"key": "YOUR_MERCHANT_ACCOUNT",
"value": "",
"type": "string"
}
]
}
Reference in New Issue View Git Blame Copy Permalink