Skip to main content
GET
/
transfers
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 transferListResponse of client.transfers.list()) {
  console.log(transferListResponse.id);
}
{
  "data": [
    {
      "id": "ctt_xxxxxxxxxxxxxx",
      "amount": 6.9,
      "currency": "usd",
      "created_at": "2023-12-01T05:00:00.401Z",
      "fee_amount": 6.9,
      "notes": "Monthly revenue share payout",
      "metadata": {},
      "origin_ledger_account_id": "ldgr_xxxxxxxxxxxxx",
      "destination_ledger_account_id": "ldgr_xxxxxxxxxxxxx"
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

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

​
origin_id
string | null

Filter to transfers sent from this account. Accepts a user, company, or ledger account ID.

​
destination_id
string | null

Filter to transfers received by this account. Accepts a user, company, or ledger account ID.

​
order
enum<string> | null

The column to sort transfers by. Defaults to creation date.

Available options:
amount,
created_at
​
direction
enum<string> | null

The sort direction for results. Defaults to descending.

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

Only return transfers created before this timestamp.

Example:

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

​
created_after
string<date-time> | null

Only return transfers created after this timestamp.

Example:

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

Response

A successful response

The connection type for CreditTransactionTransfer.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.