Skip to main content
GET
/
payout_methods
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const payoutMethod = await client.payoutMethods.retrieve('potk_xxxxxxxxxxxxx');

console.log(payoutMethod.id);
{
  "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>"
  }
}

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 ***************************

Path Parameters

​
id
string
required

The unique identifier of the payout method to retrieve.

Example:

"potk_xxxxxxxxxxxxx"

Response

A successful response

A configured payout destination where a user receives earned funds, such as a bank account or digital wallet.

​
id
string
required

The unique identifier for the payout token.

Example:

"potk_xxxxxxxxxxxxx"

​
created_at
string<date-time>
required

The datetime the payout token was created.

Example:

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

​
company
object
required

The company associated with this payout destination. Null if not linked to a specific company.

​
nickname
string | null
required

A user-defined label to help identify this payout destination. Not sent to the provider. Null if no nickname has been set.

Example:

"My Business Account"

​
currency
string
required

The three-letter ISO currency code that payouts are delivered in for this destination.

Example:

"USD"

​
is_default
boolean
required

Whether this is the default payout destination for the associated payout account.

​
account_reference
string | null
required

A masked identifier for the payout destination, such as the last four digits of a bank account or an email address. Null if no reference is available.

Example:

"****1234"

​
institution_name
string | null
required

The name of the bank or financial institution receiving payouts. Null if not applicable or not provided.

Example:

"Chase Bank"

​
destination
object
required

The payout destination configuration linked to this token. Null if not yet configured.