The products endpoint

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:

Name	Use-Case	Supported Types	Resource Doc
update	On-Demand real-time account update (balance, due dates, etc) from the Account’s financial institution	All liabilities	Updates
balance	On-Demand real-time balance from the Account’s financial institution	All liabilities	Balances
card_brand	On-Demand retrieval of credit card metadata (Product / Brand Name, Art, etc) directly from the card issuer	Credit Cards	Card Brand
attribute	On-Demand retrieval of account attributes from the Account’s credit reporting	All liabilities	Attributes
payoff	On-Demand retrieval of auto loan payoff (amount, per diem, etc) from the Account’s financial institution	Auto Loans	Payoffs
payment	Next day electronic push payments to the Account’s financial institution	All liabilities	Payments
sensitive	On-Demand retrieval of underlying sensitive account information (PAN, CVV, account number)	All liabilities	Sensitive
payment_instrument	On-Demand retrieval of payment instruments (cards, network tokens) from the Account’s financial institution	Credit Cards	Payment Instruments

Product Objects

Webhook Payload

The Webhook payload will contain the following information:

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

THE PRODUCT OBJECT

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