The updates endpoint
The Updates endpoint retrieves in real-time account data including Balance, due dates, APRs, directly from the Account’s financial institution.
direct
update coverage expands to 92% of all outstanding debt.The Updates endpoint is available as a:
Type | Use-Case |
---|---|
Product | On-Demand real-time account update (balance, due dates, etc) from the Account’s financial institution |
Subscription | Near real-time account update (balance, due dates, etc) from the Account’s financial institution. Webhook Payload |
Update Objects
Unique identifier for the Update.
The ID of the associated Account.
The source of the Update's data.
Status of the Update.
The liability type of the Update's Account. See Account Liability Types.
An object representing an error that occurred while processing this Update. See Update errors.
Timestamp of when the Update was created.
Timestamp of when the Update was last updated.
Properties based on type
This object will be populated if the Update is of type credit_card
.
The amount of credit currently available for use on this account.
The current balance of the account.
The date on which the account was officially closed, formatted in ISO 8601 (YYYY-MM-DD).
The maximum amount of credit that can be extended to the borrower on this account.
The fixed interest rate for this account.
The maximum interest rate (variable) allowed for this account.
The minimum interest rate (variable) allowed for this account.
The liability interest rate source. One of financial_institution
, public_data
or method
The liability interest rate type. One of fixed
or variable
The amount of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
The amount of the next minimum payment on the account.
The date when the next statement for the credit card will be issued, formatted in ISO 8601 (YYYY-MM-DD).
The date when the account was originally opened, formatted in ISO 8601 (YYYY-MM-DD).
Sub-type of the credit card. One of flexible_spending
, charge
, secured
, unsecured
, purchase
or business
Categorizes the usage behavior of the credit card holder.
Webhook Payload
The Webhook payload will contain the following information: