NAV
php shell

Wstęp

Informacje ogólne

Monetivo API umożliwia integrację własnego oprogramowania merchanta (np. sklepu) z systemem płatności Monetivo. Udostępniamy biblioteki, które pozwalają na m.in. wygenerowanie transakcji płatniczej oraz obsługa powiadomień o dokonaniu płatności. Bilbioteka umożliwia również wykonanie innych operacji na koncie merchanta systemu Monetivo takich jak:

Możesz korzystać z Monetivo API nie używając bibliotek. W takim przypadku samodzielnie wysyłasz zapytania HTTP do naszego REST API.

System Monetivo składa się z dwóch odizolowanych od siebie środowisk:

Dostęp do API

Możesz uzyskać dostęp do Monetivo API po wykonaniu nastepujących kroków:

  1. Zarejestruj albo zaloguj się w Panelu Merchanta,
  2. Kliknij Dodaj sklep i podaj szczegółowe informacje o Twoim sklepie.

Po utworzeniu sklepu w systemie Monetivo otrzymasz dostęp do środowiska testowego w postaci tokenu aplikacji, loginu oraz hasła. Dane te są przypisane do specjalnego użytkownika, tzw. użytkownika integracji, który posiada zmniejszony poziom uprawnień. Logując się jako użytkownik integracji możesz wykonać podstawowe czynności, takie jak utworzenie transakcji czy zwrot transakcji. Część zapytań do naszego API może być wykonywana tylko przez użytkownika administracyjnego.

Jeśli Twoja integracja przebiegnie pomyślnie, po uprzednim uzupełnieniu niezbędnych danych będziesz mieć możliwość migracji na środowisko produkcyjne. Niektóre akcje, takie jak wypłata środków na Twój rachunek bankowy, możliwe są do wykonania jedynie w środowisku produkcyjnym.

Elementy systemu Monetivo

Z punktu widzenia Merchanta, system Monetivo obejmuje kilka elementów:

  1. rachunek wewnętrzny na którym księgowane są środki w systemie Monetivo (Account),
  2. punkt sprzedaży (POS), odpowiadający np. sklepowi Merchanta,
  3. rachunek do wypłat (Bank account), wykorzystywany do wypłat środków z rachunku wewnętrznego na zewnętrzny rachunek bankowy Merchanta.

Każdy z tych elementów jest w pełni konfigurowalny z poziomu naszego API. Dążąc do uproszczenia integracji, wprowadziliśmy koncepcję Sklepu. Sklep w systemie Monetivo stanowi połączenie rachunku oraz POS. Dodając sklep w Panelu Merchanta Monetivo, nasz system automatycznie skonfiguruje dla Ciebie POS oraz rachunek wewnętrzny. Korzystając z API nadal masz możliwość dodatkowej konfiguracji obu tych elementów z osobna.

Biblioteki

PHP

Biblioteka MerchantAPI PHP umożliwia integrację oprogramowania napisanego w języku PHP z systemem Monetivo.

Wymagania systemowe

Instalacja

  1. Standardowa - przy użyciu Composer:

composer require monetivo/monetivo-php jeśli Composer nie został zainstalowany globalnie:

php composer.phar require monetivo/monetivo-php

  1. Niestandardowa - przy użyciu archiwum z biblioteką:

    • rozpakowanie archiwum do dowolnego folderu,
    • dołączenie pliku autoload.php z zachowaniem odpowiedniej ścieżki:

    require '<ścieżka do pliku autoload.php>';

Autentykacja

Dostęp do API wymaga autentykacji (zalogowania). Do autentykacji potrzebne są:

Po pomyślnej autentykacji zostanie zwrócony token, który jest niezbędny do wykonywania zapytań do API. Nasza biblioteka automatycznie dołączy token do każdego zapytania w postaci nagłówka. Każdy błąd, zarówno po stronie klienta API jak i systemu Monetivo, sygnalizowany jest wyrzuceniem wyjątku MonetivoException. Instancja wyjątku w większości przypadków zawiera także dodatkowe przydatne informacje.

Żądanie HTTP

POST https://api.monetivo.com/v1/auth/login

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji

Parametry żądania

Parametr Domyślnie Wymagany Opis
login - tak login merchanta
password - tak hasło merchanta

Odpowiedź

Klucz Opis
token token użytkownika, do wykorzystania w nagłówku X-Auth-Token

Przykładowa autentykacja:

<?php

// ładowanie biblioteki za pośrednictwem Composer
require __DIR__.'/vendor/autoload.php';

try {
    // token aplikacji
    $app_token = 'tokenaplikacji';

    // login merchanta
    $login = 'merchant_test_12345';

    // hasło merchanta
    $password = 'very_strong_password';

    // inicjalizacja biblioteki
    $api = new \Monetivo\MerchantApi($app_token);

    // autentykacja; jeśli wystąpi błąd to zostanie wyrzucony wyjątek MonetivoException
    // zmienna `$token` zawiera token autoryzacyjny. Jego ważność to 15 minut.
    $token = $api->auth($login, $password);

    // następne zapytania do API
}
catch(Monetivo\Exceptions\MonetivoException $e) {
  echo $e->getHttpCode(); // wyświetla kod odpowiedzi serwera;
  echo $e->getResponse(); // zawiera odpowiedź serwera
}
curl -X "POST" "https://api.monetivo.com/v1/auth/login \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
     --data-urlencode "login=1GE" \
     --data-urlencode "password=37855xb46d9x478fexxx"

Pamiętaj, że autentykację wywołujesz jednokrotnie, a przy kolejnych zapytaniach do API posługujesz się odebranym tokenem

Transakcje

Tworzenie transakcji

<?php

// autentykacja...

 $params = array(
             'order_data' => [
                 'description' => 'Christmas gifts',
                 'order_id' => '12345'
                 ],
             'buyer' => [
                 'name' => 'John Smith',
                 'email' =>  'js@example.com'
                 ],
             'language' => 'pl',
             'currency' => 'PLN',
             'amount' => '150.00',
             'return_url' => 'https://example.com/thanks'
         );
 $transaction = $api->transactions()->create($params);

// Przykładowy zwrócony wynik
Array
(
    [pos_id] => 1
    [amount] => 17.50
    [language] => pl
    [currency] => PLN
    [buyer] => Array
        (
            [name] => John Smith
            [email] => john@example.com
        )

    [order_data] => Array
        (
            [description] => Opis testowy
            [order_id] => 403a6047-4798-4f1e-a93c-xxxxxxxxxxxx
        )

    [return_url] => http://example.com
    [status_history] => Array
        (
        )

    [updated_at] => 2016-12-22T11:00:22+0000
    [created_at] => 2016-12-22T11:00:22+0000
    [identifier] => XXXXXXX
    [sign] => daa31f723b855af6cc4ff274fe0dxxxxxxxxxxxx
    [redirect_url] => https://secure.monetivo.com/pay/XXXXXXX/daa31f723b855af6cc4ff274fe0dxxxxxxxxxxxx
    [httpCode] => 200
)
curl -X "POST" "https://api.monetivo.com/v1/transactions" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
     --data-urlencode "amount=120.00" \
     --data-urlencode "return_url=https://example.com/thankyou" \
     --data-urlencode "order_data[description]=Testowy opis zamówienia" \
     --data-urlencode "buyer[email]=jkowalski@example.com" \
     --data-urlencode "language=PL" \
     --data-urlencode "currency=PLN" \
     --data-urlencode "order_data[order_id]=MYSHOP-12345" \
     --data-urlencode "buyer[name]=Jan Kowalski"

