Peach Finance

Statements

This object represents line of credit (e.g. credit card) or loan (e.g. personal installment) statement. Each statement is associated with one due date.

For lines of credit, statements are created one calendar day after the period end date. The number of dates between a statement creation and a due date can be configured by lenders, but are normally 14 or 21 days.

For installments, there are two options for when statements can be created:

  1. One calendar day after the period end date, which is also the due date. In this case, the statement date and due date are the same.
  2. A number of calendar days before the period end date. The offset (as number of calendar days) can be configured by lenders. In this case, a statement is created and sent before the period ends, which means some of the statement details are calculated based on partial period data (e.g. amount of interest accrued in the period.)

Get statements

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
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

sortBy
Array of strings

The data attributes by which to sort the results.

year
string

Only return statements from the current year.

includeAllVersions
boolean
Default: false

A flag to determine if all template versions should be returned, not just the most recent / active ones.

includeTestVersions
boolean
Default: false

A flag to determine whether test versions should be returned. If this flag is set to "true", the system will ignore the includeAllVersions attribute and return only test versions.

documentDescriptorIds
Array of strings (AnyId)

List of document descriptor IDs to filter by

Responses
200

Collection of statements

get/people/{personId}/loans/{loanId}/statements
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Get statement details

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.

statementId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The statement object unique identifier.

Responses
200

Details for a single statement

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

Update statement

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.

statementId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The statement object unique identifier.

Request Body schema: application/json
required
documentDescriptorId
required
string

Identifier for the document descriptor to be attached to the statement. This value can only be updated if isCreateAndSendPDF is set to false on the loan type configuration.

Responses
200

A single Statement

put/people/{personId}/loans/{loanId}/statements/{statementId}
Request samples
application/json
{
  • "documentDescriptorId": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Generate statement

Generates a statement, and if one already exists, replaces the older one as the active one. If sync=true is passed, the server will try to wait up to 20 seconds for the statement creation to finish. If it finishes in time, it will return the statement object. Otherwise, it will return nothing.

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.

periodId
required
string

The identifier of the period.

query Parameters
sync
boolean
Default: false

Make the process synchronous.

sendNotice
boolean
Default: false

When set to true, the system will send a statementGenerated notice to the borrower.

Responses
201

Success

post/people/{personId}/loans/{loanId}/periods/{periodId}/generate-statement
Response samples
application/json
{
  • "processingComplete": true,
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Autopay

Request sandbox access