Adyen · JSON Structure

Configuration Transfer Route Request Structure

TransferRouteRequest schema from Adyen API

Type: object Properties: 7 Required: 3
PaymentsFinancial-ServicesFintech

TransferRouteRequest is a JSON Structure definition published by Adyen, describing 7 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

balanceAccountId balancePlatform category counterparty country currency priorities

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/configuration-transfer-route-request-structure.json",
  "description": "TransferRouteRequest schema from Adyen API",
  "type": "object",
  "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": "#/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.\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"
  ],
  "name": "TransferRouteRequest"
}

Work with this as data

Every JSON Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure 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 Structure
curl "https://apis.io/api/v1/json-structures/configuration-transfer-route-request-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?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.

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