Payouts

List Payouts

Lists an account's or user's payouts, newest first.

get/payouts

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.

currencystring

Optional currency code filter, for example usd.

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

Filter to payouts whose status reads this word, matching exactly what this version displays — reversed finds settled payouts the bank later returned. Requires Api-Version-Date 2026-08-21 or later.

source'api' | 'dashboard' | 'automatic'

Filter by how the payout was created. Payouts created before source tracking or through internal tooling carry no source and never match.

payout_method_idstring

Filter to payouts sent to one saved payout method (a pytk_ identifier). An unknown id matches nothing.

created_beforestring date-time

Only payouts created before this ISO 8601 time (exclusive).

created_afterstring date-time

Only payouts created at or after this ISO 8601 time (inclusive).

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

payouts listed

Example response

{
  "data": [
    {
      "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"
      },
      "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",
      "statement_descriptor": "MYCOMPANY",
      "status": "in_review",
      "status_detail": "awaiting_provider_acceptance",
      "trace_code": "021000021234567"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "has_next_page": true,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 10 of the 74 revisions of this API.6528

    • ○

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

      response-required-property-added

  • 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

    • ○

      added the new optional query request parameter created_after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter created_before

      new-optional-request-parameter

    • ○

      added the new optional query request parameter payout_method_id

      new-optional-request-parameter

    • ○

      added the new optional query request parameter source

      new-optional-request-parameter

    • ○

      added the new optional query request parameter status

      new-optional-request-parameter

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

  • 715c4defcbbf533See 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

    • ●

      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

    • ○

      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

    • ○

      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 optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

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

  • 099fdc3be42211See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ○

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

      response-required-property-added

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

Of the 74 revisions, 1 has no diff computed.