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:
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.
direct
Updates received directly from the financial institution.
snapshot
Updates received from a monthly snapshot view from the financial institution.
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.
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
.
credit_card.available_credit
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.
credit_card.interest_rate_percentage
The fixed interest rate for this account.
credit_card.interest_rate_percentage_max
The maximum interest rate (variable) allowed for this account.
credit_card.interest_rate_percentage_min
The minimum interest rate (variable) allowed for this account.
credit_card.interest_rate_source
The liability interest rate source. One of financial_institution
, public_data
or method
credit_card.interest_rate_type
The liability interest rate type. One of fixed
or variable
credit_card.last_payment_amount
The amount of the last payment on the account.
credit_card.last_payment_date
ISO 8601 formatted date (YYYY-MM-DD) of the last payment on the account.
credit_card.next_payment_due_date
ISO 8601 formatted date (YYYY-MM-DD) of the next minimum payment on the account.
credit_card.next_payment_minimum_amount
The amount of the next minimum payment on the account.
credit_card.next_statement_date
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
credit_card.usage_pattern
Categorizes the usage behavior of the credit card holder.
transactor
Pays balances in full each month.
revolver
Carries balances from month to month.
dormant
An inactive account with no recent transactions.
unknown
Usage pattern is not determined or not available.
Webhook Payload
The Webhook payload will contain the following information: