Lint a payload against a profile
lint_payloadValidate ISO 20022 payment payloads against specific bank clearing profile rules to identify violations, missing elements, or format defects before clearing submission.
Instructions
Evaluate a payload against a clearing profile and return findings.
Purpose:
Validate an ISO 20022 XML or JSON message payload against the
market-practice rules and constraints of a specific bank clearing profile.
When to use:
Use before submitting payment messages to clearing rails (CBPR+, SEPA,
FedNow) to identify rule violations, missing elements, or format defects.
When NOT to use:
Do not use for basic XSD schema validation; use structural XML
validators. Do not use to validate rule pack schemas; use
`validate_profile_definition`.
Behavioral transparency:
- Deterministic: Identical payload and profile_id produce identical
findings.
- External dependencies: None (defusedxml parser only).
- Side effects: Pure read-only operation; writes no data.
- Error states: Returns an error object on XML syntax error,
unknown profile_id, or entitlement failure.
Args:
payload_content: The raw ISO 20022 message text.
profile_id: The clearing profile to lint against.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| profile_id | Yes | The clearing profile to lint against. | |
| payload_content | Yes | Raw ISO 20022 payload text (not a path). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||