Żądanie HTTP

POST https://api.monetivo.com/v1/transactions

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Parametry żądania

Parametr Domyślnie Wymagany Opis
order_data[description] - tak Opis zamówienia
order_data[order_id] - tak Dodatkowy identyfikator zamówienia (dowolna treść zdefiniowana przez merchanta)
buyer[name] - tak nazwa kupującego
buyer[email] - tak email kupującego
language - tak język, którym posługuje się Kupujący
currency - tak waluta, dowolna spośród: PLN
amount - tak kwota zamówienia
channel_id - nie identyfikator kanału płatności, zdefiniowanie powoduje wymuszenie dokonania płatności poprzez wskazany kanał bez uprzedniej możliwości wyboru przez Kupującego
accept_terms - tak, jeśli channel_id jest zdefiniowany informacja, że Kupujący zaakceptował regulamin płatności systemu Monetivo; dozwolona wartość: 1
return_url - tak adres powrotny (URL) do przekierowania
notify_url taki jak dla POS nie adres URL po stronie Merchanta na który zostanie wysłane powiadomienie o zmianie statusu transakcji w systemie Monetivo

Odpowiedź

Klucz Opis
pos_id identyfikator POS
amount kwota zamówienia
language język, którym posługuje się Kupujący
currency waluta, dowolna spośród: PLN
buyer[name] nazwa kupującego
buyer[email] email kupującego
order_data[description] opis zamówienia
order_data[order_id] dodatkowy identyfikator zamówienia (dowolna treść zdefiniowana przez merchanta)
return_url adres powrotny do przekierowania
status_history historia zmian statusu
notify_url adres URL do powiadomienia
partial_refunds zwroty częściowe z transakcji (puste dla nowej transakcji)
updated_at data ostatniej zmiany statusu transakcji
created_at data utworzenia transakcji
identifier identyfikator transakcji
sign podpis transakcji
redirect_url adres URL, który umożliwia dokonanie płatności

Lista transakcji

<?php

// autentykacja...

// pobieranie listy zapłaconych transakcji od dnia 2016-12-01

$transactions = $api->transactions()->listing(['date_from' => '2016-12-01', 'status' => \Monetivo\Api\Transactions::TRAN_STATUS_PAID]);

// Przykładowy zwrócony wynik:

