Skip to main content
GET
Get a payout
Requires scope: manage:pay-outs — see Required scopes. Reads a single pay-out in the full shape: the nested payoutRoute includes the masked beneficiary bank account, plus depositAddress for an ACTIVE route on a SELF_CUSTODY account. Use this to confirm the real outcome of a pay-out:
  • settledFiatAmount — the fiat the provider actually paid out. Null until COMPLETED, and typically lower than the crypto sent, net of fees.
  • sendTxHash — the on-chain send. The managed broadcast for PULL, the observed customer transaction for PUSH.
  • failureReason — populated for REJECTED, FAILED and RETURNED.
Internal and sensitive fields — the idempotency key, permit material, wallet ids, managed transaction ids and raw provider data — are never returned.

Authorizations

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

accountId
string<uuid>
required

Unique account identifier

payoutId
string<uuid>
required

Unique payout identifier

Response

The payout

success
boolean

Indicates whether the request was successful

result
object

Full pay-out shape, returned on creation and by the detail read. Never carries the idempotency key, permit material, internal wallet ids, managed transaction ids or raw provider data.