Skip to main content
GET
Retrieve Payout

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-05-1"

Path Parameters

payout_id
string
required

The payout ID — a wdrl_ payout from GET /payouts, or the cofr_ payout request id returned by POST /payouts.

Query Parameters

account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

Response

payout found for a user

amount
number<float>
required

The payout amount in whole currency units.

Example:

500

created_at
string<date-time>
required

When the payout was created.

Example:

"2026-07-29T18:22:00.000Z"

currency
string
required

Payout currency.

Example:

"usd"

estimated_arrival
string<date-time> | null
required

Estimated time the funds become available in the destination account.

Example:

"2026-08-03T00:00:00.000Z"

fee_amount
number<float>
required

The fee charged for the payout, in the payout currency.

Example:

0.25

id
string
required

Payout ID.

Example:

"wdrl_xxxxxxxxxxxxx"

object
enum<string>
required
Available options:
payout
payer_name
string | null
required

Name of the entity processing the payout.

Example:

"ACH Bank Deposit"

payout_method
object | null
required

The saved payout method used. Requires payout:destination:read; null without it.

payout_request_id
string | null
required

The ID returned by POST /payouts when this payout was requested. For a payout request retrieved by its own cofr_ id, this is that same id. Null for payouts not created by POST /payouts.

Example:

"cofr_xxxxxxxxxxxxx"

speed
enum<string>
required

Payout delivery speed.

Available options:
standard,
instant
status
enum<string>
required

Current payout status.

Available options:
requested,
awaiting_payment,
in_transit,
completed,
failed,
canceled,
denied