Skip to main content
The Updates endpoint retrieves in real-time account data including Balance, due dates, APRs, directly from the Account’s financial institution.
Method’s real-time direct update coverage expands to 92% of all outstanding debt.
The Updates endpoint is available as a:
TypeUse-Case
ProductOn-Demand real-time account update (balance, due dates, etc) from the Account’s financial institution
SubscriptionNear real-time account update (balance, due dates, etc) from the Account’s financial institution. Webhook Payload

Update Objects

Properties based on type

Some fields are only available when source is direct (real-time data from the financial institution) and are not included in the response for snapshot updates. These fields are marked accordingly in the documentation below.

Webhook Payload

The Webhook payload will contain the following information:
{
  "id": "string",
  "type": "update.create" | "update.update",
  "path": "/accounts/<acc_id>/updates/<upt_id>",
}
{
  "id": "upt_NYV5kfjskTTCJ",
  "status": "completed",
  "account_id": "acc_bFDiQGxiR8bqc",
  "source": "direct",
  "type": "credit_card",
  "credit_card": {
    "auto_pay_amount": 4000,
    "auto_pay_date": "2024-05-01",
    "auto_pay_status": "active",
    "available_credit": 120000,
    "balance": 80000,
    "closed_at": null,
    "credit_limit": 200000,
    "interest_rate_percentage_max": 23.5,
    "interest_rate_percentage_min": 12.0,
    "interest_rate_type": "variable",
    "last_payment_amount": 5000,
    "last_payment_date": "2024-04-05",
    "last_statement_balance": 85000,
    "next_payment_due_date": "2024-05-01",
    "next_payment_minimum_amount": 4000,
    "opened_at": "2018-10-30",
    "past_due_amount": null,
    "past_due_date": null,
    "past_due_status": "on_time",
    "remaining_statement_balance": 80000,
    "sub_type": "flexible_spending",
    "usage_pattern": "transactor"
  },
  "data_as_of": "2024-03-20T04:43:21.434Z",
  "error": null,
  "created_at": "2024-03-20T04:43:21.434Z",
  "updated_at": "2024-03-20T04:43:21.655Z"
}