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",
"created_at": "2023-12-01T05:00:00.401Z",
"company": {
"id": "biz_xxxxxxxxxxxxxx"
},
"nickname": "My Business Account",
"currency": "USD",
"is_default": true,
"account_reference": "****1234",
"institution_name": "Chase Bank",
"destination": {
"country_code": "<string>",
"category": "crypto",
"name": "<string>"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}Returns a list of active payout methods configured for a company, ordered by most recently created.
Required permissions:
payout:destination:readimport 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",
"created_at": "2023-12-01T05:00:00.401Z",
"company": {
"id": "biz_xxxxxxxxxxxxxx"
},
"nickname": "My Business Account",
"currency": "USD",
"is_default": true,
"account_reference": "****1234",
"institution_name": "Chase Bank",
"destination": {
"country_code": "<string>",
"category": "crypto",
"name": "<string>"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}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 ***************************
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
42
Returns the last n elements from the list.
42
The unique identifier of the company to list payout methods for.
"biz_xxxxxxxxxxxxxx"
Was this page helpful?