Liability account data

Accounts connected through Method Data automatically have basic liability data, and are ready to receive payments.

In order to retrieve enhanced / expanded liability data you must initiate a sync using Method Sync

Sync a liability's data

✨ Method Sync allows you to retrieve real-time enhanced data for any liability created in Method. Method Sync is available for a fast growing list of merchants.

With Sync, you can fetch key liability details such as interest_rate_percentage, payoff_amount, balance and much more in real-time directly from the servicer or financial institution. ➡️ See all available data fields below per liability type.

💡 To check the status of a sync use the data_status and data_last_successful_sync in the account.liability response.

Request

cURL
Node.js
Python

POST /accounts/:account_id/syncs
curl https://production.methodfi.com/accounts/acc_Zc4F2aTLt8CBt/syncs \
  -X POST \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

POST /accounts/:account_id/syncs
const account = await method.accounts('acc_Zc4F2aTLt8CBt').syncs.create();

POST /accounts/:account_id/syncs
account = method.accounts('acc_Zc4F2aTLt8CBt').syncs.create()

RESPONSE
{
  "data": {
    "id": "acc_sync_6d94yUUMjbcXL",
    "acc_id": "acc_Zc4F2aTLt8CBt",
    "status": "in_progress",
    "error": null,
    "created_at": "2022-06-14T15:10:28.213Z",
    "updated_at": "2022-06-14T15:10:28.213Z"
  }
}

Retrieve a liability's data

This request retrieves a liability account created from the Method Data + Method Sync flow.

➡️ See liability account types to learn more.

cURL
Node.js
Python

GET /accounts/:account_id
curl https://production.methodfi.com/accounts/acc_Zc4F2aTLt8CBt \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

GET /accounts/:account_id
const account = await method.accounts.get('acc_Zc4F2aTLt8CBt');

GET /accounts/:account_id
account = method.accounts.get('acc_Zc4F2aTLt8CBt')

RESPONSE
{
  "id": "acc_Zc4F2aTLt8CBt",
  "holder_id": "ent_au22b1fbFJbp8",
  "type": "liability",
  "liability": {
    "mch_id": "mch_183",
    "mask": "1580",
    "type": "credit_card",
    "payment_status": "active",
    "data_status": "active",
    "data_status_error": null,
    "data_last_successful_sync": "2023-01-22T01:23:36.047Z",
    "data_source": "financial_institution",
    "data_updated_at": "2023-01-22T01:23:36.047Z",
    "ownership": "authorized",
    "credit_card": {
      "name": "Chase Sapphire Reserve",
      "balance": 750014,
      "opened_at": "2016-11-25",
      "last_payment_date": "2022-12-28",
      "last_payment_amount": 451757,
      "next_payment_due_date": "2023-01-27",
      "next_payment_minimum_amount": 6500,
      "last_statement_balance": 650043,
      "remaining_statement_balance": 0,
      "available_credit": 1530000,
      "interest_rate_percentage": 23.5,
      "interest_rate_type": "variable",
      "interest_rate_source": "financial_institution",
      "past_due_status": "unknown",
      "past_due_balance": null,
      "past_due_date": null,
      "auto_pay_status": "unknown",
      "auto_pay_amount": null,
      "auto_pay_date": null,
      "sub_type": "flexible_spending",
      "term_length": null,
      "closed_at": null,
      "credit_limit": 2380000,
      "next_statement_date": "2022-12-02",
      "delinquent_status": null,
      "delinquent_amount": null,
      "delinquent_period": null,
      "delinquent_action": null,
      "delinquent_start_date": null,
      "delinquent_major_start_date": null,
      "delinquent_status_updated_at": null,
      "delinquent_history": []
    }
  },
  "status": "active",
  "capabilities": [
    "payments:receive",
    "data:sync"
  ],
  "available_capabilities": [],
  "error": null,
  "created_at": "2022-02-16T02:56:19.548Z",
  "updated_at": "2022-06-14T15:13:09.520Z"
}

Example Response (Student loan)

{
  ...
  "liability": {
    "mch_id": "mch_2",
    "mask": "4455",
    "type": "student_loan",
    "payment_status": "active",
    "data_status": "active",
    "data_last_successful_sync": "2022-06-14T15:13:02.546Z",
    "data_status_error": null,
    "data_source": "financial_institution",
    "data_updated_at": "2023-01-22T01:23:36.047Z",
    "ownership": "primary",
    "student_loan": {
      "name": "FedLoan Student Loan",
      "sub_type": "federal",
      "sequence": 6,
      "balance": 1952634,
      "original_loan_amount": null,
      "last_payment_amount": 1150,
      "last_payment_date": "2022-04-22",
      "next_payment_due_date": "2022-10-28",
      "next_payment_minimum_amount": 0,
      "disbursed_at": "2018-01-22",
      "interest_rate_percentage": 3.4,
      "interest_rate_type": "fixed",
      "interest_rate_source": "financial_institution",
      "delinquent_status": null,
      "delinquent_amount": null,
      "delinquent_period": null,
      "delinquent_action": null,
      "delinquent_start_date": null,
      "delinquent_major_start_date": null,
      "delinquent_status_updated_at": null,
      "delinquent_history": []
    }
  },
  ...
}

