With this payment method, the payer can spread the order amount over instalments.
IMPORTANT! imoje instalments are only available to individual customers of your shop.
There are two instalment options available:
- up to 60 instalments, variable APR, depending on the number of instalments
- up to 10 instalments, 0% APR
The minimum amount required to use imoje instalments is PLN 300, and the maximum is PLN 50,000.
imoje instalments will be displayed by default along with other payment methods. If you use the visibleMethod table, you must add the value imoje_installments.
Creating a payment with imoje instalments
imoje instalments will be displayed by default along with other payment methods. If you are using the visibleMethod array, you must add the value imoje_installments.
Example request:
<input type="hidden" value="63f574ed-d90d-4abe-9cs1-39117584a7b7" name="serviceId">
<input type="hidden" value="6yt3gjtm9p1odfgx8491" name="merchantId">
<input type="hidden" value="5000000" name="amount">
<input type="hidden" value="PLN" name="currency">
<input type="hidden" value="imoje raty" name="orderId">
<input type="hidden" value="imoje raty" name="orderDescription">
<input type="hidden" value="John" name="customerFirstName">
<input type="hidden" value="Doe" name="customerLastName">
<input type="hidden" value="johndoe@domain.com" name="customerEmail">
<input type="hidden" value="501501501" name="customerPhone">
<input type="hidden" value="https://your-shop.com/success" name="urlSuccess">
<input type="hidden" value="https://your-shop.com/failure" name="urlFailure">
<input type="hidden" value="https://your-shop.com/return" name="urlReturn">
<input type="hidden" value="imoje_installments" name="visibleMethod">
<input type="hidden" value="cd5024f5ce5e6ff47990fe60572758fbcbcd6e3c04895d6815932b2d14e04ffd;sha256" name="signature">
imoje instalment calculator - widget
The imoje instalment widget allows you to display an instalment calculator on the shop summary, which the payer can use to preliminarily determine the amount of instalments for a selected period. The preliminary instalment amount can be downloaded from the calculator and then transferred in the transaction creation query.
To call the calculator, use the appropriate JavaScript script and call it in the object with the ID imoje-installments__wrapper.
Widget URLs
PRODUKCJA: https://paywall.imoje.pl/js/installments.js
SANDBOX: https://sandbox.paywall.imoje.pl/js/installments.js
Script ID
imoje-installments__script
Parameters
| Parameter | Description |
|---|---|
merchantId |
Customer ID |
serviceId |
Customer store ID as UUID v4 |
amount |
Transaction amount in the smallest currency unit, e.g. pence. Minimum value: 30000 Maximum value: 5000000 |
currency |
Transaction currency in ISO 4217 standard, acceptable value: PLN |
signature |
Calculated signature |
Example of script invocation
(function () {
const form = document.getElementById('form');
function onSubmit(event) {
event.preventDefault();
let script = document.getElementById('imoje-installments__script');
if (!script) {
script = document.createElement('script');
script.id = 'imoje-installments__script';
script.src = 'https://paywall.imoje.pl/js/installments.js';
script.onload = () => onSubmit(event);
document.body.appendChild(script);
return;
}
const options = {
merchantId: "Twój identyfikator Klienta",
serviceId: "Twój identyfikator sklepu",
amount: "Kwota zamówienia",
currency: "PLN",
signature: "Wyliczona sygnatura"
};
document.getElementById('imoje-installments__wrapper').imojeInstallments(options);
}
form.addEventListener('submit', onSubmit);
})();
Downloading settings from the calculator
Depending on the imoje instalment channel selected on the calculator and the number of instalments, the widget creates a new event each time, based on which you can download the values and pass them in the request creating the transaction.
Example of data download
window.addEventListener('message', function (data) {
if (data.data.channel && data.data.period) {
var channel = data.data.channel;
var period = data.data.period;
}
}, false);
Refunds to imoje instalments
With this payment method, the supplier decides how much can be refunded for a given transaction.
To obtain information about the maximum amount of full and partial refunds, please use this request.