Skip to main content
GET
Get a payout

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

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.

sent_to_bank
object | null

What the bank received on the last attempt to send the payout, on an austin_capital_trust account: the memo (in English, translated only when written in another language, and within the rail's limit: 80 characters on ACH and Instant Pay, 210 on WIRE and SWIFT) and, on a wire, the purpose. null until the payout is sent, and on other accounts.

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.

rfi
object | null

The open request for information holding this payout, or null. Present whenever status reads NEEDS_ACTION, and names the request to answer.

Example:
awaiting_recipient_approval
boolean

Whether the payout is waiting for its recipient to be approved before it can be sent. false once the recipient is approved, and on every payout that has finished.

pobo
boolean

Whether the payout was made on behalf of one of the sub-client's customers. false on every other payout.

extra_info
object | null

Your notes under extra_info, as you sent them, beside what Kira recorded about the payout: the rail, the fees, and for a crypto-funded payout where to send the funds.

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.

proof_of_delivery
object[]

The proof that the payout reached the recipient's bank, one entry per record the delivering bank published. [] until one is published, which happens only after the payout is COMPLETED and can take days.

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.