TransferRoute

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/configuration-transfer-route-schema.json",
  "title": "TransferRoute",
  "description": "TransferRoute schema from Adyen API",
  "type": "object",
  "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:\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).",
      "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"
        }
      ]
    }
  }
}