Plaid

Plaid Liabilities API

The Plaid Liabilities API is a financial tool that allows developers to access detailed information about a user's liabilities, such as credit card balances, loans, and other debts. By connecting with a user's financial accounts, the API can provide real-time updates on the status of their liabilities, including current balances, due dates, interest rates, and minimum payments. This information can help users better manage their debts and make more informed financial decisions. Additionally, developers can use the API to create innovative financial products and services that help users pay down their debts and improve their overall financial health.

GitHub OpenAPI

Documentation

📖
Documentation
https://plaid.com/docs/api/products/liabilities/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/plaid/refs/heads/main/openapi/plaid-liabilities--openapi-original.yml

OpenAPI Specification

plaid-liabilities--openapi-original.yml Raw ↑ 
openapi: 3.0.0
servers:
  - description: Production
    url: https://production.plaid.com
  - description: Development
    url: https://development.plaid.com
  - description: Sandbox
    url: https://sandbox.plaid.com
info:
  title: 'Plaid liabilities/'
  version: 2020-09-14_1.517.0
  description: Needs description.
  contact:
    name: Plaid Developer Team
    url: https://plaid.com
  termsOfService: https://plaid.com/legal/
tags:
  - name: Plaid
security:
  - clientId: []
    secret: []
    plaidVersion: []
