Get Cards
Header Parameters
Authorizationstring
Query Parameters
consumer_idstring Required
The associated consumer identifier (Required).
providerstring
The issuing provider/bank of the card (Optional).
is_primaryboolean
Filter to retrieve cards by primary status: set to 'true' to retrieve only primary cards, 'false' for only dependent cards, or omit to retrieve all cards (primary and dependent).
page_sizeinteger
Number of items per page
Minimum
1
Maximum
100
Default value
20
pageinteger
Zero-based page number
Default value
0
last_four_digitsstring
Optional filter to search for cards by their last four digits. When provided, must be a valid four-digit numeric string (e.g., "0123").
Pattern
^[0-9]{4}$
Response
200
Object
Successful retrieval of the list of cards.
Response Attributes
itemsarray Required
List of card resources.
Max items
100
Show child attributes
paginationobject
Pagination links for navigating through paged results.
Show child attributes
400
Object
Invalid request.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
401
Object
Unauthorized. Authentication failed.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
403
Object
Forbidden. User does not have permission to access card resources for the specified consumer.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
404
Object
Consumer not found.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
500
Object
Internal server error. An unexpected error occurred while processing the request.
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
default
Object
Unexpected error
Response Attributes
typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
Was this section helpful?
Response
Was this section helpful?