v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
Card Tokens

card_tokens_get

Use query parameters to filter the search. To list all Transactions related to a Card Token, use GET /v1/transactions with query ?search={token_id}.

scopes:

  • admin:checkout
get/accounts/{aid}/payments/card-tokens

Query parameters

customer_idstring

Filter by customer_id

relationship_idstring

Filter by relationship_id

statusstring[]

Filter by status

include_deletedboolean

Include deleted card tokens in the response

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

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

Response

Card Tokens

idstring required
tokenstring
type'payment_token' required
status'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'CANCELLED' | 'DELETED' required
card_brand'visa' | 'mastercard' required
masked_panstring
pan_expiry_datestring \d{2}/\d{4}
token_expiry_datestring \d{2}/\d{4}
customer_idstring
account_idstring required
relationship_idstring

Reference to the merchant entity for which the token is dedicated. Merchant-dedicated tokens are uniquely created per merchant_relationship_id.

transaction_idstring checkout-id

Reference to the transaction where the token was created

external_token_referencesstring[]

External references to migrated card tokens

payment_product_typestring required
created_atstring date-time required
created_bystring
updated_atstring date-time required
deleted_atstring date-time
deleted_bystring

Example response

[
  {
    "masked_pan": "476173******0416",
    "pan_expiry_date": "09/2030",
    "token_expiry_date": "09/2030",
    "account_id": "P12345678",
    "payment_product_type": "dintero_psp.creditcard"
  }
]