diff --git a/postman/GrantService-v3.json b/postman/GrantService-v3.json deleted file mode 100644 index 40eee27..0000000 --- a/postman/GrantService-v3.json +++ /dev/null @@ -1,188 +0,0 @@ -{ - "info": { - "name": "Capital API (v3)", - "description": { - "content": "Adyen Capital allows you to build an embedded financing offering for your users to serve their operational needs. Learn more about [Adyen Capital](https://docs.adyen.com/marketplaces-and-platforms/capital).\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\n-H \"X-API-Key: YOUR_API_KEY\" \\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\n...\n```\n## Roles and permissions\nTo use the Capital API, you need an additional role for your API credential. Your Adyen contact will set up the roles and permissions for you.\n## Versioning\nThe Capital API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/btl/v3/grants\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://balanceplatform-api-live.adyen.com/btl/v3`.\n\n", - "type": "text/markdown" - }, - "version": "3", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" - }, - "item": [ - { - "name": "Capital", - "item": [ - { - "name": "/grants", - "description": "Returns a list of grants with status and outstanding balances.", - "item": [ - { - "name": "Get a capital account", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants" - ], - "variable": [ - ], - "query": [ - { - "key": "counterpartyAccountHolderId", - "value": "counterpartyAccountHolderId_example" - } - ] - }, - "description": "Returns a list of grants with status and outstanding balances." - } - } - ] - }, - { - "name": "/grants/{{id}}", - "description": "Returns the details of a capital account specified in the path.", - "item": [ - { - "name": "Get grant reference details", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants/{{id}}", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants", - "{{id}}" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "The unique identifier of the grant." - } - ], - "query": [ - ] - }, - "description": "Returns the details of a capital account specified in the path." - } - } - ] - }, - { - "name": "/grants", - "description": "Requests the payout of the selected grant offer.", - "item": [ - { - "name": "Request grant payout to a balance account", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"grantAccountId\" : \"CG00000000000000000000001\",\n \"grantOfferId\" : \"0000000000000001\",\n \"counterparty\" : {\n \"accountHolderId\" : \"AH00000000000000000000001\",\n \"balanceAccountId\" : \"BA00000000000000000000001\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/grants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "grants" - ], - "variable": [ - ], - "query": [ - ] - }, - "description": "Requests the payout of the selected grant offer." - } - } - ] - } - ] - } - ], - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "value", - "value": "{{X-API-Key}}", - "type": "string" - }, - { - "key": "key", - "value": "X-API-Key", - "type": "string" - } - ] - }, - "variable": [ - { - "key": "baseUrl", - "value": "https://balanceplatform-api-test.adyen.com/btl/v3", - "type": "string" - }, - { - "key": "X-API-Key", - "value": "", - "type": "string" - }, - { - "key": "id", - "value": "id_example", - "type": "string" - } - ] -} -