The CardBrand endpoint retrieves the associated credit card metadata (Product / Brand Name, Art, etc) directly from the card issuer.

CardBrand is only available for visa and mastercard credit cards.

The CardBrand endpoint is available as a:

TypeUse-Case
ProductOn-Demand retrieval of credit card metadata (Product / Brand Name, Art, etc) directly from the card issuer

CardBrand Objects

id
string

Unique identifier for the CardBrand.

account_id
string

The ID of the associated Account.

network
enum

The credit card network. One of visa or mastercard

issuer
string

The credit card issuer.

last4
string

The last 4 digits of the card account number.

brands
object[]

The brands associated with the card.

shared
boolean

If true, Method requires additional verification (AccountVerificationSession of type pre_auth) to return the definite brand for an Account, and multiple brands might be returned. If false, all verification requirements have been completed, and the brand has been returned by the issuer.

status
enum

status of the CardBrand.

error
object | null

An object representing an error that occurred while processing this CardBrand. See CardBrand errors.

created_at
string

Timestamp of when the CardBrand was created.

updated_at
string

Timestamp of when the CardBrand was last updated.

Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "card_brand.create" | "card_brand.update",
  "path": "/accounts/<acc_id>/card_brands/<cbrd_id>",
}