openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute Transfers 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: Transfers paths: /balanceTransfer: post: tags: - Transfers summary: Adyen Start a Balance Transfer description: 'Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances: * The source and destination merchant accounts must be under the same company account and legal entity. * The source merchant account must have sufficient funds. * The source and destination merchant accounts must have at least one common processing currency. When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and *not* in parallel. Some requests may not be processed if the requests are sent in parallel. ' operationId: post-balanceTransfer x-groupName: General x-sortIndex: 0 x-methodName: balanceTransfer security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: post-balance-transfer: $ref: '#/components/examples/post-balanceTransfer-post-balance-transfer' schema: $ref: '#/components/schemas/BalanceTransferRequest' responses: '200': content: application/json: examples: post-balance-transfer: $ref: '#/components/examples/post-balanceTransfer-post-balance-transfer-200' schema: $ref: '#/components/schemas/BalanceTransferResponse' description: OK - the request has succeeded. x-microcks-operation: delay: 0 dispatcher: FALLBACK /transferRoutes/calculate: post: tags: - Transfers summary: Adyen Calculate Transfer Routes description: Returns available transfer routes based on a combination of transfer `country`, `currency`, `counterparty`, and `priorities`. Use this endpoint to find optimal transfer priorities and associated requirements before you [make a transfer](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers). x-addedInVersion: '1' operationId: post-transferRoutes-calculate x-sortIndex: 1 x-methodName: calculateTransferRoutes security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: transferRoutesCalculate: $ref: '#/components/examples/post-transferRoutes-calculate-transferRoutesCalculate' schema: $ref: '#/components/schemas/TransferRouteRequest' responses: '200': content: application/json: examples: transferRoutesCalculate: $ref: '#/components/examples/post-transferRoutes-calculate-transferRoutesCalculate-200' schema: $ref: '#/components/schemas/TransferRouteResponse' description: OK - the request has succeeded. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/RestServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/RestServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/RestServiceError' description: Unprocessable Entity - a request validation error. '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /transfers: post: tags: - Transfers summary: Adyen Transfer Funds description: '>Versions 1 and 2 of the Transfers API are deprecated. If you are just starting your implementation, use the latest version. Starts a request to transfer funds to [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts), [transfer instruments](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments), or third-party bank accounts. Adyen sends the outcome of the transfer request through webhooks. To use this endpoint, you need an additional role for your API credential and transfers must be enabled for the source balance account. Your Adyen contact will set these up for you.' x-addedInVersion: '2' operationId: post-transfers x-sortIndex: 1 x-methodName: transferFunds security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: payout-cross-border: $ref: '#/components/examples/post-transfers-payout-cross-border' payout-local-transfer-sepa: $ref: '#/components/examples/post-transfers-payout-local-transfer-sepa' payout-local-transfer-us: $ref: '#/components/examples/post-transfers-payout-local-transfer-us' payout-to-balance-account: $ref: '#/components/examples/post-transfers-payout-to-balance-account' payout-to-transfer-instrument: $ref: '#/components/examples/post-transfers-payout-to-transfer-instrument' schema: $ref: '#/components/schemas/TransferInfo' parameters: - description: Header for authenticating through SCA example: SCA realm="Transfer" auth-param1="eyJjaGFsbGVuZ2UiOiJiVlV6ZW5wek0waFNl..." name: WWW-Authenticate in: header schema: type: string responses: '200': content: application/json: examples: payout-cross-border: $ref: '#/components/examples/post-transfers-payout-cross-border-200' payout-local-transfer-sepa: $ref: '#/components/examples/post-transfers-payout-local-transfer-sepa-200' payout-local-transfer-us: $ref: '#/components/examples/post-transfers-payout-local-transfer-us-200' payout-to-balance-account: $ref: '#/components/examples/post-transfers-payout-to-balance-account-200' payout-to-transfer-instrument: $ref: '#/components/examples/post-transfers-payout-to-transfer-instrument-200' schema: $ref: '#/components/schemas/Transfer' description: OK - the request has succeeded. '202': content: application/json: schema: $ref: '#/components/schemas/Transfer' examples: post-transfers202Example: summary: Default post-transfers 202 response x-microcks-default: true value: accountHolder: example_value amount: 1000 balanceAccount: example_value category: bank categoryData: example_value counterparty: example_value creationDate: '2025-03-15T14:30:00Z' description: A sample description for this resource. direction: incoming id: '500123' paymentInstrument: example_value reason: amountLimitExceeded reference: REF-001 referenceForBeneficiary: REF-001 status: approvalPending description: Accepted - the request has been accepted for processing, but the processing has not been completed. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-transfers401Example: summary: Default post-transfers 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. headers: auth-param1: $ref: '#/components/headers/auth-param1' '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-transfers403Example: summary: Default post-transfers 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-transfers422Example: summary: Default post-transfers 422 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-transfers500Example: summary: Default post-transfers 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /transfers/{transferId}/returns: post: tags: - Transfers summary: Adyen Return a Transfer description: Returns previously transferred funds without creating a new `transferId`. x-addedInVersion: '3' operationId: post-transfers-transferId-returns x-sortIndex: 2 x-methodName: returnTransfer security: - clientKey: [] - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ReturnTransferRequest' parameters: - description: The unique identifier of the transfer to be returned. name: transferId in: path required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReturnTransferResponse' examples: post-transfers-transferId-returns200Example: summary: Default post-transfers-transferId-returns 200 response x-microcks-default: true value: id: '500123' reference: REF-001 status: Authorised transferId: '500123' description: OK - the request has succeeded. '401': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-transfers-transferId-returns401Example: summary: Default post-transfers-transferId-returns 401 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-transfers-transferId-returns403Example: summary: Default post-transfers-transferId-returns 403 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-transfers-transferId-returns422Example: summary: Default post-transfers-transferId-returns 422 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/RestServiceError' examples: post-transfers-transferId-returns500Example: summary: Default post-transfers-transferId-returns 500 response x-microcks-default: true value: detail: example_value errorCode: CODE123 instance: example_value invalidFields: - example_value requestId: '500123' response: example_value status: 500 title: example_value type: standard description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: NameLocation: properties: city: description: The city where the merchant is located. type: string country: description: The country where the merchant is located in [three-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format. type: string countryOfOrigin: description: The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) format, used for government-controlled merchants such as embassies. type: string name: description: The name of the merchant's shop or service. type: string rawData: description: The raw data. type: string state: description: The state where the merchant is located. type: string type: object CALocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 5- to 12-digit bank account number, without separators or whitespace. maxLength: 12 minLength: 5 type: string accountType: default: checking description: 'The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**.' enum: - checking - savings type: string institutionNumber: description: The 3-digit institution number, without separators or whitespace. maxLength: 3 minLength: 3 type: string transitNumber: description: The 5-digit transit number, without separators or whitespace. maxLength: 5 minLength: 5 type: string type: default: caLocal description: '**caLocal**' enum: - caLocal type: string required: - type - accountNumber - institutionNumber - transitNumber type: object NOLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 11-digit bank account number, without separators or whitespace. maxLength: 11 minLength: 11 type: string type: default: noLocal description: '**noLocal**' enum: - noLocal type: string required: - type - accountNumber type: object PlatformPayment: additionalProperties: false properties: modificationMerchantReference: x-addedInVersion: '4' description: The capture's merchant reference included in the transfer. type: string modificationPspReference: x-addedInVersion: '4' description: The capture reference included in the transfer. type: string paymentMerchantReference: x-addedInVersion: '4' description: The payment's merchant reference included in the transfer. type: string platformPaymentType: x-addedInVersion: '4' description: The type of the related split. enum: - AcquiringFees - AdyenCommission - AdyenFees - AdyenMarkup - BalanceAccount - Commission - Default - Interchange - PaymentFee - Remainder - SchemeFee - TopUp - VAT type: string pspPaymentReference: x-addedInVersion: '4' description: The payment reference included in the transfer. type: string type: default: platformPayment description: '**platformPayment**' enum: - platformPayment type: string type: object BankAccountIdentificationTypeRequirement: additionalProperties: false properties: bankAccountIdentificationTypes: description: 'List of bank account identification types: eg.; [iban , numberAndBic]' items: enum: - auLocal - brLocal - caLocal - czLocal - dkLocal - hkLocal - huLocal - iban - legacy - noLocal - numberAndBic - nzLocal - plLocal - seLocal - sgLocal - ukLocal - usLocal type: string type: array description: description: Specifies the bank account details for a particular route per required field in this object depending on the country of the bank account and the currency of the transfer. type: string type: default: bankAccountIdentificationTypeRequirement description: '**bankAccountIdentificationTypeRequirement**' enum: - bankAccountIdentificationTypeRequirement type: string required: - type type: object TransferRouteRequest: properties: balanceAccountId: description: 'The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). Required if `counterparty` is **transferInstrumentId**.' type: string balancePlatform: description: The unique identifier assigned to the balance platform associated with the account holder. type: string category: description: " The type of transfer. Possible values:\n\n - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n" enum: - bank type: string counterparty: description: The recipient of the funds transfer. A bank account or a transfer instrument. $ref: '#/components/schemas/Counterparty' country: description: "The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**.\n > Either `counterparty` or `country` field must be provided in a transfer route request." type: string currency: description: The three-character ISO currency code of transfer. For example, **USD** or **EUR**. type: string priorities: description: 'The list of priorities for the bank transfer. Priorities set the speed at which the transfer is sent and the fees that you have to pay. Multiple values can be provided. 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).' items: enum: - crossBorder - fast - instant - internal - regular - wire type: string type: array required: - balancePlatform - currency - category type: object BRLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The bank account number, without separators or whitespace. maxLength: 10 minLength: 1 type: string bankCode: description: The 3-digit bank code, with leading zeros. maxLength: 3 minLength: 3 type: string branchNumber: description: The bank account branch number, without separators or whitespace. maxLength: 4 minLength: 1 type: string type: default: brLocal description: '**brLocal**' enum: - brLocal type: string required: - type - branchNumber - accountNumber - bankCode type: object JSONObject: type: object MerchantData: properties: acquirerId: description: The unique identifier of the merchant's acquirer. type: string mcc: description: The merchant category code. type: string merchantId: description: The merchant identifier. type: string nameLocation: description: Contains the merchant's name and location. $ref: '#/components/schemas/NameLocation' postalCode: description: The merchant postal code. type: string type: object CounterpartyV3: properties: balanceAccountId: description: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). type: string bankAccount: description: Contains information about the bank account. $ref: '#/components/schemas/BankAccountV3' merchant: description: Contains information about the merchant. $ref: '#/components/schemas/MerchantData' transferInstrumentId: description: Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). type: string type: object ReturnTransferRequest: properties: amount: description: Contains information about the amount to be returned. $ref: '#/components/schemas/Amount' reference: description: 'Your internal reference for the return. If you don''t provide this in the request, Adyen generates a unique reference. This reference is used in all communication with you about the instruction status. We recommend using a unique value per instruction. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). ' maxLength: 80 type: string required: - amount type: object NZLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 15-16 digit bank account number. The first 2 digits are the bank number, the next 4 digits are the branch number, the next 7 digits are the account number, and the final 2-3 digits are the suffix. maxLength: 16 minLength: 15 type: string type: default: nzLocal description: '**nzLocal**' enum: - nzLocal type: string required: - type - accountNumber type: object NumberAndBicAccountIdentification: additionalProperties: false properties: accountNumber: description: The bank account number, without separators or whitespace. The length and format depends on the bank or country. maxLength: 34 type: string additionalBankIdentification: description: Additional identification codes of the bank. Some banks may require these identifiers for cross-border transfers. $ref: '#/components/schemas/AdditionalBankIdentification' bic: description: The bank's 8- or 11-character BIC or SWIFT code. maxLength: 11 minLength: 8 type: string type: default: numberAndBic description: '**numberAndBic**' enum: - numberAndBic type: string required: - type - accountNumber - bic type: object AdditionalBankIdentification: properties: code: description: The value of the additional bank identification. type: string type: description: "The type of additional bank identification, depending on the country.\n\nPossible values:\n\n * **gbSortCode**: The 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or spaces\n * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or spaces." enum: - gbSortCode - usRoutingNumber type: string type: object TransferRouteResponse: properties: transferRoutes: description: List of available priorities for a transfer, along with requirements. Use this information to initiate a transfer. items: $ref: '#/components/schemas/TransferRoute' type: array type: object CZLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: 'The 2- to 16-digit bank account number (slo tu) in the following format: - The optional prefix (pedsl). - The required second part (zkladn st) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized)' maxLength: 17 minLength: 2 type: string bankCode: description: The 4-digit bank code (Kd banky), without separators or whitespace. maxLength: 4 minLength: 4 type: string type: default: czLocal description: '**czLocal**' enum: - czLocal type: string required: - type - accountNumber - bankCode type: object AddressRequirement: additionalProperties: false properties: description: description: Specifies the required address related fields for a particular route. type: string requiredAddressFields: description: List of address fields. items: enum: - city - country - line1 - postalCode - stateOrProvince type: string type: array type: default: addressRequirement description: '**addressRequirement**' enum: - addressRequirement type: string required: - type type: object PaymentInstrument: properties: description: description: The description of the resource. type: string id: description: The unique identifier of the resource. type: string reference: description: The reference for the resource. type: string tokenType: x-addedInVersion: '3' description: The type of wallet the network token is associated with. type: string type: object UltimatePartyIdentification: properties: address: description: Address of the bank account owner. $ref: '#/components/schemas/Address' dateOfBirth: description: 'The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**. Should not be before January 1, 1900. Allowed only when `type` is **individual**.' format: date type: string firstName: description: 'First name of the individual. Allowed only when `type` is **individual**.' type: string fullName: description: The name of the entity. type: string lastName: description: 'Last name of the individual. Allowed only when `type` is **individual**.' type: string reference: description: A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID. maxLength: 150 type: string type: default: unknown description: "The type of entity that owns the bank account.\n\n Possible values: **individual**, **organization**, or **unknown**." enum: - individual - organization - unknown type: string required: - fullName type: object SGLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 4- to 19-digit bank account number, without separators or whitespace. maxLength: 19 minLength: 4 type: string bic: description: The bank's 8- or 11-character BIC or SWIFT code. maxLength: 11 minLength: 8 type: string type: default: sgLocal description: '**sgLocal**' enum: - sgLocal type: string required: - accountNumber - bic type: object PartyIdentification: properties: address: description: Address of the bank account owner. $ref: '#/components/schemas/Address' dateOfBirth: description: 'The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**. Should not be before January 1, 1900. Allowed only when `type` is **individual**.' format: date type: string firstName: description: 'First name of the individual. Allowed only when `type` is **individual**.' type: string fullName: description: The name of the entity. type: string lastName: description: 'Last name of the individual. Allowed only when `type` is **individual**.' type: string reference: description: A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID. maxLength: 150 type: string type: default: unknown description: "The type of entity that owns the bank account.\n\n Possible values: **individual**, **organization**, or **unknown**." enum: - individual - organization - unknown type: string required: - fullName type: object ResourceReference: properties: description: description: The description of the resource. type: string id: description: The unique identifier of the resource. type: string reference: description: The reference for the resource. type: string 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 BankAccount: properties: accountIdentification: description: Contains the bank account details. The fields required in this object depend on the country of the bank account and the currency of the transfer. oneOf: - $ref: '#/components/schemas/AULocalAccountIdentification' - $ref: '#/components/schemas/BRLocalAccountIdentification' - $ref: '#/components/schemas/CALocalAccountIdentification' - $ref: '#/components/schemas/CZLocalAccountIdentification' - $ref: '#/components/schemas/DKLocalAccountIdentification' - $ref: '#/components/schemas/HKLocalAccountIdentification' - $ref: '#/components/schemas/HULocalAccountIdentification' - $ref: '#/components/schemas/IbanAccountIdentification' - $ref: '#/components/schemas/NOLocalAccountIdentification' - $ref: '#/components/schemas/NZLocalAccountIdentification' - $ref: '#/components/schemas/NumberAndBicAccountIdentification' - $ref: '#/components/schemas/PLLocalAccountIdentification' - $ref: '#/components/schemas/SELocalAccountIdentification' - $ref: '#/components/schemas/SGLocalAccountIdentification' - $ref: '#/components/schemas/UKLocalAccountIdentification' - $ref: '#/components/schemas/USLocalAccountIdentification' required: - accountIdentification type: object AULocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The bank account number, without separators or whitespace. maxLength: 9 minLength: 5 type: string bsbCode: description: The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace. maxLength: 6 minLength: 6 type: string type: default: auLocal description: '**auLocal**' enum: - auLocal type: string required: - type - accountNumber - bsbCode type: object IssuedCard: additionalProperties: false properties: authorisationType: x-addedInVersion: '4' description: The authorisation type. For example, **defaultAuthorisation**, **preAuthorisation**, **finalAuthorisation** type: string panEntryMode: x-addedInVersion: '4' description: 'Indicates the method used for entering the PAN to initiate a transaction. Possible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **ecommerce**, **token**.' enum: - chip - cof - contactless - ecommerce - magstripe - manual - token type: string processingType: x-addedInVersion: '4' description: Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for in-person payments. enum: - atmWithdraw - balanceInquiry - ecommerce - moto - pos - purchaseWithCashback - recurring - token type: string relayedAuthorisationData: x-addedInVersion: '4' description: If you are using relayed authorisation, this object contains information from the relayed authorisation response from your server. $ref: '#/components/schemas/RelayedAuthorisationData' schemeTraceId: x-addedInVersion: '4' description: The identifier of the original payment provided by the scheme. The Id could be alphanumeric or numeric depending on the scheme. The schemeTraceID should be referring to an original schemeUniqueTransactionID provided in an earlier payment (not necessarily processed by Adyen). Instances of available schemeTraceId is authAdjustment or recurring payments. type: string schemeUniqueTransactionId: x-addedInVersion: '4' description: The unique identifier created by the scheme. The ID could be alphanumeric or numeric depending on the scheme. type: string type: default: issuedCard description: '**issuedCard**' enum: - issuedCard type: string validationFacts: x-addedInVersion: '4' description: The evaluation of the validation facts. See [validation checks](https://docs.adyen.com/issuing/validation-checks) for more information. items: $ref: '#/components/schemas/TransferNotificationValidationFact' type: array type: object Address: 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**, **NL**, or **GB**. type: string line1: description: First line of the street address. type: string line2: description: Second line of the street 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-letter ISO 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 BalanceTransferResponse: properties: amount: description: The amount of the transfer in [minor units](https://docs.adyen.com/development-resources/currency-codes). $ref: '#/components/schemas/Amount' createdAt: description: The date when the balance transfer was requested. format: date-time type: string description: description: A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. maxLength: 140 type: string fromMerchant: description: The unique identifier of the source merchant account from which funds are deducted. type: string pspReference: description: Adyen's 16-character string reference associated with the balance transfer. type: string reference: description: 'A reference for the balance transfer. If you don''t provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.' maxLength: 80 type: string status: description: 'The status of the balance transfer. Possible values: **transferred**, **failed**, **error**, and **notEnoughBalance**.' enum: - error - failed - notEnoughBalance - transferred type: string toMerchant: description: The unique identifier of the destination merchant account from which funds are transferred. type: string type: description: 'The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.' enum: - tax - fee - terminalSale - credit - debit - adjustment type: string required: - amount - fromMerchant - toMerchant - type - pspReference - status - createdAt type: object CZLocalAccountIdentification_2: additionalProperties: false properties: accountNumber: description: 'The 2- to 16-digit bank account number (Číslo účtu) in the following format: - The optional prefix (předčíslí). - The required second part (základní část) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized)' maxLength: 17 minLength: 2 type: string bankCode: description: The 4-digit bank code (Kód banky), without separators or whitespace. maxLength: 4 minLength: 4 type: string type: default: czLocal description: '**czLocal**' enum: - czLocal type: string required: - type - accountNumber - bankCode type: object RelayedAuthorisationData: properties: metadata: x-addedInVersion: '3' additionalProperties: type: string description: Contains key-value pairs of your references and descriptions, for example, `customId`:`your-own-custom-field-12345`. type: object reference: x-addedInVersion: '3' description: Your reference for the relayed authorisation data. type: string 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 BankCategoryData: additionalProperties: false properties: priority: x-addedInVersion: '4' description: 'The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. 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).' enum: - crossBorder - fast - instant - internal - regular - wire type: string type: default: bank description: '**bank**' enum: - bank type: string type: object PLLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace. maxLength: 26 minLength: 26 type: string type: default: plLocal description: '**plLocal**' enum: - plLocal type: string required: - type - accountNumber type: object 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 type: object DKLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 4-10 digits bank account number (Kontonummer) (without separators or whitespace). maxLength: 10 minLength: 4 type: string bankCode: description: The 4-digit bank code (Registreringsnummer) (without separators or whitespace). maxLength: 4 minLength: 4 type: string type: default: dkLocal description: '**dkLocal**' enum: - dkLocal type: string required: - type - accountNumber - bankCode type: object TransferInfo: properties: amount: x-addedInVersion: '1' description: The amount of the transfer. $ref: '#/components/schemas/Amount' balanceAccountId: description: The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). type: string category: x-addedInVersion: '3' description: "The type of transfer.\n\nPossible values:\n\n - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: Transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: Fund movements related to payments that are acquired for your users." enum: - bank - internal - issuedCard - platformPayment - card type: string counterparty: x-addedInVersion: '3' description: The recipient of the funds transfer. A bank account, a balance account, or a transfer instrument is required. $ref: '#/components/schemas/CounterpartyInfoV3' description: x-addedInVersion: '1' description: 'Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , '' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ '' " ! ?**' maxLength: 140 type: string paymentInstrumentId: description: The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id). type: string priority: x-addedInVersion: '3' description: 'The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. 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).' enum: - crossBorder - fast - instant - internal - regular - wire type: string reference: x-addedInVersion: '2' description: Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference. maxLength: 80 type: string referenceForBeneficiary: x-addedInVersion: '2' description: " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others." maxLength: 80 type: string ultimateParty: x-addedInVersion: '3' description: The ultimate sender of the funds of the transfer (ultimate debtor). $ref: '#/components/schemas/UltimatePartyIdentification' required: - category - amount - counterparty type: object Counterparty: properties: bankAccount: description: Contains information about the bank account. $ref: '#/components/schemas/BankAccount' transferInstrumentId: description: Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). type: string type: object InternalCategoryData: additionalProperties: false properties: modificationMerchantReference: x-addedInVersion: '4' description: The capture's merchant reference included in the transfer. type: string modificationPspReference: x-addedInVersion: '4' description: The capture reference included in the transfer. type: string type: default: internal description: '**internal**' enum: - internal type: string type: object BankAccountV3: properties: accountHolder: description: Information about the owner of the bank account. $ref: '#/components/schemas/PartyIdentification' accountIdentification: description: Contains the bank account details. The fields required in this object depend on the country of the bank account and the currency of the transfer. oneOf: - $ref: '#/components/schemas/AULocalAccountIdentification' - $ref: '#/components/schemas/BRLocalAccountIdentification' - $ref: '#/components/schemas/CALocalAccountIdentification' - $ref: '#/components/schemas/CZLocalAccountIdentification_2' - $ref: '#/components/schemas/DKLocalAccountIdentification' - $ref: '#/components/schemas/HKLocalAccountIdentification' - $ref: '#/components/schemas/HULocalAccountIdentification' - $ref: '#/components/schemas/IbanAccountIdentification' - $ref: '#/components/schemas/NOLocalAccountIdentification' - $ref: '#/components/schemas/NZLocalAccountIdentification' - $ref: '#/components/schemas/NumberAndBicAccountIdentification' - $ref: '#/components/schemas/PLLocalAccountIdentification' - $ref: '#/components/schemas/SELocalAccountIdentification' - $ref: '#/components/schemas/SGLocalAccountIdentification' - $ref: '#/components/schemas/UKLocalAccountIdentification' - $ref: '#/components/schemas/USLocalAccountIdentification' required: - accountIdentification - accountHolder type: object ReturnTransferResponse: properties: id: description: The unique identifier of the return. type: string reference: description: Your internal reference for the return. type: string status: description: 'The resulting status of the return. Possible values: **Authorised**, **Declined**.' enum: - Authorised - Declined type: string transferId: description: The unique identifier of the original transfer. type: string type: object TransferRoute: properties: category: description: " The type of transfer.\n\n Possible values:\n\n - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n" enum: - bank - card - grants - internal - issuedCard - migration - platformPayment - topUp - upgrade type: string country: description: The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. type: string currency: description: The three-character ISO currency code of transfer. For example, **USD** or **EUR**. type: string priority: description: 'The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. 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).' enum: - crossBorder - fast - instant - internal - regular - wire type: string requirements: description: A set of rules defined by clearing houses and banking partners. Your transfer request must adhere to these rules to ensure successful initiation of transfer. Based on the priority, one or more requirements may be returned. Each requirement is defined with a `type` and `description`. oneOf: - $ref: '#/components/schemas/AddressRequirement' - $ref: '#/components/schemas/AmountMinMaxRequirement' - $ref: '#/components/schemas/BankAccountIdentificationTypeRequirement' - $ref: '#/components/schemas/PaymentInstrumentRequirement' type: object CounterpartyInfoV3: properties: balanceAccountId: description: Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). type: string bankAccount: description: Contains information about the bank account. $ref: '#/components/schemas/BankAccountV3' transferInstrumentId: description: Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). type: string type: object Transfer: properties: accountHolder: x-addedInVersion: '3' description: The account holder associated with the balance account used in the transfer. $ref: '#/components/schemas/ResourceReference' amount: x-addedInVersion: '1' description: The amount of the transfer. $ref: '#/components/schemas/Amount' balanceAccount: x-addedInVersion: '3' description: Contains information about the balance account involved in the transfer. $ref: '#/components/schemas/ResourceReference' category: x-addedInVersion: '3' description: "The category of transfer.\n\nPossible values:\n\n - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.\n\n- **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.\n\n- **issuedCard**: Transfer initiated by a Adyen-issued card.\n\n- **platformPayment**: Fund movements related to payments that are acquired for your users." enum: - bank - internal - issuedCard - platformPayment type: string categoryData: x-addedInVersion: '4' description: The relevant data according to the transfer category. oneOf: - $ref: '#/components/schemas/BankCategoryData' - $ref: '#/components/schemas/InternalCategoryData' - $ref: '#/components/schemas/IssuedCard' - $ref: '#/components/schemas/PlatformPayment' counterparty: x-addedInVersion: '3' description: The other party in the transfer. $ref: '#/components/schemas/CounterpartyV3' creationDate: x-addedInVersion: '3' description: The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. format: date-time type: string description: x-addedInVersion: '1' description: 'Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , '' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ '' " ! ?**' type: string direction: x-addedInVersion: '2' description: 'The direction of the transfer. Possible values: **incoming**, **outgoing**.' enum: - incoming - outgoing type: string id: description: The ID of the resource. type: string paymentInstrument: x-addedInVersion: '3' description: Contains information about the payment instrument used in the transfer. $ref: '#/components/schemas/PaymentInstrument' reason: x-addedInVersion: '2' description: Additional information about the status of the transfer. enum: - amountLimitExceeded - approved - balanceAccountTemporarilyBlockedByTransactionRule - counterpartyAccountBlocked - counterpartyAccountClosed - counterpartyAccountNotFound - counterpartyAddressRequired - counterpartyBankTimedOut - counterpartyBankUnavailable - declinedByTransactionRule - error - notEnoughBalance - refusedByCounterpartyBank - routeNotFound - scaFailed - unknown type: string reference: x-addedInVersion: '2' description: Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference. maxLength: 80 type: string referenceForBeneficiary: x-addedInVersion: '2' description: " A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds.\n\n Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`.\n\n- **internal**: 80 characters\n\n- **bank**: 35 characters when transferring to an IBAN, 15 characters for others." maxLength: 80 type: string status: x-addedInVersion: '2' description: "The result of the transfer.\n\n For example, **authorised**, **refused**, or **error**." enum: - approvalPending - atmWithdrawal - atmWithdrawalReversalPending - atmWithdrawalReversed - authAdjustmentAuthorised - authAdjustmentError - authAdjustmentRefused - authorised - bankTransfer - bankTransferPending - booked - bookingPending - cancelled - capturePending - captureReversalPending - captureReversed - captured - capturedExternally - chargeback - chargebackExternally - chargebackPending - chargebackReversalPending - chargebackReversed - credited - depositCorrection - depositCorrectionPending - dispute - disputeClosed - disputeExpired - disputeNeedsReview - error - expired - failed - fee - feePending - internalTransfer - internalTransferPending - invoiceDeduction - invoiceDeductionPending - manualCorrectionPending - manuallyCorrected - matchedStatement - matchedStatementPending - merchantPayin - merchantPayinPending - merchantPayinReversed - merchantPayinReversedPending - miscCost - miscCostPending - paymentCost - paymentCostPending - received - refundPending - refundReversalPending - refundReversed - refunded - refundedExternally - refused - reserveAdjustment - reserveAdjustmentPending - returned - secondChargeback - secondChargebackPending - undefined type: string required: - counterparty - status - category - amount 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 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 UKLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 8-digit bank account number, without separators or whitespace. maxLength: 8 minLength: 8 type: string sortCode: description: The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace. maxLength: 6 minLength: 6 type: string type: default: ukLocal description: '**ukLocal**' enum: - ukLocal type: string required: - type - accountNumber - sortCode type: object PaymentInstrumentRequirement: additionalProperties: false properties: description: description: Specifies the requirements for the payment instrument that need to be included in the request for a particular route. 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 onlyForCrossBalancePlatform: description: Specifies if the requirement only applies to transfers to another balance platform. type: boolean paymentInstrumentType: description: The type of the payment instrument. For example, "BankAccount" or "Card". enum: - BankAccount - Card type: string type: default: paymentInstrumentRequirement description: '**paymentInstrumentRequirement**' enum: - paymentInstrumentRequirement type: string required: - type type: object SELocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace. maxLength: 10 minLength: 7 type: string clearingNumber: description: The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace. maxLength: 5 minLength: 4 type: string type: default: seLocal description: '**seLocal**' enum: - seLocal type: string required: - type - accountNumber - clearingNumber type: object HKLocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 9- to 15-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code. maxLength: 15 minLength: 9 type: string clearingCode: description: The 3-digit clearing code, without separators or whitespace. maxLength: 3 minLength: 3 type: string type: default: hkLocal description: '**hkLocal**' enum: - hkLocal type: string required: - type - accountNumber - clearingCode type: object AmountMinMaxRequirement: additionalProperties: false properties: description: description: Specifies the eligible amounts for a particular route. type: string max: description: Maximum amount. format: int64 type: integer min: description: Minimum amount. format: int64 type: integer type: default: amountMinMaxRequirement description: '**amountMinMaxRequirement**' enum: - amountMinMaxRequirement type: string required: - type type: object HULocalAccountIdentification: additionalProperties: false properties: accountNumber: description: The 24-digit bank account number, without separators or whitespace. maxLength: 24 minLength: 24 type: string type: default: huLocal description: '**huLocal**' enum: - huLocal type: string required: - type - accountNumber type: object BalanceTransferRequest: properties: amount: description: The amount of the transfer in [minor units](https://docs.adyen.com/development-resources/currency-codes). $ref: '#/components/schemas/Amount' description: description: A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. maxLength: 140 type: string fromMerchant: description: The unique identifier of the source merchant account from which funds are deducted. type: string reference: description: 'A reference for the balance transfer. If you don''t provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.' maxLength: 80 type: string toMerchant: description: The unique identifier of the destination merchant account from which funds are transferred. type: string type: description: 'The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.' enum: - tax - fee - terminalSale - credit - debit - adjustment type: string required: - amount - fromMerchant - toMerchant - type type: object TransferNotificationValidationFact: properties: result: description: The evaluation result of the validation fact. type: string type: description: The type of the validation fact. type: string 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-transfers-payout-to-transfer-instrument: summary: Pay out to a transfer instrument description: Example request to pay out to a transfer instrument value: amount: value: 80000 currency: EUR balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4 category: bank counterparty: transferInstrumentId: SE1234567890ABC1234567890 priority: regular referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer 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' 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' post-balanceTransfer-post-balance-transfer: summary: Transfer balances between merchant accounts description: Example request for transferring balance between merchant accounts value: amount: value: 50000 currency: EUR description: Your description for the transfer fromMerchant: MerchantAccount_NL toMerchant: MerchantAccount_DE type: debit post-transfers-payout-cross-border: summary: Make a cross-border transfer description: Example request to make a cross-border transfer value: amount: value: 110000 currency: EUR balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4 category: bank counterparty: bankAccount: accountHolder: fullName: A. Klaassen address: city: San Francisco country: US postalCode: '94678' stateOrProvince: CA line1: '274' line2: Brannan Street accountIdentification: type: numberAndBic accountNumber: '123456789' bic: BOFAUS3NXXX priority: crossBorder referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer 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-transferRoutes-calculate-transferRoutesCalculate: summary: Calculate transfer routes description: Example request for calculating transfer routes value: balancePlatform: YOUR_BALANCE_PLATFORM currency: USD category: bank counterparty: bankAccount: accountIdentification: type: iban iban: NL91ABNA0417164300 post-transfers-payout-cross-border-200: summary: Response code - 200 OK description: Example response for a transfers request value: id: 1W1UG35U8A9J5ZLG accountHolder: description: Your account holder description id: AH3227C223222C5GXQXF658WB reference: Your account holder reference amount: value: 110000 currency: EUR balanceAccount: description: Your balance account description id: BAB8B2C3D4E5F6G7H8D9J6GD4 reference: Your balance account reference category: bank categoryData: priority: crossBorder type: bank counterparty: bankAccount: accountHolder: fullName: A. Klaassen address: city: San Francisco country: US postalCode: '94678' stateOrProvince: CA line1: '274' line2: Brannan Street accountIdentification: type: numberAndBic accountNumber: '123456789' bic: BOFAUS3NXXX paymentInstrument: description: Your payment instrument description id: PI3222G223222G59347DAA265 reference: Your payment instrument reference referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer direction: outgoing reason: approved status: authorised post-transfers-payout-to-balance-account: summary: Transfer funds to another balance account description: Example request to transfer funds to another balance account value: amount: value: 10000 currency: EUR balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4 category: internal counterparty: balanceAccountId: BA32272223222B5LPRFDW7J9G referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer post-transfers-payout-local-transfer-sepa-200: summary: Response code - 200 OK description: Example response for a transfers request value: id: 1W1UG35U8A9J5ZLG accountHolder: description: Your account holder description id: AH3227C223222C5GXQXF658WB reference: Your account holder reference amount: value: 110000 currency: EUR balanceAccount: description: Your balance account description id: BAB8B2C3D4E5F6G7H8D9J6GD4 reference: Your balance account reference category: bank categoryData: priority: regular type: bank counterparty: bankAccount: accountHolder: fullName: A. Klaassen accountIdentification: type: iban iban: NL91ABNA0417164300 paymentInstrument: description: Your payment instrument description id: PI3222G223222G59347DAA265 reference: Your payment instrument reference referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer direction: outgoing reason: approved status: authorised post-transfers-payout-local-transfer-sepa: summary: Make a SEPA funds transfer description: Example request to make a SEPA funds transfer value: amount: value: 110000 currency: EUR balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4 category: bank counterparty: bankAccount: accountHolder: fullName: A. Klaassen accountIdentification: type: iban iban: NL91ABNA0417164300 priority: regular referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer post-transferRoutes-calculate-transferRoutesCalculate-200: summary: Response for calculating transfer routes description: Example response for calculating transfer routes value: transferRoutes: - country: NL currency: USD priority: crossBorder requirements: - description: Amount of transfer must be at least 100, and no greater than 99999999999 max: 99999999999 min: 100 type: amountMinMaxRequirement - description: Country, street and city is required. requiredAddressFields: - STREET - CITY type: addressRequirement - description: Bank account identification type must be iban or numberAndBic bankAccountIdentificationTypes: - iban - numberAndBic type: bankAccountIdentificationTypeRequirement - issuingCountryCode: NL paymentInstrumentType: BankAccount type: paymentInstrumentRequirement - country: NL currency: USD priority: wire requirements: - description: Amount of transfer must be at least 100, and no greater than 99999999999 max: 99999999999 min: 100 type: amountMinMaxRequirement - description: Country, street and city is required. requiredAddressFields: - STREET - CITY type: addressRequirement - description: Bank account identification type must be iban or numberAndBic bankAccountIdentificationTypes: - iban - numberAndBic type: bankAccountIdentificationTypeRequirement - issuingCountryCode: NL paymentInstrumentType: BankAccount type: paymentInstrumentRequirement post-transfers-payout-to-balance-account-200: summary: Response code - 200 OK description: Example response for a transfers request value: id: 1W1UG35U8A9J5ZLG accountHolder: description: Your account holder description id: AH3227C223222C5GXQXF658WB reference: Your account holder reference amount: currency: EUR value: 10000 balanceAccount: description: Your balance account description id: BAB8B2C3D4E5F6G7H8D9J6GD4 reference: Your balance account reference category: internal counterparty: balanceAccountId: BA32272223222B5LPRFDW7J9G referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer direction: outgoing reason: approved status: authorised post-balanceTransfer-post-balance-transfer-200: summary: Transfer balances between merchant accounts description: Example response for transferring balance between merchant accounts value: amount: value: 50000 currency: EUR createdAt: '2022-01-24T14:59:11+01:00' description: Your description for the transfer fromMerchant: MerchantAccount_NL toMerchant: MerchantAccount_DE type: debit reference: Unique reference for the transfer pspReference: '8816080397613514' status: transferred post-transfers-payout-local-transfer-us-200: summary: Response code - 200 OK description: Example response for a transfers request value: id: 1W1UG35U8A9J5ZLG accountHolder: description: Your account holder description id: AH3227C223222C5GXQXF658WB reference: Your account holder reference amount: value: 110000 currency: USD balanceAccount: description: Your balance account description id: BAB8B2C3D4E5F6G7H8D9J6GD4 reference: Your balance account reference category: bank categoryData: priority: regular type: bank counterparty: bankAccount: accountHolder: fullName: A. Klaassen accountIdentification: type: usLocal accountNumber: '123456789' routingNumber: 11000138 paymentInstrument: description: Your payment instrument description id: PI3222G223222G59347DAA265 reference: Your payment instrument reference referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer direction: outgoing reason: approved status: authorised post-transfers-payout-local-transfer-us: summary: Make a US local funds transfer description: Example request to make a US local funds transfer value: amount: value: 110000 currency: USD balanceAccountId: BAB8B2C3D4E5F6G7H8D9J6GD4 category: bank counterparty: bankAccount: accountHolder: fullName: A. Klaassen accountIdentification: type: usLocal accountNumber: '123456789' routingNumber: 11000138 priority: regular referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer post-transfers-payout-to-transfer-instrument-200: summary: Response code - 200 OK description: Example response for a transfers request value: id: 1W1UG35U8A9J5ZLG accountHolder: description: Your account holder description id: AH3227C223222C5GXQXF658WB reference: Your account holder reference amount: value: 80000 currency: EUR balanceAccount: description: Your balance account description id: BAB8B2C3D4E5F6G7H8D9J6GD4 reference: Your balance account reference category: bank categoryData: priority: regular type: bank counterparty: transferInstrumentId: SE1234567890ABC1234567890 paymentInstrument: description: Your payment instrument description id: PI3222G223222G59347DAA265 reference: Your payment instrument reference referenceForBeneficiary: Your-reference-sent-to-the-beneficiary reference: Your internal reference for the transfer description: Your description for the transfer direction: outgoing reason: approved status: authorised 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' headers: auth-param1: description: Base64-encoded blob of data. You will need auth-param1 when authenticating your user using the SDK. schema: type: string securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification