Balances

This object represents current loan balances.

Get loan balances

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
isRounded
boolean

If true, balances will be rounded to the closes 1 cent.

skipYtd
boolean

If true, skip year-to-date calculations.

fast
boolean
Default: false

Perform a slightly less up-to-date balance check that is faster

toEffectiveDate
string <date>

Last day for which to fetch balances

Responses
200

Success

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

Get loan future balances

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
isRounded
boolean

If true, balances will be rounded to the closes 1 cent.

Responses
200

Success

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

Get draw balances

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.

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

The draw identifier.

query Parameters
isRounded
boolean

If true, balances will be rounded to the closes 1 cent.

skipYtd
boolean

If true, skip year-to-date calculations.

fast
boolean
Default: false

Perform a slightly less up-to-date balance check that is faster

toEffectiveDate
string <date>

Last day for which to fetch balances

skipInterestAccrual
boolean

If true, skip automatic interest accrual to catch up if it is missing.

Responses
200

Success

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

Get draw future balances

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.

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

The draw identifier.

query Parameters
isRounded
boolean

If true, balances will be rounded to the closes 1 cent.

Responses
200

Success

get/people/{personId}/loans/{loanId}/draws/{drawId}/future-balances
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}