api panelu administracyjnego sprzedawcy

Dział Pomocy Technicznej Dotpay
ul. Wielicka 72, 30-552 Kraków
tel. +48 12 688 26 00
faks +48 12 688 26 49
e-mail: [email protected]
API PANELU ADMINISTRACYJNEGO SPRZEDAWCY
Wersja 1.35.4.1
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
SPIS TREŚCI
Strona | 2 / 61
WSTĘP .................................................................................................................................................................. 3
I. CHARAKTERYSTYKA I ADRES INTERFEJSU ..................................................................................................... 4
II. UWIERZYTELNIANIE I AUTORYZACJA ........................................................................................................... 5
III. FORMAT DANYCH WEJŚCIA / WYJŚCIA ........................................................................................................ 6
IV. PAGINACJA ..................................................................................................................................................... 8
V. ZASOBY ..........................................................................................................................................................10
V. 1.
ACCOUNTS/ (LISTA SKLEPÓW (ID) UŻYTKOWNIKA) .............................................................................................. 10
accounts/(int: account_id)/ (szczegóły sklepu (ID) ) ......................................................................................... 13
accounts/(int: account_id)/channels/ (lista kanałów płatności sklepu (ID) ) ................................................... 15
accounts/(int: account_id)/payment_links/ (utworzenie linku płatniczego) .................................................... 18
accounts/(int: account_id)/payment_links/(string: token)/ (usunięcie linku płatniczego)............................... 24
accounts/(int: account_id)/payment_links/ (lista linków płatniczych) ............................................................. 26
accounts/(int: account_id)/payment_links/(string: token)/ (szczegóły linku płatniczego) .............................. 31
accounts/(int: account_id)/payout/ (wypłata środków z salda sklepu (ID) ) .................................................... 34
V. 2.
OPERATIONS/ (LISTA OPERACJI) ...................................................................................................................... 37
operations/(string: operation_number)/ (szczegóły pojedynczej operacji) ...................................................... 42
operations/(string: operation_number)/operations/ (lista operacji zawartych w operacji payout) ................ 45
V. 3.
PAYMENTS/ (LISTA OPERACJI PŁATNOŚCI) .......................................................................................................... 48
payments/(string: operation_number)/ (szczegóły pojedynczej operacji płatności) ........................................ 49
payments/(string: operation_number)/mark_as_complete/ (oznaczenie flagą „complete”) .......................... 50
payments/(string: operation_number)/mark_as_complete/ (usunięcie flagi „complete”) ............................. 52
payments/(string: operation_number)/refund/ (zwrot operacji płatności) ..................................................... 54
V. 4.
V1/REPORTS/ (LISTA RAPORTÓW) ................................................................................................................... 56
TABELA ROUTINGU ..........................................................................................................................................59
DZIENNIK ZMIAN ..............................................................................................................................................61
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
WSTĘP
Niniejszy dokument opisuje interfejs systemu płatności oferowanego przez serwis dotpay i przeznaczony
jest zarówno dla podmiotów zainteresowanych ofertą serwisu, jak i osób zajmujących się wdrożeniem systemu.
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 3 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
I. CHARAKTERYSTYKA I ADRES INTERFEJSU
Strona | 4 / 61
API panelu administracyjnego Sprzedawcy został wykonany w stylu architektury REST.
Adresy pod którymi dostępny jest interfejs to:
środowisko produkcyjne:
https://ssl.dotpay.pl/s2/login/api/
środowisko testowe:
https://ssl.dotpay.pl/test_seller/api/
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
II. UWIERZYTELNIANIE I AUTORYZACJA
Uwierzytelnianie do API następuje poprzez podanie (metodą HTTP Basic authentication) loginu i hasła
użytkownika analogicznych dla danych logowania do GUI panelu administracyjnego Sprzedawcy.
Po wywołaniu danego zasobu API zostanie zwrócona odpowiedź z odpowiednim kodem odpowiedzi HTTP.
Przykładowo dla zasobu:
https://ssl.dotpay.pl/test_seller/api/accounts/
po wykonaniu żądania z błędnym loginem / hasłem:
nagłówki żądania:
GET /test_seller/api/accounts/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Content-Type: application/json
Authorization: Basic ZGFzZGFzOmRhc2RzYQ==
zostanie zwrócona odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 401 Unauthorized
Content-Type: application/json
WWW-Authenticate: Basic realm="api"
Vary: Accept
Allow: GET, HEAD, OPTIONS
odpowiedź:
{
"detail": "Invalid username/password"
}
Jeśli zaistnieje taka potrzeba, to jak w powyższym przykładzie zostanie zwrócona własność detail
z tekstowym opisem błędu.
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
401 Unauthorized
403 Forbidden
OPIS
ok
nie udało się uwierzytelnić
brak uprawnień
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 5 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
III. FORMAT DANYCH WEJŚCIA / WYJŚCIA
Strona | 6 / 61
API ma możliwość komunikacji w formacie json (domyślnie) lub xml. Wybór formatowania odbywa się za
pomocą przesłania nagłówków Accept oraz Content-Type lub dodatkowego parametru format (przekazanego
metodą GET), którego wartością jest nazwa danego formatu (json lub xml).
Przykładowo dla żądania zasobu:
https://ssl.dotpay.pl/test_seller/api/accounts/
z nagłówkami:
GET /test_seller/api/accounts/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Content-Type: application/json
zostanie zwrócona odpowiedź:
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"href": "https://ssl.dotpay.pl/test_seller/api/accounts/443005/",
"id": "443005",
"status": "active",
"name": "Hoan Kiem Megastore",
"mcc_code": "7273",
"main_url": "http://www.example.com/",
"config": {
"urlc": "http://www.example.com/confirmation/",
"block_external_urlc": false,
"pin": "eMhbAulyaQKnFORbRL2EwK0hHZ5C7rkX"
}
}
]
}
dla nagłówków:
GET /test_seller/api/accounts/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/xml
Content-Type: application/xml
zostanie zwrócona odpowiedź:
<root>
<count>1</count>
<next><next/>
<previous><previous/>
<results>
<list-item>
<href>https://ssl.dotpay.pl/test_seller/api/accounts/443005/</href>
<id>443005</id>
<status>active</status>
<name>Hoan Kiem Megastore</name>
<mcc_code>7273</mcc_code>
<main_url>http://www.example.com/</main_url>
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
<config>
<urlc>http://www.example.com/confirmation/</urlc>
<block_external_urlc>False</block_external_urlc>
<pin>eMhbAulyaQKnFORbRL2EwK0hHZ5C7rkX</pin>
</config>
</list-item>
</results>
</root>
W przypadku wywołania zasobów z parametrem format (jak w poniższych przykładach), API zwróci
odpowiedź analogiczną do powyższych.
https://ssl.dotpay.pl/test_seller/api/accounts/?format=json
https://ssl.dotpay.pl/test_seller/api/accounts/?format=xml
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 7 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
IV. PAGINACJA
Strona | 8 / 61
Dla żądań wymagających zwrócenia większej ilości danych odpowiedź API jest paginowana (domyślnie dla
jednej strony wyświetlane jest maksymalnie 100 elementów). Odpowiedź zawiera własności next oraz
previous, w których znajduje się adres kolejnej / poprzedniej strony odpowiedzi, natomiast we własności count
znajduje się ilość obiektów zwróconych w całej odpowiedzi.
Znaczenie parametrów możliwych do przesyłania w żądaniu w celu filtrowania odpowiedzi:
WŁASNOŚĆ
TYP
ZNACZENIE / OPIS
page
int
numer strony
page_size
int
Ilość elementów wyświetlana na jednej
stronie
minimalna wartość: 1
maksymalna wartość: 100
Przykładowo dla zasobu:
https://ssl.dotpay.pl/test_seller/api/operations/?page=2
zostanie zwrócona odpowiedź jak poniższy fragment:
{
"count": 538,
"next": "https://ssl.dotpay.pl/test_seller/api/operations/?page=3",
"previous": "https://ssl.dotpay.pl/test_seller/api/operations/",
"results": [
{
"href": "https://ssl.dotpay.pl/test_seller/api/operations/M1226-8222/",
"number": "M1226-8222",
"creation_datetime": "2015-04-29T10:28:25.187213",
"type": "payment",
"status": "new",
"amount": "41.00",
"currency": "PLN",
"original_amount": "10.23",
"original_currency": "EUR",
"account_id": "443005",
"related_operation": null,
"description": "Zamowienie 839574",
"control": "Bdt1Gc2Q2iRQ1EeW",
"payer": {
"first_name": "Jan",
"last_name": "Kowalski",
"email": "[email protected]"
}
},
{
"href": "https://ssl.dotpay.pl/test_seller/api/operations/M1512-0298/",
"number": "M1512-0298",
"creation_datetime": "2015-04-28T10:59:33.753832",
"type": "payment",
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
"status": "completed",
"amount": "1.00",
"currency": "PLN",
"original_amount": "1.00",
"original_currency": "PLN",
"account_id": "443005",
"related_operation": null,
"description": "Order 1265",
"control": "ahh39mgmywm3wm4azzo18ja0y2fknzfz",
"payer": {
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]"
}
},
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 9 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
V. ZASOBY
Strona | 10 / 61
V. 1. accounts/
(lista sklepów (ID) użytkownika)
Zasób zwraca listę wszystkich sklepów, do których zalogowany użytkownik posiada uprawnienia.
przykładowe żądanie:
nagłówki żądania:
GET /test_seller/api/accounts/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
odpowiedź:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"href": "https://ssl.dotpay.pl/test_seller/api/accounts/470707/",
"id": "470707",
"status": "active",
"name": "HK Test 2",
"mcc_code": "3709",
"main_url": null,
"config": {
"urlc": "http://www.example.com/urlc_confirmation/",
"block_external_urlc": true,
"pin": "74fr6JxOy5jxJ2Qz"
}
},
{
"href": "https://ssl.dotpay.pl/test_seller/api/accounts/443005/",
"id": "443005",
"status": "active",
"name": "Hoan Kiem Megastore",
"mcc_code": "7273",
"main_url": "http://www.example.com/",
"config": {
"urlc": "http://www.example.com/confirmation/",
"block_external_urlc": false,
"pin": "eMhbAulyaQKnFORbRL2EwK0hHZ5C7rkX"
}
}
]
}
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Znaczenie własności zwracanych w tablicy results:
WŁASNOŚĆ
TYP
ZNACZENIE / OPIS
href
string
adres API, pod którym znajduje się odpowiedź dla
danego sklepu (ID)
id
int
numer sklepu (ID)
status
string
status sklepu (ID)
name
string
nazwa sklepu (ID)
mcc_code
string
kod kategorii sprzedaży (MCC)
main_url
string
adres sprzedażowy sklepu (ID)
config.urlc
string
adres powiadomień urlc
config.block_external_urlc
bool
blokuj zewnętrzne urlc
config.pin
string
PIN
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/accounts/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 11 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
odpowiedź:
Strona | 12 / 61
HTTP status code: 200
------------------------stdClass Object
(
[count] => 2
[next] =>
[previous] =>
[results] => Array
(
[0] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/accounts/470707/
[id] => 470707
[status] => active
[name] => HK Test 2
[mcc_code] => 3709
[main_url] =>
[config] => stdClass Object
(
[urlc] => http://www.example.com/urlc_confirmation/
[block_external_urlc] => 1
[pin] => 74fr6JxOy5jxJ2Qz
)
)
[1] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/accounts/443005/
[id] => 443005
[status] => active
[name] => Hoan Kiem Megastore
[mcc_code] => 7273
[main_url] => http://www.example.com/
[config] => stdClass Object
(
[urlc] => http://www.example.com/confirmation/
[block_external_urlc] =>
[pin] => eMhbAulyaQKnFORbRL2EwK0hHZ5C7rkX
)
)
)
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
accounts/(int: account_id)/
(szczegóły sklepu (ID) )
Zasób zwraca szczegóły danego sklepu (ID) do którego zalogowany użytkownik posiada uprawnienia.
przykładowe żądanie:
nagłówki żądania:
GET /test_seller/api/accounts/443005/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
odpowiedź:
{
"href": "https://ssl.dotpay.pl/test_seller/api/accounts/443005/",
"id": "443005",
"status": "active",
"name": "Hoan Kiem Megastore",
"mcc_code": "7273",
"main_url": "http://www.example.com/",
"config": {
"urlc": "http://www.example.com/confirmation/",
"block_external_urlc": false,
"pin": "eMhbAulyaQKnFORbRL2EwK0hHZ5C7rkX"
}
}
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
404 Not Found
OPIS
ok
nie znaleziono sklepu
Własności zwrócone w odpowiedzi zostały opisane w rozdziale accounts (lista sklepów (ID) użytkownika)
powyżej.
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 13 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
Strona | 14 / 61
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/accounts/443005/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
odpowiedź:
HTTP status code: 200
------------------------stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/accounts/443005/
[id] => 443005
[status] => active
[name] => Hoan Kiem Megastore
[mcc_code] => 7273
[main_url] => http://www.example.com/
[config] => stdClass Object
(
[urlc] => http://www.example.com/confirmation/
[block_external_urlc] =>
[pin] => ueVBmSZa6ESmHi9V74fr6JxOy5jxJ2Qz
)
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
accounts/(int: account_id)/channels/
(lista kanałów płatności sklepu (ID) )
Zasób zwraca listę dostępnych kanałów płatności dla danego sklepu (ID).
przykładowe żądanie:
nagłówki żądania:
GET /test_seller/api/accounts/443005/channels/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
fragment odpowiedzi:
[
{
"id": 0,
"name": "Credit cards",
"logo": "https://ssl.dotpay.pl/test_payment/cloudfs2/magellan_media/
payment_channel_logo/51651fe3dadfce4f1697d53b/",
"group": "credit_cards",
"is_blocked_by_seller": false,
"is_disabled": false,
"is_offline": false
},
{
"id": 77,
"name": "FerBuy",
"logo": "https://ssl.dotpay.pl/test_payment/cloudfs2/magellan_media/
payment_channel_logo/5582b7e8eb0a1945e1bafcb2/",
"group": "fast_transfers",
"is_blocked_by_seller": false,
"is_disabled": false,
"is_offline": false
},
{
"id": 21,
"name": "VIA - Moje Rachunki",
"logo": "https://ssl.dotpay.pl/test_payment/cloudfs2/magellan_media/
payment_channel_logo/5304f103eb0a197367152088/",
"group": "cash",
"is_blocked_by_seller": false,
"is_disabled": false,
"is_offline": false
},
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 15 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
Strona | 16 / 61
OPIS
200 OK
ok
404 Not Found
nie znaleziono sklepu
Znaczenie własności zwracanych w odpowiedzi:
WŁASNOŚĆ
TYP
ZNACZENIE / OPIS
id
int
numer kanału płatności
name
string
nazwa kanału płatności
logo
string
adres url, pod którym znajduje się logotyp kanału
płatności
group
string
grupa do jakiej należy kanał płatności
is_blocked_by_seller
bool
blokada kanału przez Sprzedawcę
is_disabled
bool
kanał wyłączony
is_offline
bool
kanał w trybie offline, tj. nie jest w stanie zaksięgować
płatności w czasie rzeczywistym
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/accounts/443005/channels/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
print_r(json_decode($response));
echo '</pre>';
?>
Strona | 17 /61
fragment odpowiedzi:
HTTP status code: 200
------------------------Array
(
[0] => stdClass Object
(
[id] => 0
[name] => Credit cards
[logo] => https://ssl.dotpay.pl/test_payment/cloudfs2/magellan_media/
payment_channel_logo/51651fe3dadfce4f1697d53b/
[group] => credit_cards
[is_blocked_by_seller] =>
[is_disabled] =>
[is_offline] =>
)
[1] => stdClass Object
(
[id] => 77
[name] => FerBuy
[logo] => https://ssl.dotpay.pl/test_payment/cloudfs2/magellan_media/
payment_channel_logo/5582b7e8eb0a1945e1bafcb2/
[group] => fast_transfers
[is_blocked_by_seller] =>
[is_disabled] =>
[is_offline] =>
)
[2] => stdClass Object
(
[id] => 21
[name] => VIA - Moje Rachunki
[logo] => https://ssl.dotpay.pl/test_payment/cloudfs2/magellan_media/
payment_channel_logo/5304f103eb0a197367152088/
[group] => cash
[is_blocked_by_seller] =>
[is_disabled] =>
[is_offline] =>
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
accounts/(int: account_id)/payment_links/
Strona | 18 / 61
(utworzenie linku płatniczego)
Zasób pozwala stworzyć link płatniczy dla danego sklepu (ID).
przykładowe żądanie:
nagłówki żądania:
POST /test_seller/api/accounts/443005/payment_links/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
żądanie:
{
"amount": "99.11",
"currency": "PLN",
"description": "Payment for 586930 order",
"control": "202cb962ac59075b964b07152d234b70",
"language": "pl",
"channel_id": 4,
"ch_lock": "1",
"onlinetransfer": "1",
"redirection_type": "0",
"buttontext": "return",
"url": "http://www.example.com/thanks_page.php",
"urlc": "http://www.example.com/confirmation/",
"expiration_datetime": "2015-12-01T16:48:00",
"payer": {
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]",
"phone": "+48123456789",
"address": {
"street": "Wielicka",
"building_number": 72,
"postcode": "30-552",
"city": "Krakow",
"region": "Malopolska",
"country": "POL"
}
},
"recipient": {
"account_number": "PL92942215610877228680536980",
"company": "PJ Shop",
"first_name": "Patrick",
"last_name": "Jones",
"address": {
"street": "Marszalkowska",
"building_number": 100,
"postcode": "00-576",
"city": "Warszawa"
}
}
}
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 201 Created
Content-Type: application/json
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
Location: https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/5e60d3r728trixvagqj7bds19r0irm31/
Strona | 19 /61
odpowiedź:
{
"href": "https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/5e60d3r728trixvagqj7bds19r0irm31/",
"payment_url": "https://ssl.dotpay.pl/test_payment/
?pid=5e60d3r728trixvagqj7bds19r0irm31",
"token": "5e60d3r728trixvagqj7bds19r0irm31",
"amount": "99.11",
"currency": "PLN",
"description": "Payment for 586930 order",
"control": "202cb962ac59075b964b07152d234b70",
"language": "pl",
"channel_id": 4,
"ch_lock": true,
"onlinetransfer": true,
"redirection_type": 0,
"buttontext": "return",
"url": "http://www.example.com/thanks_page.php",
"urlc": "http://www.example.com/confirmation/",
"expiration_datetime": "2015-12-01T16:48:00",
"payer": {
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]",
"phone": "+48123456789",
"address": {
"street": "Wielicka",
"building_number": "72",
"flat_number": null,
"postcode": "30-552",
"city": "Krakow",
"region": "Malopolska",
"country": "POL"
}
},
"recipient": {
"account_number": "PL92 9422 1561 0877 2286 8053 6980",
"company": "PJ Shop",
"first_name": "Patrick",
"last_name": "Jones",
"address": {
"street": "Marszalkowska",
"building_number": "100",
"flat_number": null,
"postcode": "00-576",
"city": "Warszawa"
}
}
}
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
201 Created
OPIS
utworzono link
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
404 Not Found
Strona | 20 / 61
nie znaleziono sklepu
Znaczenie własności przesyłanych w żądaniu (z wyjątkiem href, payment_url, token) oraz zwracanych
w odpowiedzi:
WŁASNOŚĆ
TYP
ZNACZENIE / OPIS
href
string
adres API, pod którym znajdują się szczegóły
utworzonego linku
payment_url
string
wygenerowany link płatniczy
token
string
token identyfikujący płatność
amount
decimal
kwota
currency
string
waluta
format: ISO 4217
description
string
opis płatności
control
string
parametr pozwalający na przechowanie ciągu
(np. numeru zamówienia ze sklepu Sprzedawcy)
o długości do 1000 znaków. Parametr w formie
niezmienionej jest odsyłany do serwisu
Sprzedawcy w powiadomieniu URLC
language
string
język
format: ISO 639-1
channel_id
string
numer kanału płatności
ch_lock
string
zablokowanie określonego kanału płatności
onlinetransfer
string
sposób wyświetlenia kanałów offline na stronie
płatności
UWAGA: parametr tymczasowo niedostępny
redirection_type
string
metoda odwołania do serwisu Sprzedawcy po
dokonanej płatności
buttontext
string
treść przycisku powrotu do serwisu sprzedawcy
url
string
adres na który jest realizowany powrót do
Sprzedawcy
urlc
string
adres na który zostanie przesłana notyfikacja
URLC
expiration_datetime
string
data ważności linku
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
format: YYYY-MM-DDTHH:MM:SS
payer.first_name
string
imię osoby płacącej
payer.last_name
string
nazwisko osoby płacącej
payer.email
string
email osoby płacącej
payer.phone
string
telefon osoby płacącej
payer.address.street
string
ulica
payer.address.building_number
string
numer budynku
payer.address.flat_number
string
numer mieszkania
payer.address.postcode
string
kod pocztowy
payer.address.city
string
miasto
payer.address.region
string
region
payer.address.country
string
państwo
format: ISO 3166-1 alfa-3
recipient.account_number
string
numer rachunku odbiorcy płatności
format: IBAN
recipient.company
string
nazwa firmy odbiorcy płatności
recipient.first_name
string
imię odbiorcy płatności
recipient.last_name
string
nazwisko odbiorcy płatności
recipient.address.street
string
ulica
recipient.address.building_number
string
numer budynku
recipient.address.flat_number
string
numer mieszkania
recipient.address.postcode
string
kod pocztowy
recipient.address.city
string
miasto
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 21 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Strona | 22 / 61
<?php
$fields = array(
'amount' => '99.11',
'currency' => 'PLN',
'description' => 'Payment for 586930 order',
'control' => '202cb962ac59075b964b07152d234b70',
'language' => 'pl',
'channel_id' => 4,
'ch_lock' => "1",
'onlinetransfer' => "1",
'redirection_type' => "0",
'buttontext' => "return",
'url' => 'http://www.example.com/thanks_page.php',
'urlc' => 'http://www.example.com/confirmation/',
'expiration_datetime' => '2015-12-01T16:48:00',
'payer' => array(
'first_name' => 'John',
'last_name' => 'Smith',
'email' => '[email protected]',
'phone' => '+48123456789',
'address' => array(
'street' => 'Wielicka',
'building_number' => 72,
'postcode' => '30-552',
'city' => 'Krakow',
'region' => 'Malopolska',
'country' => 'POL')
),
'recipient' => array(
'account_number' => 'PL92942215610877228680536980',
'company' => 'PJ Shop',
'first_name' => 'Patrick',
'last_name' => 'Jones',
'address' => array(
'street' => 'Marszalkowska',
'building_number' => 100,
'postcode' => '00-576',
'city' => 'Warszawa')
),
);
$data=json_encode($fields);
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/api/
accounts/443005/payment_links/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
curl_setopt ($ch, CURLOPT_POST, 1);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: '.strlen($data)));
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
Strona | 23 /61
odpowiedź:
HTTP status code: 201
------------------------stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/5e60d3r728trixvagqj7bds19r0irm31/
[payment_url] => https://ssl.dotpay.pl/test_payment/
?pid=5e60d3r728trixvagqj7bds19r0irm31
[token] => 5e60d3r728trixvagqj7bds19r0irm31
[amount] => 99.11
[currency] => PLN
[description] => Payment for 586930 order
[control] => 202cb962ac59075b964b07152d234b70
[language] => pl
[channel_id] => 4
[ch_lock] => 1
[onlinetransfer] => 1
[redirection_type] => 0
[buttontext] => return
[url] => http://www.example.com/thanks_page.php
[urlc] => http://www.example.com/confirmation/
[expiration_datetime] => 2015-12-01T16:48:00
[payer] => stdClass Object
(
[first_name] => John
[last_name] => Smith
[email] => [email protected]
[phone] => +48123456789
[address] => stdClass Object
(
[street] => Wielicka
[building_number] => 72
[flat_number] =>
[postcode] => 30-552
[city] => Krakow
[region] => Malopolska
[country] => POL
)
)
[recipient] => stdClass Object
(
[account_number] => PL92 9422 1561 0877 2286 8053 6980
[company] => PJ Shop
[first_name] => Patrick
[last_name] => Jones
[address] => stdClass Object
(
[street] => Marszalkowska
[building_number] => 100
[flat_number] =>
[postcode] => 00-576
[city] => Warszawa
)
)
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
accounts/(int: account_id)/payment_links/(string: token)/
Strona | 24 / 61
(usunięcie linku płatniczego)
Zasób pozwala usunąć stworzony link płatniczy dla danego sklepu (ID).
przykładowe żądanie:
nagłówki żądania:
DELETE
/test_seller/api/accounts/443005/payment_links/5e60d3r728trixvagqj7bds19r0irm31/
HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 204 No Content
Content-Type: application/json
Vary: Accept
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
OPIS
204 No Content
usunięto link
404 Not Found
nie znaleziono sklepu
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/accounts/443005/payment_links/5e60d3r728trixvagqj7bds19r0irm31/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
odpowiedź:
HTTP status code: 204
-------------------------
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 25 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
accounts/(int: account_id)/payment_links/
Strona | 26 / 61
(lista linków płatniczych)
Zasób zwraca listę linków płatniczych dla danego sklepu (ID).
przykładowe żądanie:
nagłówki żądania:
GET /test_seller/api/accounts/443005/payment_links/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
fragment odpowiedzi:
{
"count": 116,
"next": "https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/?page=2",
"previous": null,
"results": [
{
"href": "https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/3drilk63fknyko778yziran6yx603xvo/",
"payment_url": "https://ssl.dotpay.pl/test_payment/
?pid=3drilk63fknyko778yziran6yx603xvo",
"token": "3drilk63fknyko778yziran6yx603xvo",
"amount": "99.11",
"currency": "PLN",
"description": "Payment for 586930 order",
"control": "202cb962ac59075b964b07152d234b70",
"language": "pl",
"channel_id": 4,
"ch_lock": true,
"onlinetransfer": true,
"redirection_type": 0,
"url": "http://www.example.com/thanks_page.php",
"urlc": "http://www.example.com/confirmation/",
"expiration_datetime": "2015-12-01T16:48:00",
"payer": {
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]",
"phone": "+48123456789",
"address": {
"street": "Wielicka",
"building_number": "72",
"flat_number": null,
"postcode": "30-552",
"city": "Krakow",
"region": "Malopolska",
"country": "POL"
}
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
},
"recipient": {
"account_number": "PL92 9422 1561 0877 2286 8053 6980",
"company": "PJ Shop",
"first_name": "Patrick",
"last_name": "Jones",
"address": {
"street": "Marszalkowska",
"building_number": "100",
"flat_number": null,
"postcode": "00-576",
"city": "Warszawa"
}
}
},
{
"href": "https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/jov2viovv0tlz22wwy2svtunb2sm5x4o/",
"payment_url": "https://ssl.dotpay.pl/test_payment/
?pid=jov2viovv0tlz22wwy2svtunb2sm5x4o",
"token": "jov2viovv0tlz22wwy2svtunb2sm5x4o",
"amount": "99.11",
"currency": "PLN",
"description": "platnosc dla Jan Kowalski",
"control": null,
"language": "pl",
"channel_id": null,
"ch_lock": null,
"onlinetransfer": null,
"redirection_type": 0,
"url": "http://www.example.com/",
"urlc": null,
"expiration_datetime": null,
"payer": {
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]",
"phone": null,
"address": {
"street": "Warszawska",
"building_number": "1",
"flat_number": null,
"postcode": "11-111",
"city": "Krakow",
"region": null,
"country": "POL"
}
},
"recipient": {
"account_number": "",
"company": null,
"first_name": null,
"last_name": null,
"address": {
"street": null,
"building_number": null,
"flat_number": null,
"postcode": null,
"city": null
}
}
},
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 27 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
Strona | 28 / 61
200 OK
404 Not Found
OPIS
ok
nie znaleziono sklepu
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/accounts/443005/payment_links/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
fragment odpowiedzi:
HTTP status code: 200
------------------------stdClass Object
(
[count] => 116
[next] => https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/?page=2
[previous] =>
[results] => Array
(
[0] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/3drilk63fknyko778yziran6yx603xvo/
[payment_url] => https://ssl.dotpay.pl/test_payment/
?pid=3drilk63fknyko778yziran6yx603xvo
[token] => 3drilk63fknyko778yziran6yx603xvo
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
[amount] => 99.11
[currency] => PLN
[description] => Payment for 586930 order
[control] => 202cb962ac59075b964b07152d234b70
[language] => pl
[channel_id] => 4
[ch_lock] => 1
[onlinetransfer] => 1
[redirection_type] => 0
[url] => http://www.example.com/thanks_page.php
[urlc] => http://www.example.com/confirmation/
[expiration_datetime] => 2015-12-01T16:48:00
[payer] => stdClass Object
(
[first_name] => John
[last_name] => Smith
[email] => [email protected]
[phone] => +48123456789
[address] => stdClass Object
(
[street] => Wielicka
[building_number] => 72
[flat_number] =>
[postcode] => 30-552
[city] => Krakow
[region] => Malopolska
[country] => POL
)
)
[recipient] => stdClass Object
(
[account_number] => PL92 9422 1561 0877 2286 8053 6980
[company] => PJ Shop
[first_name] => Patrick
[last_name] => Jones
[address] => stdClass Object
(
[street] => Marszalkowska
[building_number] => 100
[flat_number] =>
[postcode] => 00-576
[city] => Warszawa
)
)
)
[1] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/jov2viovv0tlz22wwy2svtunb2sm5x4o/
[payment_url] => https://ssl.dotpay.pl/test_payment/
?pid=jov2viovv0tlz22wwy2svtunb2sm5x4o
[token] => jov2viovv0tlz22wwy2svtunb2sm5x4o
[amount] => 99.11
[currency] => PLN
[description] => platnosc dla Jan Kowalski
[control] =>
[language] => pl
[channel_id] =>
[ch_lock] =>
[onlinetransfer] =>
[redirection_type] => 0
[url] => http://www.example.com/
[urlc] =>
[expiration_datetime] =>
[payer] => stdClass Object
(
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 29 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
[first_name] => John
[last_name] => Smith
[email] => [email protected]
[phone] =>
[address] => stdClass Object
(
[street] => Warszawska
[building_number] => 1
[flat_number] =>
[postcode] => 11-111
[city] => Krakow
[region] =>
[country] => POL
)
Strona | 30 / 61
)
[recipient] => stdClass Object
(
[account_number] =>
[company] =>
[first_name] =>
[last_name] =>
[address] => stdClass Object
(
[street] =>
[building_number] =>
[flat_number] =>
[postcode] =>
[city] =>
)
)
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
accounts/(int: account_id)/payment_links/(string: token)/
(szczegóły linku płatniczego)
Zasób zwraca szczegóły danego linku płatniczego.
przykładowe żądanie:
nagłówki żądania:
GET
/test_seller/api/accounts/443005/payment_links/3drilk63fknyko778yziran6yx603xvo/
HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
odpowiedź:
{
"href": "https://ssl.dotpay.pl/test_seller/api/accounts/443005/
payment_links/3drilk63fknyko778yziran6yx603xvo/",
"payment_url": "https://ssl.dotpay.pl/test_payment/
?pid=3drilk63fknyko778yziran6yx603xvo",
"token": "3drilk63fknyko778yziran6yx603xvo",
"amount": "99.11",
"currency": "PLN",
"description": "Payment for 586930 order",
"control": "202cb962ac59075b964b07152d234b70",
"language": "pl",
"channel_id": 4,
"ch_lock": true,
"onlinetransfer": true,
"redirection_type": 0,
"url": "http://www.example.com/thanks_page.php",
"urlc": "http://www.example.com/confirmation/",
"expiration_datetime": "2015-12-01T16:48:00",
"payer": {
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]",
"phone": "+48123456789",
"address": {
"street": "Wielicka",
"building_number": "72",
"flat_number": null,
"postcode": "30-552",
"city": "Krakow",
"region": "Malopolska",
"country": "POL"
}
},
"recipient": {
"account_number": "PL92 9422 1561 0877 2286 8053 6980",
"company": "PJ Shop",
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 31 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
"first_name": "Patrick",
"last_name": "Jones",
"address": {
"street": "Marszalkowska",
"building_number": "100",
"flat_number": null,
"postcode": "00-576",
"city": "Warszawa"
}
Strona | 32 / 61
}
}
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
404 Not Found
OPIS
ok
nie znaleziono sklepu
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/accounts/443005/payment_links/3drilk63fknyko778yziran6yx603xvo/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
odpowiedź:
HTTP status code: 200
------------------------stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/accounts/443005/
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
payment_links/3drilk63fknyko778yziran6yx603xvo/
[payment_url] => https://ssl.dotpay.pl/test_payment/
?pid=3drilk63fknyko778yziran6yx603xvo
[token] => 3drilk63fknyko778yziran6yx603xvo
[amount] => 99.11
[currency] => PLN
[description] => Payment for 586930 order
[control] => 202cb962ac59075b964b07152d234b70
[language] => pl
[channel_id] => 4
[ch_lock] => 1
[onlinetransfer] => 1
[redirection_type] => 0
[url] => http://www.example.com/thanks_page.php
[urlc] => http://www.example.com/confirmation/
[expiration_datetime] => 2015-12-01T16:48:00
[payer] => stdClass Object
(
[first_name] => John
[last_name] => Smith
[email] => [email protected]
[phone] => +48123456789
[address] => stdClass Object
(
[street] => Wielicka
[building_number] => 72
[flat_number] =>
[postcode] => 30-552
[city] => Krakow
[region] => Malopolska
[country] => POL
)
)
[recipient] => stdClass Object
(
[account_number] => PL92 9422 1561 0877 2286 8053 6980
[company] => PJ Shop
[first_name] => Patrick
[last_name] => Jones
[address] => stdClass Object
(
[street] => Marszalkowska
[building_number] => 100
[flat_number] =>
[postcode] => 00-576
[city] => Warszawa
)
)
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 33 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
accounts/(int: account_id)/payout/
Strona | 34 / 61
(wypłata środków z salda sklepu (ID) )
Zasób pozwala zlecić wypłatę środków z salda danego sklepu (ID). Wykonanie żądania powoduje
powstanie operacji typu payout_any_amount dla każdego obiektu tablicy transfers.
Jeśli w żądaniu nie zostanie przesłany numer rachunku do wypłaty (account_number), to dla powstałej operacji
zostanie przypisany domyślny numer rachunku określony w konfiguracji sklepu, w panelu administracyjnym.
Uwaga! Brak odpowiedniej konfiguracji konta (ID), wynikającej z umowy, spowoduje zignorowanie danych
przesłanych w account_number.
Uwaga! Zwrócenie odpowiedzi „ok” jest jedynie potwierdzeniem poprawności żądania i nie jest równoważne z
utworzeniem operacji wypłaty. Powstanie oraz status operacji można zweryfikować za pomocą zasobu
operations/. W celu optymalizacji żądania sugerujemy filtrowanie za pomocą type, creation_date_from oraz
control (wskazane jest, aby był on unikalny), na przykład:
GET https://ssl.dotpay.pl/test_seller/api/operations/?type=payout&creation_date_from=2017-0215&control=qwerty123
przykładowe żądanie:
nagłówki żądania:
POST /test_seller/api/accounts/443005/payout/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
żądanie:
{
"currency": "PLN",
"transfers": [
{
"amount": "19.30",
"control": "019e1921bfb1193965d1e",
"description": "payout for JS",
"recipient": {
"account_number": "PL32249000896640389235035459",
"name": "John Smith"
}
},
{
"amount": "56.20",
"control": "3769978411",
"description": "payout for PJ",
"recipient": {
"account_number": "PL33109032070768017608228474",
"name": "Patrick Jones"
}
}
]
}
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Vary: Accept
Allow: POST, OPTIONS
odpowiedź:
Strona | 35 /61
{
"detail": "ok"
}
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
OPIS
ok
403 Forbidden
brak uprawnień
404 Not Found
nie znaleziono sklepu
Znaczenie własności przesyłanych w żądaniu:
WŁASNOŚĆ
currency
TYP
string
ZNACZENIE / OPIS
waluta w jakiej dokonywane są wypłaty
format: ISO 4217
transfers.amount
decimal
kwota wypłacanych środków
transfers.control
string
identyfikator operacji
transfers.description
string
opis wypłaty
transfers.recipient.account_number
string
numer konta bankowego, na który zostaną
wypłacone środki
format: IBAN
transfers.recipient.name
string
nazwa odbiorcy przelewu
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$fields = array(
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Strona | 36 / 61
'currency' => 'PLN',
'transfers' => array(
array(
'amount' => '19.30',
'control' => '019e1921bfb1193965d1e',
'description' => 'payout for JS',
'recipient' => array(
'account_number' => 'PL32249000896640389235035459',
'name' => 'John Smith',
)
),
array(
'amount' => '56.20',
'control' => '3769978411',
'description' => 'payout for PJ',
'recipient' => array(
'account_number' => 'PL33109032070768017608228474',
'name' => 'Patrick Jones',
)
)
)
);
$data=json_encode($fields);
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/api/
accounts/443005/payout/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
curl_setopt ($ch, CURLOPT_POST, 1);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: '.strlen($data)));
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
odpowiedź:
HTTP status code: 200
------------------------stdClass Object
(
[detail] => ok
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
V. 2. operations/
(lista operacji)
Zasób zwraca listę operacji utworzonych we wszystkich sklepach (ID), do których dany użytkownik ma
uprawnienia.
przykładowe żądanie:
nagłówki żądania:
GET /test_seller/api/operations/?type=payment&status=completed HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
fragment odpowiedzi:
{
"count": 283,
"next": "https://ssl.dotpay.pl/test_seller/api/operations/
?page=2&status=completed&type=payment",
"previous": null,
"results": [
{
"href": "https://ssl.dotpay.pl/test_seller/api/operations/M1279-3810/",
"number": "M1279-3810",
"creation_datetime": "2015-09-04T13:16:04.373986",
"type": "payment",
"status": "completed",
"amount": "156.00",
"currency": "PLN",
"original_amount": "156.00",
"original_currency": "PLN",
"account_id": "443005",
"related_operation": null,
"description": "Order 645978",
"control": "",
"payer": {
"first_name": "Patrick",
"last_name": "Jones",
"email": "[email protected]"
}
},
{
"href": "https://ssl.dotpay.pl/test_seller/api/operations/M1508-4532/",
"number": "M1508-4532",
"creation_datetime": "2015-09-04T13:14:10.788754",
"type": "payment",
"status": "completed",
"amount": "835.00",
"currency": "PLN",
"original_amount": "835.00",
"original_currency": "PLN",
"account_id": "443005",
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 37 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
"related_operation": null,
"description": "payment for A shop",
"control": "",
"payer": {
"first_name": "John",
"last_name": "Smith",
"email": "[email protected]"
}
Strona | 38 / 61
},
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
OPIS
ok
Znaczenie parametrów możliwych do przesyłania w żądaniu w celu filtrowania odpowiedzi:
WŁASNOŚĆ
account_id
type
TYP
int
ZNACZENIE / OPIS
numer sklepu (ID)
typ operacji
dostępne wartości:
payment
payment_multimerchant_child
payout
refund
complaint
release_rollback
status
status operacji
dostępne wartości:
new
processing
completed
rejected
processing_realization_waiting
processing_realization
creation_date_from
od daty utworzenia operacji
format: YYYY-MM-DD
creation_date_to
do daty utworzenia operacji
format: YYYY-MM-DD
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
description
string
opis (bądź jego fragment) operacji
control
string
parametr kontrolny (bądź jego fragment)
operacji
Znaczenie własności zwracanych w odpowiedzi, w tablicy results:
WŁASNOŚĆ
TYP
ZNACZENIE / OPIS
href
string
adres API, pod którym znajdują się szczegóły danej
operacji
number
string
numer operacji
creation_datetime
string
data utworzenia
format: ISO 8601 (RFC 3339)
type
string
typ operacji
status
string
status operacji
amount
decimal
kwota zaksięgowanej operacji
currency
string
waluta zaksięgowanej operacji
format: ISO 4217
original_amount
decimal
oryginalna kwota przesłana w zleceniu płatności
original_currency
string
waluta kwoty przesłanej w zleceniu płatności
format: ISO 4217
account_id
int
numer sklepu (ID)
related_operation
string
operacja powiązana (np. zwrot), jeśli takowa istnieje
description
string
opis operacji
control
string
parametr kontrolny operacji (przesłany przez serwis
Sprzedawcy w zleceniu płatności)
payer.first_name
string
imię osoby dokonującej płatność
payer.last_name
string
nazwisko osoby dokonującej płatność
payer.email
string
email osoby dokonującej płatność
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 39 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
Strona | 40 / 61
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/operations/?type=payment&status=completed");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
fragment odpowiedzi:
HTTP status code: 200
------------------------stdClass Object
(
[count] => 283
[next] => https://ssl.dotpay.pl/test_seller/api/
operations/?page=2&status=completed&type=payment
[previous] =>
[results] => Array
(
[0] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/operations/M1279-3810/
[number] => M1279-3810
[creation_datetime] => 2015-09-04T13:16:04.373986
[type] => payment
[status] => completed
[amount] => 156.00
[currency] => PLN
[original_amount] => 156.00
[original_currency] => PLN
[account_id] => 443005
[related_operation] =>
[description] => Order 645978
[control] =>
[payer] => stdClass Object
(
[first_name] => Patrick
[last_name] => Jones
[email] => [email protected]
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
)
)
[1] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/operations/M1508-4532/
[number] => M1508-4532
[creation_datetime] => 2015-09-04T13:14:10.788754
[type] => payment
[status] => completed
[amount] => 835.00
[currency] => PLN
[original_amount] => 835.00
[original_currency] => PLN
[account_id] => 443005
[related_operation] =>
[description] => payment for A shop
[control] =>
[payer] => stdClass Object
(
[first_name] => John
[last_name] => Smith
[email] => [email protected]
)
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 41 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
operations/(string: operation_number)/
Strona | 42 / 61
(szczegóły pojedynczej operacji)
Zasób zwraca szczegóły danej operacji.
przykładowe żądanie:
nagłówki żądania:
GET /test_seller/api/operations/M1279-3810/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
odpowiedź:
{
"href": "https://ssl.dotpay.pl/test_seller/api/operations/M1279-3810/",
"number": "M1279-3810",
"creation_datetime": "2015-09-04T13:16:04.373986",
"type": "payment",
"status": "completed",
"amount": "156.00",
"currency": "PLN",
"original_amount": "156.00",
"original_currency": "PLN",
"account_id": "443005",
"related_operation": null,
"description": "Order 645978",
"control": "",
"payer": {
"first_name": "Patrick",
"last_name": "Jones",
"email": "[email protected]"
},
"payment_method": {
"channel_id": 4
}
}
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
404 Not Found
OPIS
ok
nie znaleziono operacji
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Własności zwrócone w odpowiedzi zostały opisane w rozdziale operations/ (lista operacji) powyżej, natomiast
poniżej zostały wymienione dodatkowe / opcjonalne własności jakie mogą wystąpić w zależności od konfiguracji
sklepu (ID):
Strona | 43 /61
WŁASNOŚĆ
TYP
ZNACZENIE / OPIS
payment_method.channel_id
int
numer kanału, jakim została wykonana
płatność
payment_method.payer_bank_account.name
string
nazwa nadawcy przelewu
payment_method.payer_bank_account.number
string
numer rachunku bankowego z jakiego
została dokonana płatność
format: IBAN
payment_method.credit_card
.issuer_identification_number
string
numer identyfikacyjny emitenta karty
płatniczej
payment_method.credit_card.brand
string
marka karty płatniczej
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/operations/M1279-3810/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
odpowiedź:
Strona | 44 / 61
HTTP status code: 200
------------------------stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/operations/M1279-3810/
[number] => M1279-3810
[creation_datetime] => 2015-09-04T13:16:04.373986
[type] => payment
[status] => completed
[amount] => 156.00
[currency] => PLN
[original_amount] => 156.00
[original_currency] => PLN
[account_id] => 443005
[related_operation] =>
[description] => Order 645978
[control] =>
[payer] => stdClass Object
(
[first_name] => Patrick
[last_name] => Jones
[email] => [email protected]
)
[payment_method] => stdClass Object
(
[channel_id] => 4
)
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
operations/(string: operation_number)/operations/
(lista operacji zawartych w operacji
payout)
Zasób zwraca listę operacji zawartych w operacji typu payout (wypłata).
przykładowe żądanie:
nagłówki żądania:
GET /test_seller/api/operations/M1884-2104/operations/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
fragment odpowiedzi:
{
"count": 54,
"next": null,
"previous": null,
"results": [
{
"href": "https://ssl.dotpay.pl/test_seller/api/operations/M1404-9234/",
"number": "M1404-9234",
"creation_datetime": "2015-09-09T06:55:43.216434",
"type": "payment",
"status": "completed",
"amount": "1.00",
"currency": "PLN",
"original_amount": "1.00",
"original_currency": "PLN",
"account_id": "443005",
"related_operation": null,
"description": "test",
"control": "",
"payer": {
"first_name": "Jan",
"last_name": "Kowalski",
"email": "[email protected]"
}
},
{
"href": "https://ssl.dotpay.pl/test_seller/api/operations/M1172-9817/",
"number": "M1172-9817",
"creation_datetime": "2015-09-08T10:13:12.225399",
"type": "refund",
"status": "processing_realization_waiting",
"amount": "238.00",
"currency": "PLN",
"original_amount": "238.00",
"original_currency": "PLN",
"account_id": "443005",
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 45 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
"related_operation":
"https://ssl.dotpay.pl/test_seller/api/operations/M1508-4532/",
"description": "Zwrot: payment for A shop",
"control": null,
"payer": null
Strona | 46 / 61
},
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
404 Not Found
OPIS
ok
nie znaleziono operacji
Własności zwrócone w odpowiedzi zostały opisane w rozdziale operations/ (lista operacji) powyżej
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/operations/?type=payment&status=completed");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
fragment odpowiedzi:
HTTP status code: 200
------------------------stdClass Object
(
[count] => 54
[next] =>
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
[previous] =>
[results] => Array
(
[0] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/operations/M1404-9234/
[number] => M1404-9234
[creation_datetime] => 2015-09-09T06:55:43.216434
[type] => payment
[status] => completed
[amount] => 1.00
[currency] => PLN
[original_amount] => 1.00
[original_currency] => PLN
[account_id] => 443005
[related_operation] =>
[description] => test
[control] =>
[payer] => stdClass Object
(
[first_name] => Jan
[last_name] => Kowalski
[email] => [email protected]
)
)
[1] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/operations/M1172-9817/
[number] => M1172-9817
[creation_datetime] => 2015-09-08T10:13:12.225399
[type] => refund
[status] => processing_realization_waiting
[amount] => 238.00
[currency] => PLN
[original_amount] => 238.00
[original_currency] => PLN
[account_id] => 443005
[related_operation] =>
https://ssl.dotpay.pl/test_seller/api/operations/M1508-4532/
[description] => Zwrot: payment for A shop
[control] =>
[payer] =>
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 47 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
V. 3. payments/
Strona | 48 / 61
(lista operacji płatności)
Zasób zwraca listę operacji płatności (funkcjonuje analogicznie do zasobu operations/ (lista operacji),
niemniej jednak zwraca wyłącznie operacje płatności).
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
payments/(string: operation_number)/
(szczegóły pojedynczej operacji płatności)
Zasób zwraca szczegóły danej operacji płatności (funkcjonuje analogicznie do zasobu operations/(string:
operation_number)/ (szczegóły pojedynczej operacji), niemniej jednak zwraca wyłącznie operacje płatności).
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 49 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
payments/(string: operation_number)/mark_as_complete/
(oznaczenie flagą
„complete”)
Strona | 50 / 61
Zasób pozwala oznaczyć daną operację flagą “complete”. (W konfiguracji wypłat istnieje możliwość
aktywacji opcji generowania polecenia wypłat z operacji oznaczonych flagą.)
przykładowe żądanie:
nagłówki żądania:
POST /test_seller/api/payments/M1006-4674/mark_as_complete/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: POST, DELETE, OPTIONS
odpowiedź:
{
"detail": "ok"
}
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
404 Not Found
OPIS
ok
nie znaleziono operacji
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$fields=null;
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL," https://ssl.dotpay.pl/test_seller/api/
payments/M1006-4674/mark_as_complete/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
curl_setopt ($ch, CURLOPT_POST, 1);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $fields);
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
odpowiedź:
HTTP status code: 200
------------------------stdClass Object
(
[detail] => ok
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 51 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
payments/(string: operation_number)/mark_as_complete/
Strona | 52 / 61
(usunięcie flagi „complete”)
Zasób pozwala usunąć flagę “complete”, którą została oznaczona dana operacja.
przykładowe żądanie:
nagłówki żądania:
DELETE /test_seller/api/payments/M1006-4674/mark_as_complete/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: POST, DELETE, OPTIONS
odpowiedź:
{
"detail": "ok"
}
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
404 Not Found
OPIS
ok
nie znaleziono operacji
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL," https://ssl.dotpay.pl/test_seller/api/
payments/M1006-4674/mark_as_complete/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
$response = curl_exec ($ch); // API response
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
odpowiedź:
HTTP status code: 200
------------------------stdClass Object
(
[detail] => ok
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 53 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
(zwrot operacji płatności)
payments/(string: operation_number)/refund/
Strona | 54 / 61
Zasób pozwala zlecić zwrot danej operacji płatności.
przykładowe żądanie:
nagłówki żądania:
POST /test_seller/api/payments/M1279-3810/refund/ HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
żądanie:
{
"amount": "14.29",
"description": "Refund for order 569784",
"control": "921bfb1193965d1e"
}
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: POST, OPTIONS
odpowiedź:
{
"detail": "ok"
}
Znaczenie zwracanych kodów odpowiedzi HTTP:
HTTP status code
200 OK
404 Not Found
OPIS
ok
nie znaleziono operacji
Znaczenie własności przesyłanych w żądaniu:
WŁASNOŚĆ
TYP
ZNACZENIE / OPIS
amount
decimal
kwota zwrotu
description
string
opis
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
control
string
Parametr kontrolny
Strona | 55 /61
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$fields = array(
'amount' => '14.29',
'description' => 'Refund for order 569784',
'control' => '921bfb1193965d1e'
);
$data=json_encode($fields);
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL," https://ssl.dotpay.pl/test_seller/api/
payments/M1279-3810/refund/");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
curl_setopt ($ch, CURLOPT_POST, 1);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: '.strlen($data)));
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
odpowiedź:
HTTP status code: 200
------------------------stdClass Object
(
[detail] => ok
)
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
V. 4. v1/reports/
Strona | 56 / 61
(lista raportów)
Zasób zwraca listę raportów utworzonych we wszystkich sklepach (ID), do których dany użytkownik ma
uprawnienia.
przykładowe żądanie:
nagłówki żądania:
GET /test_seller/api/v1/reports HTTP/1.1
Host: ssl.dotpay.pl
Accept: application/json
Authorization: Basic dXNlcjU4NDc6QVFNQWJxZEF2Qg==
Content-Type: application/json
odpowiedź:
nagłówki odpowiedzi:
HTTP/1.1 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
odpowiedź:
{
"count": 6,
"next": null,
"previous": null,
"results": [
{
"href": "https://ssl.dotpay.pl/test_seller/api/v1/reports/876/",
"creation_datetime": "2016-06-25T02:15:29.947693",
"name": "20160625021529_443005_M9171-9392_OAR",
"type": "OAR",
"trigger": "Payout",
"format": "csv",
"download_url": "https://ssl.dotpay.pl/test_seller/
api/v1/reports/876/download/",
"account_id": "443005"
},
{
"href": "https://ssl.dotpay.pl/test_seller/api/v1/reports/875/",
"creation_datetime": "2016-06-25T02:15:29.961765",
"name": "20160625021529_443005_M9945-1209_OAR",
"type": "OAR",
"trigger": "Payout",
"format": "csv",
"download_url": "https://ssl.dotpay.pl/test_seller/
api/v1/reports/875/download/",
"account_id": "443005"
},
Znaczenie własności zwracanych w tablicy results:
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
WŁASNOŚĆ
TYP
ZNACZENIE / OPIS
string
adres API, pod którym znajdują się szczegóły danego
raportu
creation_datetime
string
data utworzenia raportu
name
string
nazwa raportu
type
string
typ raportu
trigger
string
przełącznik
format
string
format raportu
download_url
string
adres do pobrania raportu
account_id
int
numer sklepu (ID), którego dotyczy raport
href
Poniżej został zamieszczony przykład żądania (oraz odpowiedzi) wykorzystujący język PHP oraz bibliotekę cURL.
żądanie:
<?php
$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL,"https://ssl.dotpay.pl/test_seller/
api/v1/reports/?account_id=443005&creation_date_from=2016-06-01");
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, TRUE);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt ($ch, CURLOPT_CAINFO, "ca-bundle.crt");
//http://curl.haxx.se/docs/caextract.html
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_TIMEOUT, 100);
curl_setopt ($ch, CURLOPT_USERPWD, 'user:password');
$response = curl_exec ($ch); // API response
$curl_info = curl_getinfo($ch); //curl info
curl_close ($ch);
echo '<pre>';
echo 'HTTP status code: '.$curl_info[http_code];
echo PHP_EOL.'-------------------------'.PHP_EOL.PHP_EOL;
print_r(json_decode($response));
echo '</pre>';
?>
odpowiedź:
HTTP status code: 200
-------------------------
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 57 /61
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
Strona | 58 / 61
stdClass Object
(
[count] => 6
[next] =>
[previous] =>
[results] => Array
(
[0] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/v1/reports/876/
[creation_datetime] => 2016-06-25T02:15:29.947693
[name] => 20160625021529_443005_M9171-9392_OAR
[type] => OAR
[trigger] => Payout
[format] => csv
[download_url] => https://ssl.dotpay.pl/test_seller/
api/v1/reports/876/download/
[account_id] => 443005
)
[1] => stdClass Object
(
[href] => https://ssl.dotpay.pl/test_seller/api/v1/reports/875/
[creation_datetime] => 2016-06-25T02:15:29.961765
[name] => 20160625021529_443005_M9945-1209_OAR
[type] => OAR
[trigger] => Payout
[format] => csv
[download_url] => https://ssl.dotpay.pl/test_seller/
api/v1/reports/875/download/
[account_id] => 443005
)
Znaczenie parametrów możliwych do przesyłania w żądaniu w celu filtrowania odpowiedzi:
WŁASNOŚĆ
account_id
creation_date_from
TYP
int
ZNACZENIE / OPIS
numer sklepu (ID)
od daty utworzenia raportu
format: YYYY-MM-DD
creation_date_to
do daty utworzenia raportu
format: YYYY-MM-DD
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
TABELA ROUTINGU
W poniższej tabeli zostały zestawione zasoby oraz metody ich wywołania.
ZASÓB
METODA
Strona | 59 /61
OPIS
accounts/
GET
lista sklepów (ID)
użytkownika
accounts/(int: account_id)/
GET
szczegóły sklepu (ID)
accounts/(int: account_id)/channels/
GET
lista kanałów płatności
sklepu (ID)
accounts/(int: account_id)/payment_links/
POST
utworzenie linku
płatniczego
accounts/(int: account_id)/payment_links/(string:
token)/
DELETE
usunięcie linku płatniczego
accounts/(int: account_id)/payment_links/
GET
lista linków płatniczych
accounts/(int: account_id)/payment_links/(string:
token)/
GET
szczegóły linku płatniczego
accounts/(int: account_id)/payout/
POST
wypłata środków z salda
sklepu (ID)
operations/
GET
lista operacji
operations/(string: operation_number)/
GET
szczegóły pojedynczej
operacji
operations/(string: operation_number)/operations/
GET
lista operacji zawartych w
operacji payout
payments/
GET
lista operacji płatności
payments/(string: operation_number)/
GET
szczegóły pojedynczej
operacji płatności
payments/(string:
operation_number)/mark_as_complete/
POST
oznaczenie flagą
„complete”
payments/(string:
operation_number)/mark_as_complete/
DELETE
usunięcie flagi „complete”
payments/(string: operation_number)/refund/
POST
zwrot operacji płatności
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
v1/reports/
GET
lista raportów
Strona | 60 / 61
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
API Panelu Administracyjnego Sprzedawcy wersja 1.35.4.1
DZIENNIK ZMIAN
WERSJA
DATA
OPIS ZMIAN
1.35.4.1
2017-02-15
 dodanie parametru „buttontext” do zasobu /payment_links/
1.31.11.1
2016-07-07
 dodanie zasobu /v1/reports/
 dodanie rozdziału „DZIENNIK ZMIAN”
Dział Pomocy Technicznej Dotpay, ul. Wielicka 72, 30-552 Kraków, tel. +48 12 688 26 00, e-mail: [email protected]
Strona | 61 /61