Fees

This object contains information about the fees that are charged to the loan, including draw, origination or dynamic fees, such as late fees.

Get fee types

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

The loan type identifier.

Responses
200

Success

get/loan-types/{loanTypeId}/fee-types
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Update origination fee

This endpoint allows lenders to change the origination fee amount. The system will update the origination fee amount and replay the loan from the activation date.

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
sync
boolean
Default: false

Make the process synchronous.

Request Body schema: application/json
feeAmount
number
Default: 0

The updated amount of the origination fee. The new amount cannot be higher than the amount passed on loan creation in atOrigination.

caseId
string

An identifier for an existing case.

Responses
204

Success

put/people/{personId}/loans/{loanId}/fees/origination
Request samples
application/json
{
  • "feeAmount": 0,
  • "caseId": "string"
}

Update draw fee

This endpoint allows lenders to change the draw fee amount. The system will update the draw fee amount and replay the loan from the draw activation date.

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
sync
boolean
Default: false

Make the process synchronous.

Request Body schema: application/json
feeAmount
number
Default: 0

The updated amount of the draw fee. The new amount cannot be higher than the amount passed on draw creation in atOrigination.

caseId
string

An identifier for an existing case.

Responses
204

Success

put/people/{personId}/loans/{loanId}/draws/{drawId}/fees/draw
Request samples
application/json
{
  • "feeAmount": 0,
  • "caseId": "string"
}

Get fees

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
includeDraws
boolean
Default: true

If set to true, includes the fees on all draws on the line of credit.

Responses
200

Success

get/people/{personId}/loans/{loanId}/fees
Response samples
application/json
{
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Charge dynamic fee

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
sync
boolean
Default: false

Make the process synchronous.

Request Body schema: application/json
apiName
string

The identifier of the dynamic fee configuration for this loan.

previewMode
boolean

In previewMode=true, the fee is computed but not charged.

caseId
string

An identifier for an existing case.

feeAmount
number

The fee amount, which is required only if the fee type was configured as chargedLogic=adHoc and amountLogic=adHoc. In all other cases, the system will calculate the fee based on pre-configured logic.

Responses
200

Success

412

Fee not charged

post/people/{personId}/loans/{loanId}/fees
Request samples
application/json
{
  • "apiName": "modificationFee",
  • "previewMode": true,
  • "caseId": "string",
  • "feeAmount": 0
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": [
    ]
}

Cancel dynamic fees

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
loanFeeIds
Array of strings
caseId
string

An identifier for an existing case.

Responses
204

Canceled

423

Locked

post/people/{personId}/loans/{loanId}/cancel-fees
Request samples
application/json
{
  • "loanFeeIds": [
    ],
  • "caseId": "string"
}
Response samples
application/json
{
  • "message": "Loan is locked for updates. Please try again."
}

Cancel dynamic fee

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.

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

The loan fee identifier.

Request Body schema: application/json
caseId
string

An identifier for an existing case.

Responses
204

Canceled

423

Locked

post/people/{personId}/loans/{loanId}/fees/{loanFeeId}/cancel
Request samples
application/json
{
  • "caseId": "string"
}
Response samples
application/json
{
  • "message": "Loan is locked for updates. Please try again."
}