Sign in
Payouts

Create Payout

Sends money from an account or user balance to a saved payout method for that owner.

post/payouts

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

OR

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": 50,
  "currency": "usd",
  "notes": "Detailing supplies restock",
  "payout_method_id": "potk_xxxxxxxxxxxxxx",
  "speed": "standard"
}

Response

payout created

amountstring decimal required

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

created_atstring date-time required

When the payout was created.

currencystring required

Payout currency.

destination_amountstring decimal nullable required

The amount delivered in the destination currency, as a decimal string. Null until the payout settles; appears on the payout in GET /payouts once assigned.

destination_currencystring nullable required

Currency the funds are delivered in, taken from the payout method. 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.

estimated_arrivalstring date-time nullable required

Estimated time the funds become available in the destination account. Null until the payout settles.

exchange_ratenumber float nullable required

Exchange rate from the payout currency to the destination currency. Null until the payout settles; appears on the payout in GET /payouts once assigned.

fee_amountstring decimal required

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

fee_paid_by'self' | 'platform' required

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

idstring required

Payout ID, prefixed wdrl_ — the id POST returns is the id GET /payouts lists. Conversion requests created before this version keep answering under their cofr_ id.

markup_feestring decimal required

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

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

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

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. Null until the payout settles.

payout_request_idstring nullable required

For a stablecoin payout, the id of the conversion request that funds it, prefixed cofr_; null on fiat payouts.

source'api' | 'dashboard' | 'automatic' | 'null' nullable required

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

speed'standard' | 'instant' required

Payout delivery speed.

statement_descriptorstring nullable required

Text that appears on the recipient's bank statement, or null if no descriptor was set. When set, 5-22 alphanumeric characters (A-Z, a-z, 0-9).

status'requested' | 'in_review' | 'processing' | 'completed' | 'reversed' | 'canceled' | 'failed' | 'denied' required

Current payout status, in the same vocabulary as GET /payouts.

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

trace_codestring nullable required

ACH trace number the recipient's bank can use to locate this payout. Always null here — it is assigned when the payout is submitted to the bank, and appears on the payout in GET /payouts once it has been sent; payouts not sent over ACH never get one.

Example response

{
  "amount": "50.0",
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "estimated_arrival": "2026-01-01T12:00:00.000Z",
  "failure": {
    "code": "beneficiary_name_mismatch"
  },
  "fee_amount": "2.5",
  "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": "MassPay",
  "payout_method": {
    "nickname": "Ops checking",
    "supported_payout_method": {
      "delivery_type": "bank_deposit",
      "icon_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/ach-payout-icon",
      "payer_name": "ACH Bank Deposit"
    }
  },
  "payout_request_id": "cofr_xxxxxxxxxxxxx",
  "source": "api",
  "speed": "instant",
  "statement_descriptor": "MYCOMPANY",
  "status": "in_review",
  "status_detail": "pending_debit"
}

Changes

Changed in 17 of the 74 revisions of this API.8940

  • 9b2baa68698c2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 16c82685be351See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 621705ee8f4a22See the full diff
    • ●

      added the new card enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new check enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      removed the masspay_card enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the paper_check enum value from the // response property for the response status

      response-property-enum-value-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 715c4defcbbf544See the full diff
    • ▲

      the response's property type changed from number to string, and format from float to decimal for status

      response-property-type-changed

    • ▲

      the response's property type changed from number null to string null, and format from float to decimal for status

      response-property-type-changed

    • ▲

      the response's property type changed from number to string, and format from float to decimal for status

      response-property-type-changed

    • ▲

      the response's property type changed from number to string, and format from float to decimal for status

      response-property-type-changed

    • ▲

      the response's property type changed from number to string, and format from float to decimal for status

      response-property-type-changed

    • ●

      removed the request property

      request-property-removed

    • ●

      added the new in_review enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new processing enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new reversed enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      removed the awaiting_payment enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the in_transit enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 4a1a4a5d2c727See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 6a23760847c811See the full diff
    • ▲

      removed subschema #1 subschema #2 from the request body oneOf list

      request-body-one-of-removed

    • ○

      added subschema #1 subschema #2 to the request body oneOf list

      request-body-one-of-added

  • f67a043e31904See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • a84d4905fdbb11See the full diff
    • ▲

      removed subschema #1 subschema #2 from the request body oneOf list

      request-body-one-of-removed

    • ○

      added subschema #1 subschema #2 to the request body oneOf list

      request-body-one-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ae20b30817de2See the full diff
    • ○

      the request property default value false was removed

      request-property-default-value-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 6fb1c04bf2553See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added subschema #1 subschema #2 to the request body oneOf list

      request-body-one-of-added

    • ○

      added the required property to the response with the status

      response-required-property-added

Of the 74 revisions, 1 has no diff computed.