Refunds

This object represents refunds. Various situations require full or partial refunds of a loan. Depending on the refund amount and whether the borrower has made payments, a refund may also trigger a reimbursement to the borrower.

Create refund

The refund endpoint will execute a full or partial refund according to the refundAmount specified. A full refund is equal to the amountFinancedAtOrigination. An atFaultParty must also be specified, in order to trigger the corresponding accounting entries related to billing for the refund.

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
refundAmount
number <float> >= 0

The refund amount. The maximum eligible refund amount is the amountFinancedAtOrigination of the loan. The refund is applied against the principal of the loan.

atFaultParty
string

The party at fault for the refund. Mainly used for ledger/accounting.

If loanOwner, the lender is billed for the entire refund, and paid interest and fees are refunded to the borrower.

If loanServicer, the servicer is billed for the entire refund, and paid interest and fees are refunded to the borrower.

If merchant, the merchant is billed for the entire refund, and paid interest and fees are refunded to the borrower.

If borrower, the merchant is billed for the entire refund, and the borrower receives no refund for paid interest and fees.

Enum: "loanOwner" "loanServicer" "merchant" "borrower"
caseId
string

The case identifier.

object

The details of refund.

Responses
200

Loan Refund

post/people/{personId}/loans/{loanId}/refunds
Request samples
application/json
{
  • "refundAmount": 0,
  • "atFaultParty": "loanOwner",
  • "caseId": "string",
  • "refundDetails": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get refunds

Returns a list of all prior refunds for the loan, as well as the remaining eligible refund amount.

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.

Responses
200

Loan Refund

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

Get refunds

Returns a list of all prior refunds for the loan, as well as the remaining eligible refund amount.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

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.

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

The loan refund identifier.

Responses
200

Loan Refund

get/companies/{companyId}/people/{personId}/loans/{loanId}/refunds/{loanRefundId}
Response samples
application/json
{
  • "refundDate": "2019-08-24",
  • "refundAmount": 0,
  • "originalAmount": 0,
  • "isFullRefund": true,
  • "atFaultParty": "loanOwner",
  • "caseId": "string",
  • "refundDetails": {
    }
}