GET
/
developer
/
cards
/
summary
Get a summary of your card program
curl --request GET \
  --url https://api.bridge.xyz/v0/developer/cards/summary \
  --header 'Api-Key: <api-key>'
{
  "period": "year",
  "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
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
period
enum<string>
required

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

Available options:
year,
month,
week,
day,
lifetime
​
period_key
string

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

200
application/json

The summary of a card program

The summary of a card program for a given period