jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
02ca833a34da1edcc7c8711e2ce49910e62f2e8b
adyen-openapi/json/BalancePlatformService-v1.json
Colin Rood 48e7ad728e Remove "ssn" from KYC API
2021-08-02 06:56:38 -07:00

6407 lines
268 KiB
JSON
Raw Blame History

{
"openapi" : "3.1.0",
"servers" : [
{
"url" : "https://balanceplatform-api-test.adyen.com/bcl/v1"
}
],
"info" : {
"version" : "1",
"x-publicVersion" : true,
"title" : "Issuing: Balance Platform API",
"description" : "The Balance Platform API enables you to create a platform, onboard users as account holders, create balance accounts, and issue cards.\n\nFor information about use cases, refer to [Adyen Issuing](https://docs.adyen.com/issuing).\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\nBalance Platform API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/bcl/v1\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v1`.\n\nFor more information, refer to our [Going live documentation](https://docs.adyen.com/issuing/integration-checklist#going-live).",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://www.adyen.help/hc/en-us/community/topics",
"email" : "developer-experience@adyen.com"
}
},
"x-groups" : [
"General",
"Account holders",
"Balance accounts",
"Payment instruments",
"Payment instrument groups",
"Transaction rules",
"Legal entities",
"Transfer instruments",
"Documents"
],
"paths" : {
"/accountHolders" : {
"post" : {
"summary" : "Create an account holder.",
"description" : "Creates an account holder. This resource represents your user's entity within the balance platform.\n\nFor more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts).",
"x-addedInVersion" : 1,
"operationId" : "post-accountHolders",
"x-groupName" : "Account holders",
"x-sortIndex" : 1,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createAccountHolder" : {
"$ref" : "#/components/examples/post-accountHolders-createAccountHolder"
}
},
"schema" : {
"$ref" : "#/components/schemas/AccountHolderInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/post-accountHolders-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/AccountHolder"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/accountHolders/{id}" : {
"get" : {
"summary" : "Retrieve an account holder.",
"description" : "Returns a specific account holder.",
"x-addedInVersion" : 1,
"operationId" : "get-accountHolders-id",
"x-groupName" : "Account holders",
"x-sortIndex" : 3,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the account holder.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$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-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"summary" : "Update an account holder.",
"description" : "Updates a specific account holder. When updating an account holder resource, note that:\n\n* If a parameter is not provided in the request, the parameter is left unchanged.\n\n* When updating any parameter in the `contactDetails` object, you must send all other existing `contactDetails` parameters.",
"x-addedInVersion" : 1,
"operationId" : "patch-accountHolders-id",
"x-groupName" : "Account holders",
"x-sortIndex" : 2,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updateAccountHolderStatus" : {
"$ref" : "#/components/examples/patch-accountHolders-id-updateAccountHolderStatus"
}
},
"schema" : {
"$ref" : "#/components/schemas/AccountHolder"
}
}
}
},
"parameters" : [
{
"description" : "Unique identifier of the account holder.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/patch-accountHolders-id-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/AccountHolder"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/accountHolders/{id}/balanceAccounts" : {
"get" : {
"summary" : "Retrieve all balance accounts of a specific account holder.",
"description" : "Returns a paginated list of balance accounts associated with a specific account holder. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 balance accounts and to skip the first 10: `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.",
"x-addedInVersion" : 1,
"operationId" : "get-accountHolders-id-balanceAccounts",
"x-groupName" : "Account holders",
"x-sortIndex" : 4,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the account holder.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "The number of items that you want to skip.",
"name" : "offset",
"in" : "query",
"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.",
"name" : "limit",
"in" : "query",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$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-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/balanceAccounts" : {
"post" : {
"summary" : "Create a balance account.",
"description" : "Creates a balance account. The balance account resource holds the funds of the associated account holder. \n\nFor more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts).",
"x-addedInVersion" : 1,
"operationId" : "post-balanceAccounts",
"x-groupName" : "Balance accounts",
"x-sortIndex" : 1,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createBalanceAccount" : {
"$ref" : "#/components/examples/post-balanceAccounts-createBalanceAccount"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalanceAccountInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/post-balanceAccounts-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalanceAccount"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/balanceAccounts/{id}" : {
"get" : {
"summary" : "Retrieve a balance account.",
"description" : "Returns a specific balance account.",
"x-addedInVersion" : 1,
"operationId" : "get-balanceAccounts-id",
"x-groupName" : "Balance accounts",
"x-sortIndex" : 3,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the balance account.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$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-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/balanceAccounts/{id}/paymentInstruments" : {
"get" : {
"summary" : "Retrieve all payment instruments for a specific balance account.",
"description" : "Returns a paginated list of the payment instruments associated with a specific balance account. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 3 payment instruments and to skip the first 6: `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6`",
"x-addedInVersion" : 1,
"operationId" : "get-balanceAccounts-id-paymentInstruments",
"x-groupName" : "Balance accounts",
"x-sortIndex" : 4,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the balance account.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "The number of items that you want to skip.",
"name" : "offset",
"in" : "query",
"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.",
"name" : "limit",
"in" : "query",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$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-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/balancePlatforms/{id}" : {
"get" : {
"summary" : "Retrieve a balance platform.",
"description" : "Returns a specific balance platform.",
"x-addedInVersion" : 1,
"operationId" : "get-balancePlatforms-id",
"x-groupName" : "General",
"x-sortIndex" : 0,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the balance platform.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$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-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/balancePlatforms/{id}/accountHolders" : {
"get" : {
"summary" : "Retrieve all account holders under a specific balance platform.",
"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: `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`.",
"x-addedInVersion" : 1,
"operationId" : "get-balancePlatforms-id-accountHolders",
"x-groupName" : "General",
"x-sortIndex" : 0,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the balance platform.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "The number of items that you want to skip.",
"name" : "offset",
"in" : "query",
"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.",
"name" : "limit",
"in" : "query",
"required" : false,
"schema" : {
"format" : "int32",
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$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-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/documents" : {
"post" : {
"summary" : "Upload a document for verification checks.",
"description" : "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities) to run automated Know Your Customer checks. If these checks fail, your Adyen contact will inform you so you can provide additional documents. Adyen uses the documents to validate the identity of the individual or organization legal entity, or the legal entity's bank account details.\n\n You should only upload documents when your Adyen contact informs you to provide additional information for the legal entity. For more information, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).",
"x-addedInVersion" : 1,
"operationId" : "post-documents",
"x-groupName" : "Documents",
"x-sortIndex" : 4,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/documents/{id}" : {
"delete" : {
"summary" : "Delete a document.",
"description" : "Deletes a document.",
"x-addedInVersion" : 1,
"operationId" : "delete-documents-id",
"x-groupName" : "Documents",
"x-sortIndex" : 7,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the document to be deleted.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VoidResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"get" : {
"summary" : "Retrieve a document.",
"description" : "Returns a specific document.",
"x-addedInVersion" : 1,
"operationId" : "get-documents-id",
"x-groupName" : "Documents",
"x-sortIndex" : 5,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the document.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"summary" : "Update a document.",
"description" : "Updates a specific document.",
"x-addedInVersion" : 1,
"operationId" : "patch-documents-id",
"x-groupName" : "Documents",
"x-sortIndex" : 6,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
}
},
"parameters" : [
{
"description" : "Unique identifier of the document to be updated.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Document"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities" : {
"post" : {
"summary" : "Create a legal entity.",
"description" : "Creates a legal entity. This resource contains information about an individual or organization that will be onboarded on your balance platform. Adyen uses this information to perform Know Your Customer (KYC) checks as required by payment industry regulations. Your Adyen contact will inform you of the status and results of the KYC checks. \n\nWhen the legal entity passes the verification checks, you can issue a card to them. For more information, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).",
"x-addedInVersion" : 1,
"operationId" : "post-legalEntities",
"x-groupName" : "Legal entities",
"x-sortIndex" : 1,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LegalEntityInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LegalEntity"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/legalEntities/{id}" : {
"get" : {
"summary" : "Retrieve a legal entity.",
"description" : "Returns a specific legal entity.",
"x-addedInVersion" : 1,
"operationId" : "get-legalEntities-id",
"x-groupName" : "Legal entities",
"x-sortIndex" : 2,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the legal entity.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LegalEntity"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"summary" : "Update a legal entity.",
"description" : "Updates a legal entity. When updating a legal entity resource, note that:\n\n * To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.",
"x-addedInVersion" : 1,
"operationId" : "patch-legalEntities-id",
"x-groupName" : "Legal entities",
"x-sortIndex" : 3,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenericEntityInfo"
}
}
}
},
"parameters" : [
{
"description" : "Unique identifier of the legal entity.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LegalEntity"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentInstrumentGroups" : {
"post" : {
"summary" : "Create a payment instrument group.",
"description" : "Creates a payment instrument group, which you use to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.",
"x-addedInVersion" : 1,
"operationId" : "post-paymentInstrumentGroups",
"x-groupName" : "Payment instrument groups",
"x-sortIndex" : 1,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createPaymentInstrumentGroups" : {
"$ref" : "#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrumentGroupInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/post-paymentInstrumentGroups-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrumentGroup"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentInstrumentGroups/{id}" : {
"get" : {
"summary" : "Retrieve a payment instrument group.",
"description" : "Returns a specific payment instrument group.",
"x-addedInVersion" : 1,
"operationId" : "get-paymentInstrumentGroups-id",
"x-groupName" : "Payment instrument groups",
"x-sortIndex" : 2,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the payment instrument group.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/get-paymentInstrumentGroups-id-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrumentGroup"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentInstrumentGroups/{id}/transactionRules" : {
"get" : {
"summary" : "Retrieve all transaction rules for a specific payment instruments group.",
"description" : "Returns a list of all the transaction rules associated with a specific payment instrument group.",
"x-addedInVersion" : 1,
"operationId" : "get-paymentInstrumentGroups-id-transactionRules",
"x-groupName" : "Payment instrument groups",
"x-sortIndex" : 3,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the payment instrument group.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransactionRulesResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentInstruments" : {
"post" : {
"summary" : "Create a payment instrument.",
"description" : "Creates a payment instrument, which results in issuing either a physical or a virtual card to your user.\n\n For more information, refer to [Create cards](https://docs.adyen.com/issuing/create-cards).",
"x-addedInVersion" : 1,
"operationId" : "post-paymentInstruments",
"x-groupName" : "Payment instruments",
"x-sortIndex" : 11,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createPhysicalCard" : {
"$ref" : "#/components/examples/post-paymentInstruments-createPhysicalCard"
},
"createVirtualCard" : {
"$ref" : "#/components/examples/post-paymentInstruments-createVirtualCard"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrumentInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/post-paymentInstruments-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentInstruments/{id}" : {
"get" : {
"summary" : "Retrieve a payment instrument.",
"description" : "Returns a specific payment instrument.",
"x-addedInVersion" : 1,
"operationId" : "get-paymentInstruments-id",
"x-groupName" : "Payment instruments",
"x-sortIndex" : 13,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the payment instrument.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/get-paymentInstruments-id-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"summary" : "Update a payment instrument.",
"description" : "Updates a specific payment instrument. Once a payment instrument is already active, you can only update the status. However, for cards created with a **Requested** or **Inactive** status, you can still update the balance account associated with the card.",
"x-addedInVersion" : 1,
"operationId" : "patch-paymentInstruments-id",
"x-groupName" : "Payment instruments",
"x-sortIndex" : 12,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updatePaymentInstrumentBalanceAccount" : {
"$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount"
},
"updatePaymentInstrumentStatus" : {
"$ref" : "#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrumentUpdateRequest"
}
}
}
},
"parameters" : [
{
"description" : "Unique identifier of the payment instrument.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/patch-paymentInstruments-id-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
},
"invalidData-422" : {
"$ref" : "#/components/examples/patch-paymentInstruments-id-invalidData-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentInstruments/{id}/transactionRules" : {
"get" : {
"summary" : "Retrieve all transaction rules for a specific payment instrument.",
"description" : "Returns a list of transaction rules associated to a specific payment instrument.",
"x-addedInVersion" : 1,
"operationId" : "get-paymentInstruments-id-transactionRules",
"x-groupName" : "Payment instruments",
"x-sortIndex" : 14,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the payment instrument.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/get-paymentInstruments-id-transactionRules-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransactionRulesResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/transactionRules" : {
"post" : {
"summary" : "Create a transaction rule.",
"description" : "Creates a transaction rule. Transaction rules define conditions to automatically approve or deny transactions. You can apply transaction rules to a specific payment instrument, a group of payment instruments, or to all the payment instruments in your balance platform.\n\nFor more information on how you can set conditions, refer to [Transaction rules](https://docs.adyen.com/issuing/transaction-rules).",
"x-addedInVersion" : 1,
"operationId" : "post-transactionRules",
"x-groupName" : "Transaction rules",
"x-sortIndex" : 1,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"createTransactionRule" : {
"$ref" : "#/components/examples/post-transactionRules-createTransactionRule"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransactionRuleInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/post-transactionRules-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransactionRule"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/transactionRules/{transactionRuleId}" : {
"delete" : {
"summary" : "Delete a transaction rule.",
"description" : "Deletes a transaction rule.",
"x-addedInVersion" : 1,
"operationId" : "delete-transactionRules-transactionRuleId",
"x-groupName" : "Transaction rules",
"x-sortIndex" : 5,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the transaction rule.",
"name" : "transactionRuleId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/delete-transactionRules-transactionRuleId-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransactionRule"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"get" : {
"summary" : "Retrieve a transaction rule.",
"description" : "Returns a specific transaction rule.",
"x-addedInVersion" : 1,
"operationId" : "get-transactionRules-transactionRuleId",
"x-groupName" : "Transaction rules",
"x-sortIndex" : 2,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the transaction rule.",
"name" : "transactionRuleId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/get-transactionRules-transactionRuleId-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransactionRuleResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"summary" : "Update a transaction rule.",
"description" : "Updates a transaction rule. When updating a transaction rule resource, note that: \n\n* When updating only the `status`, you can send only the `status` parameter. All other parameters not provided in the request are left unchanged.\n\n* When updating any other parameter, you need to send all existing resource parameters. If you omit a parameter in the request, the parameter is removed from the resource.",
"x-addedInVersion" : 1,
"operationId" : "patch-transactionRules-transactionRuleId",
"x-groupName" : "Transaction rules",
"x-sortIndex" : 3,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"updateTransactionRuleStatus" : {
"$ref" : "#/components/examples/patch-transactionRules-transactionRuleId-updateTransactionRuleStatus"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransactionRuleInfo"
}
}
}
},
"parameters" : [
{
"description" : "Unique identifier of the transaction rule.",
"name" : "transactionRuleId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success-200" : {
"$ref" : "#/components/examples/patch-transactionRules-transactionRuleId-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/TransactionRule"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$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-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/transferInstruments" : {
"post" : {
"summary" : "Create a transfer instrument.",
"description" : "Creates a transfer instrument. A transfer instrument is a bank account or other payment details that a legal entity owns. Adyen performs Know Your Customer (KYC) checks on the transfer instrument as required by payment industry regulations. Your Adyen contact will inform you of the status and results of the KYC checks.\n\nWhen the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).",
"x-addedInVersion" : 1,
"operationId" : "post-transferInstruments",
"x-groupName" : "Transfer instruments",
"x-sortIndex" : 8,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferInstrumentInfo"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/transferInstruments/{id}" : {
"delete" : {
"summary" : "Delete a transfer instrument",
"description" : "Deletes a transfer instrument.",
"x-addedInVersion" : 1,
"operationId" : "delete-transferInstruments-id",
"x-groupName" : "Transfer instruments",
"x-sortIndex" : 11,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the transfer instrument to be deleted.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VoidResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"get" : {
"summary" : "Retrieve a transfer instrument.",
"description" : "Returns a specific transfer instrument.",
"x-addedInVersion" : 1,
"operationId" : "get-transferInstruments-id",
"x-groupName" : "Transfer instruments",
"x-sortIndex" : 9,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Unique identifier of the transfer instrument.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"summary" : "Update a transfer instrument.",
"description" : "Updates a transfer instrument.",
"x-addedInVersion" : 1,
"operationId" : "patch-transferInstruments-id",
"x-groupName" : "Transfer instruments",
"x-sortIndex" : 10,
"security" : [
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferInstrumentInfo"
}
}
}
},
"parameters" : [
{
"description" : "Unique identifier of the transfer instrument.",
"name" : "id",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferInstrument"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
}
},
"components" : {
"schemas" : {
"AccountHolder" : {
"properties" : {
"balancePlatform" : {
"description" : "Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) where the account holder belongs. Required in the request if your API credentials has access to multiple balance platforms.",
"type" : "string"
},
"contactDetails" : {
"description" : "Contact details of the account holder.",
"$ref" : "#/components/schemas/ContactDetails"
},
"description" : {
"description" : "Your description for the account holder, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"id" : {
"description" : "Unique identifier of the account holder.",
"type" : "string"
},
"legalEntityId" : {
"description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities) associated with the account holder. Adyen performs the Know Your Customer (KYC) verification process against the legal entity of the account holder.\n\nTo create a legal entity, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).",
"type" : "string"
},
"reference" : {
"description" : "Your reference to the account holder, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"status" : {
"description" : "The status of the account holder.\n\nPossible values: \n\n * **Active**: The account holder is active. This the default status when creating an account holder. \n\n * **Suspended**: The account holder is temporarily suspended. You can set the account back to active or permanently close the account. \n\n* **Closed**: The account holder is permanently closed. This action cannot be undone.",
"enum" : [
"Active",
"Closed",
"Inactive",
"Suspended"
],
"type" : "string"
},
"sweepConfigurations" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/SweepConfiguration"
},
"description" : "Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).\n\n Sweep configurations on the account holder level applies to all the account holder's balance accounts.\n\n The key must be a currency code in the three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format and in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.\n\n",
"type" : "object"
}
},
"required" : [
"contactDetails",
"id"
]
},
"AccountHolderInfo" : {
"properties" : {
"balancePlatform" : {
"description" : "Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) where the account holder belongs. Required in the request if your API credentials has access to multiple balance platforms.",
"type" : "string"
},
"contactDetails" : {
"description" : "Contact details of the account holder.",
"$ref" : "#/components/schemas/ContactDetails"
},
"description" : {
"description" : "Your description for the account holder, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"legalEntityId" : {
"description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities) associated with the account holder. Adyen performs the Know Your Customer (KYC) verification process against the legal entity of the account holder.\n\nTo create a legal entity, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).",
"type" : "string"
},
"reference" : {
"description" : "Your reference to the account holder, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"sweepConfigurations" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/SweepConfiguration"
},
"description" : "Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).\n\n Sweep configurations on the account holder level applies to all the account holder's balance accounts.\n\n The key must be a currency code in the three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format and in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.\n\n",
"type" : "object"
}
},
"required" : [
"contactDetails"
]
},
"Address" : {
"properties" : {
"city" : {
"description" : "The name of the city.",
"type" : "string"
},
"country" : {
"description" : "The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
"type" : "string"
},
"houseNumberOrName" : {
"description" : "The number or name of the house.",
"type" : "string"
},
"postalCode" : {
"description" : "A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.",
"type" : "string"
},
"stateOrProvince" : {
"description" : "State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.",
"type" : "string"
},
"street" : {
"description" : "The name of the street.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.",
"type" : "string"
}
},
"required" : [
"street",
"houseNumberOrName",
"city",
"postalCode",
"country"
]
},
"Address2" : {
"properties" : {
"city" : {
"description" : "The name of the city.",
"type" : "string"
},
"country" : {
"description" : "The two-letter country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.",
"type" : "string"
},
"postalCode" : {
"description" : "Postal code.",
"type" : "string"
},
"stateOrProvince" : {
"description" : "State or province as defined in ISO 3166-2. For example, **CA** in the US.",
"type" : "string"
},
"street" : {
"description" : "The name of the street, and the house or building number.",
"type" : "string"
},
"street2" : {
"description" : "The apartment, unit, or suite number.",
"type" : "string"
}
}
},
"Amount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
},
"required" : [
"value",
"currency"
]
},
"Attachment" : {
"properties" : {
"content" : {
"description" : "The document, in Base64-encoded string format.",
"format" : "byte",
"type" : "string"
},
"contentType" : {
"deprecated" : true,
"x-deprecatedInVersion" : 1,
"x-deprecatedMessage" : "Field is being deprecated.",
"description" : "The file format.\n\n Possible values: **application/pdf**, **image/jpg**, **image/jpeg**, or **image/png**. ",
"type" : "string"
},
"filename" : {
"deprecated" : true,
"x-deprecatedInVersion" : 1,
"x-deprecatedMessage" : "Field is being deprecated.",
"description" : "The name of the file including the file extension.",
"type" : "string"
},
"pageType" : {
"description" : "Specifies which side of the ID card is being uploaded.\n\n- When `type` is **driversLicense**, set this to **front** or **back**.\n\n- When omitted, we infer the page number based on the order of attachments.",
"type" : "string"
}
}
},
"Authentication" : {
"properties" : {
"password" : {
"description" : "The password to be used for 3D Secure password-based authentication.",
"type" : "string"
},
"phone" : {
"description" : "The phone number to be used for payment authentication.\n>Make sure to verify that the account holder owns the phone number.",
"$ref" : "#/components/schemas/Phone"
}
}
},
"Balance" : {
"properties" : {
"available" : {
"description" : "The remaining amount available for spending.",
"format" : "int64",
"type" : "integer"
},
"balance" : {
"description" : "The total amount in the balance.",
"format" : "int64",
"type" : "integer"
},
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance.",
"type" : "string"
},
"reserved" : {
"description" : "The amount reserved for payments that have been authorised, but have not been captured yet.",
"format" : "int64",
"type" : "integer"
}
},
"required" : [
"currency",
"balance",
"reserved",
"available"
]
},
"BalanceAccount" : {
"properties" : {
"accountHolderId" : {
"description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}) associated with the balance account.",
"type" : "string"
},
"balances" : {
"description" : "List of balances with the amount and currency.",
"items" : {
"$ref" : "#/components/schemas/Balance"
},
"type" : "array"
},
"defaultCurrencyCode" : {
"description" : "The default currency code of this balance account, in three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format.\nThe default value is **EUR**.",
"type" : "string"
},
"description" : {
"description" : "A human-readable description of the balance account, maximum 300 characters. You can use this parameter to help distinguish between multiple balance accounts under an account holder.",
"maxLength" : 300,
"type" : "string"
},
"id" : {
"description" : "Unique identifier of the balance account.",
"type" : "string"
},
"paymentInstruments" : {
"description" : "List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}__queryParam_id) associated with the balance account.",
"items" : {
"$ref" : "#/components/schemas/PaymentInstrumentReference"
},
"type" : "array"
},
"reference" : {
"description" : "Your reference to the balance account, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"status" : {
"description" : "The status of the balance account, set to **Active** by default. \n",
"type" : "string"
},
"sweepConfigurations" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/SweepConfiguration"
},
"description" : "Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).\n\nSweep configurations on the balance account override [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/accountHolders__reqParam_sweepConfigurations) configurations.\n\nThe key must be a currency code in the three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format and in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.",
"type" : "object"
}
},
"required" : [
"accountHolderId",
"id"
]
},
"BalanceAccountInfo" : {
"properties" : {
"accountHolderId" : {
"description" : "Unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}) associated with the balance account.",
"type" : "string"
},
"defaultCurrencyCode" : {
"description" : "The default currency code of this balance account, in three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format.\nThe default value is **EUR**.",
"type" : "string"
},
"description" : {
"description" : "A human-readable description of the balance account, maximum 300 characters. You can use this parameter to help distinguish between multiple balance accounts under an account holder.",
"maxLength" : 300,
"type" : "string"
},
"reference" : {
"description" : "Your reference to the balance account, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"sweepConfigurations" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/SweepConfiguration"
},
"description" : "Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).\n\nSweep configurations on the balance account override [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/accountHolders__reqParam_sweepConfigurations) configurations.\n\nThe key must be a currency code in the three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) format and in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.",
"type" : "object"
}
},
"required" : [
"accountHolderId"
]
},
"BalancePlatform" : {
"properties" : {
"description" : {
"description" : "A description of the balance platform, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"id" : {
"description" : "Unique identifier of the balance platform.",
"type" : "string"
},
"status" : {
"description" : "The status of the balance platform.\n\nPossible values: **Active**, **Inactive**, **Closed**, **Suspended**.",
"type" : "string"
}
},
"required" : [
"id"
]
},
"BankAccountInfo" : {
"properties" : {
"accountNumber" : {
"description" : "The bank account number (without separators).\n\n When this is provided, the `bankCode` and `branchCode` are also required.",
"type" : "string"
},
"accountType" : {
"description" : "The type of bank account. Only applies to bank accounts held in the US. \n\nPossible values: **checking**, **savings**.",
"type" : "string"
},
"bankBicSwift" : {
"description" : "The bank's BIC or SWIFT code.",
"type" : "string"
},
"bankCity" : {
"description" : "The city where the bank is located.",
"type" : "string"
},
"bankCode" : {
"description" : "The bank code of the banking institution with which the bank account is registered.\n\nRequired when you provide an `accountNumber`.",
"type" : "string"
},
"bankName" : {
"description" : "The name of the banking institution with which the bank account is held.",
"type" : "string"
},
"branchCode" : {
"description" : "The branch code of the branch under which the bank account is registered.\n\nRequired when you provide an `accountNumber`.\n\n In the following countries, this value corresponds to:\n\n\n* United States - Routing number\n* United Kingdom - Sort code\n* Germany - Bankleitzahl",
"type" : "string"
},
"checkCode" : {
"description" : "The check code of the bank account.",
"type" : "string"
},
"countryCode" : {
"description" : "Country where the bank account is registered, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.",
"type" : "string"
},
"currencyCode" : {
"description" : "The account's three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **EUR**.",
"type" : "string"
},
"iban" : {
"description" : "The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.",
"type" : "string"
}
}
},
"BirthData" : {
"properties" : {
"dateOfBirth" : {
"description" : "The individual's date of birth, in YYYY-MM-DD format.",
"type" : "string"
}
}
},
"Card" : {
"properties" : {
"authentication" : {
"description" : "Authentication details for 3D Secure and SMS one-time password (OTP) for wallet activation.",
"$ref" : "#/components/schemas/Authentication"
},
"bin" : {
"description" : "The BIN of the card number.",
"type" : "string"
},
"brand" : {
"description" : "The brand for the payment instrument.\nPossible values: **visa**, **mc**.",
"type" : "string"
},
"brandVariant" : {
"description" : "The brand variant for the payment instrument.\n>Contact your Adyen Implementation Manager to get the values that are relevant to your integration. Examples: **visadebit**, **mcprepaid**.",
"type" : "string"
},
"cardholderName" : {
"description" : "The name of the card holder. Maximum length 26 characters.",
"type" : "string"
},
"configuration" : {
"description" : "Specific settings for this card, including the configuration profile.",
"$ref" : "#/components/schemas/CardConfiguration"
},
"cvc" : {
"description" : "The CVC2 value of the card.\n> The CVC2 is not sent by default. This is only returned in the `POST` response for single-use virtual cards.",
"type" : "string"
},
"deliveryContact" : {
"description" : "The delivery contact (name and address) for physical card delivery.",
"$ref" : "#/components/schemas/Contact"
},
"expiration" : {
"description" : "The expiration date of the card.",
"$ref" : "#/components/schemas/Expiry"
},
"formFactor" : {
"description" : "The form factor of the card.\nPossible values: **virtual**, **physical**.",
"enum" : [
"physical",
"unknown",
"virtual"
],
"type" : "string"
},
"lastFour" : {
"description" : "Last last four digits of the card number.",
"type" : "string"
},
"number" : {
"description" : "The primary account number of the card.\n> The primary account number is masked by default. The full primary account number is only returned for single-use virtual cards.",
"readOnly" : true,
"type" : "string"
}
},
"required" : [
"formFactor",
"cardholderName",
"brand",
"brandVariant",
"number"
]
},
"CardConfiguration" : {
"properties" : {
"activationUrl" : {
"description" : "The activation URL of the card configuration profile.",
"type" : "string"
},
"cardImageId" : {
"description" : "The Entity Reference of the card image.",
"type" : "string"
},
"carrierImageId" : {
"description" : "The Entity Reference of the carrier image.",
"type" : "string"
},
"configurationProfileId" : {
"description" : "The ID of the card configuration profile.",
"type" : "string"
},
"currency" : {
"description" : "The ISO-4217 currency code for the card. For example **EUR**.",
"type" : "string"
},
"language" : {
"description" : "The ISO-639-1 application language for the card. For example, **en**.",
"type" : "string"
},
"logoImageId" : {
"description" : "The Entity Reference of the logo image.",
"type" : "string"
}
}
},
"CardInfo" : {
"properties" : {
"authentication" : {
"description" : "Authentication details for 3D Secure and SMS one-time password (OTP) for wallet activation.",
"$ref" : "#/components/schemas/Authentication"
},
"brand" : {
"description" : "The brand for the payment instrument.\nPossible values: **visa**, **mc**.",
"type" : "string"
},
"brandVariant" : {
"description" : "The brand variant for the payment instrument.\n>Contact your Adyen Implementation Manager to get the values that are relevant to your integration. Examples: **visadebit**, **mcprepaid**.",
"type" : "string"
},
"cardholderName" : {
"description" : "The name of the card holder. Maximum length 26 characters.",
"type" : "string"
},
"configuration" : {
"description" : "Specific settings for this card, including the configuration profile.",
"$ref" : "#/components/schemas/CardConfiguration"
},
"deliveryContact" : {
"description" : "The delivery contact (name and address) for physical card delivery.",
"$ref" : "#/components/schemas/Contact"
},
"formFactor" : {
"description" : "The form factor of the card.\nPossible values: **virtual**, **physical**.",
"enum" : [
"physical",
"unknown",
"virtual"
],
"type" : "string"
}
},
"required" : [
"formFactor",
"cardholderName",
"brand",
"brandVariant"
]
},
"Contact" : {
"properties" : {
"address" : {
"description" : "The address of the contact.",
"$ref" : "#/components/schemas/Address"
},
"email" : {
"description" : "The e-mail address of the contact.",
"type" : "string"
},
"fullPhoneNumber" : {
"description" : "The phone number of the contact provided as a single string. It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
"type" : "string"
},
"name" : {
"description" : "The name of the contact.",
"$ref" : "#/components/schemas/Name"
},
"personalData" : {
"description" : "Personal data of the contact.",
"$ref" : "#/components/schemas/PersonalData"
},
"phoneNumber" : {
"description" : "The phone number of the contact.",
"$ref" : "#/components/schemas/PhoneNumber"
},
"webAddress" : {
"description" : "The URL of the website of the contact.",
"type" : "string"
}
}
},
"ContactDetails" : {
"properties" : {
"address" : {
"description" : "The address of the account holder.",
"$ref" : "#/components/schemas/Address"
},
"email" : {
"description" : "The e-mail address of the account holder.",
"type" : "string"
},
"phone" : {
"description" : "The phone number of the account holder.",
"$ref" : "#/components/schemas/Phone"
},
"webAddress" : {
"description" : "URL to the website of the account holder.",
"type" : "string"
}
},
"required" : [
"email",
"phone",
"address"
]
},
"Document" : {
"properties" : {
"attachment" : {
"deprecated" : true,
"x-deprecatedInVersion" : 1,
"x-deprecatedMessage" : "Use the `attachments` array instead.",
"description" : "This object will be deprecated soon. Use the `attachments` array instead.",
"$ref" : "#/components/schemas/Attachment"
},
"attachments" : {
"description" : "Array that contains the document. The array supports multiple attachments for uploading different sides or pages of one document.",
"items" : {
"$ref" : "#/components/schemas/Attachment"
},
"type" : "array"
},
"description" : {
"description" : "Your description of the document.",
"type" : "string"
},
"expiryDate" : {
"deprecated" : true,
"x-deprecatedInVersion" : 1,
"x-deprecatedMessage" : "Field is deprecated.",
"description" : "The expiry date of the document, in YYYY-MM-DD format.",
"type" : "string"
},
"id" : {
"description" : "Unique identifier of the document.",
"type" : "string"
},
"issuerCountry" : {
"deprecated" : true,
"x-deprecatedInVersion" : 1,
"x-deprecatedMessage" : "Field is deprecated.",
"description" : "The country where the document was issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**.",
"type" : "string"
},
"issuerState" : {
"deprecated" : true,
"x-deprecatedInVersion" : 1,
"x-deprecatedMessage" : "Field is being deprecated.",
"description" : "The state or province where the document was issued (AU only).",
"type" : "string"
},
"number" : {
"description" : "The number in the document.",
"type" : "string"
},
"owner" : {
"description" : "Contains information about the resource that owns the document.",
"$ref" : "#/components/schemas/Entity"
},
"type" : {
"description" : "The type of document. The possible values depend on the legal entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **driversLicense**, **identityCard**, **nationalIdNumber**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**\n\nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner), use **bankStatement**.",
"enum" : [
"bankStatement",
"driversLicense",
"identityCard",
"nationalIdNumber",
"passport",
"proofOfAddress",
"proofOfNationalIdNumber",
"proofOfResidency",
"registrationDocument",
"taxDocument"
],
"type" : "string"
}
}
},
"Entity" : {
"properties" : {
"id" : {
"description" : "Unique identifier of the resource that owns the document. Depending on the entity `type`, this value can be the unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/legalEntities/{id}__queryParam_id) or the [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/get/transferInstruments/{id}__queryParam_id).",
"type" : "string"
},
"type" : {
"description" : "The type of resource that owns the document. Possible values: **legalEntity**, **bankAccount**.",
"type" : "string"
}
}
},
"EntityReference" : {
"properties" : {
"id" : {
"description" : "Unique identifier of the resource.",
"type" : "string"
}
}
},
"Expiry" : {
"properties" : {
"month" : {
"description" : "The month in which the card will expire.",
"type" : "string"
},
"year" : {
"description" : "The year in which the card will expire.",
"type" : "string"
}
}
},
"GenericEntityInfo" : {
"properties" : {
"entityAssociations" : {
"description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners through ownership or control, and signatories. ",
"items" : {
"$ref" : "#/components/schemas/LegalEntityAssociation"
},
"type" : "array"
},
"individual" : {
"description" : "Information about the individual. Required if `type` is **individual**.",
"$ref" : "#/components/schemas/Individual"
},
"organization" : {
"description" : "Information about the organization. Required if `type` is **organization**.",
"$ref" : "#/components/schemas/Organization"
}
}
},
"IdentificationData" : {
"properties" : {
"expiryDate" : {
"deprecated" : true,
"x-deprecatedInVersion" : 1,
"x-deprecatedMessage" : "Field is deprecated.",
"description" : "The expiry date of the document, in YYYY-MM-DD format.",
"type" : "string"
},
"issuerCountry" : {
"deprecated" : true,
"x-deprecatedInVersion" : 1,
"x-deprecatedMessage" : "Field is deprecated.",
"description" : "The country where the document was issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US**.",
"type" : "string"
},
"issuerState" : {
"description" : "The state or province where the document was issued (AU only).",
"type" : "string"
},
"nationalIdExempt" : {
"description" : "Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, note that Adyen will require them to [upload an ID document](https://docs.adyen.com/issuing/kyc-verification#upload-documents).",
"type" : "boolean"
},
"number" : {
"description" : "The number in the document.",
"type" : "string"
},
"type" : {
"description" : "The type of document. The possible values depend on the legal entity `type`.\n\n* For `type` **organization**, the values can be **proofOfAddress**, **registrationDocument**, **taxDocument**. \n\n* For `type` **individual**, the values can be **driversLicense**, **identityCard**, **nationalIdNumber**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**.\n\nWhen uploading a document owned by a [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/documents__reqParam_owner), use **bankStatement**.",
"enum" : [
"bankStatement",
"driversLicense",
"identityCard",
"nationalIdNumber",
"passport",
"proofOfAddress",
"proofOfNationalIdNumber",
"proofOfResidency",
"registrationDocument",
"ssn",
"taxDocument"
],
"type" : "string"
}
}
},
"Individual" : {
"properties" : {
"birthData" : {
"description" : "The individual's birth information.",
"$ref" : "#/components/schemas/BirthData"
},
"email" : {
"description" : "The email address of the legal entity.",
"type" : "string"
},
"identificationData" : {
"description" : "Information about the individual's identification document.",
"$ref" : "#/components/schemas/IdentificationData"
},
"name" : {
"description" : "The individual's name.",
"$ref" : "#/components/schemas/Name2"
},
"nationality" : {
"description" : "The individual's nationality.",
"type" : "string"
},
"phone" : {
"description" : "The phone number of the legal entity.",
"$ref" : "#/components/schemas/PhoneNumber2"
},
"residentialAddress" : {
"description" : "The residential address of the individual.",
"$ref" : "#/components/schemas/Address2"
},
"webData" : {
"deprecated" : true,
"description" : "The website and app URL of the legal entity.",
"$ref" : "#/components/schemas/WebData"
}
}
},
"InvalidField" : {
"properties" : {
"message" : {
"description" : "Description of the validation error.",
"type" : "string"
},
"name" : {
"description" : "The field that has an invalid value.",
"type" : "string"
},
"value" : {
"description" : "The invalid value.",
"type" : "string"
}
},
"required" : [
"name",
"value",
"message"
]
},
"LegalEntity" : {
"properties" : {
"documents" : {
"description" : "List of documents uploaded for the legal entity.",
"items" : {
"$ref" : "#/components/schemas/EntityReference"
},
"type" : "array"
},
"entityAssociations" : {
"description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners through ownership or control, and signatories. ",
"items" : {
"$ref" : "#/components/schemas/LegalEntityAssociation"
},
"type" : "array"
},
"id" : {
"description" : "Unique identifier of the legal entity.",
"type" : "string"
},
"individual" : {
"description" : "Information about the individual. Required if `type` is **individual**.",
"$ref" : "#/components/schemas/Individual"
},
"organization" : {
"description" : "Information about the organization. Required if `type` is **organization**.",
"$ref" : "#/components/schemas/Organization"
},
"transferInstruments" : {
"description" : "List of transfer instruments that the legal entity owns.",
"items" : {
"$ref" : "#/components/schemas/EntityReference"
},
"type" : "array"
},
"type" : {
"description" : "The type of legal entity. Possible values: **individual**, **organization**.",
"enum" : [
"individual",
"organization"
],
"type" : "string"
}
}
},
"LegalEntityAssociation" : {
"properties" : {
"jobTitle" : {
"description" : "The individual's job title in case of `type` **uboThroughControl** or **signatory**.",
"type" : "string"
},
"legalEntityId" : {
"description" : "Unique identifier of the individual legal entity associated with the organization.",
"type" : "string"
},
"type" : {
"description" : "How the individual is associated with the organization. \n\nPossible values: **uboThroughOwnership**, **uboThroughControl**, **signatory**. ",
"enum" : [
"signatory",
"uboThroughControl",
"uboThroughOwnership"
],
"type" : "string"
}
}
},
"LegalEntityInfo" : {
"properties" : {
"entityAssociations" : {
"description" : "List of individual legal entities associated with the organization legal entity. \nFor example, ultimate business owners through ownership or control, and signatories. ",
"items" : {
"$ref" : "#/components/schemas/LegalEntityAssociation"
},
"type" : "array"
},
"individual" : {
"description" : "Information about the individual. Required if `type` is **individual**.",
"$ref" : "#/components/schemas/Individual"
},
"organization" : {
"description" : "Information about the organization. Required if `type` is **organization**.",
"$ref" : "#/components/schemas/Organization"
},
"type" : {
"description" : "The type of legal entity. Possible values: **individual**, **organization**.",
"enum" : [
"individual",
"organization"
],
"type" : "string"
}
}
},
"Name" : {
"properties" : {
"firstName" : {
"description" : "The first name.",
"type" : "string"
},
"lastName" : {
"description" : "The last name.",
"type" : "string"
}
},
"required" : [
"firstName",
"lastName"
]
},
"Name2" : {
"properties" : {
"firstName" : {
"description" : "The individual's first name.",
"type" : "string"
},
"infix" : {
"description" : "The infix in the individual's name, if any.",
"type" : "string"
},
"lastName" : {
"description" : "The individual's last name.",
"type" : "string"
}
}
},
"Organization" : {
"properties" : {
"description" : {
"description" : "Your description for the organization.",
"type" : "string"
},
"doingBusinessAs" : {
"description" : "The organization's registered name, if different from the legal name.",
"type" : "string"
},
"email" : {
"description" : "The email address of the legal entity.",
"type" : "string"
},
"legalName" : {
"description" : "The organization's legal name.",
"type" : "string"
},
"phone" : {
"description" : "The phone number of the legal entity.",
"$ref" : "#/components/schemas/PhoneNumber2"
},
"principalPlaceOfBusiness" : {
"description" : "The address where the organization operates from. Provide this if the principal place of business is different from the `registeredAddress`.",
"$ref" : "#/components/schemas/Address2"
},
"registeredAddress" : {
"description" : "The address of the organization registered at their registrar (such as the Chamber of Commerce).",
"$ref" : "#/components/schemas/Address2"
},
"registrationNumber" : {
"description" : "The organization's registration number.",
"type" : "string"
},
"stockData" : {
"description" : "Information about the organization's publicly traded stock. Provide this object only if `type` is **listedPublicCompany**.",
"$ref" : "#/components/schemas/StockData"
},
"taxId" : {
"description" : "The organization's tax identifier.",
"type" : "string"
},
"taxIdAbsenceReason" : {
"description" : "The reason the organization has not provided a tax identifier.\n\nPossible values: **industryExemption**, **belowTaxThreshold**.",
"enum" : [
"industryExemption",
"belowTaxThreshold"
],
"type" : "string"
},
"type" : {
"description" : "The type of organization. Possible values: **associationIncorporated**, **governmentalOrganization**, **listedPublicCompany**,**nonProfit**, **partnershipIncorporated**, **privateCompany**, **unlistedPublicCompany**, **soleProprietorship**.",
"enum" : [
"associationIncorporated",
"governmentalOrganization",
"listedPublicCompany",
"nonProfit",
"partnershipIncorporated",
"privateCompany",
"unlistedPublicCompany",
"soleProprietorship"
],
"type" : "string"
},
"webData" : {
"deprecated" : true,
"description" : "The website and app URL of the legal entity.",
"$ref" : "#/components/schemas/WebData"
}
}
},
"PaginatedAccountHoldersResponse" : {
"properties" : {
"accountHolders" : {
"description" : "List of account holders.",
"items" : {
"$ref" : "#/components/schemas/AccountHolder"
},
"type" : "array"
},
"hasNext" : {
"description" : "Indicates if there are more items in the next page.",
"type" : "boolean"
},
"hasPrevious" : {
"description" : "Indicates if there are more items in the previous page.",
"type" : "boolean"
}
},
"required" : [
"accountHolders",
"hasPrevious",
"hasNext"
]
},
"PaginatedBalanceAccountsResponse" : {
"properties" : {
"balanceAccounts" : {
"description" : "List of balance accounts.",
"items" : {
"$ref" : "#/components/schemas/BalanceAccount"
},
"type" : "array"
},
"hasNext" : {
"description" : "Indicates if there are more items in the next page.",
"type" : "boolean"
},
"hasPrevious" : {
"description" : "Indicates if there are more items in the previous page.",
"type" : "boolean"
}
},
"required" : [
"balanceAccounts",
"hasPrevious",
"hasNext"
]
},
"PaginatedPaymentInstrumentsResponse" : {
"properties" : {
"hasNext" : {
"description" : "Indicates if there are more items in the next page.",
"type" : "boolean"
},
"hasPrevious" : {
"description" : "Indicates if there are more items in the previous page.",
"type" : "boolean"
},
"paymentInstruments" : {
"description" : "List of payment instruments associated with the balance account.",
"items" : {
"$ref" : "#/components/schemas/PaymentInstrument"
},
"type" : "array"
}
},
"required" : [
"paymentInstruments",
"hasPrevious",
"hasNext"
]
},
"PaymentInstrument" : {
"properties" : {
"balanceAccountId" : {
"description" : "Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) associated with the payment instrument.",
"type" : "string"
},
"card" : {
"description" : "Contains information about the card payment instrument.",
"$ref" : "#/components/schemas/Card"
},
"description" : {
"description" : "Your description for the payment instrument, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"id" : {
"description" : "Unique identifier of the payment instrument.",
"type" : "string"
},
"issuingCountryCode" : {
"description" : "Country where the payment instrument is being issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**, **US**.",
"type" : "string"
},
"paymentInstrumentGroupId" : {
"description" : "The ID of a payment instrument group that this payment instrument is part of.",
"type" : "string"
},
"reference" : {
"description" : "Your reference to the payment instrument, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"status" : {
"description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, the status is set to **Active** by default. However, there can be exceptions based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards issued in the US, the default status is **Requested**.\n\nPossible values: \n\n * **Active**: The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable when creating physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**\n\n ",
"enum" : [
"Active",
"Closed",
"Inactive",
"Lost",
"Requested",
"Stolen",
"Suspended"
],
"type" : "string"
},
"type" : {
"description" : "The type of payment instrument.\n\nPossible value: **card** ",
"enum" : [
"bankAccount",
"card",
"unknown"
],
"type" : "string"
}
},
"required" : [
"balanceAccountId",
"issuingCountryCode",
"type",
"id"
]
},
"PaymentInstrumentGroup" : {
"properties" : {
"balancePlatform" : {
"description" : "Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) where this payment instrument group belongs.",
"type" : "string"
},
"description" : {
"description" : "Your description for the payment instrument group, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"id" : {
"description" : "Unique identifier of the payment instrument group.",
"type" : "string"
},
"properties" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "Properties of the payment instrument group.",
"type" : "object"
},
"reference" : {
"description" : "Your reference to the payment instrument group, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"txVariant" : {
"description" : "The tx variant of the payment instrument group.",
"type" : "string"
}
},
"required" : [
"balancePlatform",
"txVariant"
]
},
"PaymentInstrumentGroupInfo" : {
"properties" : {
"balancePlatform" : {
"description" : "Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) where this payment instrument group belongs.",
"type" : "string"
},
"description" : {
"description" : "Your description for the payment instrument group, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"properties" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "Properties of the payment instrument group.",
"type" : "object"
},
"reference" : {
"description" : "Your reference to the payment instrument group, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"txVariant" : {
"description" : "The tx variant of the payment instrument group.",
"type" : "string"
}
},
"required" : [
"balancePlatform",
"txVariant"
]
},
"PaymentInstrumentInfo" : {
"properties" : {
"balanceAccountId" : {
"description" : "Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) associated with the payment instrument.",
"type" : "string"
},
"card" : {
"description" : "Object that contains information about the card payment instrument.",
"$ref" : "#/components/schemas/CardInfo"
},
"description" : {
"description" : "Your description for the payment instrument, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"issuingCountryCode" : {
"description" : "Country where the payment instrument is being issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**, **US**.",
"type" : "string"
},
"paymentInstrumentGroupId" : {
"description" : "The ID of a payment instrument group that this payment instrument is part of.",
"type" : "string"
},
"reference" : {
"description" : "Your reference to the payment instrument, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"status" : {
"description" : "The status of the payment instrument. If a status is not specified when creating a payment instrument, the status is set to **Active** by default. However, there can be exceptions based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards issued in the US, the default status is **Requested**.\n\nPossible values: \n\n * **Active**: The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable when creating physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**\n\n ",
"enum" : [
"Active",
"Closed",
"Inactive",
"Lost",
"Requested",
"Stolen",
"Suspended"
],
"type" : "string"
},
"type" : {
"description" : "The type of payment instrument.\n\nPossible value: **card** ",
"enum" : [
"bankAccount",
"card",
"unknown"
],
"type" : "string"
}
},
"required" : [
"balanceAccountId",
"issuingCountryCode",
"type"
]
},
"PaymentInstrumentReference" : {
"properties" : {
"id" : {
"description" : "Unique identifier of the payment instrument.",
"type" : "string"
}
},
"required" : [
"id"
]
},
"PaymentInstrumentUpdateRequest" : {
"properties" : {
"balanceAccountId" : {
"description" : "Unique identifier of the balance account associated with this payment instrument.\n>You can only change the balance account ID if the payment instrument has a **Requested** or **Inactive** status.",
"type" : "string"
},
"card" : {
"description" : "Object that contains information about the card payment instrument.",
"$ref" : "#/components/schemas/CardInfo"
},
"status" : {
"description" : "The new status of the payment instrument.\n\nPossible values: \n\n * **Active**: The payment instrument is active and can be used to make payments. \n\n * **Requested**: The payment instrument has been requested. This state is applicable when creating physical cards. \n\n* **Inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. \n\n * **Closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n* **Stolen** \n\n * **Lost**\n\n ",
"enum" : [
"Active",
"Closed",
"Inactive",
"Lost",
"Requested",
"Stolen",
"Suspended"
],
"type" : "string"
}
}
},
"PersonalData" : {
"properties" : {
"dateOfBirth" : {
"description" : "The date of birth of the person.\nThe date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).",
"type" : "string"
},
"idNumber" : {
"description" : "An ID number of the person.",
"type" : "string"
},
"nationality" : {
"description" : "The nationality of the person represented by a two-character country code.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",
"maxLength" : 2,
"minLength" : 2,
"type" : "string"
}
}
},
"Phone" : {
"properties" : {
"number" : {
"description" : "The full phone number provided as a single string. \nFor example, **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, \n\n or **\"(0031) 611223344\"**.",
"type" : "string"
},
"type" : {
"description" : "The type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n",
"enum" : [
"Landline",
"Mobile"
],
"type" : "string"
}
},
"required" : [
"number",
"type"
]
},
"PhoneNumber" : {
"properties" : {
"phoneCountryCode" : {
"description" : "The two-character country code of the phone number.\n>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').",
"type" : "string"
},
"phoneNumber" : {
"description" : "The phone number.\n>The inclusion of the phone number country code is not necessary.",
"type" : "string"
},
"phoneType" : {
"description" : "The type of the phone number.\n>The following values are permitted: `Landline`, `Mobile`, `SIP`, `Fax`.",
"enum" : [
"Fax",
"Landline",
"Mobile",
"SIP"
],
"type" : "string"
}
},
"required" : [
"phoneCountryCode",
"phoneNumber"
]
},
"PhoneNumber2" : {
"properties" : {
"countryCode" : {
"description" : "The two-letter country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** or **NL**.",
"type" : "string"
},
"number" : {
"description" : "The phone number.",
"type" : "string"
},
"type" : {
"description" : "The type of phone number.\n Possible values: **mobile**, **landline**, **sip**, or **fax.** ",
"type" : "string"
}
}
},
"RecurringDetail" : {
"properties" : {
"merchantAccount" : {
"description" : "The merchant account used when the payment details were stored.",
"type" : "string"
},
"reference" : {
"description" : "The `recurringDetailReference` returned in the response when the payment details were stored.",
"type" : "string"
},
"shopperReference" : {
"description" : "The unique identifier used when the payment details were stored.",
"type" : "string"
}
}
},
"RestServiceError" : {
"properties" : {
"detail" : {
"description" : "A human-readable explanation specific to this occurrence of the problem.",
"type" : "string"
},
"errorCode" : {
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"errorType" : {
"description" : "A URI that identifies the problem type, which points to human-readable documentation on this problem type.",
"type" : "string"
},
"instance" : {
"description" : "A unique URI that identifies the specific occurrence of the problem.",
"type" : "string"
},
"invalidFields" : {
"description" : "Detailed explanations of each validation error, when applicable.",
"items" : {
"$ref" : "#/components/schemas/InvalidField"
},
"type" : "array"
},
"requestId" : {
"description" : "A unique reference for the request, essentially same as `pspReference`.",
"type" : "string"
},
"status" : {
"description" : "The HTTP status code.",
"format" : "int32",
"type" : "integer"
},
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
}
},
"required" : [
"errorType",
"errorCode",
"title",
"detail",
"status"
]
},
"ServiceError" : {
"properties" : {
"errorCode" : {
"description" : "The error code mapped to the error message.",
"type" : "string"
},
"errorType" : {
"description" : "The category of the error.",
"type" : "string"
},
"message" : {
"description" : "A short explanation of the issue.",
"type" : "string"
},
"pspReference" : {
"description" : "The PSP reference of the payment.",
"type" : "string"
},
"status" : {
"description" : "The HTTP response status.",
"format" : "int32",
"type" : "integer"
}
}
},
"StockData" : {
"properties" : {
"marketIdentifier" : {
"description" : "The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) of the stock market where the organization's stocks are traded.",
"type" : "string"
},
"stockNumber" : {
"description" : "The stock number.",
"type" : "string"
},
"tickerSymbol" : {
"description" : "The stock ticker symbol.",
"type" : "string"
}
}
},
"SweepConfiguration" : {
"properties" : {
"balanceAccountId" : {
"description" : "Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}) that will be the source or destination of the balance sweep. This can only be used for periodic sweep schedules such as `schedule.type` **daily** or **monthly**.",
"type" : "string"
},
"merchantAccount" : {
"description" : "The merchant account that will be the source of funds. You can only use this if you are processing payments with Adyen. This can only be used for sweeps of `type` **pull** and `schedule.type` **balance**.",
"type" : "string"
},
"schedule" : {
"description" : "The schedule when the `triggerAmount` is evaluated. If the balance meets the threshold, funds are pushed out of or pulled in to the balance account.",
"$ref" : "#/components/schemas/SweepSchedule"
},
"sweepAmount" : {
"description" : "The amount that must be pushed out or pulled in. You can configure only one of `sweepAmount` or `targetAmount`.",
"$ref" : "#/components/schemas/Amount"
},
"targetAmount" : {
"description" : "The amount that must be available in the balance account after the sweep. You can configure only one of `sweepAmount` or `targetAmount`.",
"$ref" : "#/components/schemas/Amount"
},
"transferInstrumentId" : {
"description" : "Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/transferInstruments/{id}__queryParam_id) that will be the source or destination of the balance sweep. This can only be used for periodic sweep schedules such as `schedule.type` **daily** or **monthly**.",
"type" : "string"
},
"triggerAmount" : {
"description" : "The threshold amount that triggers the sweep. If not specified, the amount defaults to zero. The `triggerAmount` is evaluated at the specified `schedule.type`.\n\n* For `type` **pull**, if the balance is less than or equal to the `triggerAmount`, funds will be pulled in to the balance account.\n\n* For `type` **push**, if the balance is more than or equal to the `triggerAmount`, funds will be pushed out of the balance account.",
"$ref" : "#/components/schemas/Amount"
},
"type" : {
"default" : "push",
"description" : "The direction of sweep. Possible values:\n\n * **push**: _Push funds out_ to a destination balance account or transfer instrument.\n\n * **pull**: _Pull funds in_ from a source merchant account or balance account. ",
"enum" : [
"pull",
"push"
],
"type" : "string"
}
},
"required" : [
"schedule",
"type"
]
},
"SweepSchedule" : {
"properties" : {
"type" : {
"description" : "The schedule type.\n\nPossible values:\n\n* **daily**: Push out funds daily at 07:00 AM CET.\n\n* **weekly**: Push out funds every Monday at 07:00 AM CET.\n\n* **monthly**: Push out funds every 1st of the month at 07:00 AM CET.\n\n* **balance**: Only for sweeps of `type` **pull** and with a `merchantAccount` source. Pull in funds instantly if the balance is less than or equal to the `triggerAmount`.",
"enum" : [
"balance",
"daily",
"monthly",
"weekly"
],
"type" : "string"
}
}
},
"TransactionRule" : {
"properties" : {
"amount" : {
"description" : "The maximum amount that a payment instrument can be used for in a given period specified in the `interval.type`.",
"$ref" : "#/components/schemas/Amount"
},
"balancePlatformId" : {
"description" : "Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/get/balancePlatforms/{id}__queryParam_id) to which the rule applies.",
"type" : "string"
},
"countries" : {
"description" : "List of countries to which the rule applies. For example: **[\"NL\",\"US\"]**.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"description" : {
"description" : "Your description for the transaction rule, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"endDate" : {
"description" : "The date when the rule will stop being evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**.\n\nIf not provided when creating a transaction rule, the rule will be evaluated until the rule status is set to **inactive**.",
"type" : "string"
},
"entryModes" : {
"description" : "List of point-of-sale entry modes to which the rule applies.\n\nPossible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **token**, **server**, **barcode**, **ocr**.",
"items" : {
"enum" : [
"barcode",
"chip",
"cof",
"contactless",
"magstripe",
"manual",
"ocr",
"server",
"token",
"unknown"
],
"type" : "string"
},
"type" : "array"
},
"id" : {
"description" : "Unique identifier of the transaction rule.",
"type" : "string"
},
"interval" : {
"description" : "The interval when the rule conditions must be applied.",
"$ref" : "#/components/schemas/TransactionRuleInterval"
},
"maxTransactions" : {
"description" : "The maximum number of transactions that a payment instrument can be used for in a given period specified in the `interval.type`.",
"format" : "int32",
"type" : "integer"
},
"mccs" : {
"description" : "List of Merchant Category Codes (MCCs) to which the rule applies.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"paymentInstrumentGroupId" : {
"description" : "Unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstrumentGroups/{id}) to which the rule applies.",
"type" : "string"
},
"paymentInstrumentId" : {
"description" : "Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}) to which the rule applies.",
"type" : "string"
},
"processingTypes" : {
"description" : "List of processing types to which the rule applies.\n\nPossible values: **atmWithdraw**, **pos**, **ecommerce**, **moto**, **recurring**, **balanceInquiry**.",
"items" : {
"enum" : [
"atmWithdraw",
"balanceInquiry",
"ecommerce",
"moto",
"pos",
"recurring",
"unknown"
],
"type" : "string"
},
"type" : "array"
},
"reference" : {
"description" : "Your reference for the transaction rule, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"startDate" : {
"description" : "The date when the rule will start to be evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**.\n\nIf not provided when creating a transaction rule, the `startDate` is set to the date when the rule status is set to **active**. \n\n",
"type" : "string"
},
"status" : {
"description" : "The status of the transaction rule. If you provide a `startDate` in the request, the rule is automatically created \nwith an **active** status. \n\nPossible values: **active**, **inactive**.",
"enum" : [
"active",
"inactive"
],
"type" : "string"
},
"type" : {
"description" : "The type of conditions provided in the rule.\n\nPossible values:\n * **allowList** - The rule provides categories (such as country and MCC) where payments must be allowed. \n * **blockList** - The rule provides categories (such as country and MCC) where payments must be blocked. \n * **maxUsage** - The rule sets limits for the maximum amount or maximum number of transactions for the lifetime of the payment instrument. \n * **velocity** - The rule sets limits for the maximum amount or maximum number of transactions for a given time interval.\n",
"enum" : [
"allowList",
"blockList",
"maxUsage",
"velocity"
],
"type" : "string"
}
},
"required" : [
"type",
"description",
"reference",
"interval"
]
},
"TransactionRuleInfo" : {
"properties" : {
"amount" : {
"description" : "The maximum amount that a payment instrument can be used for in a given period specified in the `interval.type`.",
"$ref" : "#/components/schemas/Amount"
},
"balancePlatformId" : {
"description" : "Unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/get/balancePlatforms/{id}__queryParam_id) to which the rule applies.",
"type" : "string"
},
"countries" : {
"description" : "List of countries to which the rule applies. For example: **[\"NL\",\"US\"]**.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"description" : {
"description" : "Your description for the transaction rule, maximum 300 characters.",
"maxLength" : 300,
"type" : "string"
},
"endDate" : {
"description" : "The date when the rule will stop being evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**.\n\nIf not provided when creating a transaction rule, the rule will be evaluated until the rule status is set to **inactive**.",
"type" : "string"
},
"entryModes" : {
"description" : "List of point-of-sale entry modes to which the rule applies.\n\nPossible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **token**, **server**, **barcode**, **ocr**.",
"items" : {
"enum" : [
"barcode",
"chip",
"cof",
"contactless",
"magstripe",
"manual",
"ocr",
"server",
"token",
"unknown"
],
"type" : "string"
},
"type" : "array"
},
"interval" : {
"description" : "The interval when the rule conditions must be applied.",
"$ref" : "#/components/schemas/TransactionRuleInterval"
},
"maxTransactions" : {
"description" : "The maximum number of transactions that a payment instrument can be used for in a given period specified in the `interval.type`.",
"format" : "int32",
"type" : "integer"
},
"mccs" : {
"description" : "List of Merchant Category Codes (MCCs) to which the rule applies.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"paymentInstrumentGroupId" : {
"description" : "Unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstrumentGroups/{id}) to which the rule applies.",
"type" : "string"
},
"paymentInstrumentId" : {
"description" : "Unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/paymentInstruments/{id}) to which the rule applies.",
"type" : "string"
},
"processingTypes" : {
"description" : "List of processing types to which the rule applies.\n\nPossible values: **atmWithdraw**, **pos**, **ecommerce**, **moto**, **recurring**, **balanceInquiry**.",
"items" : {
"enum" : [
"atmWithdraw",
"balanceInquiry",
"ecommerce",
"moto",
"pos",
"recurring",
"unknown"
],
"type" : "string"
},
"type" : "array"
},
"reference" : {
"description" : "Your reference for the transaction rule, maximum 150 characters.",
"maxLength" : 150,
"type" : "string"
},
"startDate" : {
"description" : "The date when the rule will start to be evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**.\n\nIf not provided when creating a transaction rule, the `startDate` is set to the date when the rule status is set to **active**. \n\n",
"type" : "string"
},
"status" : {
"description" : "The status of the transaction rule. If you provide a `startDate` in the request, the rule is automatically created \nwith an **active** status. \n\nPossible values: **active**, **inactive**.",
"enum" : [
"active",
"inactive"
],
"type" : "string"
},
"type" : {
"description" : "The type of conditions provided in the rule.\n\nPossible values:\n * **allowList** - The rule provides categories (such as country and MCC) where payments must be allowed. \n * **blockList** - The rule provides categories (such as country and MCC) where payments must be blocked. \n * **maxUsage** - The rule sets limits for the maximum amount or maximum number of transactions for the lifetime of the payment instrument. \n * **velocity** - The rule sets limits for the maximum amount or maximum number of transactions for a given time interval.\n",
"enum" : [
"allowList",
"blockList",
"maxUsage",
"velocity"
],
"type" : "string"
}
},
"required" : [
"type",
"description",
"reference",
"interval"
]
},
"TransactionRuleInterval" : {
"properties" : {
"type" : {
"description" : "Defines the period when the rule conditions and limits apply, and how often the amount and transaction counters are reset.\n\nPossible values:\n * **perTransaction**: The conditions are evaluated and the counters are reset for every transaction.\n * **daily**: The counters are reset daily at 00:00:00 UTC.\n * **weekly**: The counters are reset every Monday at 00:00:00 UTC. \n * **monthly**: The counters reset every 1st day of the month at 00:00:00 UTC. \n * **lifetime**: The conditions and limits apply to the lifetime of the payment instrument.",
"enum" : [
"daily",
"lifetime",
"monthly",
"perTransaction",
"weekly"
],
"type" : "string"
}
},
"required" : [
"type"
]
},
"TransactionRuleResponse" : {
"properties" : {
"transactionRule" : {
"description" : "The transaction rule.",
"$ref" : "#/components/schemas/TransactionRule"
}
}
},
"TransactionRulesResponse" : {
"properties" : {
"transactionRules" : {
"description" : "List of transaction rules.",
"items" : {
"$ref" : "#/components/schemas/TransactionRule"
},
"type" : "array"
}
}
},
"TransferInstrument" : {
"properties" : {
"bankAccount" : {
"description" : "Contains information about the legal entity's bank account. Required when `type` is **bankAccount**.",
"$ref" : "#/components/schemas/BankAccountInfo"
},
"id" : {
"description" : "Unique identifier of the transfer instrument.",
"type" : "string"
},
"legalEntityId" : {
"description" : "Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/legalEntities/{id}__queryParam_id) that owns the transfer instrument.",
"type" : "string"
},
"recurringDetail" : {
"description" : "Contains information about the legal entity's previously stored payment details. Required when `type` is **recurringDetail**.",
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : {
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**, **recurringDetail**.",
"type" : "string"
}
}
},
"TransferInstrumentInfo" : {
"properties" : {
"bankAccount" : {
"description" : "Contains information about the legal entity's bank account. Required when `type` is **bankAccount**.",
"$ref" : "#/components/schemas/BankAccountInfo"
},
"legalEntityId" : {
"description" : "Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/legalEntities/{id}__queryParam_id) that owns the transfer instrument.",
"type" : "string"
},
"recurringDetail" : {
"description" : "Contains information about the legal entity's previously stored payment details. Required when `type` is **recurringDetail**.",
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : {
"description" : "The type of transfer instrument.\n\nPossible values: **bankAccount**, **recurringDetail**.",
"type" : "string"
}
}
},
"VoidResponse" : {
},
"WebData" : {
"properties" : {
"appAddress" : {
"description" : "Application URL.",
"type" : "string"
},
"webAddress" : {
"description" : "Website URL.",
"type" : "string"
}
}
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
},
"examples" : {
"delete-transactionRules-transactionRuleId-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully deleting a transaction rule",
"value" : {
"amount" : {
"currency" : "EUR",
"value" : 10000
},
"description" : "Allow up to 100 EUR per month",
"interval" : {
"type" : "monthly"
},
"paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ",
"reference" : "myRule16378",
"startDate" : "2021-01-25T12:46:35.476629Z",
"type" : "velocity",
"id" : "TR3227C223222B5CMDKQTBQ5M"
}
},
"generic-400" : {
"summary" : "Response code - 400 Bad request",
"value" : {
"type" : "https://docs.adyen.com/errors/general/bad-request",
"title" : "Bad request",
"status" : 400,
"detail" : "Empty input which would have resulted in a null result.",
"errorCode" : "00_400"
}
},
"generic-401" : {
"summary" : "Response code - 401 Unauthorized",
"value" : {
"type" : "https://docs.adyen.com/errors/security/unauthorized",
"title" : "Unauthorized",
"status" : 401,
"errorCode" : "00_401"
}
},
"generic-403" : {
"summary" : "Response code - 403 Forbidden.",
"value" : {
"type" : "https://docs.adyen.com/errors/security/unauthorized",
"title" : "Forbidden",
"status" : 403,
"detail" : "Not the right permission to access this service.",
"errorCode" : "00_403"
}
},
"generic-404" : {
"summary" : "Response code 404 - Not found",
"value" : {
"type" : "https://docs.adyen.com/errors/security/unauthorized",
"title" : "Unauthorized",
"status" : 401,
"detail" : "Not the right permission to access this service.",
"errorCode" : "00_401"
}
},
"generic-422" : {
"summary" : "Response code - 422 Unprocessable Entity.",
"value" : {
"type" : "https://docs.adyen.com/errors/general/invalid-field-value",
"title" : "Invalid Payment Instrument information provided",
"status" : 422,
"detail" : "The balanceAccountId can only be changed when the status is Inactive or Requested",
"requestId" : "1W1UI15PLVGC9V8O",
"errorCode" : "30_031"
}
},
"generic-500" : {
"summary" : "Response code - 500 Internal Server Error",
"value" : {
"type" : "https://docs.adyen.com/errors/general/internal",
"title" : "An internal error happened",
"status" : 500,
"detail" : "Unrecoverable error while trying to create payment instrument",
"requestId" : "1WAF555PLWNTLYOQ",
"errorCode" : "00_500"
}
},
"generic-503" : {
"summary" : "Response code - 503 Internal Server Error",
"value" : {
"type" : "https://docs.adyen.com/errors/general/processing-error",
"title" : "Error processing request",
"status" : 500,
"detail" : "Error while determining the payment instrument workflow",
"requestId" : "1W1UHY5O2CONU4R7",
"errorCode" : "99_500"
}
},
"get-accountHolders-id-balanceAccounts-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a list of balance accounts under an account holder",
"value" : {
"balanceAccounts" : [
{
"accountHolderId" : "AH32272223222B59K6ZKBBFNQ",
"defaultCurrencyCode" : "EUR",
"id" : "BA32272223222B59K6ZXHBFN6",
"status" : "Active"
},
{
"accountHolderId" : "AH32272223222B59K6ZKBBFNQ",
"defaultCurrencyCode" : "EUR",
"id" : "BA32272223222B59K72CKBFNJ",
"status" : "Active"
},
{
"accountHolderId" : "AH32272223222B59K6ZKBBFNQ",
"defaultCurrencyCode" : "EUR",
"id" : "BA32272223222B5BRR27B2M7G",
"status" : "Active"
}
],
"hasNext" : true,
"hasPrevious" : false
}
},
"get-accountHolders-id-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving an account holder",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"contactDetails" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "274",
"postalCode" : "1020CD",
"street" : "Brannan Street"
},
"email" : "s.hopper@example.com",
"phone" : {
"number" : "+315551231234",
"type" : "Mobile"
}
},
"description" : "S.Hopper - Staff 123",
"id" : "AH32272223222B5CM4MWJ892H",
"status" : "Active"
}
},
"get-balanceAccounts-id-paymentInstruments-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a list of payment instruments under a balance account",
"value" : {
"hasNext" : "true",
"hasPrevious" : "false",
"paymentInstruments" : [
{
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"issuingCountryCode" : "GB",
"status" : "Active",
"type" : "card",
"card" : {
"brandVariant" : "mc",
"cardholderName" : "name",
"formFactor" : "virtual",
"bin" : "555544",
"expiration" : {
"month" : "12",
"year" : "2022"
},
"lastFour" : "2357",
"number" : "************2357"
},
"id" : "PI32272223222B59M5TM658DT"
},
{
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"issuingCountryCode" : "GB",
"status" : "Active",
"type" : "card",
"card" : {
"brandVariant" : "mc",
"cardholderName" : "name",
"formFactor" : "virtual",
"bin" : "555544",
"expiration" : {
"month" : "01",
"year" : "2023"
},
"lastFour" : "8331",
"number" : "************8331"
},
"id" : "PI32272223222B59PXDGQDLSF"
}
]
}
},
"get-balanceAccounts-id-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a balance account",
"value" : {
"accountHolderId" : "AH32272223222B59K6RTQBFNZ",
"defaultCurrencyCode" : "EUR",
"balances" : [
{
"available" : 0,
"balance" : 0,
"currency" : "EUR",
"reserved" : 0
}
],
"id" : "BA3227C223222B5BLP6JQC3FD",
"paymentInstruments" : [
{
"id" : "PI32272223222B5BRM4FZ7J9J"
}
],
"status" : "Active"
}
},
"get-balancePlatforms-id-accountHolders-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a list of account holders under a balance platform",
"value" : {
"accountHolders" : [
{
"contactDetails" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "6",
"postalCode" : "12336750",
"street" : "Simon Carmiggeltstraat"
}
},
"description" : "J. Doe",
"id" : "AH32272223222B59DDWSCCMP7",
"status" : "Active"
},
{
"contactDetails" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "11",
"postalCode" : "12336750",
"street" : "Simon Carmiggeltstraat"
}
},
"description" : "S. Hopper",
"id" : "AH32272223222B59DJ7QBCMPN",
"status" : "Active"
}
],
"hasNext" : "true",
"hasPrevious" : "false"
}
},
"get-balancePlatforms-id-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a balance platform",
"value" : {
"id" : "YOUR_BALANCE_PLATFORM",
"status" : "Active"
}
},
"get-paymentInstrumentGroups-id-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a payment instrument group",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"txVariant" : "mc",
"id" : "PG3227C223222B5CMD3FJFKGZ"
}
},
"get-paymentInstrumentGroups-id-transactionRules-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a list of transaction rules applied to a payment instrument group",
"value" : {
"transactionRules" : [
{
"description" : "Allow 5 transactions per month",
"interval" : {
"type" : "monthly"
},
"maxTransactions" : 5,
"paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ",
"reference" : "myRule12345",
"startDate" : "2021-01-25T12:46:35.476629Z",
"status" : "active",
"type" : "velocity",
"id" : "TR32272223222B5CMDGMC9F4F"
},
{
"amount" : {
"currency" : "EUR",
"value" : 10000
},
"description" : "Allow up to 100 EUR per month",
"interval" : {
"type" : "monthly"
},
"paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ",
"reference" : "myRule16378",
"startDate" : "2021-01-25T12:46:35.476629Z",
"status" : "active",
"type" : "velocity",
"id" : "TR32272223222B5CMDGT89F4F"
}
]
}
},
"get-paymentInstruments-id-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a payment instrument",
"value" : {
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"description" : "S. Hopper - Main card",
"issuingCountryCode" : "GB",
"status" : "Active",
"type" : "card",
"card" : {
"brand" : "mc",
"brandVariant" : "mcdebit",
"cardholderName" : "Simon Hopper",
"formFactor" : "virtual",
"bin" : "555544",
"expiration" : {
"month" : "01",
"year" : "2024"
},
"lastFour" : "3548",
"number" : "************3548"
},
"id" : "PI32272223222B5CMD3MQ3HXX"
}
},
"get-paymentInstruments-id-transactionRules-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a list of transaction rules applied to a payment instrument",
"value" : {
"transactionRules" : [
{
"description" : "Allow 5 transactions per month",
"interval" : {
"type" : "monthly"
},
"maxTransactions" : 5,
"paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ",
"reference" : "myRule12345",
"startDate" : "2021-01-25T12:46:35.476629Z",
"status" : "active",
"type" : "velocity",
"id" : "TR32272223222B5CMDGMC9F4F"
},
{
"amount" : {
"currency" : "EUR",
"value" : 10000
},
"description" : "Allow up to 100 EUR per month",
"interval" : {
"type" : "monthly"
},
"paymentInstrumentGroupId" : "PG3227C223222B5CMD3FJFKGZ",
"reference" : "myRule16378",
"startDate" : "2021-01-25T12:46:35.476629Z",
"status" : "active",
"type" : "velocity",
"id" : "TR32272223222B5CMDGT89F4F"
}
]
}
},
"get-transactionRules-transactionRuleId-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response when retrieving a transaction rule",
"value" : {
"transactionRule" : {
"description" : "Allow 5 transactions per month",
"interval" : {
"type" : "monthly"
},
"maxTransactions" : 5,
"paymentInstrumentId" : "PI3227C223222B59KGTXP884R",
"reference" : "myRule12345",
"startDate" : "2021-01-25T12:46:35.476629Z",
"status" : "active",
"type" : "velocity",
"id" : "TR32272223222B5CMD3V73HXG"
}
}
},
"patch-accountHolders-id-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully updating the status of an account holder",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"contactDetails" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "274",
"postalCode" : "1020CD",
"street" : "Brannan Street"
},
"email" : "s.hopper@example.com",
"phone" : {
"number" : "+315551231234",
"type" : "Mobile"
}
},
"description" : "S.Hopper - Staff 123",
"id" : "AH32272223222B5CM4MWJ892H",
"status" : "Suspended"
}
},
"patch-accountHolders-id-updateAccountHolderStatus" : {
"summary" : "Update the status of an account holder.",
"description" : "Example request for updating the status of an account holder",
"value" : {
"status" : "Suspended"
}
},
"patch-paymentInstruments-id-invalidData-422" : {
"summary" : "Response code - 422 Unprocessable Entity",
"description" : "Example response for a failed request to update the balance account ID",
"value" : {
"type" : "https://docs.adyen.com/errors/general/invalid-field-value",
"title" : "Invalid Payment Instrument information provided",
"status" : 422,
"detail" : "The balanceAccountId can only be changed when the status is Inactive or Requested",
"requestId" : "1W1UI15PLVGC9V8O",
"errorCode" : "30_031"
}
},
"patch-paymentInstruments-id-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example respones for successfully updating the status of a payment instrument",
"value" : {
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"description" : "S. Hopper - Main card",
"issuingCountryCode" : "GB",
"status" : "Suspended",
"type" : "card",
"card" : {
"brand" : "mc",
"brandVariant" : "mcdebit",
"cardholderName" : "Simon Hopper",
"formFactor" : "virtual",
"bin" : "555544",
"expiration" : {
"month" : "01",
"year" : "2024"
},
"lastFour" : "5785",
"number" : "************5785"
},
"id" : "PI3227C223222B5CMD278FKGS"
}
},
"patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount" : {
"summary" : "Update the balance account linked to a payment instrument.",
"description" : "Example request for updating the balance account of a payment instrument",
"value" : {
"balanceAccountId" : "BA32272223222B5CM82WL892M"
}
},
"patch-paymentInstruments-id-updatePaymentInstrumentStatus" : {
"summary" : "Update the status of a payment instrument.",
"value" : {
"status" : "Suspended"
}
},
"patch-transactionRules-transactionRuleId-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully updating the status of a transaction rule",
"value" : {
"description" : "Allow 5 transactions per month",
"interval" : {
"type" : "monthly"
},
"maxTransactions" : 5,
"paymentInstrumentId" : "PI3227C223222B59KGTXP884R",
"reference" : "myRule12345",
"startDate" : "2021-01-21T12:46:35.476629Z",
"status" : "inactive",
"type" : "velocity",
"id" : "TR3227C223222B5B85CDV4DRS"
}
},
"patch-transactionRules-transactionRuleId-updateTransactionRuleStatus" : {
"summary" : "Update the status of transaction rule.",
"description" : "Example request for updating the status of a transaction rule",
"value" : {
"status" : "inactive"
}
},
"post-accountHolders-createAccountHolder" : {
"summary" : "Create an account holder.",
"description" : "Example request for creating an account holder",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"description" : "S.Hopper - Staff 123",
"contactDetails" : {
"email" : "s.hopper@example.com",
"phone" : {
"number" : "+315551231234",
"type" : "Mobile"
},
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"street" : "Brannan Street",
"houseNumberOrName" : "274",
"postalCode" : "1020CD"
}
}
}
},
"post-accountHolders-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully creating an account holder",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"contactDetails" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"houseNumberOrName" : "274",
"postalCode" : "1020CD",
"street" : "Brannan Street"
},
"email" : "s.hopper@example.com",
"phone" : {
"number" : "+315551231234",
"type" : "Mobile"
}
},
"description" : "S.Hopper - Staff 123",
"id" : "AH3227C223222B5CMD2SXFKGT",
"status" : "Active"
}
},
"post-balanceAccounts-createBalanceAccount" : {
"summary" : "Create a balance account.",
"description" : "Example request for creating a balance account",
"value" : {
"accountHolderId" : "AH32272223222B59K6ZKBBFNQ",
"description" : "S.Hopper - Main balance account"
}
},
"post-balanceAccounts-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully creating a balance account",
"value" : {
"accountHolderId" : "AH32272223222B59K6ZKBBFNQ",
"defaultCurrencyCode" : "EUR",
"description" : "S.Hopper - Main balance account",
"balances" : [
{
"available" : 0,
"balance" : 0,
"currency" : "EUR",
"reserved" : 0
}
],
"id" : "BA3227C223222B5CMD38HFKGH",
"status" : "Active"
}
},
"post-paymentInstrumentGroups-createPaymentInstrumentGroups" : {
"summary" : "Create a payment instrument group.",
"description" : "Example request for creating a payment instrument group",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"txVariant" : "mc"
}
},
"post-paymentInstrumentGroups-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully creating a payment instrument group",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"txVariant" : "mc",
"id" : "PG3227C223222B5CMD3FJFKGZ"
}
},
"post-paymentInstruments-createPhysicalCard" : {
"summary" : "Create a physical card",
"description" : "Example request for creating a physical card",
"value" : {
"type" : "card",
"issuingCountryCode" : "NL",
"balanceAccountId" : "BALANCE_ACCOUNT_ID",
"status" : "Inactive",
"card" : {
"formFactor" : "physical",
"brand" : "mc",
"brandVariant" : "mcdebit",
"cardholderName" : "Sam Hopper",
"deliveryContact" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"stateOrProvince" : "NH",
"street" : "Simon Carmiggeltstraat",
"houseNumberOrName" : "6-50",
"postalCode" : "1011DJ"
},
"name" : {
"firstName" : "Sam",
"lastName" : "Hopper"
}
},
"configuration" : {
"configurationProfileId" : "YOUR_CONFIGURATION_PROFILE_ID"
},
"expiry" : {
"month" : 8,
"year" : 2024
}
},
"description" : "S.Hopper - Main card"
}
},
"post-paymentInstruments-createVirtualCard" : {
"summary" : "Create a virtual card.",
"description" : "Example request for creating a virtual card",
"value" : {
"type" : "card",
"description" : "S. Hopper - Main card",
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"issuingCountryCode" : "GB",
"card" : {
"cardholderName" : "Simon Hopper",
"brand" : "mc",
"brandVariant" : "mcdebit",
"formFactor" : "virtual"
}
}
},
"post-paymentInstruments-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully creating a virtual card",
"value" : {
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"description" : "S. Hopper - Main card",
"issuingCountryCode" : "GB",
"status" : "Active",
"type" : "card",
"card" : {
"brand" : "mc",
"brandVariant" : "mcdebit",
"cardholderName" : "Simon Hopper",
"formFactor" : "virtual",
"bin" : "555544",
"cvc" : "873",
"expiration" : {
"month" : "01",
"year" : "2024"
},
"lastFour" : "3548"
},
"id" : "PI32272223222B5CMD3MQ3HXX"
}
},
"post-transactionRules-createTransactionRule" : {
"summary" : "Create a transaction rule.",
"value" : {
"description" : "Allow 5 transactions per month",
"interval" : {
"type" : "monthly"
},
"maxTransactions" : 5,
"paymentInstrumentId" : "PI3227C223222B59KGTXP884R",
"reference" : "myRule12345",
"startDate" : "2021-01-21T12:46:35.476629Z",
"status" : "inactive",
"type" : "velocity"
}
},
"post-transactionRules-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully creating a transaction rule",
"value" : {
"description" : "Allow 5 transactions per month",
"interval" : {
"type" : "monthly"
},
"maxTransactions" : 5,
"paymentInstrumentId" : "PI3227C223222B59KGTXP884R",
"reference" : "myRule12345",
"startDate" : "2021-01-21T12:46:35.476629Z",
"status" : "active",
"type" : "velocity",
"id" : "TR32272223222B5CMD3V73HXG"
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink