API przelewów
Przed rozpoczęciem integracji skonfiguruj serwis.
Inicjowanie płatności i odbiór notyfikacji
API z walidacją parametrów
sequenceDiagram
autonumber
Klient->>Sprzedawca: Zamówienie
Sprzedawca->>HotPay: Jawna inicjalizacja płatności
loop Procesowanie płatności
HotPay->>HotPay: Klient przeprowadza płatność
end
HotPay-->>Sprzedawca: Wysłanie notyfikacji
Note over Sprzedawca: Weryfikacja płatności
HotPay->>Sprzedawca: Powrót klienta do sklepu
Inicjalizacja płatności
Przekierowanie do panelu transakcyjnego
Adres URL: https://platnosc.hotpay.pl/
Content-Type: multipart/form-data
Dostępne metody: POST/GET
Opis użycia
| Zmienna | Wymagane | Opis zmiennej |
|---|---|---|
SEKRET |
TAK | Kod sekret do pobrania z panelu HotPay generowany dla każdego serwisu. |
KWOTA |
TAK | Kwota wywoływanej płatności. |
NAZWA_USLUGI |
TAK | Nazwa usługi/towaru |
ADRES_WWW |
NIE | Adres URL powrotu |
ID_ZAMOWIENIA |
TAK | Identyfikator zamówienia po stronie serwisu – nadawany przez właściciela serwisu. Ciąg znaków przesyłany w tej zmiennej nie może być dłuższy niż 64 znaki. |
EMAIL |
NIE | Email klienta |
DANE_OSOBOWE |
NIE | Dane osobowe klienta |
HASH |
TAK | HASH funkcji skrótu sha256, składającej się z elementów: "HASLOZUSTAWIEN".";" . $FORMULARZ["KWOTA"] . ";" . $FORMULARZ["NAZWA_USLUGI"] . ";" . $FORMULARZ["ADRES_WWW"] . ";" . $FORMULARZ["ID_ZAMOWIENIA"] . ";" . $FORMULARZ["SEKRET"] |
<?php
$HASLO_Z_USTAWIEN = 'XXX';
$FORMULARZ = [
'SEKRET' => 'XXX',
'KWOTA' => '1',
'NAZWA_USLUGI' => 'XXX',
'ADRES_WWW' => 'https://hotpay.pl',
'ID_ZAMOWIENIA' => 'ZAM-123',
'EMAIL' => '',
'DANE_OSOBOWE' => '',
];
$FORMULARZ['HASH'] = hash('sha256', implode(';', [
$HASLO_Z_USTAWIEN,
$FORMULARZ['KWOTA'],
$FORMULARZ['NAZWA_USLUGI'],
$FORMULARZ['ADRES_WWW'],
$FORMULARZ['ID_ZAMOWIENIA'],
$FORMULARZ['SEKRET'],
]));
echo '<form id="order" action="https://platnosc.hotpay.pl/" method="post" enctype="multipart/form-data">';
foreach ($FORMULARZ as $klucz => $wartosc) {
echo '<input name="'
. htmlspecialchars($klucz, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8')
. '" value="'
. htmlspecialchars($wartosc, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8')
. '" type="hidden">';
}
echo '<button type="submit">DALEJ</button></form>';
Odbiór notyfikacji
Notyfikacje są wysyłane metodą POST typu form-data na adres WWW podany w ustawieniach usługi.
Zasady konfiguracji odbioru, weryfikacji danych i obsługi ponowień opisano na stronie Notyfikacje.
Opis użycia
| Zmienna | Opis zmiennej |
|---|---|
SEKRET |
Kod sekret do pobrania z panelu HotPay generowany dla każdego serwisu. |
KWOTA |
Kwota wywoływanej płatności. |
STATUS |
Status płatności: SUCCESS – płatność zaakceptowana; PENDING – płatność oczekująca; FAILURE – płatność odrzucona. |
ID_ZAMOWIENIA |
Identyfikator zamówienia po stronie serwisu – nadawany przez właściciela serwisu. Ciąg znaków przesyłany w tej zmiennej nie może być dłuższy niż 64 znaki. |
ID_PLATNOSCI |
Unikalny identyfikator płatności |
SECURE |
Identyfikator bezpiecznej transakcji |
HASH |
HASH funkcji skrótu sha256, składającej się z elementów: HASLO_Z_USTAWIEN.";".$_POST["KWOTA"].";".$_POST["ID_PLATNOSCI"].";".$_POST["ID_ZAMOWIENIA"].";".$_POST["STATUS"].";".$_POST["SECURE"].";".$_POST["SEKRET"] |
<?php
$HASLO_Z_USTAWIEN="XXX";
if(!empty($_POST["KWOTA"]) &&
!empty($_POST["ID_PLATNOSCI"]) &&
!empty($_POST["ID_ZAMOWIENIA"]) &&
!empty($_POST["STATUS"]) &&
!empty($_POST["SEKRET"]) &&
!empty($_POST["SECURE"]) &&
!empty($_POST["HASH"])
){
if(hash("sha256",$HASLO_Z_USTAWIEN.";".$_POST["KWOTA"].";".$_POST["ID_PLATNOSCI"].";".$_POST["ID_ZAMOWIENIA"].";".$_POST["STATUS"].";".$_POST["SECURE"].";".$_POST["SEKRET"]) == $_POST["HASH"]){
//komunikacja poprawna
if($_POST["STATUS"]=="SUCCESS"){
//płatność zaakceptowana
}else if($_POST["STATUS"]=="FAILURE"){
//odrzucone
}
}
}
API zaawansowane z walidacją parametrów
sequenceDiagram
autonumber
Klient->>Sprzedawca: Zamówienie
Sprzedawca->>HotPay: Rejestracja transakcji
HotPay->>Sprzedawca: Otrzymanie odpowiedzi
Sprzedawca->>HotPay: Przekierowanie klienta
loop Procesowanie płatności
HotPay->>HotPay: Klient przeprowadza płatność
end
HotPay-->>Sprzedawca: Wysłanie notyfikacji
Note over Sprzedawca: Weryfikacja płatności
HotPay->>Sprzedawca: Powrót klienta do sklepu
Inicjalizacja płatności
Przekierowanie do panelu transakcyjnego
Adres URL: https://platnosc.hotpay.pl/
Content-Type: multipart/form-data
Dostępne metody: POST/GET
Opis użycia
| Zmienna | Wymagane | Opis zmiennej |
|---|---|---|
SEKRET |
TAK | Kod sekret do pobrania z panelu HotPay generowany dla każdego serwisu. |
KWOTA |
TAK | Kwota wywoływanej płatności. |
NAZWA_USLUGI |
TAK | Nazwa usługi/towaru |
ADRES_WWW |
NIE | Adres URL powrotu |
ID_ZAMOWIENIA |
TAK | Identyfikator zamówienia po stronie serwisu – nadawany przez właściciela serwisu. Ciąg znaków przesyłany w tej zmiennej nie może być dłuższy niż 64 znaki. |
TYP |
TAK | Wartość: INIT |
EMAIL |
NIE | Email klienta |
DANE_OSOBOWE |
NIE | Dane osobowe klienta |
HASH |
TAK | HASH funkcji skrótu sha256, składającej się z elementów: "HASLOZUSTAWIEN".";" . $FORMULARZ["KWOTA"] . ";" . $FORMULARZ["NAZWA_USLUGI"] . ";" . $FORMULARZ["ADRES_WWW"] . ";" . $FORMULARZ["ID_ZAMOWIENIA"] . ";" . $FORMULARZ["SEKRET"] |
<?php
$HASLO_Z_USTAWIEN = 'XXX';
$FORMULARZ = [
'SEKRET' => 'XXX',
'KWOTA' => '1',
'NAZWA_USLUGI' => 'XXX',
'ADRES_WWW' => 'https://hotpay.pl',
'ID_ZAMOWIENIA' => 'ZAM-123',
'TYP' => 'INIT',
'EMAIL' => '',
'DANE_OSOBOWE' => '',
];
$FORMULARZ['HASH'] = hash('sha256', implode(';', [
$HASLO_Z_USTAWIEN,
$FORMULARZ['KWOTA'],
$FORMULARZ['NAZWA_USLUGI'],
$FORMULARZ['ADRES_WWW'],
$FORMULARZ['ID_ZAMOWIENIA'],
$FORMULARZ['SEKRET'],
]));
$ch = curl_init('https://platnosc.hotpay.pl/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $FORMULARZ,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 15,
]);
$wynik = curl_exec($ch);
$kodHttp = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($wynik === false) {
$blad = curl_error($ch);
curl_close($ch);
throw new RuntimeException('Błąd połączenia z API HotPay: ' . $blad);
}
curl_close($ch);
if ($kodHttp < 200 || $kodHttp >= 300) {
throw new RuntimeException('API HotPay zwróciło HTTP ' . $kodHttp);
}
$odpowiedz = json_decode($wynik, true, 512, JSON_THROW_ON_ERROR);
if (!is_array($odpowiedz) || !is_bool($odpowiedz['STATUS'] ?? null)) {
throw new UnexpectedValueException('Nieprawidłowy format odpowiedzi API HotPay.');
}
if ($odpowiedz['STATUS'] === true) {
if (!is_string($odpowiedz['URL'] ?? null) || $odpowiedz['URL'] === '') {
throw new UnexpectedValueException('Brak adresu płatności w odpowiedzi.');
}
echo '<a href="'
. htmlspecialchars($odpowiedz['URL'], ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8')
. '">Zapłać</a>';
} else {
$wiadomosc = is_string($odpowiedz['WIADOMOSC'] ?? null)
? $odpowiedz['WIADOMOSC']
: 'Nie udało się utworzyć płatności.';
echo htmlspecialchars($wiadomosc, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
}
Przykład wymaga Node.js 20 lub nowszego z natywnym FormData oraz pakietu axios.
import axios from 'axios';
import { createHash } from 'node:crypto';
const HASLO_Z_USTAWIEN = 'XXX';
const FORMULARZ = {
SEKRET: 'XXX',
KWOTA: '1',
NAZWA_USLUGI: 'XXX',
ADRES_WWW: 'https://hotpay.pl',
ID_ZAMOWIENIA: 'ZAM-123',
EMAIL: '',
DANE_OSOBOWE: '',
TYP: 'INIT',
};
const form = new FormData();
for (const [nazwa, wartosc] of Object.entries(FORMULARZ)) {
form.append(nazwa, wartosc);
}
form.append('HASH', createHash('sha256').update([
HASLO_Z_USTAWIEN,
FORMULARZ.KWOTA,
FORMULARZ.NAZWA_USLUGI,
FORMULARZ.ADRES_WWW,
FORMULARZ.ID_ZAMOWIENIA,
FORMULARZ.SEKRET,
].join(';')).digest('hex'));
axios.request({
method: 'POST',
url: 'https://platnosc.hotpay.pl/',
data: form,
responseType: 'json',
timeout: 15000,
}).then(({ data: odpowiedz }) => {
if (!odpowiedz || typeof odpowiedz.STATUS !== 'boolean') {
throw new Error('Nieprawidłowy format odpowiedzi API HotPay.');
}
if (odpowiedz.STATUS !== true) {
throw new Error(odpowiedz.WIADOMOSC || 'Nie udało się utworzyć płatności.');
}
if (typeof odpowiedz.URL !== 'string' || odpowiedz.URL === '') {
throw new Error('Brak adresu płatności w odpowiedzi.');
}
console.log('ADRES PŁATNOŚCI: ' + odpowiedz.URL);
}).catch((blad) => {
console.error(blad.message);
});
Odbiór notyfikacji
Notyfikacje są wysyłane metodą POST typu form-data na adres WWW podany w ustawieniach usługi.
Zasady konfiguracji odbioru, weryfikacji danych i obsługi ponowień opisano na stronie Notyfikacje.
Uwaga
Pamiętaj o weryfikacji danych przychodzących.
Uwaga
Notyfikacje są wysyłane z góry ustalonych adresów IP, prosimy dodać je do whitelisty:
- 18.197.55.26
- 3.126.108.86
- 3.64.128.101
- 18.184.99.42
- 3.72.152.155
- 35.159.7.168
Opis użycia
| Zmienna | Opis zmiennej |
|---|---|
SEKRET |
Kod sekret do pobrania z panelu HotPay generowany dla każdego serwisu. |
KWOTA |
Kwota wywoływanej płatności. |
STATUS |
Status płatności: SUCCESS – płatność zaakceptowana; PENDING – płatność oczekująca; FAILURE – płatność odrzucona. |
ID_ZAMOWIENIA |
Identyfikator zamówienia po stronie serwisu – nadawany przez właściciela serwisu. Ciąg znaków przesyłany w tej zmiennej nie może być dłuższy niż 64 znaki. |
ID_PLATNOSCI |
Unikalny identyfikator płatności |
SECURE |
Identyfikator bezpiecznej transakcji |
HASH |
HASH funkcji skrótu sha256, składającej się z elementów: HASLO_Z_USTAWIEN.";".$_POST["KWOTA"].";".$_POST["ID_PLATNOSCI"].";".$_POST["ID_ZAMOWIENIA"].";".$_POST["STATUS"].";".$_POST["SECURE"].";".$_POST["SEKRET"] |
<?php
$HASLO_Z_USTAWIEN="XXX";
if(!empty($_POST["KWOTA"]) &&
!empty($_POST["ID_PLATNOSCI"]) &&
!empty($_POST["ID_ZAMOWIENIA"]) &&
!empty($_POST["STATUS"]) &&
!empty($_POST["SEKRET"]) &&
!empty($_POST["SECURE"]) &&
!empty($_POST["HASH"])
){
if(hash("sha256",$HASLO_Z_USTAWIEN.";".$_POST["KWOTA"].";".$_POST["ID_PLATNOSCI"].";".$_POST["ID_ZAMOWIENIA"].";".$_POST["STATUS"].";".$_POST["SECURE"].";".$_POST["SEKRET"]) == $_POST["HASH"]){
//komunikacja poprawna
if($_POST["STATUS"]=="SUCCESS"){
//płatność zaakceptowana
}else if($_POST["STATUS"]=="FAILURE"){
//odrzucone
}
}
}
API bez walidacji
sequenceDiagram
autonumber
Klient->>Sprzedawca: Zamówienie
Sprzedawca->>HotPay: Jawna inicjalizacja płatności
loop Procesowanie płatności
HotPay->>HotPay: Klient przeprowadza płatność
end
HotPay-->>Sprzedawca: Wysłanie notyfikacji
Note over Sprzedawca: Weryfikacja płatności
HotPay->>Sprzedawca: Powrót klienta do sklepu
Inicjalizacja płatności
Przekierowanie do panelu transakcyjnego
Adres URL: https://platnosc.hotpay.pl/
Content-Type: multipart/form-data
Dostępne metody: POST/GET
Opis użycia
| Zmienna | Wymagane | Opis zmiennej |
|---|---|---|
SEKRET |
TAK | Kod sekret do pobrania z panelu HotPay generowany dla każdego serwisu. |
KWOTA |
TAK | Kwota wywoływanej płatności. |
NAZWA_USLUGI |
TAK | Nazwa usługi/towaru |
ADRES_WWW |
NIE | Adres URL powrotu |
ID_ZAMOWIENIA |
TAK | Identyfikator zamówienia po stronie serwisu – nadawany przez właściciela serwisu. Ciąg znaków przesyłany w tej zmiennej nie może być dłuższy niż 64 znaki. |
EMAIL |
NIE | Email klienta |
DANE_OSOBOWE |
NIE | Dane osobowe klienta |
<form id="order" action="https://platnosc.hotpay.pl/" method="post">
<input required name="SEKRET" value="SEKRET_USLUGI"
type="hidden">
<input required name="KWOTA" value="1" type="hidden">
<input required name="NAZWA_USLUGI" value="XXX"
type="hidden">
<input required name="ADRES_WWW" value="XXX" type="hidden">
<input required name="ID_ZAMOWIENIA" value="XXX"
type="hidden">
<input name="EMAIL" value="" type="hidden">
<input name="DANE_OSOBOWE" value="" type="hidden">
<button type="submit">DALEJ</button>
</form>
Odbiór notyfikacji
Notyfikacje są wysyłane metodą POST typu form-data na adres WWW podany w ustawieniach usługi.
Zasady konfiguracji odbioru, weryfikacji danych i obsługi ponowień opisano na stronie Notyfikacje.
Uwaga
Pamiętaj o weryfikacji danych przychodzących.
Uwaga
Notyfikacje są wysyłane z góry ustalonych adresów IP, prosimy dodać je do whitelisty:
- 18.197.55.26
- 3.126.108.86
- 3.64.128.101
- 18.184.99.42
- 3.72.152.155
- 35.159.7.168
Opis użycia
| Zmienna | Opis zmiennej |
|---|---|
SEKRET |
Kod sekret do pobrania z panelu HotPay generowany dla każdego serwisu. |
KWOTA |
Kwota wywoływanej płatności. |
STATUS |
Status płatności: SUCCESS – płatność zaakceptowana; PENDING – płatność oczekująca; FAILURE – płatność odrzucona. |
ID_ZAMOWIENIA |
Identyfikator zamówienia po stronie serwisu – nadawany przez właściciela serwisu. Ciąg znaków przesyłany w tej zmiennej nie może być dłuższy niż 64 znaki. |
ID_PLATNOSCI |
Unikalny identyfikator płatności |
HASH |
HASH funkcji skrótu sha256, składającej się z elementów: HASLO_Z_USTAWIEN.";".$_POST["KWOTA"].";".$_POST["ID_PLATNOSCI"].";".$_POST["ID_ZAMOWIENIA"].";".$_POST["STATUS"].";".$_POST["SEKRET"] |
<?php
$HASLO_Z_USTAWIEN="XXX";
if(!empty($_POST["KWOTA"]) &&
!empty($_POST["ID_PLATNOSCI"]) &&
!empty($_POST["ID_ZAMOWIENIA"]) &&
!empty($_POST["STATUS"]) &&
!empty($_POST["SEKRET"]) &&
!empty($_POST["HASH"])
){
if(hash("sha256",$HASLO_Z_USTAWIEN.";".$_POST["KWOTA"].";".$_POST["ID_PLATNOSCI"].";".$_POST["ID_ZAMOWIENIA"].";".$_POST["STATUS"].";".$_POST["SEKRET"]) == $_POST["HASH"]){
//komunikacja poprawna
if($_POST["STATUS"]=="SUCCESS"){
//płatność zaakceptowana
}else if($_POST["STATUS"]=="FAILURE"){
//odrzucone
}
}
}
API konta
API konta umożliwia pobieranie informacji o transakcjach przelewowych oraz wykonywanie ich zwrotów. Pobranie danych transakcji jest możliwe na podstawie identyfikatora płatności nadanego przez HotPay lub własnego identyfikatora zamówienia.
Dane dostępowe
Do wykonania obu operacji wymagane są:
API_KEY– klucz API dostępny w ustawieniach konta HotPay.USLUGA– sekret usługi, której dotyczy transakcja. Jest to sekret wykorzystywany jakoSEKRETprzy inicjowaniu płatności przelewowej.
Pobieranie transakcji
Pobieranie transakcji
Adres URL: https://api.hotpay.pl/KONTO/PRZELEW/
Content-Type: multipart/form-data
Dostępne metody: POST
Format odpowiedzi: JSON
W żądaniu należy przekazać dane dostępowe oraz jeden z identyfikatorów: ID_PLATNOSCI lub ID_ZAMOWIENIA.
Opis użycia
| Zmienna | Wymagane | Opis zmiennej |
|---|---|---|
API_KEY |
TAK | Klucz API dostępny w ustawieniach konta HotPay. |
USLUGA |
TAK | Sekret usługi, której dotyczy transakcja. |
ID_PLATNOSCI |
Warunkowo | Identyfikator płatności nadany przez HotPay. Wymagany, jeśli nie przekazano ID_ZAMOWIENIA. |
ID_ZAMOWIENIA |
Warunkowo | Własny identyfikator zamówienia przekazany przy inicjowaniu płatności. Stosowany zamiast ID_PLATNOSCI. |
<?php
$ch = curl_init("https://api.hotpay.pl/KONTO/PRZELEW/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'API_KEY' => 'XXX',
'USLUGA' => 'XXX',
'ID_PLATNOSCI' => 'XXX'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$result = curl_exec($ch);
if ($result === false) {
$blad = curl_error($ch);
curl_close($ch);
throw new RuntimeException('Błąd połączenia z API HotPay: ' . $blad);
}
curl_close($ch);
$odpowiedz = json_decode($result, true, 512, JSON_THROW_ON_ERROR);
if (($odpowiedz['STATUS'] ?? false) !== true) {
throw new RuntimeException(
$odpowiedz['WIADOMOSC'] ?? 'Nie udało się pobrać transakcji.'
);
}
$transakcje = $odpowiedz['TRANSAKCJE'];
// Dane transakcji są dostępne w tablicy $transakcje.
Aby pobrać dane na podstawie własnego identyfikatora zamówienia, w przykładzie PHP zamień tablicę przekazywaną do CURLOPT_POSTFIELDS na:
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'API_KEY' => 'XXX',
'USLUGA' => 'XXX',
'ID_ZAMOWIENIA' => 'ZAM-123'
]);
Identyfikator ID_PLATNOSCI potrzebny do zwrotu odczytasz z pola ID_PLATNOSCI w odpowiednim elemencie tablicy TRANSAKCJE.
Odpowiedź
Odpowiedź API
{
"STATUS": true,
"WIADOMOSC": "",
"TRANSAKCJE": [
{
"ID_PLATNOSCI": "xxx",
"ID_ZAMOWIENIA": "ZAM-123",
"DATA_START": "xxx",
"DATA_AKTUALIZACJA": "xxx",
"KWOTA": 10,
"KWOTA_SALDO": 10,
"STATUS": "xxx",
"EMAIL": "[email protected]",
"DANE_OSOBOWE": "xxx"
}
]
}
Wartości są przykładowe. Zapis xxx zastępuje dane zwracane przez API, w tym daty oraz status transakcji.
| Zmienna | Opis zmiennej |
|---|---|
STATUS |
Wynik wykonania zapytania. Wartość true oznacza poprawne pobranie danych. |
WIADOMOSC |
Komunikat zwrócony przez API. |
TRANSAKCJE |
Tablica zawierająca dane transakcji. |
Każdy element tablicy TRANSAKCJE zawiera następujące pola:
| Zmienna | Opis zmiennej |
|---|---|
ID_PLATNOSCI |
Identyfikator płatności nadany przez HotPay. Wykorzystywany przy wykonywaniu zwrotu. |
ID_ZAMOWIENIA |
Własny identyfikator zamówienia przekazany przy inicjowaniu płatności. |
DATA_START |
Data rozpoczęcia transakcji. |
DATA_AKTUALIZACJA |
Data aktualizacji transakcji. |
KWOTA |
Kwota transakcji. |
KWOTA_SALDO |
Kwota salda zwrócona przez API dla transakcji. |
STATUS |
Status transakcji. |
EMAIL |
Adres e-mail powiązany z transakcją. |
DANE_OSOBOWE |
Dane osobowe powiązane z transakcją. |
Wynik zapytania a status płatności
Pole STATUS na poziomie odpowiedzi określa wynik zapytania do API. Status samej płatności znajduje się w polu STATUS wewnątrz elementu tablicy TRANSAKCJE. Poprawne pobranie danych nie oznacza, że płatność została zaakceptowana.
Zwrot transakcji
Do wykonania zwrotu wymagany jest identyfikator płatności ID_PLATNOSCI oraz kwota zwrotu. Jeżeli znasz wyłącznie własny identyfikator zamówienia, najpierw pobierz informacje o transakcji, przekazując ID_ZAMOWIENIA do endpointu pobierania transakcji.
Zwrot transakcji
Adres URL: https://api.hotpay.pl/KONTO/PRZELEW/ZWROT
Content-Type: multipart/form-data
Dostępne metody: POST
Format odpowiedzi: JSON
Opis użycia
| Zmienna | Wymagane | Opis zmiennej |
|---|---|---|
API_KEY |
TAK | Klucz API dostępny w ustawieniach konta HotPay. |
USLUGA |
TAK | Sekret usługi, której dotyczy transakcja. |
ID_PLATNOSCI |
TAK | Identyfikator płatności nadany przez HotPay. |
KWOTA |
TAK | Kwota zwrotu w PLN w formacie dziesiętnym. Dla zwrotu 10 PLN należy przekazać wartość 10. |
<?php
$ch = curl_init("https://api.hotpay.pl/KONTO/PRZELEW/ZWROT");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'API_KEY' => 'XXX',
'USLUGA' => 'XXX',
'ID_PLATNOSCI' => 'XXX',
'KWOTA' => '10'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
$result = curl_exec($ch);
if ($result === false) {
$blad = curl_error($ch);
curl_close($ch);
throw new RuntimeException('Błąd połączenia z API HotPay: ' . $blad);
}
curl_close($ch);
$odpowiedz = json_decode($result, true, 512, JSON_THROW_ON_ERROR);
if (($odpowiedz['STATUS'] ?? false) !== true) {
throw new RuntimeException(
$odpowiedz['WIADOMOSC'] ?? 'Nie udało się wykonać zwrotu.'
);
}
// API potwierdziło poprawny zwrot transakcji.
Odpowiedź
Odpowiedź API
{
"STATUS": true,
"WIADOMOSC": "xxx"
}
Wartość true oznacza poprawny zwrot transakcji. Zapis xxx zastępuje treść komunikatu zwróconego przez API.
| Zmienna | Opis zmiennej |
|---|---|
STATUS |
Wynik przyjęcia zwrotu. Wartość true oznacza poprawne przyjęcie. |
WIADOMOSC |
Komunikat zwrócony przez API. |