Payment Plans

To use our API for PaymentsPlans you have to authenticate. See our Authentication document for instructions on how authentication works.

This API is a REST service and has the capability of calculating a payment plan.

Calculate

Calculate a payment plan.

HTTP Verb: GET

Parameters

Parameter

Required

Description

Parameter

Required

Description

merchantId

true

Id of the specific merchant that is making the sale. User must have access to merchantId.

amount

true

Total amount to be added to payment plan

NumberOfInstallments

true

The count of installments the user has requested

Example

https://externalapistaging.pei.is/api/paymentplans/calculator?merchantid=4&amount=45000&numberofInstallments=2

Response

{ "installments": [ { "dueDate": "2016-10-28T00:00:00+00:00", "principal": 22509, "contractInterest": 231, "lendingFee": 258, "noticeAndPaymentFee": 90, "installmentFee": 225, "total": 23313 }, { "dueDate": "2016-11-28T00:00:00+00:00", "principal": 22491, "contractInterest": 248, "lendingFee": 260, "noticeAndPaymentFee": 90, "installmentFee": 225, "total": 23314 } ], "total": 46627, "annualPercentageRate": 55.73942144110333174467086792 }