Private API Reference

Loan Obligations

A Loan Obligation represents a bill on a loan: an amount of principal, interest, and fees the borrower must pay by a due date.

Events

Your application can listen to webhooks about this resource. All of the events about Loan Obligations will have the category "loan_obligation.created" .

The Loan Obligation object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "due_at": "2020-01-31T23:59:59Z",
  "due_fees": 100,
  "due_interest": 100,
  "due_principal": 100,
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "loan_obligation_p6zk4mqoelj8bs7b8jmh",
  "idempotency_key": null,
  "past_due_at": "2020-01-31T23:59:59Z",
  "type": "loan_obligation"
}

Attributes

account_id

string

The identifier of the loan Account the Loan Obligation is billed against.

More about Accounts.

created_at

string

The ISO 8601 date and time at which the Loan Obligation was created.

due_at

string

The ISO 8601 date and time at which the Loan Obligation is due.

due_fees

integer

The amount of fees due in the minor unit of the currency. For dollars, this is cents.

due_interest

integer

The amount of interest due in the minor unit of the currency. For dollars, this is cents.

due_principal

integer

The amount of principal due in the minor unit of the currency. For dollars, this is cents.

file_id

string

The identifier of the File containing a PDF of the Loan Obligation.

More about Files.

string

The Loan Obligation identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

past_due_at

string

The ISO 8601 date and time after which the Loan Obligation is past due if it is unpaid.

type

string

A constant representing the object’s type. For this resource it will always be loan_obligation.

List Loan Obligations

curl \
  --url "${INCREASE_URL}/loan_obligations" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Loan Obligation object */ },
    { /* Loan Obligation object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Loan Obligations to those billed against the specified loan Account.

More about Accounts.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

More parameters

Retrieve a Loan Obligation

curl \
  --url "${INCREASE_URL}/loan_obligations/loan_obligation_p6zk4mqoelj8bs7b8jmh" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

loan_obligation_id

string

Required

The identifier of the Loan Obligation.

More about Loan Obligations.

Retrieve the balances of a Loan Obligation

curl \
  --url "${INCREASE_URL}/loan_obligations/loan_obligation_p6zk4mqoelj8bs7b8jmh/balances" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a Loan Obligation Balance Lookup object:

{
  "due_fees": 100,
  "due_interest": 100,
  "due_principal": 100,
  "loan_obligation_id": "loan_obligation_p6zk4mqoelj8bs7b8jmh",
  "paid_fees": 100,
  "paid_interest": 100,
  "paid_principal": 100,
  "type": "loan_obligation_balance_lookup"
}

Parameters

loan_obligation_id

string

Required

The identifier of the Loan Obligation to look up the balances of.

More about Loan Obligations.

at_time

string

The moment to query the balances at. If not set, returns the current balances.

Sandbox: Create a Loan Obligation

Simulates a Loan Obligation being created for a loan Account, billing everything the Account owes. In production, Loan Obligations are created at the end of each cycle of the Account’s obligation schedule.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/loan_obligations" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky"
  }'

Parameters

account_id

string

Required

The identifier of the loan Account the Loan Obligation should be billed against.

More about Accounts.