paths:
  /processor/liabilities/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
        - Plaid
      summary: Plaid Retrieve Liabilities data
      externalDocs:
        url: /api/processor-partners/#processorliabilitiesget
      operationId: processorLiabilitiesGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessorLiabilitiesGetResponse'
              examples:
                example-1:
                  value:
                    account:
                      account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                      balances:
                        available:
                        current: 410
                        iso_currency_code: USD
                        limit: 2000
                        unofficial_currency_code:
                      mask: '3333'
                      name: Plaid Credit Card
                      official_name: Plaid Diamond 12.5% APR Interest Credit Card
                      subtype: credit card
                      type: credit
                    liabilities:
                      credit:
                        - account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                          aprs:
                            - apr_percentage: 15.24
                              apr_type: balance_transfer_apr
                              balance_subject_to_apr: 1562.32
                              interest_charge_amount: 130.22
                            - apr_percentage: 27.95
                              apr_type: cash_apr
                              balance_subject_to_apr: 56.22
                              interest_charge_amount: 14.81
                            - apr_percentage: 12.5
                              apr_type: purchase_apr
                              balance_subject_to_apr: 157.01
                              interest_charge_amount: 25.66
                            - apr_percentage: 0
                              apr_type: special
                              balance_subject_to_apr: 1000
                              interest_charge_amount: 0
                          is_overdue: false
                          last_payment_amount: 168.25
                          last_payment_date: '2019-05-22'
                          last_statement_issue_date: '2019-05-28'
                          last_statement_balance: 1708.77
                          minimum_payment_amount: 20
                          next_payment_due_date: '2020-05-28'
                      mortgage: []
                      student: []
                    request_id: dTnnm60WgKGLnKL
      description: >-
        The `/processor/liabilities/get` endpoint returns various details about
        a loan or credit account. Liabilities data is available primarily for US
        financial institutions, with some limited coverage of Canadian
        institutions. Currently supported account types are account type
        `credit` with account subtype `credit card` or `paypal`, and account
        type `loan` with account subtype `student` or `mortgage`.


        The types of information returned by Liabilities can include balances
        and due dates, loan terms, and account details such as original loan
        amount and guarantor. Data is refreshed approximately once per day; the
        latest data can be retrieved by calling `/processor/liabilities/get`.


        Note: This request may take some time to complete if `liabilities` was
        not specified as an initial product when creating the processor token.
        This is because Plaid must communicate directly with the institution to
        retrieve the additional data.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessorLiabilitiesGetRequest'
  /liabilities/get:
    x-plaid-business-unit-context: BUSINESS_UNIT_PLAID
    post:
      tags:
        - Plaid
      summary: Plaid Retrieve Liabilities data
      externalDocs:
        url: /api/products/liabilities/#liabilitiesget
      operationId: liabilitiesGet
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LiabilitiesGetResponse'
              examples:
                example-1:
                  value:
                    accounts:
                      - account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
                        balances:
                          available: 100
                          current: 110
                          iso_currency_code: USD
                          limit:
                          unofficial_currency_code:
                        mask: '0000'
                        name: Plaid Checking
                        official_name: Plaid Gold Standard 0% Interest Checking
                        subtype: checking
                        type: depository
                      - account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                        balances:
                          available:
                          current: 410
                          iso_currency_code: USD
                          limit: 2000
                          unofficial_currency_code:
                        mask: '3333'
                        name: Plaid Credit Card
                        official_name: Plaid Diamond 12.5% APR Interest Credit Card
                        subtype: credit card
                        type: credit
                      - account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
                        balances:
                          available:
                          current: 65262
                          iso_currency_code: USD
                          limit:
                          unofficial_currency_code:
                        mask: '7777'
                        name: Plaid Student Loan
                        official_name:
                        subtype: student
                        type: loan
                      - account_id: BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J
                        balances:
                          available:
                          current: 56302.06
                          iso_currency_code: USD
                          limit:
                          unofficial_currency_code:
                        mask: '8888'
                        name: Plaid Mortgage
                        official_name:
                        subtype: mortgage
                        type: loan
                    item:
                      available_products:
                        - balance
                        - investments
                      billed_products:
                        - assets
                        - auth
                        - identity
                        - liabilities
                        - transactions
                      consent_expiration_time:
                      error:
                      institution_id: ins_3
                      item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
                      update_type: background
                      webhook: https://www.genericwebhookurl.com/webhook
                    liabilities:
                      credit:
                        - account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
                          aprs:
                            - apr_percentage: 15.24
                              apr_type: balance_transfer_apr
                              balance_subject_to_apr: 1562.32
                              interest_charge_amount: 130.22
                            - apr_percentage: 27.95
                              apr_type: cash_apr
                              balance_subject_to_apr: 56.22
                              interest_charge_amount: 14.81
                            - apr_percentage: 12.5
                              apr_type: purchase_apr
                              balance_subject_to_apr: 157.01
                              interest_charge_amount: 25.66
                            - apr_percentage: 0
                              apr_type: special
                              balance_subject_to_apr: 1000
                              interest_charge_amount: 0
                          is_overdue: false
                          last_payment_amount: 168.25
                          last_payment_date: '2019-05-22'
                          last_statement_issue_date: '2019-05-28'
                          last_statement_balance: 1708.77
                          minimum_payment_amount: 20
                          next_payment_due_date: '2020-05-28'
                      mortgage:
                        - account_id: BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J
                          account_number: '3120194154'
                          current_late_fee: 25
                          escrow_balance: 3141.54
                          has_pmi: true
                          has_prepayment_penalty: true
                          interest_rate:
                            percentage: 3.99
                            type: fixed
                          last_payment_amount: 3141.54
                          last_payment_date: '2019-08-01'
                          loan_term: 30 year
                          loan_type_description: conventional
                          maturity_date: '2045-07-31'
                          next_monthly_payment: 3141.54
                          next_payment_due_date: '2019-11-15'
                          origination_date: '2015-08-01'
                          origination_principal_amount: 425000
                          past_due_amount: 2304
                          property_address:
                            city: Malakoff
                            country: US
                            postal_code: '14236'
                            region: NY
                            street: 2992 Cameron Road
                          ytd_interest_paid: 12300.4
                          ytd_principal_paid: 12340.5
                      student:
                        - account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
                          account_number: '4277075694'
                          disbursement_dates:
                            - '2002-08-28'
                          expected_payoff_date: '2032-07-28'
                          guarantor: DEPT OF ED
                          interest_rate_percentage: 5.25
                          is_overdue: false
                          last_payment_amount: 138.05
                          last_payment_date: '2019-04-22'
                          last_statement_issue_date: '2019-04-28'
                          loan_name: Consolidation
                          loan_status:
                            end_date: '2032-07-28'
                            type: repayment
                          minimum_payment_amount: 25
                          next_payment_due_date: '2019-05-28'
                          origination_date: '2002-08-28'
                          origination_principal_amount: 25000
                          outstanding_interest_amount: 6227.36
                          payment_reference_number: '4277075694'
                          pslf_status:
                            estimated_eligibility_date: '2021-01-01'
                            payments_made: 200
                            payments_remaining: 160
                          repayment_plan:
                            description: Standard Repayment
                            type: standard
                          sequence_number: '1'
                          servicer_address:
                            city: San Matias
                            country: US
                            postal_code: '99415'
                            region: CA
                            street: 123 Relaxation Road
                          ytd_interest_paid: 280.55
                          ytd_principal_paid: 271.65
                    request_id: dTnnm60WgKGLnKL
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LiabilitiesGetRequest'
      description: >-
        The `/liabilities/get` endpoint returns various details about an Item
        with loan or credit accounts. Liabilities data is available primarily
        for US financial institutions, with some limited coverage of Canadian
        institutions. Currently supported account types are account type
        `credit` with account subtype `credit card` or `paypal`, and account
        type `loan` with account subtype `student` or `mortgage`. To limit
        accounts listed in Link to types and subtypes supported by Liabilities,
        you can use the `account_filters` parameter when [creating a Link
        token](https://plaid.com/docs/api/tokens/#linktokencreate).


        The types of information returned by Liabilities can include balances
        and due dates, loan terms, and account details such as original loan
        amount and guarantor. Data is refreshed approximately once per day; the
        latest data can be retrieved by calling `/liabilities/get`.


        Note: This request may take some time to complete if `liabilities` was
        not specified as an initial product when creating the Item. This is
        because Plaid must communicate directly with the institution to retrieve
        the additional data.
components:
  schemas:
    ProcessorLiabilitiesGetResponse:
      type: object
      additionalProperties: true
      description: >-
        ProcessorLiabilitiesGetResponse defines the response schema for
        `/processor/liabilities/get`
      properties:
        account:
          $ref: '#/components/schemas/AccountBase'
        liabilities:
          $ref: '#/components/schemas/LiabilitiesObject'
        request_id:
          $ref: '#/components/schemas/RequestID'
      required:
        - account
        - liabilities
        - request_id
    LiabilitiesGetResponse:
      type: object
      additionalProperties: true
      description: >-
        LiabilitiesGetResponse defines the response schema for
        `/liabilities/get`
      properties:
        accounts:
          type: array
          description: An array of accounts associated with the Item
          items:
            $ref: '#/components/schemas/AccountBase'
        item:
          $ref: '#/components/schemas/Item'
        liabilities:
          $ref: '#/components/schemas/LiabilitiesObject'
        request_id:
          $ref: '#/components/schemas/RequestID'
      required:
        - accounts
        - item
        - liabilities
        - request_id