TransferInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/transfers-transfer-info-schema.json",
  "title": "TransferInfo",
  "description": "TransferInfo schema from Adyen API",
  "type": "object",
  "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.\n\nSupported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , ' + Space**\n\nSupported 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**.\n\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).",
      "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"
  ]
}