Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
cards

aid_cards_get

Get all cards for an account

scopes:

  • admin:wallets
  • read:wallets
get/accounts/{aid}/wallets/cards

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Query parameters

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

starting_afterstring

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, end the result contains paging_token=pt1, your subsequent call can include starting_after=pt1 in order to fetch the next page of the list.

searchstring

Will try to match the search to either card_id, customer_id or amount

created_at.gtestring isodate

Card created after (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

created_at.ltestring isodate

Card created before a date (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

type'gift_card' | 'credit_note'

Filter cards by type

status'inactive' | 'unused' | 'partially_used' | 'used' | 'expired'

Filter cards by amount and expiry status

expires_at.gtestring isodate

Card expires after (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

expires_at.ltestring isodate

Card expires before a date (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

amount_balanceinteger

Exact card balance

amount_balance.gteinteger

Lower limit for filtering on card balance.

amount_balance.lteinteger

Upper limit for filtering on card balance.

amount_availableinteger

Amount available on the card

amount_available.gteinteger

Lower limit for filtering on available amount on card.

amount_available.lteinteger

Upper limit for filtering on available amount on card.

currencystring[]

The currency of the card. ?currency=NOK&currency=SEK

customerstring

Filter cards by customer_id

Response

Collection of cards

starting_afterstring

The cursor to use in the next request to get the next page of results

Example response

{
  "cards": [
    {
      "brand": "Visa",
      "masked_pan": "476173******0416",
      "country": "NOR",
      "three_ds_version": "2",
      "eci": "05",
      "payment_system_type": "wallet"
    }
  ]
}