Skip to main content
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,
  "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
  }
}

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

The summary of a card program

The summary of a card program for a given period

​
period
enum<string>

The period type of the card program summary

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

The starting date of the period, in ISO8601 format

Example:

"2025-01-01"

​
cards_provisioned_count
integer

The number of cards provisioned during the period

Example:

1123

​
card_transactions_count
integer

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

Example:

31415

​
provisioned_cards_by_country
object

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.

Example:
{ "USA": 123, "MEX": 45 }
​
transaction_volume
string

The total transaction volume during the period, in USD

Example:

"-100.0"

​
transacting_card_accounts_count
integer

The number of card accounts that transacted during the period

Example:

2047

​
card_transactions_count_by_country
object

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.

Example:
{ "USA": 74, "MEX": 55 }
​
transaction_volume_by_country
object

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.

Example:
{ "USA": "7.04", "MEX": "5.0" }
​
transacting_cards_by_country
object

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:
{ "USA": 123, "MEX": 45 }