Dispatch a payable to the bank
POST/payables/:id/send-to-bank
Dispatches an authorized payable to the bank through the Kobana gateway (creates the payment, then envelopes and approves it). Requires scope finance.payables.dispatch — deliberately separate from finance.payables.write (dispatching money is not editing a title) and, by default, never granted in the same token as .authorize. X-Idempotency-Key is required. Only an official title dispatches — one whose payment_authorization is null or authorized; a title still awaiting authorization (pending_authorization / authorizing) or rejected returns 422. The payable must also carry the payment coordinates for its method and a Kobana-mirrored source account. Returns the refreshed payable detail with the execution mirror (kobana_status, kobana_payment_uid) populated. Note: the Kobana sandbox example_bank does not execute outbound payments, so the full confirmed cycle is only observable against an environment that actually settles.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
- 500
Dispatched. Body is the refreshed payable detail with the Kobana mirror populated.
Missing / blank X-Idempotency-Key.
Missing / invalid / expired / revoked token.
Token lacks the finance.payables.dispatch scope.
Payable not found within the tenant.
X-Idempotency-Key reused with a different body.
Not dispatchable: title not official (awaiting authorization / rejected), missing payment coordinates, source account not mirrored in Kobana, or the Kobana integration is not connected.
Unhandled server error.