Sign in
OpenAPI 3.1.02026-08-113844085.5 MB

a01100378e59

Payouts

Retrieve Payout

Fetches a single payout. Accepts a wdrl_ payout id from GET /payouts, or the cofr_ payout request id returned by POST /payouts on stablecoin accounts — poll it to watch a requested payout settle.

get/payouts/{payout_id}

Query parameters

account_idstring

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

user_idstring

The owning user ID (a user_ identifier). Provide this or account_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.

notesstring nullable required

Free-form notes the payout's creator attached, visible only to the paying account.

object'payout' required
payer_namestring nullable required

Name of the entity processing the payout.

payout_request_idstring nullable 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.

speed'standard' | 'instant' required

Payout delivery speed.

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

Current payout status.

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": "March affiliate commissions",
  "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"
}