Sign in
latestOpenAPI 3.1.02026-08-153864115.7 MB

c301132dbfd7

Payouts

Retrieve Payout

Fetches one payout by its wdrl_ or cofr_ ID. Use the cofr_ payout request ID returned by POST /payouts for a stablecoin account to poll until the payout settles.

get/payouts/{id}

Query parameters

account_idstring

Owning account ID, prefixed biz_. Provide exactly one of account_id or user_id.

user_idstring

Owning user ID, prefixed user_. Provide exactly one of account_id or user_id.

Response

payout found for a user

amountnumber float required

The payout amount in whole currency units.

created_atstring date-time required

When the payout was created.

currencystring required

Payout currency.

estimated_arrivalstring date-time nullable required

Estimated time the funds become available in the destination account.

fee_amountnumber float required

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

idstring required

Payout ID, prefixed wdrl_ for a payout returned by GET /payouts or cofr_ for a payout request returned by POST /payouts.

notesstring nullable required

Free-form notes attached by the payout creator, or null when none were provided. Maximum 255 characters.

object'payout' required
payer_namestring nullable required

Name of the entity processing the payout.

payout_request_idstring nullable required

Payout request ID, prefixed cofr_, returned by POST /payouts. For a request retrieved by its own cofr_ ID, this equals id. Returns null for payouts not created by POST /payouts.

speed'standard' | 'instant' required

Payout delivery speed.

status'requested' | 'awaiting_payment' | 'in_transit' | 'completed' | 'failed' | 'canceled' | 'denied' required

Current payout status.

trace_codestring nullable required

ACH trace number the recipient's bank can use to locate this payout. Assigned when the payout is submitted to the bank, so it is null before then and on payouts not sent over ACH.

Example response

{
  "amount": 500,
  "created_at": "2026-07-29T18:22:00.000Z",
  "currency": "usd",
  "estimated_arrival": "2026-08-03T00:00:00.000Z",
  "fee_amount": 0.25,
  "id": "wdrl_xxxxxxxxxxxxx",
  "notes": "Detailing supplies restock",
  "object": "payout",
  "payer_name": "ACH Bank Deposit",
  "payout_method": {
    "nickname": "Business checking",
    "supported_payout_method": {
      "icon_url": "https://cdn.whop.com/payouts/ach.png",
      "payer_name": "ACH Bank Deposit"
    }
  },
  "payout_request_id": "cofr_xxxxxxxxxxxxx",
  "speed": "standard",
  "status": "requested",
  "trace_code": "021000021234567"
}