Integration GuideAPI Reference
API Reference

List the saved payment instruments of one payer of the calling settlement account

Returns the LIVE handles of the named payer ordered by lastUsedAt — descending by default, ascending with sort=asc — capped at 100. The cap is applied AFTER the order, so sort decides which end of an oversized bucket a merchant reaches. Revoked handles are never listed, so TERMINATED appears only for a handle whose card was killed (statusReason=INSTRUMENT_DEAD). The payer must be named with exactly one of payerId or merchantPayerReference. The optional filters are repeatable and are AND-combined; an empty scope answers 200 with an empty list, never 404. Route availability is NOT applied: a handle whose payment route fell away is still listed and still deletable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Prefixed payer id (PAYR…); mutually exclusive with merchantPayerReference

string

Merchant's own payer reference; mutually exclusive with payerId

paymentMethodName
array of strings

Keep only handles bound to these payment methods, by name; repeatable, an unknown name simply matches nothing

paymentMethodName
type
array of strings

Keep only handles of these kinds; repeatable

type
Allowed:
status
array of strings

Keep only handles in these states; repeatable. USABLE = ACTIVE, UNUSABLE = BLOCKED or TERMINATED; the response statuses ACTIVE, BLOCKED and TERMINATED are accepted as well. BLOCKED matches nothing today

status
Allowed:
string

Order over lastUsedAt: desc (default) or asc; any other value is rejected with 400

Headers
string
required
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*