openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 279 kB
JSON
{"openapi":"3.1.0","servers":[{"url":"https://balanceplatform-api-test.adyen.com/bcl/v2"}],"info":{"contact":{"name":"Adyen Developer Experience team","url":"https://github.com/Adyen/adyen-openapi","x-twitter":"Adyen"},"description":"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`.","termsOfService":"https://www.adyen.com/legal/terms-and-conditions","title":"Configuration API","version":"2","x-apisguru-categories":["payment"],"x-logo":{"url":"https://adyen.com/.resources/adyen-website/themes/images/apple-icon-180x180.png"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/BalancePlatformService-v2.json","version":"3.1"}],"x-preferred":true,"x-providerName":"adyen.com","x-publicVersion":true,"x-serviceName":"BalancePlatformService"},"tags":[{"name":"Platform"},{"name":"Account holders"},{"name":"Balance accounts"},{"name":"Payment instruments"},{"name":"Payment instrument groups"},{"name":"Transaction rules"},{"name":"Bank account validation"},{"name":"Network tokens"},{"name":"Grant accounts"},{"name":"Grant offers"},{"name":"Card orders"},{"name":"Manage card PIN"},{"name":"Transfer routes"}],"paths":{"/accountHolders":{"post":{"description":"Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities).\n\n","operationId":"post-accountHolders","requestBody":{"content":{"application/json":{"examples":{"createAccountHolder":{"$ref":"#/components/examples/post-accountHolders-createAccountHolder"}},"schema":{"$ref":"#/components/schemas/AccountHolderInfo"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"createAccountHolder":{"$ref":"#/components/examples/post-accountHolders-createAccountHolder-200"}},"schema":{"$ref":"#/components/schemas/AccountHolder"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Create an account holder","tags":["Account holders"],"x-addedInVersion":"1","x-methodName":"createAccountHolder","x-sortIndex":1}},"/accountHolders/{id}":{"get":{"description":"Returns an account holder.","operationId":"get-accountHolders-id","parameters":[{"description":"The unique identifier of the account holder.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-accountHolders-id-success-200"}},"schema":{"$ref":"#/components/schemas/AccountHolder"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get an account holder","tags":["Account holders"],"x-addedInVersion":"1","x-methodName":"getAccountHolder","x-sortIndex":3},"patch":{"description":"Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.","operationId":"patch-accountHolders-id","parameters":[{"description":"The unique identifier of the account holder.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"requestAccountHolderCapability":{"$ref":"#/components/examples/patch-accountHolders-id-requestAccountHolderCapability"},"updateAccountHolderStatus":{"$ref":"#/components/examples/patch-accountHolders-id-updateAccountHolderStatus"}},"schema":{"$ref":"#/components/schemas/AccountHolderUpdateRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"requestAccountHolderCapability":{"$ref":"#/components/examples/patch-accountHolders-id-requestAccountHolderCapability-200"},"updateAccountHolderStatus":{"$ref":"#/components/examples/patch-accountHolders-id-updateAccountHolderStatus-200"}},"schema":{"$ref":"#/components/schemas/AccountHolder"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Update an account holder","tags":["Account holders"],"x-addedInVersion":"1","x-methodName":"updateAccountHolder","x-sortIndex":2}},"/accountHolders/{id}/balanceAccounts":{"get":{"description":"Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.","operationId":"get-accountHolders-id-balanceAccounts","parameters":[{"description":"The unique identifier of the account holder.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The number of items that you want to skip.","in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.","in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-accountHolders-id-balanceAccounts-success-200"}},"schema":{"$ref":"#/components/schemas/PaginatedBalanceAccountsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get all balance accounts of an account holder","tags":["Account holders"],"x-addedInVersion":"1","x-methodName":"getAllBalanceAccountsOfAccountHolder","x-sortIndex":4}},"/accountHolders/{id}/taxForms":{"get":{"description":"Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/us-tax-forms/).","operationId":"get-accountHolders-id-taxForms","parameters":[{"description":"The unique identifier of the account holder.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The type of tax form you want to retrieve. Accepted values are **US1099k** and **US1099nec**","in":"query","name":"formType","required":true,"schema":{"enum":["US1099k","US1099nec"],"type":"string","x-enum":[{"value":"US1099k"},{"value":"US1099nec"}]}},{"description":"The tax year in YYYY format for the tax form you want to retrieve","in":"query","name":"year","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-accountHolders-id-taxForms-success-200"}},"schema":{"$ref":"#/components/schemas/GetTaxFormResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a tax form","tags":["Account holders"],"x-addedInVersion":"2","x-methodName":"getTaxForm","x-sortIndex":5}},"/balanceAccounts":{"post":{"description":"Creates a balance account that holds the funds of the associated account holder.","operationId":"post-balanceAccounts","requestBody":{"content":{"application/json":{"examples":{"createBalanceAccount":{"$ref":"#/components/examples/post-balanceAccounts-createBalanceAccount"}},"schema":{"$ref":"#/components/schemas/BalanceAccountInfo"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"createBalanceAccount":{"$ref":"#/components/examples/post-balanceAccounts-createBalanceAccount-200"}},"schema":{"$ref":"#/components/schemas/BalanceAccount"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Create a balance account","tags":["Balance accounts"],"x-addedInVersion":"1","x-methodName":"createBalanceAccount","x-sortIndex":1}},"/balanceAccounts/{balanceAccountId}/sweeps":{"get":{"description":"Returns a list of the sweeps configured for a balance account.\n\nTo 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`.","operationId":"get-balanceAccounts-balanceAccountId-sweeps","parameters":[{"description":"The unique identifier of the balance account.","in":"path","name":"balanceAccountId","required":true,"schema":{"type":"string"}},{"description":"The number of items that you want to skip.","in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.","in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-balanceAccounts-balanceAccountId-sweeps-success-200"}},"schema":{"$ref":"#/components/schemas/BalanceSweepConfigurationsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get all sweeps for a balance account","tags":["Balance accounts"],"x-addedInVersion":"2","x-methodName":"getAllSweepsForBalanceAccount","x-sortIndex":7},"post":{"description":"Creates a sweep that results in moving funds from or to a balance account.\n\nA sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.","operationId":"post-balanceAccounts-balanceAccountId-sweeps","parameters":[{"description":"The unique identifier of the balance account.","in":"path","name":"balanceAccountId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"createSweep-pull":{"$ref":"#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-pull"},"createSweep-push":{"$ref":"#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-push"},"createSweep-push-priorities":{"$ref":"#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-priorities"}},"schema":{"$ref":"#/components/schemas/CreateSweepConfigurationV2"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"createSweep-pull":{"$ref":"#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-pull-200"},"createSweep-push":{"$ref":"#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-200"},"createSweep-push-priorities":{"$ref":"#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-priorities-200"}},"schema":{"$ref":"#/components/schemas/SweepConfigurationV2"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Create a sweep","tags":["Balance accounts"],"x-addedInVersion":"2","x-methodName":"createSweep","x-sortIndex":5}},"/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}":{"delete":{"description":"Deletes a sweep for a balance account.","operationId":"delete-balanceAccounts-balanceAccountId-sweeps-sweepId","parameters":[{"description":"The unique identifier of the balance account.","in":"path","name":"balanceAccountId","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the sweep.","in":"path","name":"sweepId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content - look at the actual response code for the status of the request. "},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Delete a sweep","tags":["Balance accounts"],"x-addedInVersion":"2","x-methodName":"deleteSweep","x-sortIndex":9},"get":{"description":"Returns a sweep.","operationId":"get-balanceAccounts-balanceAccountId-sweeps-sweepId","parameters":[{"description":"The unique identifier of the balance account.","in":"path","name":"balanceAccountId","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the sweep.","in":"path","name":"sweepId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-balanceAccounts-balanceAccountId-sweeps-sweepId-success-200"}},"schema":{"$ref":"#/components/schemas/SweepConfigurationV2"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a sweep","tags":["Balance accounts"],"x-addedInVersion":"2","x-methodName":"getSweep","x-sortIndex":8},"patch":{"description":"Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged.","operationId":"patch-balanceAccounts-balanceAccountId-sweeps-sweepId","parameters":[{"description":"The unique identifier of the balance account.","in":"path","name":"balanceAccountId","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the sweep.","in":"path","name":"sweepId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"updateSweep-status":{"$ref":"#/components/examples/patch-balanceAccounts-balanceAccountId-sweeps-sweepId-updateSweep-status"}},"schema":{"$ref":"#/components/schemas/UpdateSweepConfigurationV2"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"updateSweep-status":{"$ref":"#/components/examples/patch-balanceAccounts-balanceAccountId-sweeps-sweepId-updateSweep-status-200"}},"schema":{"$ref":"#/components/schemas/SweepConfigurationV2"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Update a sweep","tags":["Balance accounts"],"x-addedInVersion":"2","x-methodName":"updateSweep","x-sortIndex":6}},"/balanceAccounts/{id}":{"get":{"description":"Returns a balance account and its balances for the default currency and other currencies with a non-zero balance.","operationId":"get-balanceAccounts-id","parameters":[{"description":"The unique identifier of the balance account.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-balanceAccounts-id-success-200"}},"schema":{"$ref":"#/components/schemas/BalanceAccount"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a balance account","tags":["Balance accounts"],"x-addedInVersion":"1","x-methodName":"getBalanceAccount","x-sortIndex":3},"patch":{"description":"Updates a balance account.","operationId":"patch-balanceAccounts-id","parameters":[{"description":"The unique identifier of the balance account.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"updateBalanceAccount":{"$ref":"#/components/examples/patch-balanceAccounts-id-updateBalanceAccount"}},"schema":{"$ref":"#/components/schemas/BalanceAccountUpdateRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"updateBalanceAccount":{"$ref":"#/components/examples/patch-balanceAccounts-id-updateBalanceAccount-200"}},"schema":{"$ref":"#/components/schemas/BalanceAccount"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Update a balance account","tags":["Balance accounts"],"x-addedInVersion":"1","x-methodName":"updateBalanceAccount","x-sortIndex":2}},"/balanceAccounts/{id}/paymentInstruments":{"get":{"description":"Returns a paginated list of the payment instruments associated with a balance account. \n\nTo 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`.","operationId":"get-balanceAccounts-id-paymentInstruments","parameters":[{"description":"The unique identifier of the balance account.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The number of items that you want to skip.","in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.","in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The status of the payment instruments that you want to get. By default, the response includes payment instruments with any status.","in":"query","name":"status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-balanceAccounts-id-paymentInstruments-success-200"}},"schema":{"$ref":"#/components/schemas/PaginatedPaymentInstrumentsResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get payment instruments linked to a balance account","tags":["Balance accounts"],"x-addedInVersion":"1","x-methodName":"getPaymentInstrumentsLinkedToBalanceAccount","x-sortIndex":4}},"/balancePlatforms/{id}":{"get":{"description":"Returns a balance platform.","operationId":"get-balancePlatforms-id","parameters":[{"description":"The unique identifier of the balance platform.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-balancePlatforms-id-success-200"}},"schema":{"$ref":"#/components/schemas/BalancePlatform"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a balance platform","tags":["Platform"],"x-addedInVersion":"1","x-methodName":"getBalancePlatform","x-sortIndex":1}},"/balancePlatforms/{id}/accountHolders":{"get":{"description":"Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.","operationId":"get-balancePlatforms-id-accountHolders","parameters":[{"description":"The unique identifier of the balance platform.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The number of items that you want to skip.","in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.","in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-balancePlatforms-id-accountHolders-success-200"}},"schema":{"$ref":"#/components/schemas/PaginatedAccountHoldersResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get all account holders under a balance platform","tags":["Platform"],"x-addedInVersion":"1","x-methodName":"getAllAccountHoldersUnderBalancePlatform","x-sortIndex":2}},"/cardorders":{"get":{"description":"Returns a paginated list of card orders.","operationId":"get-cardorders","parameters":[{"description":"The unique identifier of the card order. ","in":"query","name":"id","required":false,"schema":{"type":"string"}},{"description":"The unique identifier of the card manufacturer profile.","in":"query","name":"cardManufacturingProfileId","required":false,"schema":{"type":"string"}},{"description":"The status of the card order.","in":"query","name":"status","required":false,"schema":{"type":"string"}},{"description":"The unique code of the card manufacturer profile.\n\nPossible values: **mcmaestro**, **mc**, **visa**, **mcdebit**. ","in":"query","name":"txVariantCode","required":false,"schema":{"type":"string"}},{"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**.","in":"query","name":"createdSince","required":false,"schema":{"format":"date-time","type":"string"}},{"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**.","in":"query","name":"createdUntil","required":false,"schema":{"format":"date-time","type":"string"}},{"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**.","in":"query","name":"lockedSince","required":false,"schema":{"format":"date-time","type":"string"}},{"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**.","in":"query","name":"lockedUntil","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"The service center at which the card is issued. The value is case-sensitive. ","in":"query","name":"serviceCenter","required":false,"schema":{"type":"string"}},{"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.\n\n**Default:** 0, which means that the response contains all the elements in the list of card orders.","in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of card orders returned per page. **Default:** 10.","in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-cardorders-success-200"}},"schema":{"$ref":"#/components/schemas/PaginatedGetCardOrderResponse"}}},"description":"OK - the request has succeeded."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of card orders","tags":["Card orders"],"x-addedInVersion":"1","x-methodName":"listCardOrders","x-sortIndex":1}},"/cardorders/{id}/items":{"get":{"description":"Returns the item list of a specific card order.","operationId":"get-cardorders-id-items","parameters":[{"description":"The unique identifier of the card order.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"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.\n\n**Default:** 0, which means that the response contains all the elements in the list of card order items.","in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The number of card order items returned per page. **Default:** 10.","in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-cardorders-id-items-success-200"}},"schema":{"$ref":"#/components/schemas/PaginatedGetCardOrderItemResponse"}}},"description":"OK - the request has succeeded."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get card order items","tags":["Card orders"],"x-addedInVersion":"1","x-methodName":"getCardOrderItems","x-sortIndex":2}},"/grantAccounts/{id}":{"get":{"description":"Returns the details of the [grant account](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-account).","operationId":"get-grantAccounts-id","parameters":[{"description":"The unique identifier of the grant account.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapitalGrantAccount"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a grant account","tags":["Grant accounts"],"x-addedInVersion":"1","x-methodName":"getGrantAccount","x-sortIndex":1}},"/grantOffers":{"get":{"description":"Returns a list of all [grant offers](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter.","operationId":"get-grantOffers","parameters":[{"description":"The unique identifier of the grant account.","in":"query","name":"accountHolderId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantOffers"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-400"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-401"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-403"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-422"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"examples":{"generic":{"$ref":"#/components/examples/generic-500"}},"schema":{"$ref":"#/components/schemas/RestServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"clientKey":[]},{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get all available grant offers","tags":["Grant offers"],"x-addedInVersion":"2","x-methodName":"getAllAvailableGrantOffers","x-sortIndex":1}},"/grantOffers/{grantOfferId}":{"get":{"description":"Returns the details of a single grant offer.","operationId":"get-grantOffers-grantOfferId","parameters":[{"d