Adyen · JSON Structure

Legal Entity Transfer Instrument Structure

TransferInstrument schema from Adyen API

Type: object Properties: 7 Required: 4
PaymentsFinancial ServicesFintech

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

Properties

bankAccount capabilities documentDetails id legalEntityId problems type

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/legal-entity-transfer-instrument-structure.json",
  "description": "TransferInstrument schema from Adyen API",
  "type": "object",
  "properties": {
    "bankAccount": {
      "description": "Contains information about the legal entity's bank account.",
      "$ref": "#/components/schemas/BankAccountInfo"
    },
    "capabilities": {
      "x-addedInVersion": "3",
      "additionalProperties": {
        "$ref": "#/components/schemas/SupportingEntityCapability"
      },
      "description": "List of capabilities for this transfer instrument.",
      "type": "object"
    },
    "documentDetails": {
      "x-addedInVersion": "2",
      "description": "List of documents uploaded for the transfer instrument.",
      "items": {
        "$ref": "#/components/schemas/DocumentReference"
      },
      "type": "array"
    },
    "id": {
      "description": "The unique identifier of the transfer instrument.",
      "readOnly": true,
      "type": "string"
    },
    "legalEntityId": {
      "description": "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) that owns the transfer instrument.",
      "type": "string"
    },
    "problems": {
      "x-addedInVersion": "3",
      "description": "The verification errors related to capabilities for this transfer instrument.",
      "items": {
        "$ref": "#/components/schemas/CapabilityProblem"
      },
      "type": "array"
    },
    "type": {
      "description": "The type of transfer instrument.\n\nPossible value: **bankAccount**.",
      "enum": [
        "bankAccount",
        "recurringDetail"
      ],
      "type": "string"
    }
  },
  "required": [
    "legalEntityId",
    "type",
    "bankAccount",
    "id"
  ],
  "name": "TransferInstrument"
}