List Payouts

JavaScript

import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const payoutListResponse of client.payouts.list()) {
  console.log(payoutListResponse.id);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/payouts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
        "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"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "has_next_page": true,
    "has_previous_page": false,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

payouts

JavaScript

import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const payoutListResponse of client.payouts.list()) {
  console.log(payoutListResponse.id);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/payouts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
        "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"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "has_next_page": true,
    "has_previous_page": false,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

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"

Query Parameters

account_id

string

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

user_id

string

The owning user ID (a user_ identifier). Provide this or account_id.

currency

string

Optional currency code filter, for example usd.

status

enum<string>

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.

Available options:

requested,

in_review,

processing,

completed,

reversed,

canceled,

failed,

denied

source

enum<string>

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

Available options:

api,

dashboard,

automatic

payout_method_id

string

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

created_before

string<date-time>

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

created_after

string<date-time>

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

first

integer

default:20

Number of payouts to return from the start of the window.

Required range: x <= 100

after

string

Cursor to fetch the page after (from page_info.end_cursor).

last

integer

Number of payouts to return from the end of the window.

Required range: x <= 100

before

string

Cursor to fetch the page before (from page_info.start_cursor).

Response

payouts filtered by source, payout method, and created window

data

object[]

required

Show child attributes

page_info

object

required

Show child attributes

⌘I

Introduction

Reference

Webhooks & events

Core Resources

Notifications

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Authorizations

Headers

Query Parameters

Response