Payouts
Create a crypto payout
POST
Create a crypto payout
Authorizations
Access token from POST /auth (the data.access_token value).
API key issued by Kira. Required on every request, including /auth.
Headers
Example:
"{{client_id}}"
Example:
"2026-04-14"
Example:
"{{idempotency_key}}"
Body
application/json
Previous
Get a payoutRetrieve the full, enriched detail of a single payout you own, by its `payout_id` (the transfer UUID returned at creation and by `GET /v1/payouts`). Works for payouts from every source — API payouts and virtual-account settlement/payout flows.
The response is a bare JSON object (no `{ message, data }` wrapper). Notable fields:
- `status` — the client-facing status. A payout that hit a terminal error surfaces as `"FAILED"` (it aligns with the `payout.failed` webhook); other values are `CREATED`, `PENDING`, `PROCESSING`, `COMPLETED`, `CANCELLED`, `IN_REVIEW`.
- `origin` — `"api"`, `"payout"`, or `"deposit"`.
- `from_amount`/`from_currency` and `to_amount`/`to_currency` — decimal strings; `fee` is the derived difference (or `null` when currencies differ).
- `payment_method` — lowercased recipient rail (`wire`, `swift`, `wallet`, `ach`, `instant_pay`, `spei`).
- `txn_hash` (crypto), `uetr` (wire/SWIFT), and `provider_reference` when available.
- `sender` and `recipient` — bank account numbers and CLABEs are masked to the last 4 digits (`****1234`).
- `events[]` — a client-facing audit trail of status changes.
- `extra_info.supporting_documents[].url` — short-lived (10-minute) pre-signed download links.
- `quotation` — present only when the payout was priced by the itemized quotation engine; it is the same object returned by `POST /v1/quotations`.
**Errors:** `404` when no payout matches the id; `403` when the payout belongs to a different client.
**Example response (200):**
```json
{
"payout_id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"recipient_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"quote_id": "6ba7b812-9dad-11d1-80b4-00c04fd430c8",
"reference": "INV-2026-0042",
"memo": "April consulting services",
"origin": "payout",
"from_amount": "1000.00",
"from_currency": "USD",
"to_amount": "997.50",
"to_currency": "USD",
"fee": "2.50",
"payment_method": "wire",
"txn_hash": null,
"uetr": "a1b2c3d4-1111-2222-3333-444455556666",
"provider_reference": "provider-tx-7788",
"status": "COMPLETED",
"extra_info": {
"supporting_documents": [
{
"type": "invoice",
"url": "https://files.balampay.com/...signed...",
"description": "Invoice PDF"
}
]
},
"metadata": {
"order_id": "ord_12345"
},
"sender": {
"name": "Acme Holdings LLC",
"company_name": "Acme Holdings LLC",
"country": "US",
"bank_name": "Example Bank, N.A.",
"bank_account": "****6789"
},
"recipient": {
"name": "Jane Doe",
"company_name": null,
"country": "MX",
"account_type": "WIRE",
"bank_name": "BBVA Mexico",
"account_number": "****4321",
"routing_number": "021000021",
"account_details": {
"bank_name": "BBVA Mexico",
"address": "Av. Reforma 123, CDMX",
"account_number": "****4321",
"bank_code": "012",
"swift_bic": "BCMRMXMM"
}
},
"events": [
{
"event_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"status": "CREATED",
"message": "Payout created",
"created_at": "2026-06-25T14:00:00.000Z"
},
{
"event_id": "7c9e6679-7425-40de-944b-e07fc1f90ae8",
"status": "COMPLETED",
"message": "Payout settled",
"created_at": "2026-06-25T14:05:00.000Z"
}
],
"created_at": "2026-06-25T14:00:00.000Z",
"updated_at": "2026-06-25T14:05:00.000Z"
}
```
Next
Create a crypto payout