Get scheme profile rules
get_schemeInspect a payment scheme's rule attributes, including UETR requirement, charge bearers, remittance info length, transaction cardinality, message versions, and LEI mandates.
Instructions
Return the rule attributes of a scheme / usage-guideline profile.
Use this to inspect a rail's constraints -- whether the UETR is mandatory,
the permitted charge bearers, remittance-info length cap, per-message
transaction cardinality, pinned message versions, and which parties must
carry an LEI -- before assembling or validating a batch.
Args:
scheme: A registered scheme profile name (see ``list_schemes``).
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). |