{
  "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"
  },
  "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.

status
enum

Status of the Update.

type
enum

The liability type of the Update's Account. See Account Liability Types.

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
object | null

This object will be populated if the Update is of type credit_card.

credit_card.available_credit
number | null

The amount of credit currently available for use on this account.

credit_card.balance
string | null

The current balance of the account.

credit_card.closed_at
string | null

The date on which the account was officially closed, formatted in ISO 8601 (YYYY-MM-DD).

credit_card.credit_limit
number | null

The maximum amount of credit that can be extended to the borrower on this account.

credit_card.interest_rate_percentage_max
number | null

The maximum interest rate allowed for this account.

credit_card.interest_rate_percentage_min
number | null

The minimum interest rate allowed for this account.

credit_card.interest_rate_source
enum | null

The liability interest rate source. One of financial_institution, public_data or method

credit_card.interest_rate_type
enum | null

The liability interest rate type. One of fixed or variable

credit_card.last_payment_amount
number | null

The amount of the last payment on the account.

credit_card.last_payment_date
string | null

ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.

credit_card.last_statement_balance
number | null

The balance on the credit card as of the last issued statement.

credit_card.next_payment_due_date
string | null

ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.

credit_card.next_payment_minimum_amount
number | null

The amount of the next minimum payment on the account.

credit_card.next_statement_date
string | null

The date when the next statement for the credit card will be issued, formatted in ISO 8601 (YYYY-MM-DD).

credit_card.opened_at
string | null

The date when the account was originally opened, formatted in ISO 8601 (YYYY-MM-DD).

credit_card.sub_type
enum | null

Sub-type of the credit card. One of flexible_spending, charge, secured, unsecured, purchase or business

credit_card.usage_pattern
enum | null

Categorizes the usage behavior of the credit card holder.

​
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"
  },
  "error": null,
  "created_at": "2024-03-20T04:43:21.434Z",
  "updated_at": "2024-03-20T04:43:21.655Z"
}
Retrieve an AccountCreate an Update