List cards
OAuth scope: card.read
Retrieves the list of cards that can be viewed by the authenticated membership.
You can filter and sort this list by using query parameters 👇
This endpoint is still in beta. Please get in touch with our team if you have any question or feedback: here.
Authorizations
Bearer authorization header: Bearer <token>
, where <token>
is the access token received from the authorization server at the end of the OAuth 2.0 flow.
Headers
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Query Parameters
Text search can be performed on the following fields:
- memberships.first_name
- memberships.last_name
- cards.id
- cards.nickname
- cards.last_digits
- cards.status
- cards.pre_expires_at
- cards.exp_year
- cards.exp_month
Returned page (cf. Pagination).
2
Cards can be sorted by a specific property and order.<br>👉 Property: status
, nickname
, last_activity_at
or created_at
<br>👉 Order: asc
(Ascending) / desc
(Descending)
Cards can be filtered by their holder_id
.
The membership identifier of the card holder.
Cards can be filtered by their status
.
Status of the card. Pending: the card is awaiting PIN to be set or issuing to complete. Live: the card is active and can be used. Paused: the card is paused and cannot be used until un-paused. Stolen: the card has been reported as stolen and cannot be used. Lost: the card has been reported as lost and cannot be used. Pin_blocked: the card has been blocked due to too many wrong PIN attempts. It can still be used for card-not-present transactions. Discarded: the card has been discarded and cannot be used. Expired: the card has expired and cannot be used. Shipped_lost: the card has been lost during shipping and cannot be used. Onhold: the card issuing is on hold due to missing KYC/KYB validation and cannot be used. Order_canceled: the card order has been canceled. Pre_expired: the flash card has reached the end of its validity and cannot be used. Abusive: the card has been reported as abusive and cannot be used.
pending
, live
, paused
, stolen
, lost
, pin_blocked
, discarded
, expired
, shipped_lost
, onhold
, order_canceled
, pre_expired
, abusive
"statuses[]=pending&statuses[]=live"
Cards can be filtered by their bank_account_id
.
The id of the bank account to which the card is attached
"bank_account_ids[]=id1&bank_account_ids[]=id2"
Cards can be filtered by their card_level
.
Level of the card. A level defines a set of card capabilities and pricing. Standard, plus and metal are physical cards. See our Qonto cards: https://qonto.com/en/payment-methods/card.
standard
, plus
, metal
, virtual
, flash
, advertising
"card_levels[]=virtual&card_levels[]=flash"
Cards can be filtered by their id
.
Unique card identifier
"ids[]=id1&ids[]=id2"
Response
The response is of type object
.