Handoff to your rail
rail_handoffKeyed. With intent_id: after a person has approved, the approved instruction for your rail, with a Rate Receipt of the rate against the official rate and the negotiated deal; where no live connection is configured the adapter is marked stub. The default is that the business releases the payment itself in its own bank or rail portal (release_in_own_bank on the approved payment); SwapEazi never sends it. Sandbox only: with run_id, payment_id and connection_id, sends ONE Payment Run payment a named person approved through the business's OWN connected rail account (Yellow Card sandbox; production stays off unless the deployment sets YELLOWCARD_ENV=production), with the rail's own idempotency key, and returns the submission with a Rate Receipt and the release record. Refused, with the reason, without a recorded approval, when the payment changed since approval, above the connection's cap, or for an account other than the one approved. With run_id and payment_id only: reads that payment's status from the rail. SwapEazi holds no funds and has no account in the flow.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | With run_id: the payment's purpose as the rail records it, e.g. 'other' (default). | |
| run_id | No | Instead of intent_id: the payment run (pr_...) holding an approved payment to send. | |
| intent_id | No | An approved payment intent (from payment_intent and decide_intent): returns its instruction for your rail. | |
| access_key | No | A router key (rk_...), if not sent as a Bearer header. | |
| channel_id | No | With run_id: the rail's payout channel id for this payment (Yellow Card channelId). | |
| network_id | No | With run_id: the rail's id for the payee's bank or mobile-money network (Yellow Card networkId). | |
| payment_id | No | With run_id: the approved payment in the run, e.g. 'p_001'. | |
| account_type | No | With run_id: bank (default) or momo (mobile money). | |
| connection_id | No | With run_id: your connected rail account (from connect_rail_account) to send through. | |
| account_number | No | The payee's full account number as approved; SwapEazi keeps only its last four characters and matches this against the approved instruction. |