Integracja

Podstawowy scenariusz integracji składa się z dwóch kroków. Produkt tworzysz jednorazowo, a następnie dla każdej płatności - niezależnie od tego, czego dotyczy - tworzysz subprodukt. W odpowiedzi otrzymujesz kod QR z linkiem przekierowującym płacącego do strony płatności. Wszystkie żądania autoryzujesz kluczem API przekazywanym w nagłówku X-API-KEY.

Przykłady używają środowiska sandbox: https://gateway-api.sandbox.paymove.io.

Krok 1: Utworzenie produktu

Produkt reprezentuje Twoją działalność w systemie Paymove i jest kontenerem dla subproduktów (pojedynczych płatności). Tworzysz go tylko raz, przy starcie integracji.

curl --request POST \
  --url https://gateway-api.sandbox.paymove.io/api/product/pay \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
  --data '{
    "partnerId": "78562c79-2f5c-4415-8af4-c871eea92ef2",
    "productType": "PAY",
    "name": "Płatności Online",
    "shortName": "PAYLINK",
    "location": "Warszawa",
    "timezone": "Europe/Warsaw"
  }'

Pole	Wymagane	Opis
`partnerId`	Tak	Identyfikator partnera (nadawany przez Paymove).
`productType`	Tak	Typ produktu - zawsze `PAY`.
`name`	Tak	Nazwa produktu.
`shortName`	Tak	Krótka nazwa wyświetlana.
`location`	Tak	Lokalizacja (np. miasto).
`timezone`	Tak	Strefa czasowa IANA (np. `Europe/Warsaw`).

Odpowiedź (200):

{
  "id": "d0a834f9-94a4-4b3a-aa10-27d911e3633f",
  "name": "Płatności Online",
  "location": "Warszawa",
  "partner": {
    "id": "78562c79-2f5c-4415-8af4-c871eea92ef2",
    "name": "Nazwa Partnera Sp. z o.o.",
    "productTypes": ["PAY"]
  },
  "timezone": "Europe/Warsaw",
  "shortName": "PAYLINK",
  "emailEnabled": true,
  "smsEnabled": false,
  "fee": {
    "id": "01f9754e-78e3-4b2c-8186-d6862598a95a",
    "minimum": 30,
    "amount": 5,
    "fixed": false
  },
  "productType": "PAY",
  "status": "ACTIVE",
  "creator": "PAYMOVE",
  "reviewEnabled": false,
  "createdAt": 1783245692.623763835,
  "updatedAt": 1783245692.623763835
}

Pole id z odpowiedzi to identyfikator produktu (productId), którego użyjesz w kroku 2.

Krok 2: Utworzenie subproduktu (link płatności)

Subprodukt reprezentuje pojedynczą płatność za cokolwiek - konsultację, rezerwację, składkę, naprawę, zamówienie telefoniczne. W URL podmień identyfikator produktu (productId) otrzymany w kroku 1. W polu details przekazujesz dowolne pary klucz-wartość opisujące, czego dotyczy płatność - to one zostaną wyświetlone płacącemu na stronie płatności.

curl --request POST \
  --url https://gateway-api.sandbox.paymove.io/api/pay/product/d0a834f9-94a4-4b3a-aa10-27d911e3633f/subproduct \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
  --data '{
    "externalId": "payment-2026-0001",
    "imageFormat": "png",
    "bannerType": "ticket",
    "price": 15000,
    "details": {
      "Tytuł płatności": "Konsultacja online - 60 minut",
      "Za co": "Usługa doradcza",
      "Odbiorca": "Twoja Firma Sp. z o.o.",
      "Nr płatności": "payment-2026-0001"
    }
  }'

Pole	Wymagane	Opis
`externalId`	Tak	Identyfikator płatności w Twoim systemie. Wyświetlany w panelu Paymove.
`imageFormat`	Tak	Format grafiki kodu QR: `svg` lub `png`.
`bannerType`	Tak	Typ banera/karty (np. `ticket`) - wpływa na prezentację.
`price`	Tak	Kwota w groszach (np. `15000` = 150,00 PLN).
`details`	Nie	Dowolne pary klucz-wartość opisujące płatność - wyświetlane płacącemu na stronie płatności.

Wartości z details są wyświetlane płacącemu na stronie płatności - klucz to etykieta, a wartość to prezentowany tekst. Płatność może dotyczyć czegokolwiek: opisz ją tak, żeby płacący wiedział, za co płaci (np. „Tytuł płatności”, „Za co”, „Odbiorca”).

Odpowiedź: kod QR z linkiem płatności

Odpowiedź (200) to binarna zawartość obrazka z kodem QR w formacie wskazanym w imageFormat (SVG lub PNG), zwracana z nagłówkiem Content-Type: application/octet-stream. To nie jest JSON - zapisz body odpowiedzi bezpośrednio do pliku, np.:

curl --request POST \
  --url https://gateway-api.sandbox.paymove.io/api/pay/product/{productId}/subproduct \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
  --data '{ ... }' \
  --output link-platnosci.png

Grafika zawiera gotowy do użycia baner z kodem QR przekierowującym do płatności (dla png np. 300x780 px). Możesz go wysłać e-mailem lub SMS-em, umieścić na wydruku albo wyświetlić na ekranie - płacący po zeskanowaniu (lub kliknięciu linku) trafia bezpośrednio do opłacenia należności.

Co dalej?

DocPay: webhooki

Dodaj webhook i otrzymuj automatyczne powiadomienia o każdej zakończonej płatności.

REST API

Pełna dokumentacja endpointów PAY API: cennik, formularze, personalizacja UI i webhooki.

Wprowadzenie

Integracje

Tutoriale

Pomoc

Krok 1: Utworzenie produktu

Krok 2: Utworzenie subproduktu (link płatności)

Odpowiedź: kod QR z linkiem płatności

Co dalej?

DocPay: webhooki

REST API

​Krok 1: Utworzenie produktu

​Krok 2: Utworzenie subproduktu (link płatności)

​Odpowiedź: kod QR z linkiem płatności

​Co dalej?

DocPay: webhooki

REST API

Krok 1: Utworzenie produktu

Krok 2: Utworzenie subproduktu (link płatności)

Odpowiedź: kod QR z linkiem płatności

Co dalej?