v8

OpenAPI 3.1.02026-08-033623795.0 MB

Payment methods

List payment methods

Returns a paginated list of payment methods for a member or company, with optional filtering by creation date. A payment method is a stored representation of how a customer intends to pay, such as a card, bank account, or digital wallet.

Required permissions:

member:payment_methods:read

get/payment_methods

Query parameters

afterstring nullable

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

beforestring nullable

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

firstinteger nullable

Returns the first n elements from the list.

Example:42

lastinteger nullable

Returns the last n elements from the list.

Example:42

member_idstring nullable

The unique identifier of the member to list payment methods for.

Example:mber_xxxxxxxxxxxxx

company_idstring nullable

The unique identifier of the company. Provide either this or member_id, not both.

Example:biz_xxxxxxxxxxxxxx

direction'asc' | 'desc'

The direction of the sort.

created_beforestring date-time nullable

Only return payment methods created before this timestamp.

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

created_afterstring date-time nullable

Only return payment methods created after this timestamp.

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

Response

A successful response

Example response

{
  "data": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "payt_xxxxxxxxxxxxx"
    }
  ]
}