get_required_fields
Returns mandatory top-level schema fields for an ISO 20022 E&I message type, so you can build valid payloads before generate_message or XML serialization.
Instructions
Get required schema fields for an ISO 20022 E&I message type.
Purpose: Returns the list of mandatory top-level data fields required to construct a valid message record (e.g. assignment identification, instruct team agent, and transaction arrays).
When to use:
When preparing input payloads before calling generate_message.
When validating payload completeness prior to XML serialization.
When NOT to use:
Do NOT use with unsupported message types; discover supported types via list_message_types.
Behavioral transparency: Deterministic field dictionary lookup; pure, read-only, and idempotent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message_type | Yes | An E&I message type, e.g. 'camt.056.001.12' (see list_message_types). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||