Skip to main content
GET
JavaScript

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

Query Parameters

after
string | null

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

before
string | null

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

first
integer | null

Returns the first n elements from the list.

Example:

42

last
integer | null

Returns the last n elements from the list.

Example:

42

member_id
string | null

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

Example:

"mber_xxxxxxxxxxxxx"

company_id
string | null

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

Example:

"biz_xxxxxxxxxxxxxx"

direction
enum<string> | null

The sort direction for ordering results, either ascending or descending.

Available options:
asc,
desc
created_before
string<date-time> | null

Only return payment methods created before this timestamp.

Example:

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

created_after
string<date-time> | null

Only return payment methods created after this timestamp.

Example:

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

Response

A successful response

The connection type for PaymentMethodInterface.

data
(BasePaymentMethod · object | CardPaymentMethod · object | UsBankAccountPaymentMethod · object | CashappPaymentMethod · object | IdealPaymentMethod · object | SepaDebitPaymentMethod · object)[]
required

A list of nodes.

A saved payment method with no type-specific details available.

page_info
object
required

Information to aid in pagination.