Skip to main content
GET
/
payout_methods
/
{id}
Retrieve payout method
curl --request GET \
  --url https://api.whop.com/api/v1/payout_methods/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "potk_xxxxxxxxxxxxx",
  "nickname": "<string>",
  "currency": "<string>",
  "destination": {
    "country_code": "<string>",
    "category": "crypto",
    "name": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

​
id
string
required

The ID of the payout method

Example:

"potk_xxxxxxxxxxxxx"

Response

A successful response

An object representing an user's setup payout destination.

​
id
string
required

The ID of the payout token

Example:

"potk_xxxxxxxxxxxxx"

​
nickname
string | null
required

An optional nickname for the payout token to help the user identify it. This is not used by the provider and is only for the user's reference.

​
currency
string
required

The currency code of the payout destination. This is the currency that payouts will be made in for this token.

​
destination
object
required

The payout destination associated with the payout token