# imoje raty

W ramach tej metody płatności możliwe jest rozłożenie przez płatnika kwoty zamówienia na raty. 

> info
> **WAŻNE!** imoje raty są dostępne tylko dla klientów indywidualnych Twojego sklepu.

Dostępne są dwie opcje rat:

- do 60 rat, RRSO zmienne, zależne od ilości rat
- do 10 rat, RRSO 0%

Minimalna kwota wymagana do skorzystania z imoje raty to **300 PLN**, a maksymalna to **50000 PLN**. 

imoje raty wyświetlą się domyślnie wraz z innymi metodami płatności. Jeśli korzystasz z tablicy `visibleMethod` to należy dodać wartość `imoje_installments`.

## Utworzenie płatności z imoje raty

imoje raty wyświetlą się domyślnie wraz z innymi metodami płatności. Jeśli korzystasz z tablicy `visibleMethod` to należy dodać wartość `imoje_installments`.

## Przykład zapytania:

```json
<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">
```

## Kalkulator imoje raty - widżet

Widżet imoje raty pozwala na wyświetlenie na podsumowaniu sklepu kalkulatora rat, za pomocą którego Płatnik może wstępnie ustalić ile wyniosą raty dla wybranego okresu. 
Wstępne ustawienie ilości rat można pobrać z kalkulatora i przekazać następnie w [zapytaniu tworzącym transakcję](https://imojeapi.docs.apiary.io/#/introduction/imoje-raty/utworzenie-transakcji-z-imoje-raty). 

W celu wywołania kalkulatora należy wykorzystać odpowiedni skrypt JavaScript i wywołać go w obiekcie o id `imoje-installments__wrapper`

### Adresy URL widżetu

**PRODUKCJA:** `https://paywall.imoje.pl/js/installments.js`

**SANDBOX:** `https://sandbox.paywall.imoje.pl/js/installments.js`

### ID skryptu

`imoje-installments__script`

#### Parametry Wymagane

| Parametr               | Opis                                 |
|------------------------|--------------------------------------|
| `merchantId`           | Identyfikator klienta                 |
| `serviceId`            | Identyfikator sklepu klienta jako `UUID v4`                |
| `amount`               | Kwota transakcji w najmniejszej jednostce waluty np. grosze. </br> Minimalna wartość: `30000` </br> Maksymalna wartość: `5000000` |
| `currency`             | Waluta transakcji w standardzie ISO 4217, **dopuszczalna wartość:** `PLN`                |
| `signature`            | [Wyliczona sygnatura](#topic-autoryzacja)                |

### Przykład wywołania skryptu 

```javascript
    (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);
    })();
```

### Pobranie ustawień z kalkulatora

W zależności od wybranego na kalkulatorze kanału imoje raty oraz ilości rat, widżet za każdym razem tworzy nowe wydarzenie, na podstawie którego można pobrać wartości i przekazać je w zapytaniu tworzącym transakcję. 

#### Przykład pobrania danych 

```javascript
    window.addEventListener('message', function (data) {
        if (data.data.channel && data.data.period) {
            var channel = data.data.channel;
            var period = data.data.period;
        }
    }, false);
```

## Zwroty do imoje raty

W przypadku tej metody płatności to dostawca decyduje w jakiej wysokości można wykonać zwrot do danej transakcji.

W celu pobrania informacji o maksymalnej kwocie zwrotu pełnego i częściowego należy skorzystać z [tego zapytania](https://bump.sh/pgw/doc/imoje-api/operation/operation-post-parameter-transaction-parameter-can-refund)