Skip to main content
GET
Get a payout
Stable since 2025-01-01 — unchanged in 2026-06-01.

Authorizations

Authorization
string
header
required

Access token from POST /auth (the data.access_token value).

x-api-key
string
header
required

API key issued by Kira. Required on every request, including /auth.

Headers

X-Api-Version
string

Optional. The date-versioned API version to apply for this request (e.g. 2026-04-14). When sent it always wins, even over your pinned account default. When omitted, the API uses your account's pinned version if set, otherwise a baseline default.

Example:

"2026-06-01"

Path Parameters

payout_id
string<uuid>
required

Payout UUID.

Response

Success.

Full enriched detail of a single payout (a bare object, not wrapped in an envelope). See the GET /v1/payouts/{payout_id} operation description for a complete example and field-by-field notes.

payout_id
string<uuid>
required
user_id
string<uuid>
required
origin
enum<string>
required

How this payment record originated. Enum is exactly deposit | payout | api (a bad value on the list endpoint's ?origin= filter is rejected with 400 echoing this list). payout = a payout initiated from a virtual account (confirmed on every payout created). deposit = the inbound funding/settlement leg of a virtual account. api = a payout created directly through the API, not tied to a virtual account.

Available options:
api,
payout,
deposit
from_amount
string
required

Decimal string. The amount on the SOURCE/funding side of the payout, denominated in from_currency. "100.00" on a crypto-funded ($100.00 USDC) payout.

from_currency
string
required

ISO-4217 currency code (or stablecoin ticker) of the source/funding side (from_amount). "USD" for a fiat-funded payout, "USDC" for a crypto-funded payout (mode: "CRYPTO") — NOT always USD.

status
string
required

Client-facing status (UPPERCASE): CREATED, KYT_PENDING, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, IN_REVIEW.

created_at
string
required
updated_at
string
required
recipient_id
string<uuid> | null
quote_id
string<uuid> | null

The quote this payout was priced against. Populated on every virtual-account payout — settlement always reserves a quote, even when you did not explicitly reserve one via POST .../payout/preview with create_quote: true (unlike the preview response's quote_id, which appears only when a quote was requested).

reference
string | null

Your own reference string from the payout create request, echoed back unchanged. Sending reference: "my-ref-123" on create returned reference: "my-ref-123" on the payout detail. null when none was supplied.

memo
string | null

The customer-supplied memo from the create request (extra_info.memo), surfaced at top level. Sending extra_info: {memo: "pay for services"} on create returned top-level memo: "pay for services" on the payout detail. null when no memo was supplied.

to_amount
string

Decimal string. The amount on the DESTINATION side — what the recipient receives after fees/FX, denominated in to_currency. May differ in currency from from_amount — a payout with from_currency: "USDC" returned to_amount: "86.69", to_currency: "USD".

to_currency
string | null

ISO-4217 currency code (or stablecoin ticker) of the destination side (to_amount) — the currency the recipient is paid in. "USD" on a crypto-funded payout with no saved recipient (settles back to a fiat leg).

fee
string | null

Derived from_amountto_amount; null when the currencies differ.

payment_method
string | null

Lowercased recipient rail: wire, wallet, ach.

txn_hash
string | null

Present for crypto payouts.

uetr
string | null
deprecated

Deprecated — use reference_number. Present for wire payouts. Still populated, and scheduled for removal; migrate to reference_number, which reports the equivalent value on every rail.

reference_number
string | null

The tracking reference the sending bank assigned to this payout, in whatever form the rail uses: an IMAD for Fedwire (20260807MFP00407000001), a trace number for ACH (122245530000175), or a UETR (cdf55f20-1290-4f43-8a54-00cbe812c30a) on rails whose bank reports one. Quote it to the receiving bank to trace the payment.

null until the payment has actually been sent — a payout still being created, reviewed, or processing has no reference yet — and null for crypto payouts, which have a txn_hash instead.

provider_reference
string | null

The downstream payout provider's own reference/identifier for this payout. null on a payout still awaiting its crypto deposit (status: "CREATED").

extra_info
object | null

Free-form object carrying create-time extras and derived record-keeping data. Keys observed on a crypto payout: memo, invoice_number (nested under extra_info.extra_info), nature_of_payment, customer_reference, virtualAccountId, paymentType, payoutMode, depositWallet ({walletId, address, network, currency}), and the fee breakdown under extra_info.fees. Exact keys are provider/mode-shaped and vary by payout type.

metadata
object

Your own key/value object attached at payout create time and returned verbatim. metadata: {order_id: "abc123"} sent on create was echoed back unchanged. {} when you set no keys.

sender
object

The party funding/initiating the payout — your end-user / virtual-account owner who is paying. company_name/country come from that user; bank_name/bank_account are populated for virtual-account-sourced payouts (e.g. bank_name: "SLOVAK_SAVINGS_BANK", bank_account: "****7748" — masked to the last 4 digits).

recipient
object

The payee. When the recipient can't be resolved (e.g. a crypto payout with no saved recipient), every field is null and account_type reads the literal string "UNKNOWN".

events
object[]

Client-facing audit trail of status changes.

quotation
object

Present only when the payout was priced by the itemized quotation engine; the same object returned by POST /v1/quotations.