Skip to content
/
Create installment loan t...

Create installment loan terms SCRA

Request

Creates a customer payment plan for the borrower in accordance with SCRA regulations. Only applicable to installment loans.

Security
oauth2(Required scopes: loan:paymentplan.scra.create) or bearerAuth or apiKeyHeader
Path
personIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

loanIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

Query
syncboolean

Make the process synchronous.

Default:false
Bodyapplication/jsonrequired
annualRatenumber, (float)

The annual interest rate for the period defined. Format is decimal. For example, 0.01 is 1% annual rate, 0.2 is 20% annual rate.

Default:0.06
caseIdstring

An identifier for an existing case.

endDatestring, (date)required

The end date of the period. The end date is inclusive.

isCancelFeesboolean

When set to true, the system will waive any fees that were charged during the period.

Default:true
sendNoticeboolean(schemas-SendNoticeCancelAutopay)

When set to false, the system will NOT send a loanPaymentScheduleChanged notice to the borrower.

Default:true
startDatestring, (date)required

The start date of the period. The start date is inclusive.

POST
/people/{personId}/loans/{loanId}/payment-plan-scra
curl -i -X POST \
  'https://sandboxapi.peach.finance/api/people/{personId}/loans/{loanId}/payment-plan-scra?sync=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "annualRate": 0.06,
    "caseId": "string",
    "endDate": "2019-08-24",
    "isCancelFees": true,
    "sendNotice": true,
    "startDate": "2019-08-24"
  }'

Responses

Success

Bodyapplication/json
countintegerread-only

Total number of items in this result.

statusinteger

HTTP status code.

dataobject(ExpectedPaymentsResult)
Response
{
  "count": 0,
  "status": 0,
  "data": {
    "isLocked": true,
    "paymentFrequency": "weekly",
    "schedule": [ … ],
    "specificDays": [ … ]
  }
}