Get input JSON Schema
get_input_schemaRetrieve the complete JSON Schema for any supported ISO 20022 pain message type to learn field types and constraints for assembling records or building input forms.
Instructions
Return the full JSON Schema for a message type's flat input record.
Use this to learn every field, its type, and its constraints before
assembling records, or to drive a form/UI. For just the required-field
names use ``get_required_fields``; to actually check records against
this schema use ``validate_records``.
Args:
message_type: A supported ISO 20022 pain message type.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message_type | Yes | A supported ISO 20022 pain message type. Must be exactly one of: 'pain.001.001.03', 'pain.001.001.04', 'pain.001.001.05', 'pain.001.001.06', 'pain.001.001.07', 'pain.001.001.08', 'pain.001.001.09', 'pain.001.001.10', 'pain.001.001.11', 'pain.001.001.12', 'pain.001.001.13', 'pain.008.001.02', 'pain.008.001.08', 'pain.001', 'pain.008' (see list_message_types). The bare family names 'pain.001' and 'pain.008' are accepted as aliases for 'pain.001.001.09' and 'pain.008.001.02'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | ||
| error | No | ||
| title | No | ||
| version | No | ||
| required | No | ||
| properties | No | ||
| description | No | ||
| additionalProperties | No |