Adyen · Schema

TransferRouteRequest

PaymentsFinancial ServicesFintechAgentic CommercePoint-of-SalePayment Processing

Properties

Name Type Description
balanceAccountId string The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). Required if `counterparty` is **transferInstrumen
balancePlatform string The unique identifier assigned to the balance platform associated with the account holder.
category string The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account
counterparty object The recipient of the funds transfer. A bank account or a transfer instrument.
country string The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. > Either `counterparty` or `country` field must be provided in a transfer route request.
currency string The three-character ISO currency code of transfer. For example, **USD** or **EUR**.
priorities array 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**:
View JSON Schema on GitHub

JSON Schema

adyen-transfer-route-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-transfer-route-request-schema.json",
  "title": "TransferRouteRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adyen-calculate-api-openapi.yml#/components/schemas/TransferRouteRequest",
  "properties": {
    "balanceAccountId": {
      "description": "The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).\nRequired 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": "#/$defs/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.\nPossible values:\n\n* **regular**: For normal, low-value transactions.\n\n* **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.\n\n* **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.\n\n* **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html).\n\n* **crossBorder**: High-value transfer to a recipient in a different country.\n\n* **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",
  "$defs": {
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "#/$defs/AULocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/BRLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/CALocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/CZLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/DKLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/HKLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/HULocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/IbanAccountIdentification"
            },
            {
              "$ref": "#/$defs/NOLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/NZLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/NumberAndBicAccountIdentification"
            },
            {
              "$ref": "#/$defs/PLLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/SELocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/SGLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/UKLocalAccountIdentification"
            },
            {
              "$ref": "#/$defs/USLocalAccountIdentification"
            }
          ]
        }
      },
      "required": [
        "accountIdentification"
      ],
      "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.\n\nPossible 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"
    },
    "CZLocalAccountIdentification": {
      "additionalProperties": false,
      "properties": {
        "accountNumber": {
          "description": "The 2- to 16-digit bank account number (slo tu) in the following format:\n\n- The optional prefix (pedsl).\n\n- The required second part (zkladn st) which must be at least two non-zero digits.\n\nExamples:\n\n- **19-123457** (with prefix)\n\n- **123457** (without prefix)\n\n- **000019-0000123457** (with prefix, normalized)\n\n- **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"
    },
    "Counterparty": {
      "properties": {
        "bankAccount": {
          "description": "Contains information about the bank account.",
          "$ref": "#/$defs/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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "#/$defs/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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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.\n\nPossible 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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/adyen-transfer-route-request"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.