Sign in

v2

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-245593419.2 KB
Cards

List cards

Note: this API is still in beta. Please get in touch with our team to know more: https://getqonto.atlassian.net/servicedesk/customer/portal/5

OAuth scope: card.read

This endpoint allows you to retrieve the list of cards that can be viewed by the currently-authenticated membership.

get/v2/cards

Query parameters

querystring

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
pageinteger
Example:2

cf. https://api-doc.qonto.com/docs/business-api/05ccf93502e54-pagination

per_pageinteger
Example:20

cf. https://api-doc.qonto.com/docs/business-api/05ccf93502e54-pagination

sort_bystring
Example:status:asc

Cards can be sorted by attributes (status, nickname, last_activity_at, created_at) in 2 possible directions: asc (Ascending) / desc (Descending).

holder_ids[]CardHolderId[]

Cards can be filtered by cardholder membership ID.

statuses[]CardStatus[]

Cards can be filtered by statuses. Multiple statuses can be specified (e.g. statuses[]=pending&statuses[]=live).

[
  "pending"
]
bank_account_ids[]CardBankAccountId[]

Cards can be filtered by bank account ID. Multiple bank accounts can be specified (e.g. bank_account_ids[]=id1&bank_account_ids[]=id2).

card_levels[]CardLevel[]

Cards can be filtered by card level. Multiple card levels can be specified (e.g. card_levels[]=virtual&card_levels[]=flash).

[
  "standard"
]
ids[]CardId[]

Cards can be filtered by card ID. Multiple card IDs can be specified (e.g. ids[]=id1&ids[]=id2).

Headers

X-Qonto-Staging-Tokenstring

Required only for Sandbox API requests; to get one, please submit the following form: https://getqonto.atlassian.net/servicedesk/customer/portal/5/group/47/create/143.

Response

OK

Example response

{
  "meta": {
    "current_page": 2,
    "prev_page": 1,
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  },
  "cards": [
    {
      "nickname": "💳 for 🍗",
      "embossed_name": "DOLORES KOULECHOV",
      "status": "pending",
      "pin_set": true,
      "mask_pan": "511768******7662",
      "exp_month": "3",
      "exp_year": "2024",
      "last_digits": "7662",
      "atm_option": true,
      "nfc_option": true,
      "online_option": true,
      "foreign_option": true,
      "atm_monthly_limit": 1000,
      "atm_monthly_spent": 1000,
      "atm_daily_limit": 1000,
      "atm_daily_limit_option": true,
      "payment_monthly_limit": 1000,
      "payment_monthly_spent": 1000,
      "payment_daily_limit": 1000,
      "payment_daily_spent": 1000,
      "payment_daily_limit_option": true,
      "payment_transaction_limit": 1000,
      "payment_transaction_limit_option": true,
      "active_days": [
        1,
        3,
        5
      ],
      "card_type": "debit",
      "card_level": "standard",
      "payment_lifespan_spent": 42,
      "categories": [
        "transport",
        "restaurant_and_bar",
        "food_and_grocery"
      ],
      "parent_card_summary": {
        "last_digits": "7662"
      },
      "card_design": "plus.black.2023",
      "type_of_print": "embossed",
      "discard_on": "2022-11-31"
    }
  ]
}