Get all card accounts

curl --request GET \
  --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts \
  --header 'Api-Key: <api-key>'

{
  "count": 123,
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "status": "active",
      "balances": {
        "available": {
          "amount": "<string>",
          "currency": "usdc"
        },
        "hold": {
          "amount": "<string>",
          "currency": "usdc"
        }
      },
      "freezes": [
        {
          "card_account_id": "<string>",
          "reason": "lost_or_stolen",
          "created_at": "<string>",
          "reason_detail": "<string>",
          "starting_at": "<string>",
          "ending_at": "<string>"
        }
      ],
      "client_reference_id": "<string>",
      "cardholder_name": {
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>"
      },
      "card_image_url": "<string>",
      "status_reason": "<string>",
      "card_details": {
        "last_4": "1264",
        "expiry": "10/24",
        "bin": "44325280",
        "pin_status": "not_set"
      },
      "crypto_account": {
        "type": "standard",
        "address": "<string>"
      },
      "funding_instructions": {
        "currency": "usdc",
        "chain": "arbitrum",
        "address": "<string>",
        "memo": "<string>"
      },
      "additional_funding_instructions": [
        {
          "currency": "usdc",
          "chain": "arbitrum",
          "address": "<string>",
          "memo": "<string>"
        }
      ]
    }
  ]
}

GET

customers

{customerID}

card_accounts

Get all card accounts

curl --request GET \
  --url https://api.bridge.xyz/v0/customers/{customerID}/card_accounts \
  --header 'Api-Key: <api-key>'

{
  "count": 123,
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "status": "active",
      "balances": {
        "available": {
          "amount": "<string>",
          "currency": "usdc"
        },
        "hold": {
          "amount": "<string>",
          "currency": "usdc"
        }
      },
      "freezes": [
        {
          "card_account_id": "<string>",
          "reason": "lost_or_stolen",
          "created_at": "<string>",
          "reason_detail": "<string>",
          "starting_at": "<string>",
          "ending_at": "<string>"
        }
      ],
      "client_reference_id": "<string>",
      "cardholder_name": {
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>"
      },
      "card_image_url": "<string>",
      "status_reason": "<string>",
      "card_details": {
        "last_4": "1264",
        "expiry": "10/24",
        "bin": "44325280",
        "pin_status": "not_set"
      },
      "crypto_account": {
        "type": "standard",
        "address": "<string>"
      },
      "funding_instructions": {
        "currency": "usdc",
        "chain": "arbitrum",
        "address": "<string>",
        "memo": "<string>"
      },
      "additional_funding_instructions": [
        {
          "currency": "usdc",
          "chain": "arbitrum",
          "address": "<string>",
          "memo": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Api-Key

string

header

required

Path Parameters

customerID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Response

List of all card accounts owned by the customer

count

integer

required

The number of card accounts returned

data

object[]

required

Show child attributes

data.id

string

required

ID of the card account

Required string length: 1 - 42

data.customer_id

string

required

ID of the customer

Required string length: 1 - 42

data.status

enum<string>

required

Status of the card account

Available options:

active,

pending,

inactive,

frozen

data.balances

object

required

Balances of the card account

Show child attributes

data.balances.available

object

required

The available balance of the card account

Show child attributes

data.balances.available.amount

string

required

data.balances.available.currency

enum<string>

required

Available options:

usdc

data.balances.hold

object

required

The balance tha is placed on hold for pending authorizations

Show child attributes

data.balances.hold.amount

string

required

data.balances.hold.currency

enum<string>

required

Available options:

usdc

data.freezes

object[]

required

Show child attributes

data.freezes.card_account_id

string

required

Card account ID

Required string length: 1 - 42

data.freezes.initiator

enum<string>

required

The party that initiated the freeze. A freeze can be initiated by either the customer or developer. Only one freeze per initiator can be active at a time. If a new freeze is initiated by the same party, it overwrites any existing freeze The party that initiated the freeze. A freeze can be initiated by the customer, the developer, or Bridge. Only one freeze per initiator can be active at a time. If a new freeze is initiated by the same party, it overwrites any existing freeze

data.freezes.reason

enum<string>

required

The reason of the freeze

Available options:

lost_or_stolen,

suspicious_activity,

planned_inactivity,

suspected_fraud,

other

data.freezes.created_at

string

required

The creation time of the freeze, in ISO8601 format

data.freezes.reason_detail

string

A more detailed reason for the freeze

data.freezes.starting_at

string

The start time of the freeze, in ISO8601 format

data.freezes.ending_at

string

The end time of the freeze, in ISO8601 format

data.client_reference_id

string

The client-provided reference ID

data.cardholder_name

object

The name of the cardholder associated to the card. By default, this will be the name of the associated customer. To override the cardholder name, you can contact Bridge support.

Show child attributes

data.cardholder_name.first_name

string

required

data.cardholder_name.last_name

string

required

data.cardholder_name.middle_name

string

data.card_image_url

string

deprecated

An expiring URL used to render the card image, with a validity period of 5 minutes. Note: This field will be deprecated in favor of the more secure and scalable card details API. Please see the integration guide on safely revealing card details for more information.

data.status_reason

string

An optional detailed explanation for the card account status

data.card_details

object

Details of the issued card. This object contains enough payment card details to identify the issued card, but only provides the last four digits of the card number to maintain security.

Show child attributes

data.card_details.last_4

string

required

The last four digits of the card number

Example:

"1264"

data.card_details.expiry

string

required

The expiration date of the card, in MM/YY format

Example:

"10/24"

data.card_details.bin

string

required

The BIN of the card, including the first 8 digits

Example:

"44325280"

data.card_details.pin_status

enum<string>

The current status of the card PIN

Available options:

not_set,

ok

data.crypto_account

object

The crypto account for a self-custodial card account. This field is not supported for a Bridge-custodial card funding setup (note that if you are on cards trial, you are automatically on a custodial funding setup).

Show child attributes

data.crypto_account.type

enum<string>

required

The type of the crypto account

Available options:

standard,

bridge_wallet

data.crypto_account.address

string

required

The public address of the crypto account

data.funding_instructions

object

Funding instructions applicable only to the top-up card funding strategy, which is configured at the developer level

Show child attributes

data.funding_instructions.currency

enum<string>

required

The crypto currency used by the card account

Available options:

usdc

data.funding_instructions.chain

enum<string>

required

The chain used by the card account

Available options:

arbitrum,

avalanche_c_chain,

base,

ethereum,

optimism,

polygon,

solana,

stellar

data.funding_instructions.address

string

required

The deposit address provided by Bridge to fund the card account

data.funding_instructions.memo

string

If present, this is the message that the customer MUST include in their on-chain funding transfers. It is only applicable to memo-based blockchains such as Stellar and Tron

data.additional_funding_instructions

object[]

Show child attributes

data.additional_funding_instructions.currency

enum<string>

required

The crypto currency used by the card account

Available options:

usdc

data.additional_funding_instructions.chain

enum<string>

required

The chain used by the card account

Available options:

arbitrum,

avalanche_c_chain,

base,

ethereum,

optimism,

polygon,

solana,

stellar

data.additional_funding_instructions.address

string

required

The deposit address provided by Bridge to fund the card account

data.additional_funding_instructions.memo

string

If present, this is the message that the customer MUST include in their on-chain funding transfers. It is only applicable to memo-based blockchains such as Stellar and Tron

Retrieve a card account Provision a card account

⌘I

Endpoints

Authorizations

Path Parameters

Response