mirror of
https://github.com/gcatanese/adyen-postman.git
synced 2026-03-10 08:01:18 +00:00
1729 lines
98 KiB
JSON
1729 lines
98 KiB
JSON
{
|
|
"info": {
|
|
"name": "Configuration API (v2)",
|
|
"description": {
|
|
"content": "The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\n...\n```\n## Versioning\nThe Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/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"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"key": "limit",
|
|
"value": "56"
|
|
}
|
|
]
|
|
},
|
|
"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`."
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "Payment instrument groups",
|
|
"item": [
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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": "Account holders",
|
|
"item": [
|
|
{
|
|
"name": "/accountHolders/{{id}}",
|
|
"description": "Returns an account holder.",
|
|
"item": [
|
|
{
|
|
"name": "Get an account holder",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"key": "limit",
|
|
"value": "56"
|
|
}
|
|
]
|
|
},
|
|
"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`."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"description\": \"Liable account holder used for international payments and payouts\",\n \"reference\": \"S.Eller-001\",\n \"legalEntityId\": \"LE322JV223222D5GG42KN6869\",\n \"capabilities\": {\n \"receivePayments\": {\n \"requested\": true\n}\n}\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/accountHolders/{{id}}",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"accountHolders",
|
|
"{{id}}"
|
|
],
|
|
"variable": [
|
|
{
|
|
"key": "id",
|
|
"value": "",
|
|
"description": "The unique identifier of the account holder."
|
|
}
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged."
|
|
}
|
|
},
|
|
{
|
|
"name": "Deactivate an account holder",
|
|
"request": {
|
|
"method": "PATCH",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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",
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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": "Payment instruments",
|
|
"item": [
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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",
|
|
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts).",
|
|
"item": [
|
|
{
|
|
"name": "Create a business account",
|
|
"request": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"type\": \"bankAccount\",\n \"description\": \"YOUR_DESCRIPTION\",\n \"balanceAccountId\": \"BA3227C223222B5CTBLR8BWJB\",\n \"issuingCountryCode\": \"NL\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/paymentInstruments",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"paymentInstruments"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
|
|
}
|
|
},
|
|
{
|
|
"name": "Create a physical card",
|
|
"request": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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/marketplaces-and-platforms/business-accounts)."
|
|
}
|
|
},
|
|
{
|
|
"name": "Create a virtual card",
|
|
"request": {
|
|
"method": "POST",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"type\": \"card\",\n \"description\": \"S. Hopper - Main card\",\n \"balanceAccountId\": \"BA32272223222B59CZ3T52DKZ\",\n \"issuingCountryCode\": \"NL\",\n \"card\": {\n \"cardholderName\": \"Sam Hopper\",\n \"brand\": \"mc\",\n \"brandVariant\": \"mcdebit\",\n \"formFactor\": \"virtual\"\n}\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/paymentInstruments",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"paymentInstruments"
|
|
],
|
|
"variable": [
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user. For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "Balance accounts",
|
|
"item": [
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"key": "limit",
|
|
"value": "56"
|
|
}
|
|
]
|
|
},
|
|
"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`."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "/balanceAccounts/{{balanceAccountId}}/sweeps/{{sweepId}}",
|
|
"description": "Returns a sweep.",
|
|
"item": [
|
|
{
|
|
"name": "Get a sweep",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "/balanceAccounts/{{id}}",
|
|
"description": "Returns a balance account.",
|
|
"item": [
|
|
{
|
|
"name": "Get a balance account",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "/balanceAccounts/{{id}}/paymentInstruments",
|
|
"description": "Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`.",
|
|
"item": [
|
|
{
|
|
"name": "Get all payment instruments for a balance account",
|
|
"request": {
|
|
"method": "GET",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"key": "limit",
|
|
"value": "56"
|
|
}
|
|
]
|
|
},
|
|
"description": "Returns a paginated list of the payment instruments associated with a balance account. To fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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": "Updates a balance account.",
|
|
"item": [
|
|
{
|
|
"name": "Update a balance account",
|
|
"request": {
|
|
"method": "PATCH",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"accountHolderId\": \"<string>\",\n \"defaultCurrencyCode\": \"<string>\",\n \"description\": \"<string>\",\n \"reference\": \"<string>\",\n \"status\": \"<string>\",\n \"timeZone\": \"<string>\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/balanceAccounts/{{id}}",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"balanceAccounts",
|
|
"{{id}}"
|
|
],
|
|
"variable": [
|
|
{
|
|
"key": "id",
|
|
"value": "",
|
|
"description": "The unique identifier of the balance account."
|
|
}
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": "Updates a balance account."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"accountHolderId\": \"AH32272223222B59K6ZKBBFNQ\",\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": "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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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": "Transaction rules",
|
|
"item": [
|
|
{
|
|
"name": "/transactionRules/{{transactionRuleId}}",
|
|
"description": "Deletes a transaction rule.",
|
|
"item": [
|
|
{
|
|
"name": "Delete a transaction rule",
|
|
"request": {
|
|
"method": "DELETE",
|
|
"header": [
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
],
|
|
"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."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "/transactionRules/{{transactionRuleId}}",
|
|
"description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource.",
|
|
"item": [
|
|
{
|
|
"name": "Update the status of transaction rule",
|
|
"request": {
|
|
"method": "PATCH",
|
|
"header": [
|
|
{
|
|
"key": "Content-Type",
|
|
"value": "application/json"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"status\": \"inactive\"\n}",
|
|
"options": {
|
|
"raw": {
|
|
"language": "json"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"raw": "{{baseUrl}}/transactionRules/{{transactionRuleId}}",
|
|
"host": [
|
|
"{{baseUrl}}"
|
|
],
|
|
"path": [
|
|
"transactionRules",
|
|
"{{transactionRuleId}}"
|
|
],
|
|
"variable": [
|
|
{
|
|
"key": "transactionRuleId",
|
|
"value": "",
|
|
"description": "The unique identifier of the transaction rule."
|
|
}
|
|
],
|
|
"query": [
|
|
]
|
|
},
|
|
"description": "Updates a transaction rule. * To update only the status of a transaction rule, send only the `status` parameter. All other parameters not provided in the request are left unchanged. * When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, that parameter is removed from the resource."
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"description\": \"Allow only point-of-sale transactions\",\n \"reference\": \"{{$guid}}_4F7346\",\n \"entityKey\": {\n \"entityType\": \"paymentInstrument\",\n \"entityReference\": \"PI3227C223222B5BPCMFXD2XG\"\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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"body": {
|
|
"mode": "raw",
|
|
"raw": "{\n \"description\": \"Assign score if more than 500 EUR in 2 hours\",\n \"entityKey\": {\n \"entityReference\": \"PI3227C223222B5FN65FN5NS9\",\n \"entityType\": \"paymentInstrument\"\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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
{
|
|
"key": "Accept",
|
|
"value": "application/json"
|
|
}
|
|
],
|
|
"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)."
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"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": "YOUR_BALANCE_PLATFORM",
|
|
"value": "",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"key": "balanceAccountId",
|
|
"value": "balanceAccountId_example",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"key": "transactionRuleId",
|
|
"value": "transactionRuleId_example",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"key": "YOUR_MERCHANT_ACCOUNT",
|
|
"value": "",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"key": "id",
|
|
"value": "id_example",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"key": "sweepId",
|
|
"value": "sweepId_example",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
|