Peach Finance

Periods

Get loan periods

Returns loan's payment periods.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[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 (AnyId) ^ext-|^[A-Z][A-Z0-9]-[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
fromDate
string <date>

The first date in the range to return. The system will return any period for which period's startDate - endDate fully or partially overlap with fromDate - toDate range. Both fromDate and toDate must be passed to get all periods in the range.

toDate
string <date>

The last date in the range to return. The system will return any period for which period's startDate - endDate fully or partially overlap with fromDate - toDate range. Both fromDate and toDate must be passed to get all periods in the range.

dueDate
string <date>

The due date of the period. The system will return the object corresponding to the period with due date equal to dueDate. If no matching period is found, the system will return no results.

Responses
200

Loan Periods

get/people/{personId}/loans/{loanId}/periods
Response samples
application/json
{
  • "data": [
    ]
}

Get loan period by id

Returns a single loan period

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[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 (AnyId) ^ext-|^[A-Z][A-Z0-9]-[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.

loanPeriodId
required
string

The identifier of the period.

Responses
200

Loan Period

get/people/{personId}/loans/{loanId}/periods/{loanPeriodId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Payment Plans

Request sandbox access