Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
customers

aid_customers_cid_card_cid_get

Get all details about a customer card

scopes:

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

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)

card_idstring required

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

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

amount_balancenumber

The balance, including amount locked by pending transaction. Monetary amount in smallest unit for the currency

amount_availablenumber

The amount available for drawdown (exclusive amount locked by pending transactions). Monetary amount in smallest unit for the currency

amount_fundsnumber

The sum of all fund transactions. Monetary amount in smallest unit for the currency

amount_drawdownnumber

The sum of all drawdown transactions. Monetary amount in smallest unit for the currency

amount_pendingnumber

The sum of all pending transactions. Monetary amount in smallest unit for the currency

amount_reservednumber

The sum of all reserved transactions. Monetary amount in smallest unit for the currency

currency'NOK' | 'SEK' | 'DKK' | 'EUR' | 'USD'

Three-character ISO-4217 currency. https://en.wikipedia.org/wiki/ISO_4217

Example response

{
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "metadata": {
    "order_id": "xk39592f"
  },
  "type": "gift_card",
  "status": "unused",
  "pin": {
    "format": {
      "prefix": "DINCARD:"
    }
  },
  "tokens": [
    {
      "masked_code": "DINCARD:********-****-****-91**-*******22e5f",
      "format": {
        "prefix": "DINCARD:"
      }
    }
  ],
  "amount_balance": 50000,
  "amount_available": 50000,
  "amount_funds": 50000,
  "amount_drawdown": 50000,
  "amount_pending": 50000,
  "amount_reserved": 50000,
  "currency": "NOK"
}