Private API Reference

Loan Offers

A Loan Offer is a firm offer of credit extended by the bank to a customer following an approved Loan Application.

Events

Your application can listen to webhooks about this resource. The events about Loan Offers will have the categories "loan_offer.created" or "loan_offer.updated" .

The Loan Offer object

{
  "acceptance": null,
  "amount": 1000000,
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "expires_at": "2020-01-31T23:59:59Z",
  "id": "loan_offer_fspi9zpgcib98ok0h3dh",
  "loan_application_id": "loan_application_mpe6oe4a2gc5knzl1xfy",
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "status": "pending",
  "terms_file_id": "file_makxrc67oh9l6sg7w9yc",
  "type": "loan_offer"
}

Attributes

acceptance

dictionary

Nullable

If the Loan Offer has been accepted, this contains details of the acceptance.

amount

integer

The offered amount of credit in the minor unit of the currency. For dollars, this is cents.

created_at

string

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

entity_id

string

The identifier of the Entity the offer was extended to.

More about Entities.

expires_at

string

The ISO 8601 date and time at which the Loan Offer expires.

string

The Loan Offer’s identifier.

loan_application_id

string

Nullable

The identifier of the Loan Application that yielded this offer, if any.

More about Loan Applications.

program_id

string

The identifier of the Program the offer was made under.

More about Programs.

status

enum

The status of the Loan Offer.

terms_file_id

string

The identifier of the File containing the loan terms contract.

More about Files.

type

string

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

List Loan Offers

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

Returns a list response :

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

Parameters

status.in

array of strings

Filter Loan Offers for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

More parameters

Retrieve a Loan Offer

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

Parameters

loan_offer_id

string

Required

The identifier of the Loan Offer.

More about Loan Offers.

Sandbox: Expire a Loan Offer

Simulates a Loan Offer expiring because the customer did not accept it before its expires_at. This Loan Offer must first have a status of pending.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/loan_offers/loan_offer_fspi9zpgcib98ok0h3dh/expire" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

loan_offer_id

string

Required

The identifier of the Loan Offer you wish to expire.

More about Loan Offers.