Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.methodfi.com/llms.txt

Use this file to discover all available pages before exploring further.

The Updates endpoint retrieves real-time account data including balance, due dates, and 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

Updates with source: "snapshot" include the fields listed for their liability type below and may also include additional delinquency fields derived from credit report tradeline data. Delinquency fields are not included on Updates with source: "direct".

​
Snapshot Update Delinquency Fields

Snapshot Updates for supported liability types, including credit_card, auto_loan, mortgage, and personal_loan, may include the following additional fields on the Update’s liability object. For example, delinquent_status appears as credit_card.delinquent_status on a credit card Update and auto_loan.delinquent_status on an auto loan Update.

​
Properties based on type

​
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"
}