{
  "id": "prd_FQFHqVNiCRb7J",
  "name": "balance",
  "status": "available",
  "status_error": null,
  "latest_request_id": "bal_ELGT4hfikTTCJ",
  "is_subscribable": false,
  "created_at": "2024-03-26T20:25:27.261Z",
  "updated_at": "2024-03-26T20:25:27.316Z"
}

The Account Products endpoint outlines the Products (capabilities) an Account has access to, and provides an overview of the status of all the Products.

Most products are accessible by default. However, some products have restricted access requiring team-by-team enablement and elevated account verification.

​
Product Names

Products that an Account can have access to:

NameUse-CaseSupported TypesResource Doc
updateOn-Demand real-time account update (balance, due dates, etc) from the Account’s financial institutionAll liabilitiesUpdates
balanceOn-Demand real-time balance from the Account’s financial institutionAll liabilitiesBalances
card_brandOn-Demand retrieval of credit card metadata (Product / Brand Name, Art, etc) directly from the card issuerCredit CardsCard Brand
attributeOn-Demand retrieval of account attributes from the Account’s credit reportingAll liabilitiesAttributes
payoffOn-Demand retrieval of auto loan payoff (amount, per diem, etc) from the Account’s financial institutionAuto LoansPayoffs
paymentNext day electronic push payments to the Account’s financial institutionAll liabilitiesPayments
sensitiveOn-Demand retrieval of underlying sensitive account information (PAN, CVV, account number)All liabilitiesSensitive
payment_instrumentOn-Demand retrieval of payment instruments (cards, network tokens) from the Account’s financial institutionCredit CardsPayment Instruments

​
Product Objects

​
id
string

Unique identifier for the Product.

​
name
string

The name of the Product. See Product Names.

​
status
enum

Status of the Product.

​
status_error
object | null

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

​
latest_request_id
string | null

ID of the most recently created Product resource.

​
is_subscribable
boolean

A field indicating whether a Product supports Subscription enrollment.

​
created_at
string

Timestamp of when the Product was created.

​
updated_at
string

Timestamp of when the Product was last updated.

​
Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "product.create" | "product.update",
  "path": "/accounts/<acc_id>/products/<prd_id>",
}

{
  "id": "prd_FQFHqVNiCRb7J",
  "name": "balance",
  "status": "available",
  "status_error": null,
  "latest_request_id": "bal_ELGT4hfikTTCJ",
  "is_subscribable": false,
  "created_at": "2024-03-26T20:25:27.261Z",
  "updated_at": "2024-03-26T20:25:27.316Z"
}

{
  "id": "prd_FQFHqVNiCRb7J",
  "name": "balance",
  "status": "available",
  "status_error": null,
  "latest_request_id": "bal_ELGT4hfikTTCJ",
  "is_subscribable": false,
  "created_at": "2024-03-26T20:25:27.261Z",
  "updated_at": "2024-03-26T20:25:27.316Z"
}

The Account Products endpoint outlines the Products (capabilities) an Account has access to, and provides an overview of the status of all the Products.

Most products are accessible by default. However, some products have restricted access requiring team-by-team enablement and elevated account verification.

​
Product Names

Products that an Account can have access to:

NameUse-CaseSupported TypesResource Doc
updateOn-Demand real-time account update (balance, due dates, etc) from the Account’s financial institutionAll liabilitiesUpdates
balanceOn-Demand real-time balance from the Account’s financial institutionAll liabilitiesBalances
card_brandOn-Demand retrieval of credit card metadata (Product / Brand Name, Art, etc) directly from the card issuerCredit CardsCard Brand
attributeOn-Demand retrieval of account attributes from the Account’s credit reportingAll liabilitiesAttributes
payoffOn-Demand retrieval of auto loan payoff (amount, per diem, etc) from the Account’s financial institutionAuto LoansPayoffs
paymentNext day electronic push payments to the Account’s financial institutionAll liabilitiesPayments
sensitiveOn-Demand retrieval of underlying sensitive account information (PAN, CVV, account number)All liabilitiesSensitive
payment_instrumentOn-Demand retrieval of payment instruments (cards, network tokens) from the Account’s financial institutionCredit CardsPayment Instruments

​
Product Objects

​
id
string

Unique identifier for the Product.

​
name
string

The name of the Product. See Product Names.

​
status
enum

Status of the Product.

​
status_error
object | null

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

​
latest_request_id
string | null

ID of the most recently created Product resource.

​
is_subscribable
boolean

A field indicating whether a Product supports Subscription enrollment.

​
created_at
string

Timestamp of when the Product was created.

​
updated_at
string

Timestamp of when the Product was last updated.

​
Webhook Payload

The Webhook payload will contain the following information:

{
  "id": "string",
  "type": "product.create" | "product.update",
  "path": "/accounts/<acc_id>/products/<prd_id>",
}

{
  "id": "prd_FQFHqVNiCRb7J",
  "name": "balance",
  "status": "available",
  "status_error": null,
  "latest_request_id": "bal_ELGT4hfikTTCJ",
  "is_subscribable": false,
  "created_at": "2024-03-26T20:25:27.261Z",
  "updated_at": "2024-03-26T20:25:27.316Z"
}