Overview

The diagram below summarizes the interactions between Bond resources and APIs.

A partnership between your brand and a bank is represented by program_id. Every customer object and their associated card objects are linked to the program_id. To comply with financial regulations, you must perform a KYC check for customers before you can issue a card to them.

You can make instant fund transfers between card accounts linked to the same program_id. Customers can link their external bank accounts with a card account. ACH fund transfers between a card and an external account can take up to a few days to clear.

The /balances API and /transactions API fetch balances and details of fund transfers for all accounts associated with all card programs for a brand.

API Fields

Bond APIs use identifiers to represent resources. Bond provides two of these identifiers when you sign up; others are generated when you execute API requests to create resources. Some identifiers are required parameters for multiple API endpoints.

The table below provides a quick reference for API fields that are used frequently across the Bond platform.

API field	Description	Origin
`brand_id`	Identifies your brand organization.	Provided by Bond when your organization signs up.
`program_id`	Card program ID represents the card program offered to customers by your brand in partnership with a bank.	Provided by Bond when your organization signs up.
`brand_person_id`	This is your brand's own representation of a customer resource.	You provide this value.
`customer_id`	Represents a customer resource.	Generated when you Create a customer.
`card_account_id`	Represents a customer's card account. The customer's cards are linked to this account.	Generated when you create a card.
`card_id`	Represents a customer's card.	Generated when you create a card.
`external_account_id`	An account ID for linking external providers, for example, Plaid.	Generated during the linking external accounts process. Used in accounts and transfers endpoints.
`linked_account_id`	Bond's identifier for a customer's linked external account.	Created when you generate a Plaid Link token when linking external accounts.