Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
customers

aid_customers_cid_cards_get

Get the cards active for a customer

scopes:

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

Path parameters

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

An id that uniquely identifies the account.

customer_idstring required

The customer id you have defined for the customer. (must not have trailing or leading spaces)

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.

Response

Card details

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client that created the resource

metadataobject

A key-value JSON object to store any additional information. The dintero_* namespace for keys is reserved

active_fromstring date-time

Optional time when the card is activated. No drawdown transaction will be allowed before if set. (fund transaction is allowed)

expires_atstring date-time

Optional expiration time for the card. No transaction will be allowed on an expired card

originated_bystring

The reference to where the entity was created. (must not have trailing or leading spaces)

card_idstring required

The card id you have defined for the card. (must not have trailing or leading spaces)

customer_idstring

The customer id you have defined as the owner of the card. (must not have trailing or leading spaces)

namestring

Display name for the card

type'gift_card' | 'credit_note'

The type of the card. The value is one of the following:

  • gift_card - a gift card
  • credit_note - a credit note Defaults to gift_card
status'inactive' | 'unused' | 'used' | 'partially_used' | 'expired'

The status of the card. The value is one of the following:

  • inactive - Inactive card created by batch, needs to be activated
  • unused - the card is unused
  • used - the card has 0 balance
  • partially_used - the card has been used partially
  • expired - the card has expired

Defaults to unused

Example response

[
  {
    "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "metadata": {
      "order_id": "xk39592f"
    },
    "type": "gift_card",
    "status": "unused",
    "pin": {
      "format": {
        "prefix": "DINCARD:"
      }
    }
  }
]