Private API Reference

Loan Distributions

A Loan Distribution returns collected funds on purchased receivables to the owner of those receivables.

Events

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

The Loan Distribution object

{
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "destination_account_id": "account_in71c4amph0vgo2qllky",
  "id": "loan_distribution_h7z0rzz6ytwk285yg312",
  "loan_account_id": "account_in71c4amph0vgo2qllky",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "loan_distribution"
}

Attributes

amount

integer

The amount of the distribution 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 Distribution was created.

destination_account_id

string

The identifier of the Account the funds were distributed to.

More about Accounts.

string

The Loan Distribution identifier.

loan_account_id

string

The identifier of the loan Account the distribution relates to.

More about Accounts.

transaction_id

string

Nullable

The identifier of the Transaction created on the destination Account.

More about Transactions.

type

string

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

List Loan Distributions

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

Returns a list response :

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

Parameters

More parameters

cursor

string

limit

integer

Retrieve a Loan Distribution

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

Parameters

loan_distribution_id

string

Required

The identifier of the Loan Distribution.

More about Loan Distributions.