Installment Advances

This object represents an installment advance (also called loan proceeds or loan disbursements). Advances should be used for installment loans of type "multiple advances". Advances can be made on Loan objects only. To clarify, Advances cannot be made on Line of Credit objects. Advances increase principal balance of a Loan. Each advance has a unique identifier.

Create advance

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

loanId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

Request Body schema: application/json
externalId
string or null

A lender's identifier for a resource.

After the resource is successfully created, a lender can use the Peach assigned ID OR the externalId identifiers to fetch the resource.

Fetching with externalId:

To fetch a resource using an externalId, you MUST use the prefix ext- in the URL.

For example, a loan with an external identifier of ABCDE would be referenced like /api/people/BO-FAKE-IDNT/loans/ext-ABCDE.

Creating with externalId:

To create a resource with an external identifer, you MUST NOT use the prefix ext-.

For example, if the external identifier should be ABCDE, then pass { externalId: "ACBCE", ... } in the request body.

status
required
string
Default: "settled"
  • scheduled - the advance was scheduled in the future. If the advance status doesn’t change to pending, settled or canceled on the advance due date, the system will automatically cancel the advance on the following calendar day (aka change the status to canceled).

    For example: An advance was scheduled for May 27, 2021. On May 28, 2021, the advance status was still scheduled. The system will cancel the advance.

  • settled - the advance was settled and/or funded. settled advances increase the loan balance.

  • pending - the advance is pending. pending advances increases the loan balance similar to settled. pending status is used mainly for visuals and normally shown in Borrower Portal.

  • canceled - the advance was canceled. canceled advances reduce the draw balance. A new advance cannot be created in canceled status. Only scheduled advances can be canceled.

Enum: "scheduled" "settled" "pending" "canceled"
amount
required
number <float>

The amount of advance. The amount must be positive.

advanceDate
required
string <date>

The date of the advance. The date cannot be in the past or greater than the last due date.

  • If the advance is created in pending or settled status, the advance will be recorded in the ledger with an effective timestamp of the Create advance call.
  • If the advance is created in scheduled status, the advance will be recorded in the ledger only when the status changes to pending or settled.
object or null

The details of advance.

metadata
object

Store any type of key/value pairs in the form of a JSON dictionary.

Responses
200

Created

post/people/{personId}/loans/{loanId}/advances
Request samples
application/json
{
  • "externalId": "string",
  • "status": "scheduled",
  • "amount": 0,
  • "advanceDate": "2019-08-24",
  • "advanceDetails": {
    },
  • "metadata": { }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get advances

Returns an installment loan's advances

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

loanId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

query Parameters
status
string

The status of the advances.

Enum: "scheduled" "pending" "settled" "canceled"
Responses
200

Success

get/people/{personId}/loans/{loanId}/advances
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get advance by ID

Returns an installment loan advance

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

loanId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

advanceId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The advance identifier.

Responses
200

Success

get/people/{personId}/loans/{loanId}/advances/{advanceId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update advance

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

loanId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

advanceId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The advance identifier.

Request Body schema: application/json
externalId
string or null

A lender's identifier for a resource.

After the resource is successfully created, a lender can use the Peach assigned ID OR the externalId identifiers to fetch the resource.

Fetching with externalId:

To fetch a resource using an externalId, you MUST use the prefix ext- in the URL.

For example, a loan with an external identifier of ABCDE would be referenced like /api/people/BO-FAKE-IDNT/loans/ext-ABCDE.

Creating with externalId:

To create a resource with an external identifer, you MUST NOT use the prefix ext-.

For example, if the external identifier should be ABCDE, then pass { externalId: "ACBCE", ... } in the request body.

status
string
Default: "settled"
  • scheduled - the advance was scheduled in the future. If the advance status doesn’t change to pending, settled or canceled on the advance due date, the system will automatically cancel the advance on the following calendar day (aka change the status to canceled).

    For example: An advance was scheduled for May 27, 2021. On May 28, 2021, the advance status was still scheduled. The system will cancel the advance.

  • settled - the advance was settled and/or funded. settled advances increase the loan balance.

  • pending - the advance is pending. pending advances increases the loan balance similar to settled. pending status is used mainly for visuals and normally shown in Borrower Portal.

  • canceled - the advance was canceled. canceled advances reduce the draw balance. A new advance cannot be created in canceled status. Only scheduled advances can be canceled.

Enum: "scheduled" "settled" "pending" "canceled"
amount
number <float>

The amount of advance. The amount must be positive.

advanceDate
string <date>

The date of the advance. The date cannot be in the past or greater than the last due date.

  • If the advance is created in pending or settled status, the advance will be recorded in the ledger with an effective timestamp of the Create advance call.
  • If the advance is created in scheduled status, the advance will be recorded in the ledger only when the status changes to pending or settled.
object or null

The details of advance.

metadata
object

Store any type of key/value pairs in the form of a JSON dictionary.

Responses
200

Updated

put/people/{personId}/loans/{loanId}/advances/{advanceId}
Request samples
application/json
{
  • "externalId": "string",
  • "status": "scheduled",
  • "amount": 0,
  • "advanceDate": "2019-08-24",
  • "advanceDetails": {
    },
  • "metadata": { }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}