Skip to main content
{
  "id": "upt_NYV5kfjskTTCJ",
  "status": "completed",
  "account_id": "acc_bFDiQGxiR8bqc",
  "source": "direct",
  "type": "credit_card",
  "credit_card": {
    "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",
    "next_payment_due_date": "2024-05-01",
    "next_payment_minimum_amount": 4000,
    "opened_at": "2018-10-30",
    "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"
}
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

​
id
string
Unique identifier for the Update.
​
account_id
string
The ID of the associated Account.
​
source
enum
The source of the Update's data.
direct
Updates received directly from the financial institution.snapshot
Updates received from a monthly snapshot view from the financial institution.
​
status
enum
Status of the Update.
pending
The Update request is queued to be processed.in_progress
The Update request is being processed.completed
The Update request has successfully processed.failed
The Update request failed processing.
​
type
enum
The liability type of the Update's Account. See Account Liability Types.
​
data_as_of
string
Timestamp indicating when the data in this record was last known to be accurate.
​
error
object | null
An object representing an error that occurred while processing this Update. See Update errors.
​
created_at
string
Timestamp of when the Update was created.
​
updated_at
string
Timestamp of when the Update was last updated.

​
Properties based on type

  • Credit Card
  • Mortgage
  • Auto Loan
  • Personal Loan
  • Student Loans
  • BNPL
  • Fintech
​
credit_card
object | null
This object will be populated if the Update is of type credit_card.

​
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": {
    "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",
    "next_payment_due_date": "2024-05-01",
    "next_payment_minimum_amount": 4000,
    "opened_at": "2018-10-30",
    "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"
}
⌘I