Skip to main content
GET
/
withdrawals
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const withdrawalListResponse of client.withdrawals.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(withdrawalListResponse.id);
}
{
  "data": [
    {
      "id": "wdrl_xxxxxxxxxxxxx",
      "status": "requested",
      "amount": 6.9,
      "currency": "usd",
      "fee_amount": 6.9,
      "fee_type": "exclusive",
      "withdrawal_type": "regular",
      "speed": "standard",
      "created_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "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 ID of the company to list withdrawals for

Example:

"biz_xxxxxxxxxxxxxx"

​
direction
enum<string> | null

The direction to sort the withdrawals by The direction of the sort.

Available options:
asc,
desc
​
created_before
string<date-time> | null

The maximum creation date to filter by

Example:

"2023-12-01T05:00:00.401Z"

​
created_after
string<date-time> | null

The minimum creation date to filter by

Example:

"2023-12-01T05:00:00.401Z"

Response

A successful response

The connection type for PublicWithdrawal.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.