Custom Calculation

NOT INTENDED FOR USE IN ONLINE STORES (API call limited to 1 per minute)! Performs credit calculation according to specified loan parameters and returns calculated data (costs, interest, EOM, instalment amount, downpayment). Is used to show detailed installment calculations on product webpage, in shop’s CRM or ERP

Request
Request Body schema: application/json
vendorApiKey
required
string <uuid> <= 36 characters

Assigned vendor API key. This value will be assigned at the time of application.

amount
required
string <number> <= 32 characters

The total amount payable.

term
string <number> <= 32 characters

Number of months for credit calculation. Note: If it is not specified system will return credit calculations for all possible terms.

vendorProductCode
string <uuid> <= 255 characters

Identification for financial product that you agreed with Leanpay. If it is not specified, default will be used.

Responses
200

OK

400

-> VENDOR_API_VENDOR_UNKNOWN - Unknown vendor API key; VENDOR_API_MIN_AMOUNT_EXCEEDED - Amount is lower than allowed minimum; VENDOR_API_MAX_AMOUNT_EXCEEDED - Amount is greater than allowed maximum; VENDOR_API_VALID_UNTIL_ERROR - Valid until date is in the past; VENDOR_WRONG_PRODUCT_CODE - Unknown financial product code;

500

Internal application error with unknown reason.

503

Leanpay platform is in maintenance mode.

post/vendor/custom/custom-credit-calculation
Request samples
application/json
{
  • "vendorApiKey": "d6b5b4ed-833b-43e8-ae44-5724b423ee49",
  • "amount": "23.59 or 23.6 or 23",
  • "term": "23.59 or 23.6 or 23",
  • "vendorProductCode": "a4da54b9-54f0-47db-9898-11244a4c9308"
}
Response samples
application/json
{
  • "numberOfInstallments": 6,
  • "installmentAmount": 57.6,
  • "downPaymentAmount": 50,
  • "firstInstallmentDate": 1562284800000,
  • "firstInstallmentAmount": 68.3,
  • "loanAmount": 900,
  • "costOfReview": 10,
  • "costOfRisk": 36,
  • "clientInterestPercent": 6.95,
  • "clientInterestAmount": 36.74,
  • "eom": 15.06,
  • "totalAmount": 972.74
}