Formatwerk
sepa direct debit xml
Generate mode builds pain.008.001.08 (current DK version): one payment block per sequence type (FRST, RCUR, OOFF, FNAL; RCUR is the DK recommendation), creditor identifier checked with ISO 7064 MOD 97-10, mandate id and signature date, optional amendment details (original mandate id, original creditor id, original debtor IBAN or SMNDA), debtor address enforced for banks outside the EU/EEA. Validate mode also reads the legacy pain.008.001.02 and checks CORE/B2B mixing, sequence types, the.
POST https://format.halowerk.com/v1/sepa-direct-debit-xmlInputs
| Field | Type | Required | Description |
|---|---|---|---|
| xml | string | No | Existing pain.008 file to validate. If given, the generation fields are ignored. |
| creditor | object | No | Creditor (generate mode). |
| collection_date | string | No | Requested collection (due) date. |
| scheme | string | No | SEPA direct debit scheme. |
| transactions | array | No | Collections (generate mode). |
| message_id | string | No | Message id; default derived from the content. |
| payment_information_id | string | No | Payment information id (prefix if several sequence types). |
| created_at | string | No | Creation timestamp; default now. |
| initiating_party | string | No | Initiating party name; default creditor name. |
| ultimate_creditor | string | No | Ultimate creditor name. |
| batch_booking | boolean | No | Batch booking flag. |
| category_purpose | string | No | Category purpose code. |
| charset | string | No | dk = Latin set plus Ä Ö Ü ä ö ü ß & * $ % (German banks, DK Appendix 3); epc = EPC basic Latin set only. |
| reference_date | string | No | Reference date for date checks (submission date), default today (UTC). |
Show full input schema
{
"type": "object",
"additionalProperties": false,
"properties": {
"xml": {
"type": "string",
"maxLength": 5000000,
"description": "Existing pain.008 file to validate. If given, the generation fields are ignored."
},
"creditor": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"iban",
"creditor_id"
],
"description": "Creditor (generate mode).",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Creditor name."
},
"iban": {
"type": "string",
"minLength": 1,
"maxLength": 42,
"description": "Creditor IBAN."
},
"bic": {
"type": "string",
"minLength": 1,
"maxLength": 11,
"description": "Creditor bank BIC (optional)."
},
"creditor_id": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "SEPA creditor identifier, e.g. DE98ZZZ09999999999."
},
"address": {
"type": "object",
"additionalProperties": false,
"required": [
"town",
"country"
],
"description": "Structured or hybrid postal address (town and country mandatory since 5 October 2025).",
"properties": {
"street": {
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Street name."
},
"building_number": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "Building number."
},
"postal_code": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "Postal code."
},
"town": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Town."
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO 3166 country code."
},
"address_lines": {
"type": "array",
"maxItems": 2,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Free address line."
},
"description": "At most two free lines (hybrid address)."
}
}
}
}
},
"collection_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Requested collection (due) date."
},
"scheme": {
"type": "string",
"enum": [
"CORE",
"B2B"
],
"default": "CORE",
"description": "SEPA direct debit scheme."
},
"transactions": {
"type": "array",
"minItems": 1,
"maxItems": 5000,
"description": "Collections (generate mode).",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"debtor",
"mandate_id",
"mandate_signature_date"
],
"properties": {
"amount": {
"type": [
"number",
"string"
],
"description": "Amount in EUR, positive, at most two decimal places (number or string such as \"100.50\")."
},
"end_to_end_id": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "End-to-end reference; default NOTPROVIDED."
},
"instruction_id": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Optional instruction id."
},
"debtor": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"iban"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Debtor name."
},
"iban": {
"type": "string",
"minLength": 1,
"maxLength": 42,
"description": "Debtor IBAN."
},
"bic": {
"type": "string",
"minLength": 1,
"maxLength": 11,
"description": "Debtor bank BIC (optional)."
},
"address": {
"type": "object",
"additionalProperties": false,
"required": [
"town",
"country"
],
"description": "Structured or hybrid postal address (town and country mandatory since 5 October 2025).",
"properties": {
"street": {
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Street name."
},
"building_number": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "Building number."
},
"postal_code": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "Postal code."
},
"town": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Town."
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO 3166 country code."
},
"address_lines": {
"type": "array",
"maxItems": 2,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Free address line."
},
"description": "At most two free lines (hybrid address)."
}
}
}
}
},
"mandate_id": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Mandate reference."
},
"mandate_signature_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date the mandate was signed."
},
"sequence_type": {
"type": "string",
"enum": [
"FRST",
"RCUR",
"OOFF",
"FNAL"
],
"default": "RCUR",
"description": "Sequence type; RCUR may also be used for the first collection since November 2016."
},
"remittance_information": {
"type": "string",
"minLength": 1,
"maxLength": 400,
"description": "Unstructured remittance information, max 140 after cleaning."
},
"creditor_reference": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Structured creditor reference (instead of remittance_information)."
},
"purpose_code": {
"type": "string",
"pattern": "^[A-Z0-9]{4}$",
"description": "ISO 20022 purpose code."
},
"ultimate_debtor": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Ultimate debtor name."
},
"amendment": {
"type": "object",
"additionalProperties": false,
"description": "Mandate amendment since the last collection.",
"properties": {
"original_mandate_id": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Previous mandate reference."
},
"original_creditor_id": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "Previous creditor identifier."
},
"original_creditor_name": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Previous creditor name."
},
"original_debtor_iban": {
"type": "string",
"minLength": 1,
"maxLength": 42,
"description": "Previous debtor IBAN (account change at the same bank)."
},
"debtor_bank_changed": {
"type": "boolean",
"description": "Debtor moved to another bank (SMNDA)."
}
}
}
}
}
},
"message_id": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Message id; default derived from the content."
},
"payment_information_id": {
"type": "string",
"minLength": 1,
"maxLength": 30,
"description": "Payment information id (prefix if several sequence types)."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation timestamp; default now."
},
"initiating_party": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Initiating party name; default creditor name."
},
"ultimate_creditor": {
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Ultimate creditor name."
},
"batch_booking": {
"type": "boolean",
"description": "Batch booking flag."
},
"category_purpose": {
"type": "string",
"pattern": "^[A-Z0-9]{4}$",
"description": "Category purpose code."
},
"charset": {
"type": "string",
"enum": [
"dk",
"epc"
],
"default": "dk",
"description": "dk = Latin set plus Ä Ö Ü ä ö ü ß & * $ % (German banks, DK Appendix 3); epc = EPC basic Latin set only."
},
"reference_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Reference date for date checks (submission date), default today (UTC)."
}
}
}Published input example
{
"creditor": {
"name": "Beispiel Sportverein e.V.",
"iban": "DE79000000001234567890",
"creditor_id": "DE98ZZZ09999999999"
},
"collection_date": "2026-11-10",
"reference_date": "2026-11-02",
"transactions": [
{
"amount": "49.90",
"debtor": {
"name": "Sportgruppe Nord",
"iban": "DE16000000002345678901"
},
"mandate_id": "MITGL-0001",
"mandate_signature_date": "2025-03-01",
"remittance_information": "Mitgliedsbeitrag November 2026"
}
]
}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
- Formatwerk0.004 USDC
accounting csv unify
POSThttps://format.halowerk.com/v1/accounting-csv-unifyDATEV booking batch files (EXTF/DTVF, category 21) are read by their documented field positions: amount and S/H become a signed amount relative to the account, Belegdatum TTMM is resolved within the fiscal year from the header. Other export
- Formatwerk0.005 USDC
avv checklist
POSThttps://format.halowerk.com/v1/avv-checklistChecklist after Art. 28 GDPR (Regulation (EU) 2016/679 Art. 28 (GDPR), https://eur-lex.europa.eu/eli/reg/2016/679/oj, German and English text retrieved from the EU Publications Office 2026-11-01): Art. 28(3) sentence 1 (subject-matter, dura
- Formatwerk0.004 USDC
bagit package
POSThttps://format.halowerk.com/v1/bagit-packageCreate: files go to data/, manifest-<alg>.txt and tagmanifest-<alg>.txt are written for SHA-256 (default), SHA-512 or legacy SHA-1/MD5, bag-info.txt gets your metadata plus Bagging-Date, Bag-Size and Payload-Oxum; paths are checked (no abso