Prepare payment instructions
prepare_payment_instructionSpec v1.0 name for run_payments: prepares each payment (payee validation, route assessment, instruction, approval digest) and returns each payment's lifecycle state. Never approves or sends. Same arguments as run_payments; sample: true for the synthetic run.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | No | Instead of payables: a payout CSV or pain.001 text. | |
| sample | No | true: the built-in sample run (synthetic, labelled), no key needed. | |
| payables | No | [{ reference, payee: { name, iban?, bic?, account_number?, routing_number?, branch_code?, country? }, amount, currency, due_date?, rail?: bank | provider | stablecoin, via?, wallet? }] | |
| access_key | No | A router key (rk_...), if not sent as a Bearer header. | |
| source_currency | No | The currency the business pays from, e.g. ZAR. |