Example Response (Credit card)

{
  ...
  "liability": {
    "mch_id": "mch_183",
    "mask": "1580",
    "type": "credit_card",
    "payment_status": "active",
    "data_status": "active",
    "data_status_error": null,
    "data_last_successful_sync": "2023-01-22T01:23:36.047Z",
    "data_source": "financial_institution",
    "data_updated_at": "2023-01-22T01:23:36.047Z",
    "ownership": "authorized",
    "credit_card": {
      "name": "Chase Sapphire Reserve",
      "balance": 750014,
      "opened_at": "2016-11-25",
      "last_payment_date": "2022-12-28",
      "last_payment_amount": 451757,
      "next_payment_due_date": "2023-01-27",
      "next_payment_minimum_amount": 6500,
      "last_statement_balance": 650043,
      "remaining_statement_balance": 0,
      "available_credit": 1530000,
      "interest_rate_percentage": 23.5,
      "interest_rate_type": "variable",
      "interest_rate_source": "financial_institution",
      "past_due_status": "unknown",
      "past_due_balance": null,
      "past_due_date": null,
      "auto_pay_status": "unknown",
      "auto_pay_amount": null,
      "auto_pay_date": null,
      "sub_type": "flexible_spending",
      "term_length": null,
      "closed_at": null,
      "credit_limit": 2380000,
      "next_statement_date": "2022-12-02",
      "delinquent_status": null,
      "delinquent_amount": null,
      "delinquent_period": null,
      "delinquent_action": null,
      "delinquent_start_date": null,
      "delinquent_major_start_date": null,
      "delinquent_status_updated_at": null,
      "delinquent_history": []
    }
  },
  ...
}

Example Response (Mortgage)

{
  ...
  "liability": {
    "mch_id": "mch_183",
    "mask": "2901",
    "type": "mortgage",
    "payment_status": "active",
    "data_status": "active",
    "data_last_successful_sync": "2022-06-14T15:13:02.546Z",
    "data_status_error": null,
    "data_source": "financial_institution",
    "data_updated_at": "2023-01-22T01:23:36.047Z",
    "ownership": "primary",
    "mortgage": {
      "name": "Chase Mortgage",
      "sub_type": "conventional",
      "balance": 8976762,
      "opened_at": null,
      "term_length": 360,
      "principal_balance": 8976762,
      "original_loan_amount": 10307500,
      "last_payment_amount": 37285,
      "last_payment_date": "2022-05-17",
      "next_payment_due_date": "2022-07-01",
      "next_payment_minimum_amount": 74569,
      "expected_payoff_date": "2050-10-01",
      "interest_rate_percentage": 2.875,
      "interest_rate_type": "fixed",
      "interest_rate_source": "financial_institution",
      "address_street": "10727 DOMAIN DR",
      "address_city": "AUSTIN",
      "address_state": "TX",
      "address_zip": "78537",
      "delinquent_status": null,
      "delinquent_amount": null,
      "delinquent_period": null,
      "delinquent_action": null,
      "delinquent_start_date": null,
      "delinquent_major_start_date": null,
      "delinquent_status_updated_at": null,
      "delinquent_history": [],
      "payoff_amount": null,
      "payoff_amount_term": null,
      "year_to_date_interest_paid": null,
      "year_to_date_principal_paid": null,
      "escrow_balance": null,
      "year_start_principal_balance": null,
      "year_to_date_taxes_paid": null,
    }
  },
  ...
}

Example Response (Auto loan)

{
  ...
  "liability": {
    "mch_id": "mch_2347",
    "mask": "0966",
    "type": "auto_loan",
    "payment_status": "active",
    "data_status": "active",
    "data_last_successful_sync": "2022-06-14T15:13:02.546Z",
    "data_status_error": null,
    "data_source": "financial_institution",
    "data_updated_at": "2023-01-22T01:23:36.047Z",
    "ownership": "primary",
    "auto_loan": {
      "name": "Volvo Cars Auto Loan",
      "sub_type": "loan",
      "vin": "YV1CZ882XJ1234567",
      "balance": 6083960,
      "principal_balance": 6073960,
      "original_loan_amount": null,
      "opened_at": null,
      "payoff_amount": null,
      "payoff_amount_term": null,
      "last_payment_amount": 88800,
      "last_payment_date": "2022-05-12",
      "next_payment_due_date": "2022-06-01",
      "next_payment_minimum_amount": 88883,
      "term_length": 84,
      "interest_rate_percentage": 5.7,
      "interest_rate_type": "fixed",
      "interest_rate_source": "financial_institution",
      "delinquent_status": null,
      "delinquent_amount": null,
      "delinquent_period": null,
      "delinquent_action": null,
      "delinquent_start_date": null,
      "delinquent_major_start_date": null,
      "delinquent_status_updated_at": null,
      "delinquent_history": [],
      "mileage_allocation": null,
      "per_diem_amount": null,
    }
  },
  ...
}

Liability account data

Sync a liability's data​

Request​

Retrieve a liability's data​

Example Response (Student loan)​

Example Response (Credit card)​

Example Response (Mortgage)​

Example Response (Auto loan)​