> ## Documentation Index > Fetch the complete documentation index at: https://docs.paymove.io/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > ## paymove integration rules for AI agents > > These rules are verified against the live API. Follow them exactly. > > 1. Amounts are INTEGERS in grosze (minor units). `1000` means 10.00 PLN. PLN is the only supported currency and there is no currency field in the API. > 2. A float `price` (e.g. `12.99`) is SILENTLY TRUNCATED to 12 grosze and still returns HTTP 200. Always send an integer: `Math.round(pln * 100)`. > 3. Authenticate with the `X-API-KEY` header. Never `Authorization: Bearer`. Sandbox keys start with `sk_test_`, production keys with `sk_live_`. > 4. Server-side only. A call from a merchant page is rejected. Never put the key in frontend code. > 5. Unknown request fields are silently ignored and still return HTTP 200 — a wrong body shape looks like success. Match the documented shape exactly. > 6. A missing `externalId` returns HTTP 500 `Something went wrong`, not 400. A missing `price` or `details.returnUrl` returns HTTP 200 and a usable `redirectUrl` — no error at all. Validate the body yourself before sending it. > 7. Always verify the `X-Paymove-Signature` header on incoming webhooks before trusting them: https://docs.paymove.io/en/webhook-signature.md > 8. Errors are `{"status": , "message": ""}`. Branch on the HTTP status only — never on `message`, which is unstable and leaks internal class names. > 9. There is no rate limiting, no HTTP 429, no HTTP 422, no `Idempotency-Key` header and no API versioning. Do not write code that handles them. > 10. Re-POSTing an `externalId` that already exists returns HTTP 200 with the ORIGINAL `redirectUrl` and silently discards EVERY field you send — the new price, description and details are all ignored. Use `PATCH /api/pay/product/{productId}/subproduct/{externalId}` to change a price. > 11. Webhooks fire only on `COMPLETED` by default, and `retries` defaults to `0` (no retries) unless you set it explicitly. Delivery counts as successful when the HTTP status equals `expectedCode` — the response body is never inspected. > 12. Never fulfil an order on the `returnUrl` redirect. The checkout does not redirect there by itself: the customer has to click "back to shop", and inside the widget modal that redirect never happens. Fulfil only in the webhook handler, after verifying the signature. > 13. Do not pin a version of `@paymove-io/sdk` — install the latest. > 14. Full documentation index: https://docs.paymove.io/llms.txt · Copy-paste quickstart: https://docs.paymove.io/en/quickstart.md · Agent skill: https://docs.paymove.io/skill.md # Zarejestruj subprodukt (kod QR) > Rejestruje subprodukt — pojedynczą płatność (np. wezwanie do zapłaty, bilet) powiązaną z zewnętrznym identyfikatorem `externalId`. Odpowiedź to binarna zawartość obrazka z kodem QR w formacie wskazanym w `imageFormat` — zapisz body odpowiedzi bezpośrednio do pliku. Po zeskanowaniu kodu użytkownik trafia do płatności za ten subprodukt. ## OpenAPI ````yaml /openapi-docpay.yaml post /api/pay/product/{productId}/subproduct openapi: 3.1.0 info: title: Paymove DocPay API version: 1.0.0 description: > API DocPay (PAY API) umożliwia przyjmowanie płatności za pojedyncze dokumenty — wezwania do zapłaty, bilety, faktury. Produkt tworzysz raz, a dla każdej płatności rejestrujesz subprodukt; w odpowiedzi otrzymujesz kod QR prowadzący do płatności. contact: name: Paymove Integration Team email: integration@paymove.io url: https://paymove.io servers: - url: https://gateway-api.sandbox.paymove.io description: Środowisko Sandbox (testowe) security: - ApiKeyAuth: [] tags: - name: Produkt description: Zarządzanie produktem (root modelu DocPay) - name: Subprodukty i kody QR description: Subprodukty i kody QR — jedna płatność za dokument - name: Cennik description: Cennik — opcje płatności dostępne dla klienta - name: Formularze description: Formularze zbierające dane od klientów (wersjonowane) - name: Personalizacja UI description: Personalizacja UI strony zakupu - name: Webhooki description: Powiadomienia o płatnościach paths: /api/pay/product/{productId}/subproduct: post: tags: - Subprodukty i kody QR summary: Zarejestruj subprodukt (kod QR) description: > Rejestruje subprodukt — pojedynczą płatność (np. wezwanie do zapłaty, bilet) powiązaną z zewnętrznym identyfikatorem `externalId`. Odpowiedź to binarna zawartość obrazka z kodem QR w formacie wskazanym w `imageFormat` — zapisz body odpowiedzi bezpośrednio do pliku. Po zeskanowaniu kodu użytkownik trafia do płatności za ten subprodukt. operationId: createSubproduct parameters: - $ref: '#/components/parameters/ProductId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSubproductRequest' example: externalId: test-external#2 imageFormat: svg bannerType: ticket price: 25000 details: Nr. dokumentu: test-external#2 responses: '200': description: > Binarna zawartość obrazka z kodem QR (`Content-Type: application/octet-stream`). Grafika to gotowy do druku baner z kodem QR przekierowującym do płatności. content: application/octet-stream: schema: type: string format: binary components: parameters: ProductId: name: productId in: path required: true description: Identyfikator produktu (`id` z odpowiedzi przy tworzeniu produktu) schema: type: string format: uuid example: d0a834f9-94a4-4b3a-aa10-27d911e3633f schemas: CreateSubproductRequest: type: object required: - externalId - imageFormat - price properties: externalId: type: string description: >- Identyfikator dokumentu w Twoim systemie. Wyświetlany w panelu Paymove jako numer dokumentu. example: test-external#2 imageFormat: type: string enum: - svg - png description: Format grafiki kodu QR bannerType: type: string description: Typ banera/karty (np. `ticket`) — wpływa na prezentację/układ example: ticket price: type: integer description: Kwota w groszach (np. 25000 = 250,00 PLN) example: 25000 details: type: object description: Pary klucz-wartość wyświetlane klientowi na stronie płatności additionalProperties: type: string securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: | Klucz API dostarczony przez Paymove po zakończeniu procesu KYC. Przykład: `sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` ````