Array
(
    [total] => 2
    [per_page] => 15
    [current_page] => 1
    [last_page] => 1
    [next_page_url] =>
    [prev_page_url] =>
    [from] => 1
    [to] => 3
    [data] => Array
        (
            [0] => Array
                (
                    [pos_id] => 1
                    [identifier] => MXXXXXX
                    [currency] => PLN
                    [amount] => 2.00
                    [status] => 1
                    [language] => pl
                    [order_data] => Array
                        (
                            [order_id] => f011185b-fa2a-4b70-xxxx-xxxxxxxxxxxx
                            [description] => Zakup testowy 1
                        )

                    [buyer] => Array
                        (
                            [name] => John Smith
                            [email] => john@example.com
                        )

                    [status_history] => Array
                        (
                        )

                    [return_url] => https://example.com/thanks
                    [account_id] =>
                    [created_at] => 2016-12-09T12:38:04+0000
                    [updated_at] => 2016-12-09T12:38:04+0000
                    [channel_id] =>
                    [committed_at] =>
                    [accounted_at] =>
                    [partial_refunds] => Array()
                )

            [1] => Array
                (
                    [pos_id] => 1
                    [identifier] => M1XXXXX
                    [currency] => PLN
                    [amount] => 100.00
                    [status] => 1
                    [language] => pl
                    [order_data] => Array
                        (
                            [order_id] => d047f63d-7cdf-XXXX-9655-XXXXXXXXXXXX
                            [description] => Christmas gifts
                        )

                    [buyer] => Array
                        (
                            [name] => Anna Doe
                            [email] => ann@example.com
                        )

                    [status_history] => Array
                        (
                        )

                    [return_url] => https://example.com/thanks
                    [account_id] =>
                    [created_at] => 2016-12-09T12:41:58+0000
                    [updated_at] => 2016-12-09T12:41:58+0000
                    [channel_id] =>
                    [committed_at] =>
                    [accounted_at] =>
                    [partial_refunds] =>
                )

        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/transactions" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/transactions

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Parametry żądania

Parametr Domyślnie Wymagany Opis
date_from - nie data od
date_to - nie data do
sort asc nie kolejność sortowania: asc (od najstarszej), desc (od najnowszej)
orderby - nie kolumna sortowania, patrz niżej
per_page - nie ilość wyników na stronę
page - nie numer strony z wynikami
email - nie ograniczenie wyszukania po wskazanym adresie email
amount_from - nie kwota transakcji od
amount_to - nie kwota transakcji do (włącznie)
status - nie ograniczenie wyszukania do wskazanego statusu (wartość z tabeli Statusy transakcji)

Kolumny sortowania

Kolumna Opis
updated_at data zmiany statusu
created_at data utworzenia
amount kwota
committed_at data zaksięgowania

Statusy transakcji

Status Wartość
Nowa 1
Zapłacona 2
Zaakceptowana 4
Zwrócona 16
Odrzucona 32

Odpowiedź

Klucz Opis
total liczba wyników (transakcji)
per_page ilość wyników na stronę
current_page bieżąca strona z wynikami
last_page numer ostatniej strony z wynikami
next_page_url adres URL do pobrania następnej strony z wynikami
prev_page_url adres URL do pobrania poprzedniej strony z wynikami
from wyniki od
to wyniki do
data tablica zawierająca wyniki

Szczegóły transakcji

<?php

// autentykacja...

// pobieranie szczegółów transakcji MO12345
$identifier = 'MO12345';
$transaction = $api->transactions()->details($identifier);

// Przykładowa odpowiedź - transakcja zaakceptowana wraz z dwoma zwrotami częściowymi
Array
(
    [pos_id] => 1
    [identifier] => MXXXXXX
    [currency] => PLN
    [amount] => 15.50
    [status] => 4
    [language] => pl
    [order_data] => Array
        (
            [order_id] => d6681448-f850-4c7c-bc28-XXXXXXXXXXXX
            [description] => Opis testowy
        )

    [buyer] => Array
        (
            [name] => John Doe
            [email] => john@example.com
        )

    [status_history] => Array
        (
        )

    [return_url] => https://example.com
    [notify_url] =>
    [account_id] =>
    [partial_refunds] => Array
        (
            [0] => Array
                (
                    [amount] => 1.00
                    [committed_at] => 2017-01-04T10:10:36+0100
                    [refund_identifier] => MRX8XXXX1
                )

            [1] => Array
                (
                    [amount] => 1.00
                    [committed_at] => 2017-01-04T10:12:26+0100
                    [refund_identifier] => MRX8XXXX2
                )

        )
    [channel_id] => 25
    [created_at] => 2016-12-13T10:18:06+0000
    [updated_at] => 2016-12-13T10:18:06+0000
    [committed_at] => 2016-12-13T10:18:08+0000
    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/transactions/MRX8XXXX2" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/transactions/<ID>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ID - tak identyfikator transakcji

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
pos_id identyfikator POS
identifier identyfikator transakcji
currency waluta transakcji
amount kwota transakcji
status status transakcji
language język, którym posługuje się Kupujący
order_data[description] opis zamówienia
order_data[order_id] dodatkowy identyfikator zamówienia (dowolna treść zdefiniowana przez merchanta)
buyer[name] nazwa kupującego
buyer[email] email kupującego
status_history historia zmian statusu
return_url adres powrotny URL do przekierowania
notify_url adres URL do wysłania powiadomienia
account_id identyfikator rachunku
partial_refunds zwroty częściowe transakcji
channel_id identyfikator kanału płatności użytego do dokonania płatności przez Kupującego
created_at data utworzenia transakcji
updated_at data ostatniej zmiany statusu transakcji
committed_at data zaksięgowania transakcji na koncie Merchanta

Obsługa powiadomień o statusie

Zmiana statusu transakcji powoduje wysłanie przez system Monetivo powiadomienia na adres URL podany przez Merchanta.

Po odebraniu powiadomienia, w przypadku gdy transakcja jest poprawna (opłacona, a następnie zaakceptowana), możesz przystąpić do dalszych czynności związanych z realizacją płatności po Twojej stronie.

<?php

// autentykacja...

// odbiór powiadomienia
$transaction = $api->handleCallback();

// sprawdzenie czy transakcja została
if($transaction === false) {
  exit('Transakcja nie została zaakceptowana');
}
else {
  // transakcja została opłacona i zaakceptowana,
  // zmienna $transaction obejmuje szczegóły transakcji,
  // Twój kod - dalsza część logiki, np. oznaczenie płatności w systemie jako wykonanej, wysłanie maila, etc.
}

Parametry żądania

Parametr Domyślnie Wymagany Opis
identifier - tak identyfikator transakcji

Akceptacja transakcji

<?php

// autentykacja...

// akceptowanie transakcji MO12345
$identifier = 'MO12345';
$transaction = $api->transactions()->accept($identifier);

// Poprawna odpowiedź serwera jest taka sama jak w przypadku tworzenia transakcji
// W przypadku wystąpienia błędu zwrócony zostanie odpowiedni komunikat

// Przykład: próba zaakceptowania transakcji oczekującej - serwer zwraca komunikat o błędzie z informacją, że nie można zaakceptować oczekującej, nieopłaconej transakcji
Array
(
    [errors] => Array
        (
            [code] => 1
            [message] => "Cannot accept transaction - incorrect status"
        )
)
curl -X "PUT" "https://api.monetivo.com/v1/transactions/MO12345/accept" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

PUT https://api.monetivo.com/v1/transactions/<ID>/accept

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ID - tak identyfikator transakcji

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odrzucenie transakcji

<?php

// autentykacja...

// odrzucenie transakcji MO12345
$identifier = 'MO12345';
$transaction = $api->transactions()->decline($identifier);

curl -X "PUT" "https://api.monetivo.com/v1/transactions/MO12345/decline" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Odpowiedź serwera jest taka sama jak w przypadku tworzenia transakcji

Żądanie HTTP

PUT https://api.monetivo.com/v1/transactions/<ID>/decline

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ID - tak identyfikator transakcji

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Zwrot transakcji

<?php

// autentykacja...

// pobieranie szczegółów transakcji MO12345
$identifier = 'MO12345';
$transaction = $api->transactions()->refund($identifier);

// Przykładowy zwrócony wynik:

Array
(
    [name] => John Smith
    [email] => john@example.com
    [amount] => 1.00
    [transaction_identifier] => MO12345
    [currency] => PLN
    [description] => christmas gifts
    [reason] => 4
    [partial] => 0
    [status_history] => Array
        (
            [0] => Array
                (
                    [status] => 1
                    [date] => 2017-01-04T09:07:38+0000
                )
        )
    [status] => 1
    [updated_at] => 2017-01-04T09:07:38+0100
    [created_at] => 2017-01-04T09:07:38+0100
    [identifier] => MRX8ER10X
    [account_id] => 1
    [committed_at] => 2017-01-04T10:07:37+0100
)
curl -X "POST" "https://api.monetivo.com/v1/transactions/MRX8ER10X/refund" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

POST https://api.monetivo.com/v1/transactions/<ID>/refund

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ID - tak identyfikator transakcji

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
name nazwa kupującego
email email kupującego
amount kwota zwrotu
transaction_identifier identyfikator transakcji
currency waluta
description opis zwrotu
reason przyczyna zwrotu (patrz niżej)
partial czy zwrot częściowy. Wartość true jeśli kwota zwrotu jest niższa od kwoty transakcji
status_history historia zmian statusu
status status zwrotu
updated_at data aktualizacji zwrotu
created_at data utworzenia zwrotu
identifier identyfikator zwrotu
account_id identyfikator rachunku
committed_at data księgowania

Przyczyny zwrotu

Wartość Opis
1 transakcja nie została zaakceptowana
2 transakcja nie została odnaleziona w systemie
4 zwrot nastąpił na żądanie merchanta
8 zwrot nastąpił z powodu błędu w przetwarzaniu transakcji

Statusy zwrotu

Wartość Opis
1 oczekiwanie na uzupełnienie danych bankowych
2 oczekiwanie na przesłanie danych do banku
8 dane bankowe przesłane do wypłaty

Płatność BLIK

System Monetivo umożliwia szybkie dokonanie płatności BLIK przy użyciu API. Rozwiązanie to obejmuje 3 etapy:

  1. Rejestracja nowej transakcji (zob. Tworzenie transakcji)
  2. Wprowadzenie kodu BLIK wygenerowanego przez aplikację mobilną banku Kupującego (poniżej),
  3. Obsłużenie powiadomienia o zmianie statusu transakcji wysłanego przez Monetivo (zob. Obsługa powiadomień o statusie)
<?php

// autentykacja...

 $params = array(
             'order_data' => [
                 'description' => 'Christmas gifts',
                 'order_id' => '12345'
                 ],
             'buyer' => [
                 'name' => 'John Smith',
                 'email' =>  'js@example.com'
                 ],
             'language' => 'pl',
             'currency' => 'PLN',
             'amount' => '150.00',
             'return_url' => 'https://example.com/thanks'
         );
 // tworzenie nowej transakcji
 $transaction = $api->transactions()->create($params);
 // wprowadzenie kodu BLIK pozyskanego od Kupującego
 $blikResult = $api->transactions()->executeBlik($transaction['identifier'], '123456')

 // Przykładowy zwrócony wynik

 Array
 (
     [status] => true
 )

curl -X "POST" "https://api.monetivo.com/v1/transactions/XXXXXXX/blik" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
     --data-urlencode "blikCode=123456" \

Żądanie HTTP

POST https://api.monetivo.com/v1/transactions/<ID>/blik

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ID - tak identyfikator transakcji

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Parametry żądania

Parametr Domyślnie Wymagany Opis
blikCode - tak Kod BLIK wygenerowany w aplikacji mobilnej Kupującego

Odpowiedź

Klucz Opis
status status rejestracji transakcji w systemie BLIK: true albo false

Kanały płatności

Lista dostępnych kanałów płatności

<?php

// autentykacja...

// pobieranie listy dostępnych kanałów płatności dla waluty PLN

$accounts = $api->paymentChannels()->listing('PLN');


Przykładowy zwrócony wynik:

Array
(
    [0] => stdClass Object
        (
            [channel_id] => 1
            [name] => Blik
            [currency] => PLN
            [type] => 6
            [order_by] => 1
            [img] => https://secure.monetivo.com/assets/img/banks/1.png
        )

    [1] => stdClass Object
        (
            [channel_id] => 2
            [name] => mTransfer
            [currency] => PLN
            [type] => 1
            [order_by] => 2
            [img] => https://secure.monetivo.com/assets/img/banks/2.png
        )

    [2] => stdClass Object
        (
            [channel_id] => 3
            [name] => Płać z ING
            [currency] => PLN
            [type] => 1
            [order_by] => 3
            [img] => https://secure.monetivo.com/assets/img/banks/3.png
        )

    [3] => stdClass Object
        (
            [channel_id] => 4
            [name] => Pekao24Przelew
            [currency] => PLN
            [type] => 1
            [order_by] => 4
            [img] => https://secure.monetivo.com/assets/img/banks/4.png
        )

    [4] => stdClass Object
        (
            [channel_id] => 5
            [name] => Przelew24 BZWBK
            [currency] => PLN
            [type] => 1
            [order_by] => 5
            [img] => https://secure.monetivo.com/assets/img/banks/5.png
        )

    [5] => stdClass Object
        (
            [channel_id] => 6
            [name] => Płacę z Alior Bankiem
            [currency] => PLN
            [type] => 1
            [order_by] => 6
            [img] => https://secure.monetivo.com/assets/img/banks/6.png
        )

    [6] => stdClass Object
        (
            [channel_id] => 7
            [name] => Płacę z IPKO
            [currency] => PLN
            [type] => 1
            [order_by] => 7
            [img] => https://secure.monetivo.com/assets/img/banks/7.png
        )

    [7] => stdClass Object
        (
            [channel_id] => 8
            [name] => Płacę z Inteligo
            [currency] => PLN
            [type] => 1
            [order_by] => 8
            [img] => https://secure.monetivo.com/assets/img/banks/8.png
        )

    [8] => stdClass Object
        (
            [channel_id] => 9
            [name] => Millennium Bank PBL
            [currency] => PLN
            [type] => 1
            [order_by] => 9
            [img] => https://secure.monetivo.com/assets/img/banks/9.png
        )

    [9] => stdClass Object
        (
            [channel_id] => 10
            [name] => CA przelew online
            [currency] => PLN
            [type] => 1
            [order_by] => 10
            [img] => https://secure.monetivo.com/assets/img/banks/10.png
        )

    [10] => stdClass Object
        (
            [channel_id] => 11
            [name] => T-Mobile Usługi Bankowe
            [currency] => PLN
            [type] => 1
            [order_by] => 11
            [img] => https://secure.monetivo.com/assets/img/banks/11.png
        )

    [11] => stdClass Object
        (
            [channel_id] => 12
            [name] => Deutsche Bank
            [currency] => PLN
            [type] => 1
            [order_by] => 12
            [img] => https://secure.monetivo.com/assets/img/banks/12.png
        )

    [12] => stdClass Object
        (
            [channel_id] => 13
            [name] => BPH Przelew
            [currency] => PLN
            [type] => 1
            [order_by] => 13
            [img] => https://secure.monetivo.com/assets/img/banks/13.png
        )

    [13] => stdClass Object
        (
            [channel_id] => 14
            [name] => BGŻ BNP Paribas
            [currency] => PLN
            [type] => 1
            [order_by] => 14
            [img] => https://secure.monetivo.com/assets/img/banks/14.png
        )

    [14] => stdClass Object
        (
            [channel_id] => 15
            [name] => Eurobank - płatność online
            [currency] => PLN
            [type] => 1
            [order_by] => 15
            [img] => https://secure.monetivo.com/assets/img/banks/15.png
        )

    [15] => stdClass Object
        (
            [channel_id] => 16
            [name] => PBS PBL
            [currency] => PLN
            [type] => 1
            [order_by] => 16
            [img] => https://secure.monetivo.com/assets/img/banks/16.png
        )

    [16] => stdClass Object
        (
            [channel_id] => 17
            [name] => r-Przelew
            [currency] => PLN
            [type] => 1
            [order_by] => 17
            [img] => https://secure.monetivo.com/assets/img/banks/17.png
        )

    [17] => stdClass Object
        (
            [channel_id] => 18
            [name] => Toyota Bank Pay Way
            [currency] => PLN
            [type] => 1
            [order_by] => 18
            [img] => https://secure.monetivo.com/assets/img/banks/18.png
        )

    [18] => stdClass Object
        (
            [channel_id] => 19
            [name] => BSWSCHOWA PBL
            [currency] => PLN
            [type] => 1
            [order_by] => 19
            [img] => https://secure.monetivo.com/assets/img/banks/19.png
        )

    [19] => stdClass Object
        (
            [channel_id] => 20
            [name] => Płać z BOŚ Bank
            [currency] => PLN
            [type] => 1
            [order_by] => 20
            [img] => https://secure.monetivo.com/assets/img/banks/20.png
        )

    [20] => stdClass Object
        (
            [channel_id] => 21
            [name] => Getin Bank
            [currency] => PLN
            [type] => 1
            [order_by] => 21
            [img] => https://secure.monetivo.com/assets/img/banks/21.png
        )

    [21] => stdClass Object
        (
            [channel_id] => 22
            [name] => Płacę z Orange
            [currency] => PLN
            [type] => 1
            [order_by] => 22
            [img] => https://secure.monetivo.com/assets/img/banks/22.png
        )

    [22] => stdClass Object
        (
            [channel_id] => 23
            [name] => Płacę z Citi Handlowy
            [currency] => PLN
            [type] => 1
            [order_by] => 23
            [img] => https://secure.monetivo.com/assets/img/banks/23.png
        )

    [23] => stdClass Object
        (
            [channel_id] => 24
            [name] => e-transfer Pocztowy24
            [currency] => PLN
            [type] => 1
            [order_by] => 24
            [img] => https://secure.monetivo.com/assets/img/banks/24.png
        )

    [24] => stdClass Object
        (
            [channel_id] => 25
            [name] => Płacę z PLUS BANK
            [currency] => PLN
            [type] => 1
            [order_by] => 25
            [img] => https://secure.monetivo.com/assets/img/banks/25.png
        )

    [25] => stdClass Object
        (
            [channel_id] => 26
            [name] => Noble Bank
            [currency] => PLN
            [type] => 1
            [order_by] => 26
            [img] => https://secure.monetivo.com/assets/img/banks/26.png
        )

)
curl "https://api.monetivo.com/v1/channels" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/channels

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
currency - tak waluta wykorzystywana w kanałach płatności
type - nie typy kanałów płatności rozdzielane przecinkiem, z listy poniżej

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Typy kanałów płatności

Typ Wartość Opis
TYPE_ETRANSFER 1 kanały szybkich płatności typu eTransfer
TYPE_BLIK 2 kanały płatności systemu BLIK
TYPE_MO_APP 4 kanały aplikacji mobilnych (oferta w przygotowaniu)
TYPE_MANUAL 8 kanały dla płatności wykonywanych manualnie, np. druk płatności
TYPE_CARD 16 kanały płatności kartą kredytową
TYPE_OTHER 32 pozostałe kanały

POS

POS to punkt sprzedaży, np. Twój sklep internetowy. Możesz posiadać wiele POS-ów, które są przypisane do Twojego konta merchanta. Każdy POS posiada szereg ustawień, w tym adres URL na który będą przychodzić powiadomienia o zmianie statusu transakcji POS posiada swój identyfikator, który jest niezbędny do stworzenia transakcji.

Tworzenie POS

<?php

// autentykacja...

// pobieranie listy POS
$params = ['name' => 'My shop', 'url' => 'https://myshop.example.com', 'contact_id' => 1];
$transactions = $api->pos()->create($params);

// Przykładowy zwrócony wynik:
Array
(
    [pos_id] => 1
    [name] => Monetivo
    [url] => https://monetivo.com
    [contact_user] => Array
        (
            [name] => John
            [email] => hello@monetivo.com
            [phone] => +48123456789
            [title] => Mr
            [surname] => Doe
        )

    [enabled] => 1
    [parameters] => Array
        (
            [url_notify] => https://monetivo.com/notify
        )

    [created_at] => 2016-12-09T12:24:15+0000
    [updated_at] => 2016-12-09T12:24:15+0000
    [httpCode] => 200
)
curl -X "POST" "https://api.monetivo.com/v1/pos" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"
     --data-urlencode "name=My Shop" \
     --data-urlencode "url=https://myshop.example.com" \
     --data-urlencode "contact_id=1"

Żądanie HTTP

POST https://api.monetivo.com/v1/pos

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Parametry żądania

Parametr Domyślnie Wymagany Opis
name - tak nazwa POS (unikalna)
url - tak adres URL POS
contact_id - tak ID osoby kontaktowej

Odpowiedź

Klucz Opis
pos_id identyfikator POS
name nazwa POS
url adres URL POS
contact_user[name] imię osoby kontaktowej
contact_user[surname] nazwisko osoby kontaktowej
contact_user[email] adres email osoby kontaktowej
contact_user[phone] telefon osoby kontaktowej
contact_user[title] tytuł służbowy osoby kontaktowej
enabled POS aktywny
parameters[url_notify] adres URL do wysyłania powiadomień o zmianie statusu transakcji
created_at data utworzenia
updated_at data ostatniej edycji

Lista POS

<?php

// autentykacja...

// pobieranie listy POS

$transactions = $api->pos()->listing();

// Przykładowy zwrócony wynik:
Array
(
    [total] => 1
    [per_page] => 15
    [current_page] => 1
    [last_page] => 1
    [next_page_url] =>
    [prev_page_url] =>
    [from] => 1
    [to] => 1
    [data] => Array
        (
            [0] => Array
                (
                    [pos_id] => 1
                    [name] => Monetivo
                    [url] => https://monetivo.com
                    [contact_user] => Array
                        (
                            [name] => John
                            [email] => hello@monetivo.com
                            [phone] => +48123456789
                            [title] => Mr
                            [surname] => Doe
                        )

                    [enabled] => 1
                    [parameters] => Array
                        (
                            [url_notify] => https://monetivo.com/notify
                        )

                    [created_at] => 2016-12-09T12:24:15+0000
                    [updated_at] => 2016-12-09T12:24:15+0000
                )

        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/pos" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/pos

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Parametry żądania

Parametr Domyślnie Wymagany Opis
sort asc nie kolejność sortowania: asc (od najstarszego), desc (od najnowszego)
orderby - nie kolumna sortowania, patrz niżej
per_page - nie ilość wyników na stronę

Kolumny sortowania

Kolumna Opis
updated_at data zmiany statusu
created_at data utworzenia
pos_id sortowanie po identyfikatorze POS

Odpowiedź

Klucz Opis
total liczba wyników (POS)
per_page ilość wyników na stronę
current_page bieżąca strona z wynikami
last_page numer ostatniej strony z wynikami
next_page_url adres URL do pobrania następnej strony z wynikami
prev_page_url adres URL do pobrania poprzedniej strony z wynikami
from wyniki od
to wyniki do
data tablica zawierająca wyniki

POS

Klucz Opis
pos_id identyfikator POS
name nazwa POS
url adres URL POS
contact_user[name] imię osoby kontaktowej
contact_user[surname] nazwisko osoby kontaktowej
contact_user[email] adres email osoby kontaktowej
contact_user[phone] telefon osoby kontaktowej
contact_user[title] tytuł służbowy osoby kontaktowej
enabled POS aktywny
parameters[url_notify] adres URL do wysyłania powiadomień o zmianie statusu transakcji
created_at data utworzenia
updated_at data ostatniej edycji

Szczegóły POS

<?php

// autentykacja...

// pobieranie szczegółów POS o identyfikatorze 1
$identifier = '1';
$transaction = $api->pos()->details($identifier);

// Przykładowy zwrócony wynik:

Array
(
    [pos_id] => 1
    [name] => Monetivo
    [url] => https://monetivo.com
    [contact_user] => Array
        (
            [name] => John
            [email] => hello@monetivo.com
            [phone] => +48123456789
            [title] => Mr
            [surname] => Doe
        )

    [enabled] => 1
    [parameters] => Array
        (
            [url_notify] => https://monetivo.com/notify
        )

    [created_at] => 2016-12-09T12:24:15+0000
    [updated_at] => 2016-12-09T12:24:15+0000
)
curl "https://api.monetivo.com/v1/pos/1" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/pos/<POS_ID>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
POS_ID - tak identyfikator POS

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

POS

Klucz Opis
pos_id identyfikator POS
name nazwa POS
url adres URL POS
contact_user[name] imię osoby kontaktowej
contact_user[surname] nazwisko osoby kontaktowej
contact_user[email] adres email osoby kontaktowej
contact_user[phone] telefon osoby kontaktowej
contact_user[title] tytuł służbowy osoby kontaktowej
enabled POS aktywny
parameters[url_notify] adres URL do wysyłania powiadomień o zmianie statusu transakcji
created_at data utworzenia
updated_at data ostatniej edycji

Listowanie rachunków przypisanych do POS

<?php

// autentykacja...

// pobieranie rachunków przypisanych do POS o identyfikatorze 1
$identifier = '1';
$transaction = $api->pos()->accounts($identifier);

// Przykładowy zwrócony wynik:

Array
(
    [total] => 1
    [per_page] => 15
    [current_page] => 1
    [last_page] => 1
    [next_page_url] =>
    [prev_page_url] =>
    [from] => 1
    [to] => 1
    [data] => Array
        (
            [0] => Array
                (
                    [account_id] => 1
                    [pos_id] => 1
                    [currency] => PLN
                    [created_at] => 2016-12-09T13:24:15+0100
                )

        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/pos/1/accounts" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/pos/<POS_ID>/accounts

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
POS_ID - tak identyfikator POS

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
total liczba wyników (rachunków)
per_page ilość wyników na stronę
current_page bieżąca strona z wynikami
last_page numer ostatniej strony z wynikami
next_page_url adres URL do pobrania następnej strony z wynikami
prev_page_url adres URL do pobrania poprzedniej strony z wynikami
from wyniki od
to wyniki do
data tablica zawierająca wyniki

Przypisanie rachunku do POS

<?php

// autentykacja...

// przypisanie rachunku o identyfikatorze 4 do POS o identyfikatorze 1
$pos_identifier = '1';
$account_identifier = '4';
$transaction = $api->pos()->bindAccount($pos_identifier, $account_identifier);

// Przykładowy zwrócony wynik:

Array
(
    [total] => 1
    [per_page] => 15
    [current_page] => 1
    [last_page] => 1
    [next_page_url] =>
    [prev_page_url] =>
    [from] => 1
    [to] => 1
    [data] => Array
        (
            [0] => Array
                (
                    [account_id] => 4
                    [pos_id] => 1
                    [currency] => PLN
                    [created_at] => 2016-12-09T13:24:15+0100
                )

        )

    [httpCode] => 200
)
curl -X "POST" "https://api.monetivo.com/v1/pos/1/accounts/4" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

POST https://api.monetivo.com/v1/pos/<POS_ID>/accounts/<ACCOUNT_ID>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
POS_ID - tak identyfikator POS
ACCOUNT_ID - tak identyfikator rachunku

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
total liczba wyników (rachunków)
per_page ilość wyników na stronę
current_page bieżąca strona z wynikami
last_page numer ostatniej strony z wynikami
next_page_url adres URL do pobrania następnej strony z wynikami
prev_page_url adres URL do pobrania poprzedniej strony z wynikami
from wyniki od
to wyniki do
data tablica zawierająca wyniki

Usunięcie przypisania rachunku do POS

<?php

// autentykacja...

// przypisanie rachunku o identyfikatorze 4 do POS o identyfikatorze 1
$pos_identifier = '1';
$account_identifier = '4';
$transaction = $api->pos()->unbindAccount($pos_identifier, $account_identifier);

// Przykładowy zwrócony wynik:

Array
(
    [total] => 1
    [per_page] => 15
    [current_page] => 1
    [last_page] => 1
    [next_page_url] =>
    [prev_page_url] =>
    [from] => 1
    [to] => 1
    [data] => Array
        (
            [0] => Array
                (
                    [account_id] => 4
                    [pos_id] => 1
                    [currency] => PLN
                    [created_at] => 2016-12-09T13:24:15+0100
                )

        )

    [httpCode] => 200
)
curl -X "DELETE" "https://api.monetivo.com/v1/pos/1/accounts/4" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

DELETE https://api.monetivo.com/v1/pos/<POS_ID>/accounts/<ACCOUNT_ID>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
POS_ID - tak identyfikator POS
ACCOUNT_ID - tak identyfikator rachunku

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Rachunki

Tworzenie rachunku

<?php

// autentykacja...

 $params = array(
             'currency' => 'PLN',
             'name' => 'Rachunek testowy'
         );
 $transaction = $api->accounts()->create($params);

//Przykładowy zwrócony wynik:

Array
(
    [account_id] => 2
    [currency] => PLN
    [balance] => 0.00
    [name] => Rachunek testowy
    [created_at] => 2016-12-09T12:24:15+0000
    [updated_at] => 2017-01-03T15:18:41+0000
    [httpCode] => 200
)
curl -X "POST" "https://api.monetivo.com/v1/accounts" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
     --data-urlencode "currency=EUR" \
     --data-urlencode "name=Rachunek EUR"

Żądanie HTTP

POST https://api.monetivo.com/v1/accounts

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Parametry żądania

Parametr Domyślnie Wymagany Opis
currency - tak waluta rachunku
name - nie nazwa rachunku

Odpowiedź

Klucz Opis
account_id identyfikator rachunku
currency waluta
balance saldo na rachunku
name nazwa rachunku
created_at data utworzenia rachunku
updated_at data aktualizacji rachunku

Lista rachunków

<?php

// autentykacja...

// pobieranie listy rachunków

$accounts = $api->accounts()->listing();

// Przykładowy zwrócony wynik:

Array
(
    [total] => 2
    [per_page] => 15
    [current_page] => 1
    [last_page] => 1
    [next_page_url] =>
    [prev_page_url] =>
    [from] => 1
    [to] => 2
    [data] => Array
        (
            [0] => Array
                (
                    [account_id] => 2
                    [currency] => PLN
                    [balance] => 0.00
                    [name] => second PLN
                    [created_at] => 2016-12-15T15:15:00+0000
                    [updated_at] => 2016-12-15T15:15:00+0000
                )

            [1] => Array
                (
                    [account_id] => 1
                    [currency] => PLN
                    [balance] => 6337.54
                    [name] => Default PLN
                    [created_at] => 2016-12-09T12:24:15+0000
                    [updated_at] => 2017-01-03T15:18:41+0000
                )

        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/accounts" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QxLCJhbGciOiJIUzI1NiJ9.eyJpcCI6IjE3Mi4yMC4wLjEiLCJpc3MxOiJDUk9XRENPTU1VTklUWSIsIxV4cCI6MTQ5MTQ3ODxxMCwiZ2VuIjoxNDkxNDc4MDAwLCJ1c2VyX2lkIjoxfQ.QG8CU-4oZYueaDxnvWOGOYFa2DLD9mJ5zKMS7tcAeJ8" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/accounts

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
total liczba wyników (rachunków)
per_page ilość wyników na stronę
current_page bieżąca strona z wynikami
last_page numer ostatniej strony z wynikami
next_page_url adres URL do pobrania następnej strony z wynikami
prev_page_url adres URL do pobrania poprzedniej strony z wynikami
from wyniki od
to wyniki do
data tablica zawierająca wyniki

Szczegóły rachunku

<?php

// autentykacja...

// pobieranie szczegółów rachunku 1
$identifier = '1';
$account = $api->accounts()->details($identifier);

// Przykładowy zwrócony wynik:

Array
(
    [account_id] => 1
    [currency] => PLN
    [balance] => 6337.54
    [name] => Default PLN
    [created_at] => 2016-12-09T12:24:15+0000
    [updated_at] => 2017-01-03T15:18:41+0000
    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/accounts/1" \
     -H "X-Auth-Token: exJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpcCI6IxE3Mi4yMC4wLjEiLCJpc3MiOiJDUkxXRENPTU1VTklUWSIsImV4cCI6MTQ5MTQ4MDUwNixiZ2VuIjoxNDkxNDc5NjA2LCJ1c2VyX2lkIjoxfQ.wznV8luouhZXWOPLAyxXfsFrgo4N9mrq0Rz81hm48Pc" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/accounts/<ID>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ID - tak identyfikator rachunku

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
account_id identyfikator rachunku
currency waluta
balance saldo na rachunku
name nazwa rachunku
created_at data utworzenia rachunku
updated_at data aktualizacji rachunku

Raport rachunku

<?php

// autentykacja...

// pobieranie raportu z listą transakcji z rachunku 1 od dnia 2016-12-01

$report = $api->accounts()->report(1, \Monetivo\Api\Accounts::REPORT_TRANSACTIONS, ['date_from' => '2016-12-01']);

// Przykładowy zwrócony wynik:

Array
(
    [total] => 10
    [per_page] => 5
    [current_page] => 1
    [last_page] => 2
    [next_page_url] => https://api.monetivo.com/v1/accounts/1/report?page=2
    [prev_page_url] =>
    [from] => 1
    [to] => 15
    [data] => Array
        (
            [0] => Array
                (
                    [object_type] => 2
                    [amount] => 33.00
                    [currency] => PLN
                    [balance] => 6085.71
                    [operation_type] => 12
                    [operation_data] => Array
                        (
                            [name] => Jan Kowalski
                            [email] => jk@example.com
                            [order_id] => 7a085d21-xxxx-xxxx-xxxx-f5d8cef86636
                        )

                    [offer] => Array
                        (
                            [commission] => 0.36
                            [commission_rate] => 1.10
                            [commission_const] => 0.00
                        )

                    [identifier] => M8MXXXX
                    [created_at] => 2017-01-02T08:16:53+0000
                )

            [1] => Array
                (
                    [object_type] => 2
                    [amount] => -0.36
                    [currency] => PLN
                    [balance] => 6085.35
                    [operation_type] => 10
                    [operation_data] =>
                    [offer] =>
                    [identifier] => M8MXXXX
                    [created_at] => 2017-01-02T08:16:53+0000
                )

            [2] => Array
                (
                    [object_type] => 2
                    [amount] => 1.00
                    [currency] => PLN
                    [balance] => 6086.35
                    [operation_type] => 12
                    [operation_data] => Array
                        (
                            [name] => Anna Nowak
                            [email] => an@example.com
                            [order_id] => 2b20c8b7-xxxx-xxxx-xxxx-21fb52710f79
                        )

                    [offer] => Array
                        (
                            [commission] => 0.01
                            [commission_rate] => 1.10
                            [commission_const] => 0.00
                        )

                    [identifier] => M0LXXXX
                    [created_at] => 2017-01-02T15:00:49+0000
                )

            [3] => Array
                (
                    [object_type] => 2
                    [amount] => -0.01
                    [currency] => PLN
                    [balance] => 6086.34
                    [operation_type] => 10
                    [operation_data] =>
                    [offer] =>
                    [identifier] => M0LXXXX
                    [created_at] => 2017-01-02T15:00:49+0000
                )

            [4] => Array
                (
                    [object_type] => 2
                    [amount] => 1.00
                    [currency] => PLN
                    [balance] => 6087.34
                    [operation_type] => 12
                    [operation_data] => Array
                        (
                            [name] => J. Sobechuck
                            [email] => sopel2k@example.com
                            [order_id] => c900a485-xxxx-xxxx-xxxx-6112598fa0d9
                        )

                    [offer] => Array
                        (
                            [commission] => 0.01
                            [commission_rate] => 1.10
                            [commission_const] => 0.00
                        )

                    [identifier] => M0WXXXX
                    [created_at] => 2017-01-02T16:13:42+0000
                )

            [5] => Array
                (
                    [object_type] => 2
                    [amount] => -0.01
                    [currency] => PLN
                    [balance] => 6087.33
                    [operation_type] => 10
                    [operation_data] =>
                    [offer] =>
                    [identifier] => M0WXXXX
                    [created_at] => 2017-01-02T16:13:42+0000
                )
        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/accounts/3/report?type=2" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpcCI6IjE3Mi4yMC4wLjEiLCJpc3MiOiJDUk9XRENPTU1VTklUWSIsImV4cCI6MTQ5MTQ4MDUwNiwiZ2VuIjoxNDkxNDc5NjA2LCJ1c2VyX2lkIjoxfQ.wznV8luouhZXWOPLAypXfsFrgo4N9mrq0Rz81hm48Pc" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Wyniki posortowane są po identyfikatorze operacji

Żądanie HTTP

GET https://api.monetivo.com/v1/accounts/<ID>/report?type=<TYPE>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ID - tak identyfikator rachunku
TYPE - tak typ raportu (patrz poniżej); można określić wiele typów poprzez rozdzielenie przecinkiem
date_from - nie data od
date_to - nie data do
order asc nie kolejność sortowania: asc (od najstarszej), desc (od najnowszej)
offset - nie pomiń x wyników
limit - nie limit ilości zwracanych wyników

Obsługiwane typy raportów:

Typ Opis
1 wypłaty
2 transakcje
4 zwroty
32 obciążenia

Pozycja raportu

Klucz Opis
object_type typ operacji
amount kwota operacji
currency waluta
balance saldo po operacji
operation_data szczegóły operacji
offer szczegóły zastosowanej oferty
identifier identyfikator powiązanego obiektu
created_at data utworzenia pozycji

Rachunki bankowe

Lista rachunków bankowych

<?php

// autentykacja...

// pobieranie listy rachunków bankowych

$accounts = $api->bankAccounts()->listing();

// Przykładowy zwrócony wynik:
Array
(
    [total] => 0
    [per_page] => 15
    [current_page] => 1
    [last_page] => 0
    [next_page_url] =>
    [prev_page_url] =>
    [from] =>
    [to] =>
    [data] => Array
        (
        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/bank_accounts" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/bank_accounts

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
total liczba wyników (rachunków bankowych)
per_page ilość wyników na stronę
current_page bieżąca strona z wynikami
last_page numer ostatniej strony z wynikami
next_page_url adres URL do pobrania następnej strony z wynikami
prev_page_url adres URL do pobrania poprzedniej strony z wynikami
from wyniki od
to wyniki do
data tablica zawierająca wyniki

Szczegóły rachunku bankowego

<?php

// autentykacja...

// pobieranie szczegółów rachunku bankowego 1
$identifier = '1';
$account = $api->bankAccounts()->details($identifier);

// Przykładowy zwrócony wynik:
Array
(
    [merchant_account_id] => 1
    [account_number] => 60102010260000042270201111
    [name] => Monetivo
    [address] => Botaniczna 8
    [description] => rachunek podstawowy
    [verified_at] =>
    [created_at] =>

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/bank_accounts/1" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/bank_accounts/<ID>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ID - tak identyfikator rachunku bankowego

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Wypłaty

Funkcjonalność wypłat pozwala na transfer środków z konta Merchanta w systemie Monetivo na konto bankowe.

Zlecenie wypłaty

<?php

// autentykacja...

// tworzenie zlecenia wypłaty środków

$account_id = '1';
$payout = $api->payouts()->create($account_id);

// Przykładowy zwrócony wynik:

Array
(
    [identifier] => 1
    [account_number] => 60102010260000042270201111
    [account_name] => Default PLN
    [account_address] => Botaniczna 8, Poznan
    [amount] => 1000.00
    [status] => 1
    [status_history] => Array (

      )
    [account_id] => 1
    [currency] => PLN
    [committed_at] =>

    [httpCode] => 200
)
curl -X "POST" "https://api.monetivo.com/v1/accounts/1/payouts" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

POST https://api.monetivo.com/v1/accounts/<ACCOUNT_ID>/payouts

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
ACCOUNT_ID - tak identyfikator rachunku w systemie Monetivo

Odpowiedź

Klucz Opis
identifier identyfikator wypłaty
account_number numer rachunku bankowego na który zlecono wypłatę
account_name nazwa odbiorcy płatności
account_address adres odbiorcy płatności
amount kwota
status status, patrz niżej
status_history historia zmiana statusu
account_id identyfikator rachunku w systemie Monetivo
currency waluta
committed_at data wykonania

Statusy wypłaty

Wartość Opis
1 nowa wypłata, status początkowy
4 zlecenie wypłaty przekazane do banku

Lista wypłat

<?php

// autentykacja...

// pobieranie listy wypłat

$payouts = $api->payouts()->listing();

// Przykładowy zwrócony wynik:
Array
(
    [total] => 0
    [per_page] => 15
    [current_page] => 1
    [last_page] => 0
    [next_page_url] =>
    [prev_page_url] =>
    [from] =>
    [to] =>
    [data] => Array
        (
        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/payouts" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/payouts

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
total liczba wyników (wypłat)
per_page ilość wyników na stronę
current_page bieżąca strona z wynikami
last_page numer ostatniej strony z wynikami
next_page_url adres URL do pobrania następnej strony z wynikami
prev_page_url adres URL do pobrania poprzedniej strony z wynikami
from wyniki od
to wyniki do
data tablica zawierająca wyniki

Szczegóły wypłaty

<?php

// autentykacja...

// pobieranie szczegółów wypłaty o identyfikatorze M12345
$identifier = 'P12345';
$payout = $api->payouts()->details($identifier);

// Przykładowy zwrócony wynik:

Array
(
    [identifier] => 12345
    [account_number] => 60102010260000042270201111
    [account_name] => Default PLN
    [account_address] => Botaniczna 8, Poznan
    [amount] => 1000.00
    [status] => 2
    [status_history] => Array (

      )
    [account_id] => 1
    [currency] => PLN
    [committed_at] =>

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/payouts/P12345" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/payouts/<PAYOUT_ID>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
PAYOUT_ID - tak identyfikator wypłaty

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
identifier identyfikator wypłaty
account_number numer rachunku bankowego na który zlecono wypłatę
account_name nazwa odbiorcy płatności
account_address adres odbiorcy płatności
amount kwota
status status, patrz niżej
status_history historia zmiana statusu
account_id identyfikator rachunku w systemie Monetivo
currency waluta
committed_at data wykonania

Adresy

Do konta merchanta przypisane są dane adresowe. Dane mogą posiadać następujący typ:

Typ Opis
registration adres podawany przy rejestracji
correspondence adres korespondencyjny

Lista adresów

<?php

// autentykacja...

// pobieranie adresu do korespondencji

$addresses = $api->addresses()->listing(\Monetivo\Api\Addresses::TYPE_CORRESPONDENCE);

// Przykładowy zwrócony wynik:

Array
(
    [zip] => 60-586
    [city] => Poznań
    [block] => 8
    [phone] => +48123456789
    [street] => ul. Botaniczna
    [country] => POL
    [companyname] => Monetivo
    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/addresses/correspondence" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8"

Żądanie HTTP

GET https://api.monetivo.com/v1/addresses/<TYPE>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
TYPE - tak Typ adresu, patrz tabela wyżej

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Aktualizacja adresu

<?php

// autentykacja...

// aktualizacja adresu do korespondencji - zmiana miasta

$address = $api->addresses()->update(\Monetivo\Api\Addresses::TYPE_CORRESPONDENCE, ['city' => 'Poznań']);

// Przykładowy zwrócony wynik:

Array
(
    [zip] => 60-586
    [city] => Poznań
    [block] => 8
    [phone] => +48123456789
    [street] => ul. Botaniczna
    [country] => POL
    [companyname] => Monetivo
    [httpCode] => 200
)
curl -X "PUT" "https://api.monetivo.com/v1/addresses/correspondence" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \
     --data-urlencode "city=Poznan" \

Żądanie HTTP

PUT https://api.monetivo.com/v1/addresses/<TYPE>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
TYPE - tak Typ adresu, patrz tabela wyżej

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Parametry żądania

Parametr Domyślnie Wymagany Opis
zip - tak Kod pocztowy
city - tak Miasto
block - tak Nr mieszkania/lokalu
phone - tak Telefon
street - tak Ulica
country - tak Państwo (w formacie ISO 3166-1 alpha-2)
companyname - tak Nazwa firmy

Oferta

Oferta obejmuje informacje o prowizjach pobieranych przez Monetivo. Obecnie wyróżniamy dwa typy oferty:

Typ oferty Opis
payments oferta dotycząca płatności (prowizje za płatność w kanale)
services oferta dotycząca usług (prowizje za poszczególne usługi udostępniane przez Monetivo merchantowi)

Lista ofert

<?php

// autentykacja...

// pobieranie listy ofert dla udostępnionych usług

$offers = $api->offer()->listing(\Monetivo\Api\Offer::TYPE_PAYMENTS);

// Przykładowy zwrócony wynik:

Array
(
    [0] => Array
        (
            [channel_id] => 1
            [channel_name] => Blik
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [1] => Array
        (
            [channel_id] => 2
            [channel_name] => mTransfer
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [2] => Array
        (
            [channel_id] => 3
            [channel_name] => Płać z ING
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [3] => Array
        (
            [channel_id] => 4
            [channel_name] => Pekao24Przelew
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [4] => Array
        (
            [channel_id] => 5
            [channel_name] => Przelew24 BZWBK
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [5] => Array
        (
            [channel_id] => 6
            [channel_name] => Płacę z Alior Bankiem
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [6] => Array
        (
            [channel_id] => 7
            [channel_name] => Płacę z IPKO
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [7] => Array
        (
            [channel_id] => 8
            [channel_name] => Płacę z Inteligo
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [8] => Array
        (
            [channel_id] => 9
            [channel_name] => Millennium Bank PBL
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [9] => Array
        (
            [channel_id] => 10
            [channel_name] => CA przelew online
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [10] => Array
        (
            [channel_id] => 11
            [channel_name] => T-Mobile Usługi Bankowe
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [11] => Array
        (
            [channel_id] => 12
            [channel_name] => Deutsche Bank
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [12] => Array
        (
            [channel_id] => 13
            [channel_name] => BPH Przelew
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [13] => Array
        (
            [channel_id] => 14
            [channel_name] => BGŻ BNP Paribas
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [14] => Array
        (
            [channel_id] => 15
            [channel_name] => Eurobank - płatność online
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [15] => Array
        (
            [channel_id] => 16
            [channel_name] => PBS PBL
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [16] => Array
        (
            [channel_id] => 17
            [channel_name] => r-Przelew
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [17] => Array
        (
            [channel_id] => 18
            [channel_name] => Toyota Bank Pay Way
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [18] => Array
        (
            [channel_id] => 19
            [channel_name] => BSWSCHOWA PBL
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [19] => Array
        (
            [channel_id] => 20
            [channel_name] => Płać z BOŚ Bank
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [20] => Array
        (
            [channel_id] => 21
            [channel_name] => Getin Bank
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [21] => Array
        (
            [channel_id] => 22
            [channel_name] => Płacę z Orange
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [22] => Array
        (
            [channel_id] => 23
            [channel_name] => Płacę z Citi Handlowy
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [23] => Array
        (
            [channel_id] => 24
            [channel_name] => e-transfer Pocztowy24
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [24] => Array
        (
            [channel_id] => 25
            [channel_name] => Płacę z PLUS BANK
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [25] => Array
        (
            [channel_id] => 26
            [channel_name] => Noble Bank
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [26] => Array
        (
            [channel_id] => 27
            [channel_name] => Inny bank
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [27] => Array
        (
            [channel_id] => 28
            [channel_name] => Karty SixPay
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [28] => Array
        (
            [channel_id] => 29
            [channel_name] => Sofort
            [commission_rate] => 1.90
            [commission_const] => 0.00
        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/offer/payments" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \

Żądanie HTTP

GET https://api.monetivo.com/v1/offer/<TYPE>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
TYPE - tak typ oferty, patrz tabela wyżej

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Szczegóły oferty

<?php

// autentykacja...

// pobranie szczegółów oferty dotyczącej usługi o identyfikatorze 18

$offer = $api->offer()->details(\Monetivo\Api\Offer::TYPE_SERVICES, 18);

// Przykładowy zwrócony wynik:

Array
(
    [0] => Array
        (
            [service_id] => 18
            [service_name] => account_locked_operation
            [commission_rate] => 0.00
            [commission_const] => 0.00
        )

    [httpCode] => 200
)
curl "https://api.monetivo.com/v1/offer/services/18" \
     -H "X-Auth-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Im5pY2UgdHJ5IDspIiwiaWF0IjoxNDkxNTQ5ODE0LCJleHAiOjE0OTE1NTM1NzUsImp0aSI6IjhiNmQwYmQyLWE0ZGEtNDVjYi05MTU5LWZmZTc2NmFjMmU5MyJ9.iQj7wi5eLkqX_mGhuTP89xpw2cjM-qx6T1gvDpUGljI" \
     -H "X-API-Token: prod_3cd89e58-xxxx-xxxx-xxxx-ee804b8a2ecf" \
     -H "Content-Type: application/x-www-form-urlencoded; charset=utf-8" \

Żądanie HTTP

GET https://api.monetivo.com/v1/offer/<TYPE>/<ID>

Parametry URL żądania

Parametr Domyślnie Wymagany Opis
TYPE - tak typ adresu, patrz tabela wyżej
ID - tak identyfikator oferty (service_id)

Nagłówki żądania

Nagłówek Domyślnie Wymagany Opis
X-API-Token - tak token aplikacji
X-Auth-Token - tak token użytkownika

Odpowiedź

Klucz Opis
service_id identyfikator usługi
service_name nazwa usługi
commission_rate stawka prowizji
commission_const prowizja w postaci stałej opłaty