Skip to main content
GET
/
payout_methods
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 payoutMethodListResponse of client.payoutMethods.list({
  company_id: 'biz_xxxxxxxxxxxxxx',
})) {
  console.log(payoutMethodListResponse.id);
}
{
  "data": [
    {
      "id": "potk_xxxxxxxxxxxxx",
      "nickname": "<string>",
      "currency": "<string>",
      "destination": {
        "country_code": "<string>",
        "category": "crypto",
        "name": "<string>"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Query Parameters

​
after
string | null

Returns the elements in the list that come after the specified cursor.

​
before
string | null

Returns the elements in the list that come before the specified cursor.

​
first
integer | null

Returns the first n elements from the list.

Example:

42

​
last
integer | null

Returns the last n elements from the list.

Example:

42

​
company_id
string
required

The company ID to list payout methods for.

Example:

"biz_xxxxxxxxxxxxxx"

Response

A successful response

The connection type for PayoutToken.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.