Private API Reference

Loan Purchases

A Loan Purchase records the purchase of seasoned receivables on a loan Account, moving funds out of a source Account.

Events

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

The Loan Purchase object

{
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "id": "loan_purchase_998w3thud40bt7uxop2s",
  "idempotency_key": null,
  "loan_account_id": "account_in71c4amph0vgo2qllky",
  "source_account_id": "account_in71c4amph0vgo2qllky",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "loan_purchase"
}

Attributes

amount

integer

The amount of the purchase 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 Purchase was created.

string

The Loan Purchase 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.

loan_account_id

string

The identifier of the loan Account whose receivables were purchased.

More about Accounts.

source_account_id

string

The identifier of the Account that funded the purchase.

More about Accounts.

transaction_id

string

Nullable

The identifier of the Transaction created on the source Account.

More about Transactions.

type

string

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

List Loan Purchases

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

Returns a list response :

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

Parameters

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

cursor

string

limit

integer

Create a Loan Purchase

curl -X "POST" \
  --url "${INCREASE_URL}/loan_purchases" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 100,
    "loan_account_id": "account_in71c4amph0vgo2qllky",
    "source_account_id": "account_in71c4amph0vgo2qllky"
  }'

Parameters

amount

integer

Required

The amount to purchase in the minor unit of the currency. For dollars, this is cents.

loan_account_id

string

Required

The identifier of the loan Account whose receivables are being purchased.

More about Accounts.

source_account_id

string

Required

The identifier of the Account funding the purchase.

More about Accounts.

Retrieve a Loan Purchase

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

Parameters

loan_purchase_id

string

Required

The identifier of the Loan Purchase.

More about Loan Purchases.