You are viewing the latest API docs through the legacy docs viewer. The modern viewer can be found here: https://docs.peachfinance.com/api-docs.
Peach Finance

Rate Caps~~Internal

Get loan rate caps

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.

Responses
200

Success

404

Loan not found

get/people/{personId}/loans/{loanId}/rate-caps
Response samples
application/json
[
  • {
    }
]

Add loan rate cap

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.

Request Body schema: application/json
required
maxRate
required
number <float> (RateCapMaxRate) >= 0

The maximum spread interest rate that can accrue. Format is decimal. For example, 0.36 is 36% annual rate cap.

startDate
required
string <date> (RateCapStartDate)

Rate cap start date in product timezone, inclusive.

endDate
string or null <date> (RateCapEndDate)

Rate cap end date in product timezone, inclusive. If null, applies until end of loan/draw.

rateCapReason
required
string (RateCapReason)
Default: "other"

Reason for rate cap application:

  • MLA - Military Lending Act (36% cap for active duty military)
  • SCRA - Servicemembers Civil Relief Act
  • federal - Other federal regulations
  • state - State-specific regulations
  • other - Other regulatory or business reasons
Enum: "MLA" "SCRA" "federal" "state" "other"
Responses
200

Success

400

Bad request - validation error

404

Loan not found

post/people/{personId}/loans/{loanId}/rate-caps
Request samples
application/json
{
  • "maxRate": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "rateCapReason": "MLA"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update loan rate cap

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.

rateCapId
required
string (RateCapId) ^RC-[A-Z0-9]{4}-[A-Z0-9]{4}$

The unique identifier of the Rate Cap we wish to retrieve.

Example: RC-ABCD-1234
Request Body schema: application/json
required
maxRate
number <float> (RateCapMaxRate) >= 0

The maximum spread interest rate that can accrue. Format is decimal. For example, 0.36 is 36% annual rate cap.

startDate
string <date> (RateCapStartDate)

Rate cap start date in product timezone, inclusive.

endDate
string or null <date> (RateCapEndDate)

Rate cap end date in product timezone, inclusive. If null, applies until end of loan/draw.

rateCapReason
string (RateCapReason)
Default: "other"

Reason for rate cap application:

  • MLA - Military Lending Act (36% cap for active duty military)
  • SCRA - Servicemembers Civil Relief Act
  • federal - Other federal regulations
  • state - State-specific regulations
  • other - Other regulatory or business reasons
Enum: "MLA" "SCRA" "federal" "state" "other"
Responses
200

Success

400

Bad request - validation error

404

Loan or rate cap not found

put/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}
Request samples
application/json
{
  • "maxRate": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "rateCapReason": "MLA"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete loan rate cap

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.

rateCapId
required
string (RateCapId) ^RC-[A-Z0-9]{4}-[A-Z0-9]{4}$

The unique identifier of the Rate Cap we wish to retrieve.

Example: RC-ABCD-1234
Responses
200

Success

404

Loan or rate cap not found

delete/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}
Response samples
application/json
{
  • "message": "Rate cap deleted successfully"
}

Get draw rate caps

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.

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

The draw identifier.

Responses
200

Success

404

Loan or draw not found

get/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps
Response samples
application/json
[
  • {
    }
]

Add draw rate cap

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.

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

The draw identifier.

Request Body schema: application/json
required
maxRate
required
number <float> (RateCapMaxRate) >= 0

The maximum spread interest rate that can accrue. Format is decimal. For example, 0.36 is 36% annual rate cap.

startDate
required
string <date> (RateCapStartDate)

Rate cap start date in product timezone, inclusive.

endDate
string or null <date> (RateCapEndDate)

Rate cap end date in product timezone, inclusive. If null, applies until end of loan/draw.

rateCapReason
required
string (RateCapReason)
Default: "other"

Reason for rate cap application:

  • MLA - Military Lending Act (36% cap for active duty military)
  • SCRA - Servicemembers Civil Relief Act
  • federal - Other federal regulations
  • state - State-specific regulations
  • other - Other regulatory or business reasons
Enum: "MLA" "SCRA" "federal" "state" "other"
Responses
200

Success

400

Bad request - validation error

404

Loan or draw not found

post/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps
Request samples
application/json
{
  • "maxRate": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "rateCapReason": "MLA"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update draw rate cap

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.

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

The draw identifier.

rateCapId
required
string (RateCapId) ^RC-[A-Z0-9]{4}-[A-Z0-9]{4}$

The unique identifier of the Rate Cap we wish to retrieve.

Example: RC-ABCD-1234
Request Body schema: application/json
required
maxRate
number <float> (RateCapMaxRate) >= 0

The maximum spread interest rate that can accrue. Format is decimal. For example, 0.36 is 36% annual rate cap.

startDate
string <date> (RateCapStartDate)

Rate cap start date in product timezone, inclusive.

endDate
string or null <date> (RateCapEndDate)

Rate cap end date in product timezone, inclusive. If null, applies until end of loan/draw.

rateCapReason
string (RateCapReason)
Default: "other"

Reason for rate cap application:

  • MLA - Military Lending Act (36% cap for active duty military)
  • SCRA - Servicemembers Civil Relief Act
  • federal - Other federal regulations
  • state - State-specific regulations
  • other - Other regulatory or business reasons
Enum: "MLA" "SCRA" "federal" "state" "other"
Responses
200

Success

400

Bad request - validation error

404

Loan, draw, or rate cap not found

put/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}
Request samples
application/json
{
  • "maxRate": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "rateCapReason": "MLA"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete draw rate cap

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.

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

The draw identifier.

rateCapId
required
string (RateCapId) ^RC-[A-Z0-9]{4}-[A-Z0-9]{4}$

The unique identifier of the Rate Cap we wish to retrieve.

Example: RC-ABCD-1234
Responses
200

Success

404

Loan, draw, or rate cap not found

delete/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}
Response samples
application/json
{
  • "message": "Rate cap deleted successfully"
}
➔ Next to Transactions