Utworzenie zamówienia linku płatności Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/pgw/doc/axepta-api/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
"axepta API MCP server": {
  "url": "https://bump.sh/pgw/doc/axepta-api/mcp"
}
Close
POST /merchant/{merchantId}/payment-link

Path parameters

  • merchantId string Required

    Identyfikator klienta

application/json

Body Required

  • serviceId string(uuid) Required

    Identyfikator sklepu jako UUID v4

    Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

  • amount integer Required

    Kwota transakcji w najmniejszej jednostce waluty np. grosze

  • currency string Required

    Waluta transakcji w standardzie ISO 4217

    Maximum length is 3. Values are PLN or EUR.

  • orderId string Required

    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)

    Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\/ \u00C0-\u02C0]+$.

  • title string

    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).

    Maximum length is 255. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\/ \u00C0-\u02C0]+$.

  • customer object Required
    Hide customer attributes Show customer attributes object
    • firstName string Required

      Imię klienta,
      dopuszczalne znaki: A-Za-z0-9#&_-"',.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne), 0400 - 04FF (cyrylica)

      Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\.\/ \u00C0-\u02C0\u0400-\u04FF]+$.

    • lastName string Required

      Nazwisko klienta,
      dopuszczalne znaki: A-Za-z0-9#&_-"',.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne), 0400 - 04FF (cyrylica)

      Maximum length is 100. Format should match the following pattern: ^[A-Za-z0-9#_\-\,\.\\\\/ \u00C0-\u02C0\u0400-\u04FF"']+$.

    • email string(email) Required

      Adres e-mail w formacie zgodnym ze standardem RFC 5322 oraz RFC 6531

      Maximum length is 200.

    • phone string

      Numer telefonu,
      dopuszczalne znaki: 0-9+- oraz znak spacji (0x20)

      Maximum length is 20. Format should match the following pattern: ^[0-9\+\- ]+$.

    • cid string

      Identyfikator klienta. (Wymagane podczas płatności oneclick, recurring),
      dopuszczalne znaki: A-Za-z0-9 oraz myślnik (0x2D)

      Maximum length is 36. Format should match the following pattern: ^[A-Za-z0-9\x2D]+$.

  • returnUrl string(uri)

    Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku nie rozstrzygnięcia statusu transakcji

    Maximum length is 300.

  • successReturnUrl string(uri)

    Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku dokonania płatności z powodzeniem

    Maximum length is 300.

  • failureReturnUrl string(uri)

    Adres powrotu z zewnętrznej strony obsługującej płatność w przypadku wystąpienia błędu płatności

    Maximum length is 300.

  • visibleMethod array

    Widoczność metod płatności, domyślnie widoczne są wszystkie dostępne dla sklepu. Opis w punkcie 5.3 Widoczność metod płatności

  • 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.

  • 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.

  • distributor string

    Nazwa dystybutora, wartość dopuszczalna: "shoper".

  • surcharge boolean

    Flaga determinujaca czy zostanie użyte obciazenie platnika dla danego zamowienia. Wartość dopuszczalna: 'true', 'false' (wymagane ustawienie flagi surcharge w procesie boardingu).

POST /merchant/{merchantId}/payment-link
curl \
 --request POST 'https://api.sandbox.axepta.pl/v1/merchant/3hqitucfo8jh5kqlp7s6/payment-link' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"serviceId":"a3a5b7ad-ab73-46f0-97f2-3238f8bd450d","amount":3000,"currency":"PLN","orderId":123,"returnUrl":"https://domain.com/return","successReturnUrl":"https://domain.com/success","failureReturnUrl":"https://domain.com/failure","notificationUrl":"https://domain.com/notification","customer":{"firstName":"Jan","lastName":"Kowalski","email":"jan.kowalski@example.com"}}'
Request example
{
  "serviceId": "a3a5b7ad-ab73-46f0-97f2-3238f8bd450d",
  "amount": 3000,
  "currency": "PLN",
  "orderId": 123,
  "returnUrl": "https://domain.com/return",
  "successReturnUrl": "https://domain.com/success",
  "failureReturnUrl": "https://domain.com/failure",
  "notificationUrl": "https://domain.com/notification",
  "customer": {
    "firstName": "Jan",
    "lastName": "Kowalski",
    "email": "jan.kowalski@example.com"
  }
}