Validate records against a scheme
validate_schemeValidates payment records against a payment rail's usage-guideline rules to check for violations like charge-bearer restrictions, UETR presence, remittance-info length, and transaction cardinality.
Instructions
Validate payment records against a scheme's usage-guideline rules.
Use this to check a batch against a rail's rulebook (CBPR+, HVPS+,
Fedwire, CHAPS, T2 RTGS, SCT Inst) -- charge-bearer restrictions, UETR
presence, remittance-info length, and per-message transaction cardinality.
This is complementary to ``validate_records`` (JSON-Schema shape).
Returns ``{"scheme": str, "is_valid": bool, "total": int,
"violations": [...]}``.
Args:
scheme: A registered scheme profile name (see ``list_schemes``).
records: One or more flat payment records to check.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scheme | Yes | A registered scheme / usage-guideline profile name (case-insensitive), e.g. 'cbpr_plus', 'fedwire', 'chaps'. Must be one of: 'cbpr+', 'cbpr_plus', 'cbprplus', 'chaps', 'fedwire', 'generic', 'hvps+', 'hvps_plus', 'hvpsplus', 'sct-inst', 'sct_inst', 'sctinst', 't2_rtgs', 't2rtgs', 'target2' (see list_schemes). | |
| records | Yes | One or more flat payment records, each a dict of field name -> value; checked against the scheme's usage-guideline business rules (charge bearer, UETR, remittance length, per-message cardinality). |