CreateCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/memo-bank/main/json-schema/memo-bank-create-collection-schema.json",
  "title": "CreateCollection",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/memo-bank-collections-api-openapi.yml#/components/schemas/CreateCollection",
  "required": [
    "amount",
    "local_iban",
    "mandate",
    "scheduled_date"
  ],
  "type": "object",
  "properties": {
    "amount": {
      "minimum": 1,
      "type": "integer",
      "description": "Amount to be collected, in cents. The currency is always EURO.",
      "format": "int64"
    },
    "mandate": {
      "$ref": "#/$defs/CreateCollectionMandate"
    },
    "scheduled_date": {
      "type": "string",
      "description": "The ISO8601 formatted date on which the direct debit collection will be submitted. This date must not be in the past. If your direct debit is scheduled to be submitted on a non-business day, it will be effectively submitted on the next business day. The execution will then happen on the following business day. For example, a direct debit scheduled on a Saturday will be submitted on the following Monday and executed on the Tuesday (assuming that both week days are business days).",
      "format": "date"
    },
    "local_iban": {
      "pattern": "^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$",
      "type": "string",
      "description": "Existing IBAN to be credited. It can be the main IBAN of an account or a virtual IBAN."
    },
    "message": {
      "maxLength": 140,
      "minLength": 1,
      "type": "string",
      "description": "Message attached to this collection, visible to all involved parties."
    },
    "end_to_end_id": {
      "maxLength": 35,
      "minLength": 1,
      "pattern": "[a-zA-Z0-9\\-\\?\\:\\(\\)\\.\\,\\'\\+\\ ]{1,35}",
      "type": "string",
      "description": "Unique identification to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. It can be used for reconciliation or to link tasks relating to the transaction."
    },
    "internal_note": {
      "maxLength": 3000,
      "minLength": 1,
      "type": "string",
      "description": "Internal note attached to this collection, visible only in your Memo Bank workspace."
    },
    "custom_id": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string",
      "description": "Custom identifier that will be attached to the transaction resulting from this collection. It will not be transmitted nor visible in your Memo Bank workspace. It can only be retrieved or used to search for transactions via Memo Bank API."
    },
    "custom_metadata": {
      "maxLength": 2048,
      "minLength": 1,
      "type": "string",
      "description": "Custom metadata that will be attached to the transaction resulting from this collection. It will not be transmitted nor visible in your Memo Bank workspace and can only be retrieved via API."
    }
  },
  "$defs": {
    "CollectionMandateDebtor": {
      "required": [
        "iban",
        "name"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "Name of the debtor."
        },
        "iban": {
          "pattern": "^[A-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$",
          "type": "string",
          "description": "IBAN of the debtor."
        },
        "address": {
          "$ref": "#/$defs/CollectionMandateDebtorAddress"
        }
      },
      "description": "The debtor associated with this mandate.This field is only required in case of a new mandate. If there is an existing mandate with this reference and scheme, all information in this field will be ignored except for the debtor IBAN which needs to be the same as the one in the existing mandate. Providing a different IBAN will produce a 400 error with the code `outgoing_collection_mandate_iban_mismatch`."
    },
    "CollectionMandateDebtorAddress": {
      "required": [
        "city",
        "country",
        "postal_code",
        "street"
      ],
      "type": "object",
      "properties": {
        "street": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "Name of the street."
        },
        "building_number": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "Number of the building or house."
        },
        "postal_code": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "Postal or zip code."
        },
        "city": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "Name of the city."
        },
        "country": {
          "pattern": "^[A-Z]{2}$",
          "type": "string",
          "description": "ISO3166-1 alpha-2 country code."
        }
      },
      "description": "The debtor's address. Mandatory only when the debtor's bank — more specifically, its BIC — is located in a non-EEA SEPA country or territory."
    },
    "CreateCollectionMandate": {
      "required": [
        "reference",
        "scheme"
      ],
      "type": "object",
      "properties": {
        "reference": {
          "pattern": "^[A-Za-z0-9+?/\\-:().,'\\s]{1,35}$",
          "type": "string",
          "description": "The unique mandate reference."
        },
        "scheme": {
          "type": "string",
          "description": "The mandate scheme.",
          "enum": [
            "b2b",
            "core"
          ]
        },
        "signature_date": {
          "type": "string",
          "description": "The mandate signature date, in ISO8601 format. The date must not be in the future. This field is only required in case of a new mandate. If there is an existing mandate matching the scheme and with the same reference, this field will be ignored.",
          "format": "date"
        },
        "debtor": {
          "$ref": "#/$defs/CollectionMandateDebtor"
        },
        "contract_reference": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "The contract reference attached to this mandate. This is optional metadata.If there is an existing mandate matching the scheme and with the same reference, this field will be ignored when provided."
        }
      },
      "description": "The SEPA Direct Debit collection mandate to be used."
    }
  }
}