Retrieve Payout

Fetches one payout by its wdrl_ ID, or by the cofr_ conversion request ID a stablecoin payout carries as payout_request_id — both ids answer with the same payout object.

GET /payouts/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const payout = await client.payouts.retrieve('id');

console.log(payout.id);

200

{
  "amount": "500.0",
  "created_at": "2026-07-29T18:22:00.000Z",
  "currency": "usd",
  "destination_amount": "461.7",
  "destination_currency": "eur",
  "estimated_arrival": "2026-08-03T00:00:00.000Z",
  "exchange_rate": 0.9234,
  "failure": {
    "code": "beneficiary_name_mismatch",
    "funds_returned_at": "2023-11-07T05:31:56Z",
    "message": "<string>"
  },
  "fee_amount": "0.25",
  "fee_paid_by": "self",
  "id": "wdrl_xxxxxxxxxxxxx",
  "markup_fee": "0.0",
  "metadata": {
    "batch_id": "2026-08-18"
  },
  "net_amount": "49.75",
  "notes": "Detailing supplies restock",
  "object": "payout",
  "payer_name": "ACH Bank Deposit",
  "payout_method": {
    "nickname": "Business checking",
    "supported_payout_method": {
      "delivery_type": "bank_deposit",
      "icon_url": "https://cdn.whop.com/payouts/ach.png",
      "payer_name": "ACH Bank Deposit"
    }
  },
  "payout_request_id": "cofr_xxxxxxxxxxxxx",
  "source": "api",
  "speed": "standard",
  "status": "in_review",
  "status_detail": "awaiting_provider_acceptance",
  "trace_code": "021000021234567"
}

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-21"

Path Parameters

id · string · required

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

Query Parameters

account_id · string

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

user_id · string

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

Response

200

application/json

payout found for a user

amount · string<decimal> · required

The payout amount in whole currency units, as a decimal string.

Example:

"500.0"

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"

destination_amount · string<decimal> | null · required

The amount delivered in the destination currency, as a decimal string. Assigned when the payout is processed, so it is null before then and on payouts without a recorded conversion.

Example:

"461.7"

destination_currency · string | null · required

Currency the funds are delivered in, taken from the payout method when the payout is created. On a stablecoin payout it follows the settlement payout minted alongside it — the GET /payouts row carrying this payout's id as payout_request_id — and is null only when no settlement payout exists.

Example:

"eur"

estimated_arrival · string<date-time> | null · required

Estimated time the funds become available in the destination account.

Example:

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

exchange_rate · number<float> | null · required

Exchange rate from the payout currency to the destination currency. Assigned when the payout is processed, so it is null before then and on payouts without a recorded rate.

Example:

0.9234

failure · object | null · required

Why the payout ended without paying, or why it reversed after settlement. Present on failed, canceled, denied, and reversed payouts; null otherwise.

Show child attributes

fee_amount · string<decimal> · required

The fee charged for the payout, in the payout currency, as a decimal string.

Example:

"0.25"

fee_paid_by · enum<string> · required

Who bore the payout fee: the account itself, or its parent platform.

Available options: self, platform

Example:

"self"

id · string · required

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

Example:

"wdrl_xxxxxxxxxxxxx"

markup_fee · string<decimal> · required

Whop's markup on the provider fee, in the payout currency, as a decimal string. "0.0" when none applies.

Example:

"0.0"

metadata · object · required

Key-value data attached at creation and echoed on every read. At most 50 keys, key names up to 40 characters, string values up to 500 characters.

Show child attributes

Example:

{ "batch_id": "2026-08-18" }

net_amount · string<decimal> · required

The planned net for the destination, in the payout currency: amount minus fee_amount minus markup_fee when fee_paid_by is self; equal to amount when the platform covers the fees. A payout that ends denied, canceled, or failed delivered nothing — most keep the planned figure and failure says where the funds are, but a canceled stablecoin payout can report the settled outcome instead: amount carries what stayed in the balance, fees are zero because none were charged, and net_amount is 0 because nothing was delivered.

Example:

"49.75"

notes · string | null · required

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

Maximum string length: 255

Example:

"Detailing supplies restock"

object · enum<string> · required

Available options: payout

Example:

"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.

Show child attributes

payout_request_id · string | null · 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.

Example:

"cofr_xxxxxxxxxxxxx"

source · enum<string> | null · required

How the payout was created. automatic means a scheduled auto-payout; null on payouts created before source tracking or through internal tooling.

Available options: api, dashboard, automatic, null

Example:

"api"

speed · enum<string> · required

Payout delivery speed.

Available options: standard, instant

Example:

"standard"

status · enum<string> · required

Current payout status.

Available options: requested, in_review, processing, completed, reversed, canceled, failed, denied

Example:

"in_review"

status_detail · string · required

The finest machine phase under status — for example awaiting_provider_acceptance vs in_transit under processing, or the stablecoin conversion phase under requested. Informational vocabulary: values can be added without a version bump; status is the versioned contract.

Example:

"awaiting_provider_acceptance"

trace_code · string | null · 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:

"021000021234567"