v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

Payment Methods

List payment methods by user

Returns a paginated list of the bank account payout methods saved for a user, newest first by default. Soft-deleted methods are excluded.

API scope required: payment-methods.read

get/unstable/payment-methods

Query parameters

userLocatorstring

Identifies the target user. Format: <type>:<value> (e.g., email:alice@example.com, userId:abc123). Required with server API key auth; ignored with JWT.

type'bank-account-us' | 'bank-account-mx-clabe' | 'bank-account-co' | 'bank-account-sepa-iban'

Filter by payment method type. Without this filter, all types are returned.

cursorstring

Opaque pagination cursor from a previous response. Pass to retrieve the next page.

limitinteger

Maximum number of results per page (1-100, default 30).

sort'asc' | 'desc'

Sort by creation date: asc (oldest first) or desc (newest first, default).

hasPayout'true' | 'false'

Filter to payout methods that have (true) or have not (false) funded a settled offramp payout. Omit to return all payout methods regardless of payout history.

Response

Paginated list of PaymentMethod objects. nextCursor and previousCursor are included when additional pages exist in that direction.

nextCursorstring nullable

Cursor to fetch the next page. null when there are no more results.

previousCursorstring nullable

Cursor to fetch the previous page. null on the first page.