Products
The products endpoint
Products
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 |
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 |
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>",
}