v1

latestOpenAPI 3.0.22026-07-26128245430.3 KB

Cards

Get a summary of your card program

Get a summary of your card program, optionally for a specific period.

get/developer/cards/summary

Query parameters

period'year' | 'month' | 'week' | 'day' | 'lifetime' required

The type of period to summarize the card program by. If lifetime is specified, the period_key is not required.

period_keystring

A string to indicate the period to retrieve the card program summary for.

For year, the period key should be in the YYYY format
For month, the period key should be in the YYYYMM format
For week, the period key should be in the YYYYMMDD format indicating the beginning day of the week.
For day, the period key should be in the YYYYMMDD format
For lifetime, the period key is not required Note that if a specific period is specified, this endpoint currently only supports fetching for periods with complete data (e.g. only up to the previous year, month, week, or day).

Response

The summary of a card program

period'year' | 'month' | 'week' | 'day' | 'lifetime'

The period type of the card program summary

period_startingstring

The starting date of the period, in ISO8601 format

cards_provisioned_countinteger

The number of cards provisioned during the period

card_transactions_countinteger

The number of card transactions during the period, excluding refunds.

provisioned_cards_by_countryobject

The number of cards provisioned during the period, by issuing country. The key is the ISO-3166-1 alpha-3 country code, and the value is the number of cards provisioned for that issuing country.

transaction_volumestring

The total transaction volume during the period, in USD

transacting_card_accounts_countinteger

The number of card accounts that transacted during the period

card_transactions_count_by_countryobject

The number of card transactions during the period, by merchant country. The key is the ISO-3166-1 alpha-3 country code, and the value is the number of card transactions for that merchant country.

transaction_volume_by_countryobject

The transaction volume during the period, by merchant country. The key is the ISO-3166-1 alpha-3 country code, and the value is the transaction volume for that merchant country.

transacting_cards_by_countryobject

The number of cards that transacted during the period, by issuing country. The key is the ISO-3166-1 alpha-3 country code, and the value is the number of cards transacted for that issuing country.

Example response

{
  "period_starting": "2025-01-01",
  "cards_provisioned_count": 1123,
  "card_transactions_count": 31415,
  "provisioned_cards_by_country": {
    "USA": 123,
    "MEX": 45
  },
  "transaction_volume": "-100.0",
  "transacting_card_accounts_count": 2047,
  "card_transactions_count_by_country": {
    "USA": 74,
    "MEX": 55
  },
  "transaction_volume_by_country": {
    "USA": "7.04",
    "MEX": "5.0"
  },
  "transacting_cards_by_country": {
    "USA": 123,
    "MEX": 45
  }
}