Przykładowy adres na który należy wysłać żądanie POST
https://api.axepta.pl/v1/merchant/6yt3gjtm9p7b8h9xsdqz/payment-link
Payload zapytania
{
"serviceId": "62f574ed-d4ad-4a7e-9981-89ed7284aaba",
"amount": 1000,
"currency": "PLN",
"orderId": "139",
"successReturnUrl": "https://domain.com/success",
"failureReturnUrl": "https://domain.com/failure",
"customer": {
"firstName": "Jan",
"lastName": "Kowalski",
"email": "jan.kowalski@example.com"
}
}
Parametry payload
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
serviceId |
string(36) | ✔️ | identyfikator sklepu jako UUID v4. |
amount |
integer(1-999999999) | ✔️ | Kwota transakcji w najmniejszej jednostce waluty np. grosze. |
currency |
string(3) | ✔️ | Waluta transakcji w standardzie ISO 4217. |
orderID |
string(100) | ✔️ | Numer zamówienia akceptanta, dopuszczalne znaki: A-Za-z0-9#_-.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne) |
title |
string(255) | - | Tytuł zamówienia, dopuszczalne znaki: A-Za-z0-9#&_-"',.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne) |
returnUrl |
string(300) | - | Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku nie rozstrzygnięcia statusu transakcji. |
successReturnUrl |
string(300) | - | Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku dokonania płatności z powodzeniem. |
failureReturnUrl |
string(300) | - | Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku wystąpienia błędu płatności. |
customer |
object | ✔️ | Dane klienta. |
activeTo |
integer, null | - | Data ważności transakcji jako unix timestamp w sekundach (czas mierzony w sekundach od początku 1970 roku UTC) (wartość musi być większa, bądz równa: 1 i mniejsza bądź równa 4294967295). Jeżeli nie jest przekazana lub jest null to transakcja ważna jest zawsze. Brak realizacji płatności do tego czasu spowoduje jej anulowanie. |
paywall.forceCardChannel |
string | - | Wymuszenie trybu płatności kartą. Pozwala na inicjalizację płatności kartą w trybie zapisywania profilu kartowego. Dostępne wartości: ecom3ds, oneclick, recurring. W przypadku korzystania z oneclick lub recurring. wymagane jest przekazanie parametru customer.cid. |
distributor |
string | - | Nazwa dystybutora, wartość dopuszczalna: "shoper". |
visibleMethod |
array | - | Widoczność metod płatności, domyślnie widoczne są wszystkiedostępne dla sklepu.Opis w punkcie 5.3 |
surcharge |
boolean | - | flaga determinujaca czy zostanie użyte obciazenie platnika dla danego zamowienia. Wartość dopuszczalna: 'true', 'false' (wymagane ustawienie flagi surcharge w procesie boardingu). |
Parametry dla customer:
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
firstName |
string(100) | ✔️ | Imię klienta, dopuszczalne znaki: A-Za-z0-9#&_-"',.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne) |
lastName |
string(100) | ✔️ | Nazwisko klienta, dopuszczalne znaki: A-Za-z0-9#&_-"',.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne) |
email |
string(200) | ✔️ | Adres email. |
phone |
string(20) | - | Numer telefonu, dopuszczalne znaki: 0-9+- oraz znak spacji (0x20). |
cid |
string(36) | - | Identyfikator klienta/płatnika nadany przez akceptanta. (Wymagane podczas płatności oneclick, recurring), dopuszczalne znaki: A-Za-z0-9 oraz myślnik (0x2D) |