Skip to main content
GET
Get a payout

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

x-api-key
string
header
required

API key issued by Kira.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Path Parameters

payout_id
string<uuid>
required

UUID of the payout to read.

Response

Success.

One payout, in full. A field that was never set is returned as null.

payout_id
string<uuid>

Payout UUID.

user_id
string<uuid>

The user the payout belongs to.

recipient_id
string<uuid>

Who was paid.

quote_id
string | null

The quote redeemed on this payout, when one was.

reference
string | null

The reference you set.

memo
string | null

The memo you set.

origin
string

What started it. Available options: deposit, payout, api. See Payout values.

from_amount
string

What left the account, as a decimal string.

from_currency
string

Currency of from_amount.

to_amount
string

What the recipient got, as a decimal string.

to_currency
string | null

Currency of to_amount.

payment_method
string | null

Which rail it went out on, in lower case. See Payout values.

txn_hash
string | null

On-chain transaction that settled it. null on a bank payout.

uetr
string | null

The wire's end-to-end reference, when the rail assigns one.

reference_number
string | null

The rail's own reference for the transfer. Falls back to uetr when there is no other.

provider_reference
string | null

The bank's own id for the transfer, for when you have to ask them about it.

status
string

Where the payout has got to. See Payout values.

extra_info
object | null

The notes you sent on the payout, echoed back.

metadata
object

Key/value pairs you attached. {} when you attached none.

sender
object

Who sent it.

recipient
object

Who received it.

events
object[]

What happened, oldest first. One entry per state the payout reached.

created_at
string

When the payout was created, as an ISO 8601 timestamp.

updated_at
string

When it last changed, as an ISO 8601 timestamp.

quotation
object

The quote this payout settled at. Only when a quote_id was redeemed.