openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute balanceAccounts API description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\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-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```" x-timestamp: '2023-05-30T15:27:20Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi servers: - url: https://cal-test.adyen.com/cal/services/Account/v6 tags: - name: balanceAccounts paths: /balanceAccounts: post: tags: - balanceAccounts summary: Adyen Create a Balance Account description: Creates a balance account that holds the funds of the associated account holder. x-addedInVersion: '1' operationId: post-balanceAccounts x-sortIndex: 1 x-methodName: createBalanceAccount security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: createBalanceAccount: $ref: '#/components/examples/post-balanceAccounts-createBalanceAccount' schema: $ref: '#/components/schemas/BalanceAccountInfo' responses: '200': content: application/json: examples: createBalanceAccount: $ref: '#/components/examples/post-balanceAccounts-createBalanceAccount-200' schema: $ref: '#/components/schemas/BalanceAccount' description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /balanceAccounts/{balanceAccountId}/sweeps: get: tags: - balanceAccounts summary: Adyen Get All Sweeps for a Balance Account description: 'Returns a list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`.' x-addedInVersion: '2' operationId: get-balanceAccounts-balanceAccountId-sweeps x-sortIndex: 7 x-methodName: getAllSweepsForBalanceAccount security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the balance account. name: balanceAccountId 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: $ref: '#/components/examples/get-balanceAccounts-balanceAccountId-sweeps-success-200' schema: $ref: '#/components/schemas/BalanceSweepConfigurationsResponse' description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - balanceAccounts summary: Adyen Create a Sweep description: 'Creates a sweep that results in moving funds from or to a balance account. A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.' x-addedInVersion: '2' operationId: post-balanceAccounts-balanceAccountId-sweeps x-sortIndex: 5 x-methodName: createSweep security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: createSweep-pull: $ref: '#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-pull' createSweep-push: $ref: '#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-push' createSweep-push-priorities: $ref: '#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-priorities' schema: $ref: '#/components/schemas/CreateSweepConfigurationV2' parameters: - description: The unique identifier of the balance account. name: balanceAccountId in: path required: true schema: type: string responses: '200': content: application/json: examples: createSweep-pull: $ref: '#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-pull-200' createSweep-push: $ref: '#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-200' createSweep-push-priorities: $ref: '#/components/examples/post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-priorities-200' schema: $ref: '#/components/schemas/SweepConfigurationV2' description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /balanceAccounts/{balanceAccountId}/sweeps/{sweepId}: delete: tags: - balanceAccounts summary: Adyen Delete a Sweep description: Deletes a sweep for a balance account. x-addedInVersion: '2' operationId: delete-balanceAccounts-balanceAccountId-sweeps-sweepId x-sortIndex: 9 x-methodName: deleteSweep security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the balance account. name: balanceAccountId in: path required: true schema: type: string - description: The unique identifier of the sweep. name: sweepId in: path required: true schema: type: string responses: '204': description: 'No Content - look at the actual response code for the status of the request. ' '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - balanceAccounts summary: Adyen Get a Sweep description: Returns a sweep. x-addedInVersion: '2' operationId: get-balanceAccounts-balanceAccountId-sweeps-sweepId x-sortIndex: 8 x-methodName: getSweep security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the balance account. name: balanceAccountId in: path required: true schema: type: string - description: The unique identifier of the sweep. name: sweepId in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-balanceAccounts-balanceAccountId-sweeps-sweepId-success-200' schema: $ref: '#/components/schemas/SweepConfigurationV2' description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - balanceAccounts summary: Adyen Update a Sweep description: Updates a sweep. When updating a sweep resource, note that if a request parameter is not provided, the parameter is left unchanged. x-addedInVersion: '2' operationId: patch-balanceAccounts-balanceAccountId-sweeps-sweepId x-sortIndex: 6 x-methodName: updateSweep security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: updateSweep-status: $ref: '#/components/examples/patch-balanceAccounts-balanceAccountId-sweeps-sweepId-updateSweep-status' schema: $ref: '#/components/schemas/UpdateSweepConfigurationV2' parameters: - description: The unique identifier of the balance account. name: balanceAccountId in: path required: true schema: type: string - description: The unique identifier of the sweep. name: sweepId in: path required: true schema: type: string responses: '200': content: application/json: examples: updateSweep-status: $ref: '#/components/examples/patch-balanceAccounts-balanceAccountId-sweeps-sweepId-updateSweep-status-200' schema: $ref: '#/components/schemas/SweepConfigurationV2' description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /balanceAccounts/{id}: get: tags: - balanceAccounts summary: Adyen Get a Balance Account description: Returns a balance account and its balances for the default currency and other currencies with a non-zero balance. x-addedInVersion: '1' operationId: get-balanceAccounts-id x-sortIndex: 3 x-methodName: getBalanceAccount security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the balance account. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-balanceAccounts-id-success-200' schema: $ref: '#/components/schemas/BalanceAccount' description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - balanceAccounts summary: Adyen Update a Balance Account description: Updates a balance account. x-addedInVersion: '1' operationId: patch-balanceAccounts-id x-sortIndex: 2 x-methodName: updateBalanceAccount security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: updateBalanceAccount: $ref: '#/components/examples/patch-balanceAccounts-id-updateBalanceAccount' schema: $ref: '#/components/schemas/BalanceAccountUpdateRequest' parameters: - description: The unique identifier of the balance account. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: updateBalanceAccount: $ref: '#/components/examples/patch-balanceAccounts-id-updateBalanceAccount-200' schema: $ref: '#/components/schemas/BalanceAccount' description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /balanceAccounts/{id}/paymentInstruments: get: tags: - balanceAccounts summary: Adyen Get Payment Instruments Linked to a Balance Account description: "Returns a paginated list of the payment instruments associated with a balance account. \n\nTo fetch multiple pages, use the query parameters.For example, to limit the page to 3 payment instruments which are in active status and to skip the first 6, use `/balanceAccounts/{id}/paymentInstruments?limit=3&offset=6&status=active`." x-addedInVersion: '1' operationId: get-balanceAccounts-id-paymentInstruments x-sortIndex: 4 x-methodName: getPaymentInstrumentsLinkedToBalanceAccount security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The 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 - description: The status of the payment instruments that you want to get. By default, the response includes payment instruments with any status. name: status in: query required: false schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-balanceAccounts-id-paymentInstruments-success-200' schema: $ref: '#/components/schemas/PaginatedPaymentInstrumentsResponse' description: OK - the request has succeeded. '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/RestServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: 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 type: object SweepCounterparty: properties: balanceAccountId: description: "The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).\n\n You can only use this 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 parameter with sweeps of `type` **pull** and `schedule.type` **balance**, and if you are processing payments with Adyen.' type: string transferInstrumentId: description: 'The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To [set up automated top-up sweeps to balance accounts](https://docs.adyen.com/marketplaces-and-platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.' type: string type: object BulkAddress: properties: city: description: The name of the city. type: string company: description: The name of the company. type: string country: description: The two-character ISO-3166-1 alpha-2 country code. For example, **US**. type: string email: description: The email address. type: string houseNumberOrName: description: The house number or name. type: string mobile: description: The full telephone number. type: string postalCode: description: 'The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.' type: string stateOrProvince: description: 'The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.' type: string street: description: The streetname of the house. type: string required: - country type: object 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: "Type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n" enum: - landline - mobile type: string required: - number - type type: object JSONObject: type: object BalanceSweepConfigurationsResponse: properties: hasNext: description: Indicates whether there are more items on the next page. type: boolean hasPrevious: description: Indicates whether there are more items on the previous page. type: boolean sweeps: description: List of sweeps associated with the balance account. items: $ref: '#/components/schemas/SweepConfigurationV2' type: array required: - sweeps - hasPrevious - hasNext type: object PaymentInstrument: properties: balanceAccountId: description: The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument. type: string bankAccount: description: Contains the business account details. Returned when you create a payment instrument with `type` **bankAccount**. oneOf: - $ref: '#/components/schemas/IbanAccountIdentification' - $ref: '#/components/schemas/USLocalAccountIdentification' card: description: Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**. $ref: '#/components/schemas/Card' description: description: Your description for the payment instrument, maximum 300 characters. maxLength: 300 type: string id: description: The unique identifier of the payment instrument. type: string issuingCountryCode: description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. type: string paymentInstrumentGroupId: description: The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. type: string reference: description: Your reference for 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, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**: The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n" enum: - active - closed - inactive - suspended type: string statusReason: x-addedInVersion: '2' description: 'The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change.' enum: - accountClosure - damaged - endOfLife - expired - lost - other - stolen - suspectedFraud - transactionRule type: string type: description: 'Type of payment instrument. Possible value: **card**, **bankAccount**. ' enum: - bankAccount - card type: string required: - balanceAccountId - issuingCountryCode - type - id type: object 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 instance: description: A unique URI that identifies the specific occurrence of the problem. type: string invalidFields: description: Detailed explanation of each validation error, when applicable. items: $ref: '#/components/schemas/InvalidField' type: array requestId: description: A unique reference for the request, essentially the same as `pspReference`. type: string response: description: JSON response payload. $ref: '#/components/schemas/JSONObject' status: description: The HTTP status code. format: int32 type: integer title: description: A short, human-readable summary of the problem type. type: string type: description: A URI that identifies the problem type, pointing to human-readable documentation on this problem type. type: string required: - type - errorCode - title - detail - status type: object DeliveryContact: properties: address: description: The address of the contact. $ref: '#/components/schemas/DeliveryAddress' email: description: The email address of the contact. type: string fullPhoneNumber: description: 'The full phone number of the contact provided as a single string. It will be handled as a landline phone. **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' phoneNumber: description: The phone number of the contact. $ref: '#/components/schemas/PhoneNumber' webAddress: description: The URL of the contact's website. type: string required: - name - address type: object BalanceAccount: properties: accountHolderId: description: The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_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 three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.' type: string description: description: A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. maxLength: 300 type: string id: description: The unique identifier of the balance account. type: string metadata: additionalProperties: type: string description: 'A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.' type: object migratedAccountCode: description: The unique identifier of the account of the migrated account holder in the classic integration. readOnly: true type: string platformPaymentConfiguration: description: Contains key-value pairs to the configure the settlement model in a balance account. $ref: '#/components/schemas/PlatformPaymentConfiguration' reference: description: Your reference for the balance account, maximum 150 characters. maxLength: 150 type: string status: description: "The status of the balance account, set to **active** by default. \n" enum: - active - closed - inactive - suspended type: string timeZone: description: 'The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).' type: string required: - accountHolderId - id type: object DeliveryAddress: properties: city: description: The name of the city. type: string country: description: 'The two-character ISO-3166-1 alpha-2 country code. For example, **US**. >If you don''t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.' type: string line1: description: The street name. For example, if the address is "Rokin 49", provide "Rokin". type: string line2: description: The house number or name. For example, if the address is "Rokin 49", provide "49". type: string line3: description: Optional information about the address. type: string postalCode: description: 'The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries.' type: string stateOrProvince: description: 'The two-letterISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.' type: string required: - country type: object CardConfiguration: properties: activation: description: Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions. type: string activationUrl: description: "Your app's URL, if you want to activate cards through your app. For example, **my-app://ref1236a7d**. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. \n\nMaximum length: 255 characters." maxLength: 255 type: string bulkAddress: description: Overrides the shipment bulk address defined in the `configurationProfileId`. $ref: '#/components/schemas/BulkAddress' cardImageId: description: The ID of the card image. This is the image that will be printed on the full front of the card. type: string carrier: description: Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached. type: string carrierImageId: description: The ID of the carrier image. This is the image that will printed on the letter to which the card is attached. type: string configurationProfileId: description: 'The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.' type: string currency: description: The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. type: string envelope: description: 'Overrides the envelope design ID defined in the `configurationProfileId`. ' type: string insert: description: Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card. type: string language: description: The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**. type: string logoImageId: description: The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner. type: string pinMailer: description: Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed. type: string shipmentMethod: description: Overrides the logistics company defined in the `configurationProfileId`. type: string required: - configurationProfileId type: object PaginatedPaymentInstrumentsResponse: properties: hasNext: description: Indicates whether there are more items on the next page. type: boolean hasPrevious: description: Indicates whether there are more items on 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 type: object CreateSweepConfigurationV2: properties: category: x-addedInVersion: '2' description: "The type of transfer that results from the sweep.\n\nPossible values:\n\n - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).\n\n- **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\nRequired when setting `priorities`." enum: - bank - internal - platformPayment type: string counterparty: description: 'The destination or the source of the funds, depending on the sweep `type`. Either a `balanceAccountId`, `transferInstrumentId`, or `merchantAccount` is required.' $ref: '#/components/schemas/SweepCounterparty' currency: description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).' type: string description: description: 'The message that will be used in the sweep transfer''s description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.' type: string priorities: x-addedInVersion: '2' description: 'The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority listed first, and if that''s not possible, it moves on to the next option in the order of provided priorities. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see [optional priorities setup](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).' items: enum: - crossBorder - fast - instant - internal - regular - wire type: string type: array reason: description: The reason for disabling the sweep. enum: - amountLimitExceeded - approved - balanceAccountTemporarilyBlockedByTransactionRule - counterpartyAccountBlocked - counterpartyAccountClosed - counterpartyAccountNotFound - counterpartyAddressRequired - counterpartyBankTimedOut - counterpartyBankUnavailable - declinedByTransactionRule - error - notEnoughBalance - refusedByCounterpartyBank - routeNotFound - scaFailed - unknown readOnly: true 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' status: description: "The status of the sweep. If not provided, by default, this is set to **active**.\n\nPossible values: \n\n * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. \n\n * **inactive**: the sweep is disabled and cannot be triggered. \n\n" enum: - active - inactive type: string sweepAmount: description: The amount that must be pushed out or pulled in. You can configure either `sweepAmount` or `targetAmount`, not both. $ref: '#/components/schemas/Amount' targetAmount: description: The amount that must be available in the balance account after the sweep. You can configure either `sweepAmount` or `targetAmount`, not both. $ref: '#/components/schemas/Amount' triggerAmount: description: 'The threshold amount that triggers the sweep. If not provided, by default, the amount is set to zero. The `triggerAmount` is evaluated according to the specified `schedule.type`. * For `type` **pull**, if the balance is less than or equal to the `triggerAmount`, funds are pulled in to the balance account. * For `type` **push**, if the balance is more than or equal to the `triggerAmount`, funds are pushed out of the balance account.' $ref: '#/components/schemas/Amount' type: default: push description: "The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**.\n\nPossible values:\n\n * **push**: _push out funds_ to a destination balance account or transfer instrument.\n\n * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account." enum: - pull - push type: string required: - schedule - currency - counterparty type: object SweepSchedule: properties: cronExpression: description: "A [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that is used to set the sweep schedule. The schedule uses the time zone of the balance account. \nFor example, **30 17 * * MON** schedules a sweep every Monday at 17:30.\n\nThe expression must have five values separated by a single space in the following order:\n\n* Minute: **0-59**\n\n* Hour: **0-23**\n\n* Day of the month: **1-31**\n\n* Month: **1-12** or **JAN-DEC**\n\n* Day of the week: **0-7** (0 and 7 are Sunday) or **MON-SUN**.\n\nThe following non-standard characters are supported: *****, **L**, **#**, **W** and **/**. See [crontab guru](https://crontab.guru/) for more examples.\n\nRequired when `type` is **cron**.\n" type: string type: description: 'The schedule type. Possible values: * **cron**: push out funds based on a `cronExpression`. * **daily**: push out funds daily at 07:00 AM CET. * **weekly**: push out funds every Monday at 07:00 AM CET. * **monthly**: push out funds every first of the month at 07:00 AM CET. * **balance**: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` **pull** and when the source is a `merchantAccount` or `transferInstrument`. If the source is transferInstrument, merchant account identifier is still required, with which you want to process the transaction. ' enum: - daily - weekly - monthly - balance - cron type: string required: - type type: object PlatformPaymentConfiguration: properties: salesDayClosingTime: description: 'Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day) ends. Possible values: Time in **"HH:MM"** format. **HH** ranges from **00** to **07**. **MM** must be **00**. Default value: **"00:00"**.' format: time type: string settlementDelayDays: description: 'Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch) are made available. Possible values: **0** to **10**, or **null**. * Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement). * Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement). Default value: **null**.' format: int32 type: integer type: object IbanAccountIdentification: additionalProperties: false properties: iban: description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. type: string type: default: iban description: '**iban**' enum: - iban type: string required: - type - iban type: object SweepConfigurationV2: properties: category: x-addedInVersion: '2' description: "The type of transfer that results from the sweep.\n\nPossible values:\n\n - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).\n\n- **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\nRequired when setting `priorities`." enum: - bank - internal - platformPayment type: string counterparty: description: 'The destination or the source of the funds, depending on the sweep `type`. Either a `balanceAccountId`, `transferInstrumentId`, or `merchantAccount` is required.' $ref: '#/components/schemas/SweepCounterparty' currency: description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).' type: string description: description: 'The message that will be used in the sweep transfer''s description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.' type: string id: description: The unique identifier of the sweep. readOnly: true type: string priorities: x-addedInVersion: '2' description: 'The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority listed first, and if that''s not possible, it moves on to the next option in the order of provided priorities. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see [optional priorities setup](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).' items: enum: - crossBorder - fast - instant - internal - regular - wire type: string type: array reason: description: The reason for disabling the sweep. enum: - amountLimitExceeded - approved - balanceAccountTemporarilyBlockedByTransactionRule - counterpartyAccountBlocked - counterpartyAccountClosed - counterpartyAccountNotFound - counterpartyAddressRequired - counterpartyBankTimedOut - counterpartyBankUnavailable - declinedByTransactionRule - error - notEnoughBalance - refusedByCounterpartyBank - routeNotFound - scaFailed - unknown readOnly: true 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' status: description: "The status of the sweep. If not provided, by default, this is set to **active**.\n\nPossible values: \n\n * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. \n\n * **inactive**: the sweep is disabled and cannot be triggered. \n\n" enum: - active - inactive type: string sweepAmount: description: The amount that must be pushed out or pulled in. You can configure either `sweepAmount` or `targetAmount`, not both. $ref: '#/components/schemas/Amount' targetAmount: description: The amount that must be available in the balance account after the sweep. You can configure either `sweepAmount` or `targetAmount`, not both. $ref: '#/components/schemas/Amount' triggerAmount: description: 'The threshold amount that triggers the sweep. If not provided, by default, the amount is set to zero. The `triggerAmount` is evaluated according to the specified `schedule.type`. * For `type` **pull**, if the balance is less than or equal to the `triggerAmount`, funds are pulled in to the balance account. * For `type` **push**, if the balance is more than or equal to the `triggerAmount`, funds are pushed out of the balance account.' $ref: '#/components/schemas/Amount' type: default: push description: "The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**.\n\nPossible values:\n\n * **push**: _push out funds_ to a destination balance account or transfer instrument.\n\n * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account." enum: - pull - push type: string required: - id - schedule - currency - counterparty type: object Authentication: properties: email: description: The email address where the one-time password (OTP) is sent. type: string password: description: 'The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters. * Characters between **a-z**, **A-Z**, and **0-9** * Special characters: **äöüßÄÖÜ+-*/ç%()=?!~#''",;:$&àùòâôûáúó**' maxLength: 30 minLength: 1 type: string phone: description: 'The phone number where the one-time password (OTP) is sent. This object must have: * A `type` set to **mobile**. * A `number` with a valid country code. * A `number` with more than 4 digits, excluding the country code. >Make sure to verify that the card user owns the phone number.' $ref: '#/components/schemas/Phone' type: object UpdateSweepConfigurationV2: properties: category: x-addedInVersion: '2' description: "The type of transfer that results from the sweep.\n\nPossible values:\n\n - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).\n\n- **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\nRequired when setting `priorities`." enum: - bank - internal - platformPayment type: string counterparty: description: 'The destination or the source of the funds, depending on the sweep `type`. Either a `balanceAccountId`, `transferInstrumentId`, or `merchantAccount` is required.' $ref: '#/components/schemas/SweepCounterparty' currency: description: 'The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).' type: string description: description: 'The message that will be used in the sweep transfer''s description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.' type: string id: description: The unique identifier of the sweep. readOnly: true type: string priorities: x-addedInVersion: '2' description: 'The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority listed first, and if that''s not possible, it moves on to the next option in the order of provided priorities. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see [optional priorities setup](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/scheduled-payouts#optional-priorities-setup).' items: enum: - crossBorder - fast - instant - internal - regular - wire type: string type: array reason: description: The reason for disabling the sweep. enum: - amountLimitExceeded - approved - balanceAccountTemporarilyBlockedByTransactionRule - counterpartyAccountBlocked - counterpartyAccountClosed - counterpartyAccountNotFound - counterpartyAddressRequired - counterpartyBankTimedOut - counterpartyBankUnavailable - declinedByTransactionRule - error - notEnoughBalance - refusedByCounterpartyBank - routeNotFound - scaFailed - unknown readOnly: true 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' status: description: "The status of the sweep. If not provided, by default, this is set to **active**.\n\nPossible values: \n\n * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. \n\n * **inactive**: the sweep is disabled and cannot be triggered. \n\n" enum: - active - inactive type: string sweepAmount: description: The amount that must be pushed out or pulled in. You can configure either `sweepAmount` or `targetAmount`, not both. $ref: '#/components/schemas/Amount' targetAmount: description: The amount that must be available in the balance account after the sweep. You can configure either `sweepAmount` or `targetAmount`, not both. $ref: '#/components/schemas/Amount' triggerAmount: description: 'The threshold amount that triggers the sweep. If not provided, by default, the amount is set to zero. The `triggerAmount` is evaluated according to the specified `schedule.type`. * For `type` **pull**, if the balance is less than or equal to the `triggerAmount`, funds are pulled in to the balance account. * For `type` **push**, if the balance is more than or equal to the `triggerAmount`, funds are pushed out of the balance account.' $ref: '#/components/schemas/Amount' type: default: push description: "The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**.\n\nPossible values:\n\n * **push**: _push out funds_ to a destination balance account or transfer instrument.\n\n * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account." enum: - pull - push type: string type: object Name: properties: firstName: description: The first name. type: string lastName: description: The last name. type: string required: - firstName - lastName type: object PhoneNumber: properties: phoneCountryCode: description: 'The two-character ISO-3166-1 alpha-2 country code of the phone number. For example, **US** or **NL**.' type: string phoneNumber: description: 'The phone number. The inclusion of the phone number country code is not necessary.' type: string phoneType: description: 'The type of the phone number. Possible values: **Landline**, **Mobile**, **SIP**, **Fax**.' enum: - Fax - Landline - Mobile - SIP type: string type: object BalanceAccountInfo: properties: accountHolderId: description: The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account. type: string defaultCurrencyCode: description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.' type: string description: description: A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. maxLength: 300 type: string metadata: additionalProperties: type: string description: 'A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.' type: object migratedAccountCode: description: The unique identifier of the account of the migrated account holder in the classic integration. readOnly: true type: string platformPaymentConfiguration: description: Contains key-value pairs to the configure the settlement model in a balance account. $ref: '#/components/schemas/PlatformPaymentConfiguration' reference: description: Your reference for the balance account, maximum 150 characters. maxLength: 150 type: string timeZone: description: 'The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).' type: string required: - accountHolderId type: object Card: properties: authentication: description: Contains the card user's password and mobile phone number. This is required when you issue cards that can be used to make online payments within the EEA and the UK, or can be added to digital wallets. Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) for more information. $ref: '#/components/schemas/Authentication' bin: description: The bank identification number (BIN) of the card number. type: string brand: description: 'The brand of the physical or the virtual card. Possible values: **visa**, **mc**.' type: string brandVariant: description: 'The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**. >Reach out to your Adyen contact to get the values relevant for your integration.' type: string cardholderName: description: "The name of the cardholder.\n Maximum length: 26 characters." maxLength: 26 type: string configuration: description: "Settings required when creating a physical or a virtual card. \n\nReach out to your Adyen contact to get the values that you can send in this object." $ref: '#/components/schemas/CardConfiguration' cvc: description: 'The CVC2 value of the card. > The CVC2 is not sent by default. This is only returned in the `POST` response for single-use virtual cards.' type: string deliveryContact: x-addedInVersion: '2' description: The delivery contact (name and address) for physical card delivery. $ref: '#/components/schemas/DeliveryContact' expiration: description: The expiration date of the card. $ref: '#/components/schemas/Expiry' formFactor: description: 'The form factor of the card. Possible 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 (PAN) of the card. > The PAN is masked by default and returned only for single-use virtual cards.' readOnly: true type: string threeDSecure: description: 'Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. >Reach out to your Adyen contact to get the values relevant for your integration.' type: string required: - formFactor - cardholderName - brand - brandVariant - number type: object USLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The bank account number, without separators or whitespace. maxLength: 18 minLength: 2 type: string accountType: default: checking description: 'The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**.' enum: - checking - savings type: string routingNumber: description: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. maxLength: 9 minLength: 9 type: string type: default: usLocal description: '**usLocal**' enum: - usLocal type: string required: - type - accountNumber - routingNumber type: object 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 type: object BalanceAccountUpdateRequest: properties: accountHolderId: description: The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account. type: string description: description: A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. maxLength: 300 type: string metadata: additionalProperties: type: string description: 'A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.' type: object platformPaymentConfiguration: description: Contains key-value pairs to the configure the settlement model in a balance account. $ref: '#/components/schemas/PlatformPaymentConfiguration' reference: description: Your reference to the balance account, maximum 150 characters. maxLength: 150 type: string status: description: 'The status of the balance account. Payment instruments linked to the balance account can only be used if the balance account status is **active**. Possible values: **active**, **inactive**, **closed**, **suspended**.' enum: - active - closed - inactive - suspended type: string timeZone: description: 'The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).' type: string type: object 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 pending: description: The amount pending to be paid out but not yet available in the balance. format: int64 type: integer 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 type: object 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 type: object examples: post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-200: summary: Sweep of push type created description: Example response for creating a push sweep value: id: SWPC4227C224555B5FTD2NT2JV4WN5 counterparty: balanceAccountId: BA32278887611B5FTD2KR6TJD triggerAmount: currency: EUR value: 50000 currency: EUR schedule: type: weekly type: push status: active generic-401: summary: Response code - 401 Unauthorized value: type: https://docs.adyen.com/errors/security/unauthorized title: Unauthorized status: 401 detail: Not authorized to access this service. errorCode: '00_401' patch-balanceAccounts-balanceAccountId-sweeps-sweepId-updateSweep-status-200: summary: Sweep status updated description: Example response for updating a sweep value: id: SWPC4227C224555B5FTD2NT2JV4WN5 counterparty: merchantAccount: YOUR_MERCHANT_ACCOUNT triggerAmount: currency: EUR value: 50000 currency: EUR schedule: type: balance type: pull status: inactive post-balanceAccounts-createBalanceAccount-200: summary: Create a balance account description: Example request for creating a balance account value: accountHolderId: AH32272223222C5GXTD343TKP defaultCurrencyCode: EUR description: S.Hopper - Main balance account timeZone: Europe/Amsterdam balances: - available: 0 balance: 0 currency: EUR reserved: 0 id: BA3227C223222H5J4DCGQ9V9L status: active post-balanceAccounts-balanceAccountId-sweeps-createSweep-pull-200: summary: Sweep of pull type created description: Example response for creating a pull sweep value: id: SWPC4227C224555B5FTD2NT2JV4WN5 counterparty: merchantAccount: YOUR_MERCHANT_ACCOUNT triggerAmount: currency: EUR value: 50000 currency: EUR schedule: type: balance type: pull status: active 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' get-balanceAccounts-balanceAccountId-sweeps-success-200: summary: Sweeps under a balance account retrieved description: Example response when retrieving sweeps under a balance account value: hasNext: false hasPrevious: false sweeps: - id: SWPC4227C224555B5FTD2NT2JV4WN5 schedule: type: daily status: active targetAmount: currency: EUR value: 0 triggerAmount: currency: EUR value: 0 type: push counterparty: balanceAccountId: BA32272223222B5FTD2KR6TJD currency: EUR 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' patch-balanceAccounts-balanceAccountId-sweeps-sweepId-updateSweep-status: summary: Update the status of a sweep description: Example request for updating a sweep value: status: inactive get-balanceAccounts-id-paymentInstruments-success-200: summary: List of payment instruments retrieved 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: brand: mc 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: brand: mc brandVariant: mc cardholderName: name formFactor: virtual bin: '555544' expiration: month: '01' year: '2023' lastFour: '8331' number: '************8331' id: PI32272223222B59PXDGQDLSF post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-priorities: summary: Create a sweep to push funds out of a balance account with set priorities description: Example request for creating a push sweep with priorities value: counterparty: transferInstrumentId: SE322JV223222J5HGLCGF2WDV triggerAmount: currency: EUR value: 50000 currency: EUR priorities: - fast - instant category: bank schedule: type: weekly type: push status: active post-balanceAccounts-balanceAccountId-sweeps-createSweep-pull: summary: Create a sweep to pull funds in to a balance account description: Example request for creating a pull sweep value: counterparty: merchantAccount: YOUR_MERCHANT_ACCOUNT triggerAmount: currency: EUR value: 50000 currency: EUR schedule: type: balance type: pull status: active 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' post-balanceAccounts-createBalanceAccount: summary: Create a balance account description: Example request for creating a balance account value: accountHolderId: AH32272223222C5GXTD343TKP description: S.Hopper - Main balance account post-balanceAccounts-balanceAccountId-sweeps-createSweep-push-priorities-200: summary: Sweep of push type with priorities created description: Example response for creating a push sweep with priorities value: id: SWPC4227C224555B5FTD2NT2JV4WN9 counterparty: transferInstrumentId: SE322JV223222J5HGLCGF2WDV triggerAmount: currency: EUR value: 50000 currency: EUR priorities: - fast - instant category: bank schedule: type: weekly type: push status: active get-balanceAccounts-balanceAccountId-sweeps-sweepId-success-200: summary: Sweep retrieved description: Example response when retrieving a sweep value: id: SWPC4227C224555B5FTD2NT2JV4WN5 schedule: type: daily status: active targetAmount: currency: EUR value: 0 triggerAmount: currency: EUR value: 0 type: push counterparty: balanceAccountId: BA32272223222B5FTD2KR6TJD currency: EUR get-balanceAccounts-id-success-200: summary: Balance account details retrieved description: Example response for retrieving a balance account value: accountHolderId: AH32272223222B59K6RTQBFNZ defaultCurrencyCode: EUR timeZone: Europe/Amsterdam balances: - available: 0 balance: 0 currency: EUR reserved: 0 pending: 0 id: BA3227C223222B5BLP6JQC3FD status: active post-balanceAccounts-balanceAccountId-sweeps-createSweep-push: summary: Create a sweep to push funds out of a balance account description: Example request for creating a push sweep value: counterparty: balanceAccountId: BA32278887611B5FTD2KR6TJD triggerAmount: currency: EUR value: 50000 currency: EUR schedule: type: weekly type: push status: active patch-balanceAccounts-id-updateBalanceAccount-200: summary: Time zone of a balance account updated description: Example response for updating a balance account value: accountHolderId: AH32272223222B5GFSNVGFFM7 defaultCurrencyCode: EUR timeZone: Europe/Amsterdam balances: - available: 0 balance: 0 currency: EUR reserved: 0 id: BA32272223222B59K6ZXHBFN6 status: active patch-balanceAccounts-id-updateBalanceAccount: summary: Update the time zone of a balance account description: Example request for updating a balance account value: timeZone: Europe/Amsterdam 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' securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification