Skip to content
HALOWERK

Formatwerk

mandate ref check

Each mandate reference is checked against the DK TVS pattern for mandate ids (letters, digits, blank and + ? / - : ( ) . , '), at most 35 characters, no leading or trailing slash and no "//". References are compared without regard to upper and lower case (EPC rule quoted in DK Appendix 3, 2.2.2); the same reference for different debtor IBANs or names of one creditor is reported as a conflict, blanks as a warning (DK recommendation). Optional creditor identifiers are verified with MOD 97-10,.

POST https://format.halowerk.com/v1/mandate-ref-check

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
mandatesarrayYesMandates to check.
default_creditor_idstringNoCreditor identifier used for mandates without their own.
reference_datestringNoReference date for date checks, default today (UTC).
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "mandates"
  ],
  "properties": {
    "mandates": {
      "type": "array",
      "minItems": 1,
      "maxItems": 20000,
      "description": "Mandates to check.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "mandate_id"
        ],
        "properties": {
          "mandate_id": {
            "type": "string",
            "maxLength": 100,
            "description": "Mandate reference."
          },
          "creditor_id": {
            "type": "string",
            "maxLength": 40,
            "description": "Creditor identifier (otherwise default_creditor_id)."
          },
          "debtor_iban": {
            "type": "string",
            "maxLength": 42,
            "description": "Debtor IBAN (for conflict detection)."
          },
          "debtor_name": {
            "type": "string",
            "maxLength": 140,
            "description": "Debtor name (for conflict detection)."
          },
          "signature_date": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "description": "Date of signature."
          },
          "last_collection_date": {
            "type": "string",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "description": "Date of the latest collection presented (even if rejected, returned or refunded)."
          }
        }
      }
    },
    "default_creditor_id": {
      "type": "string",
      "maxLength": 40,
      "description": "Creditor identifier used for mandates without their own."
    },
    "reference_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Reference date for date checks, default today (UTC)."
    }
  }
}

Open original schema

Published input example

{
  "default_creditor_id": "DE98ZZZ09999999999",
  "mandates": [
    {
      "mandate_id": "M-001",
      "debtor_iban": "DE79000000001234567890"
    },
    {
      "mandate_id": "m-001",
      "debtor_iban": "DE16000000002345678901"
    }
  ]
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’