Sign in
Payout methods

List payout methods

Returns a list of active payout methods configured for a company, ordered by most recently created.

Required permissions:

  • payout:destination:read
get/payout_methods

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

Changed in 1 of the 74 revisions of this API.11

  • 697924df40d111See the full diff
    • ▲

      added the new required query request parameter account_id

      new-required-request-parameter

    • ●

      deleted the query request parameter company_id

      request-parameter-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.