Hold one payment against a mandate
check_payment_against_mandateVerify one payment against a mandate before it is prepared. A breach returns mandate_violation and the rule that failed. A pass still needs the named person to approve. Nothing is sent. A router key is required. The verification is recorded when the payment is prepared inside a payment run.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ISO 4217 code of the destination currency, e.g. 'ZAR'. | |
| from | Yes | ISO 4217 code of the source currency, e.g. 'USDT'; with to, forms the corridor (e.g. USDT-ZAR). | |
| rail | No | Optional. The rail the payment would use: bank, provider or stablecoin. | |
| amount | Yes | The payment amount, in currency, greater than zero. | |
| agent_id | No | Optional. The agent making the payment; must match the mandate's agent. | |
| currency | Yes | ISO 4217 code of amount, e.g. 'USD'. | |
| access_key | No | A router key (rk_...), if not sent as a Bearer header. | |
| mandate_id | Yes | The mandate's id, from create_mandate. | |
| cost_above_official_pct | No | Null when the gap to the official rate is not on record. Never treated as zero. |