validate
Check ISO 20022 record objects against a message type's JSON Schema before XML generation, verifying required fields, date formats, and IBAN/BIC constraints.
Instructions
Validate records for a message type against its JSON Schema, via the family's backing server. When to use: Use before 'generate' to verify record field types, required fields, date formats (YYYY-MM-DD), and IBAN/BIC constraints without generating XML. When NOT to use: Do not use to validate raw XML documents; use the backing server's XSD validation tools or 'parse'. Behavior: Pure deterministic validation; read-only and idempotent with zero network I/O.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| records | Yes | List of flat record objects (field name → value). Field names come from the family's input schema — call describe(message_type) for the required fields. For pain.001 credit transfers the key fields are: id, date ('YYYY-MM-DD' accepted), initiator_name, payment_id, requested_execution_date ('YYYY-MM-DD'), debtor_name, debtor_account_IBAN, debtor_agent_BIC, creditor_name, creditor_account_IBAN, creditor_agent_BIC, payment_amount (alias 'amount'), currency (alias 'payment_currency'), remittance_information; batch_booking takes JSON true/false, and nb_of_txs/ctrl_sum are computed automatically. IBAN and BIC values are strictly validated, never coerced. | |
| message_type | Yes | ISO 20022 message type, e.g. 'pain.001.001.09', 'pacs.008' or 'camt.053'. For pain messages a fully-versioned type is preferred; the bare family name 'pain.001' resolves to 'pain.001.001.09'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||