Request Payment Authorization
request_paymentAuthorize a payment before executing it. Get a signed grant or a denial with the violated rule, preventing unauthorized or fraudulent transfers.
Instructions
Authorize a payment action against the active Fidacy mandate. Returns an ALLOW with a signed grant, or a DENY with the violated rule. The downstream executor MUST require the grant. Call this before any payment; never pay without it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payee | Yes | Payee identifier | |
| amount | Yes | Amount in the mandate currency | |
| purpose | Yes | Your stated reason for this payment, in your own words. It is persisted readably on the tamper-evident audit record (ALLOW and DENY alike) and becomes part of the after-the-fact proof, so write the real reason. | |
| category | Yes | Purpose category (must be allowed by the mandate) | |
| currency | Yes | ISO 4217 currency code | |
| invoiceRef | No | Optional invoice identity. When set, Fidacy enforces one payment per invoice: a second request for the same invoiceRef is DENIED, at any amount. | |
| idempotencyKey | No | Optional. Your own key for this payment, if you have one (an order id, a job id). Leave it out and Fidacy derives one from the payment itself, which is the safer default: a retry of the SAME payment produces the SAME key, where an invented one would not. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| grant | No | ||
| status | Yes | ||
| message | Yes | ||
| decisionId | Yes | ||
| violatedRule | No |