Payout methods

List payout methods

Changed on

Lists the active payout methods configured for an account, newest first.

Required permissions:

  • payout:destination:read
get/payout_methods

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/payout_methods
  • Auth: HTTP bearer

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
account_idstring required

The unique identifier of the company to list payout methods for.

Example:biz_xxxxxxxxxxxxxx

Response

A successful response

Example response

{
  "data": [
    {
      "account_reference": "****1234",
      "company": {
        "id": "biz_xxxxxxxxxxxxxx"
      },
      "created_at": "2023-12-01T05:00:00.401Z",
      "currency": "USD",
      "id": "potk_xxxxxxxxxxxxx",
      "institution_name": "Frost Bank",
      "nickname": "Ops checking"
    }
  ]
}

Changes

  • 697924df40d1Revision changes
    • breaking

      added the new required query request parameter account_id

    • warning

      deleted the query request parameter company_id