Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example 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. Omit this and company_id to list your own saved payment methods.

Example:

"mber_xxxxxxxxxxxxx"

company_id
string | null

The unique identifier of the company. Provide either this or member_id, not both. Omit both to address your own saved payment methods.

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"

future_usage
enum<string> | null

Only return methods that can be charged this way after the buyer leaves. A checkout that renews should pass off_session, which drops the buyer's platform balance — a balance settles against the ledger at the time of purchase and cannot be charged later.

Available options:
off_session,
on_session

Response

A successful response

The connection type for PaymentMethodInterface.

data
(BasePaymentMethod · object | CardPaymentMethod · object | UsBankAccountPaymentMethod · object | CashappPaymentMethod · object | IdealPaymentMethod · object | SepaDebitPaymentMethod · object | PlatformBalancePaymentMethod · 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.