Utworzenie transakcji 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}/transaction

Zgodnie z wymaganiami PCI DSS (ustalonymi przez organizacje płatnicze) zabronione jest przetwarzanie, przekazywanie czy przechowywanie numerów i innych danych dotyczących kart płatniczych. Jeśli posiadasz właściwy certyfikat PCI DSS i chcesz udostępnić formatkę płatności kartami na stronie Twojego sklepu - prosimy o kontakt z obsługą Axepta. W przypadku bezpośredniego przekierowania na formatkę płatności kartami Axepta nie ma takiego wymogu.

Path parameters

  • merchantId string Required

    Identyfikator klienta

application/json

Body Required

  • type string Required

    Typ transakcji. Dopuszczalne wartości: sale

    Value is sale.

  • 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ł transakcji, 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]+$.

  • paymentMethod string Required

    Metoda realizacji zamówienia. Więcej informacji w rozdziale [1.4 Metody i kanały realizacji transakcji]

  • paymentMethodChannel string Required

    Oznaczenie kanału płatności. Więcej informacji w rozdziale [1.4 Metody i kanały realizacji transakcji]

  • successReturnUrl string(uri) Required

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

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

    Maximum length is 300.

  • returnUrl string(uri)

    Domyślny adres powrotu.

    Maximum length is 300.

  • clientIp string(ipv4, ipv6) Required

    Rzeczywisty adres IP płatnika podany w protokole IPv4 lub IPv6. Wymagany przy podaniu blikCode.

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

  • blikCode integer

    Wartość kodu blik dla transakcji z przekazaniem kodu po API.

    Maximum length is 6.

  • distributor string

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

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

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

    • 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/płatnika nadany przez akceptanta, 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]+$.

    • locale string

      Lokalizacja płatnika, określa język wysyłanej wiadomości mailowej, informującej o rozpoczęciu procesu płatności, dopuszczalne wartości: pl, en.

  • card object

    Dane dot. płatności kartą. (Wymagane podczas płatności card)

    Hide card attributes Show card attributes object
    • firstName string Required

      Imię właściciela karty, 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.

    • lastName string Required

      Nazwisko właściciela karty, 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.

    • number string Required

      Numer karty

      Maximum length is 16.

    • month string Required

      Ważność karty - miesiąc

      Maximum length is 2.

    • year string Required

      Ważność karty - rok

      Maximum length is 4.

    • cvv string Required

      Kod cvv karty

      Maximum length is 4.

  • additionalData object

    Informacje o przeglądarce płatnika, wymagane podczas wykonywania płatności kartą z autoryzacją 3ds.

POST /merchant/{merchantId}/transaction
curl \
 --request POST 'https://api.sandbox.axepta.pl/v1/merchant/{merchantId}/transaction' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"type":"sale","serviceId":"a3a5b7ad-ab73-46f0-97f2-3238f8bd450d","amount":100,"currency":"PLN","title":"Title 123","orderId":"123-123","paymentMethod":"blik","paymentMethodChannel":"blik","blickCode":777000,"successReturnUrl":"https://domain.com/success","failureReturnUrl":"https://domain.com/failure","customer":{"firstName":"Jan","lastName":"Kowalski","phone":48123123123,"email":"jan.kowalski@example.com"}}'
Request example
{
  "type": "sale",
  "serviceId": "a3a5b7ad-ab73-46f0-97f2-3238f8bd450d",
  "amount": 100,
  "currency": "PLN",
  "title": "Title 123",
  "orderId": "123-123",
  "paymentMethod": "blik",
  "paymentMethodChannel": "blik",
  "blickCode": 777000,
  "successReturnUrl": "https://domain.com/success",
  "failureReturnUrl": "https://domain.com/failure",
  "customer": {
    "firstName": "Jan",
    "lastName": "Kowalski",
    "phone": 48123123123,
    "email": "jan.kowalski@example.com"
  }
}