Skip to content

List User Cards ​

GET /openapi/v2/cards/list
ItemValue
HTTP methodGET
Request path/openapi/v2/cards/list
Request typequery

Users can be identified in either of the following ways. Provide exactly one of email and memberId:

http
GET /openapi/v2/cards/list?email=merchant@example.com
GET /openapi/v2/cards/list?memberId=member_001

Both methods return the cards associated with the user. The response memberId comes from each card record.

Request parameters:

FieldTypeRequiredDefaultDescription
emailstringConditionalNoneUser email address; provide either this or memberId, up to 128 characters.
memberIdstringConditionalNonePlatform member ID; provide either this or email, up to 64 characters.
statusstringNoNoneFilter by platform card status; use the values in Get Card Details. Matching is case-insensitive; lost and cancelled match both values for compatibility.
pageintegerNo1Page number.
pageSizeintegerNo20Number of items per page.

Response data: paginated structure; items[] fields are the same as in Get Card Details.

This endpoint reads cards stored locally for the current tenant; it does not fetch or import cards from the service provider. embossedName, expiryMonth, expiryYear, dailyLimit, singleTransactionLimit, availableLimit, cardLimit, and cardEmail are not populated in this list. Use Get Card Details for product-supported details.

Use Get User Card Overview for all held cards, shared account associations, balances, and card account limits. The overview has no pagination and retains the card list when an individual balance or limits query fails.