Skip to main content
GET
/
transfers
JavaScript
import Whopsdk from 'whopsdk';

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

// 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": 1701406800,
      "fee_amount": 6.9,
      "notes": "<string>",
      "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

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

origin_id
string | null

Filter transfers to only those that were sent from this origin account. (user_xxx, biz_xxx, ldgr_xxx)

destination_id
string | null

Filter transfers to only those that were sent to this destination account. (user_xxx, biz_xxx, ldgr_xxx)

order
enum<string> | null

The order of the transfers Which columns can be used to sort.

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

The direction of the order The direction of the sort.

Available options:
asc,
desc

Response

A successful response

The connection type for CreditTransactionTransfer.

data
array | null
required

A list of nodes.

page_info
object
required

Information to aid in pagination.

I