> ## 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": <int>, "message": "<text>"}`. 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

# Start

> DocPay — payments for single documents: payment demands, tickets and invoices, delivered as a QR code.

DocPay (PAY API) lets you accept payments for individual documents - payment requests, tickets, invoices. The basic integration scenario is simple: **you create the product once**, then register a **subproduct** for each individual payment. The response contains a QR code that redirects the customer directly to the payment page.

## How does a payment work?

```mermaid theme={"theme":{"light":"one-light","dark":"one-dark-pro"}}
sequenceDiagram
    participant M as Your system
    participant P as Paymove API
    participant K as Customer

    Note over M,P: One-time
    M->>P: Create product (partnerId, name)
    P->>M: { productId }
    Note over M,P: For each payment
    M->>P: Create subproduct (externalId, price, details)
    P->>M: QR code
    M->>K: Deliver QR code (e.g. on a document)
    K->>P: Scans QR code and pays for the document
```

| Step | Who         | What happens                                                                         |
| ---- | ----------- | ------------------------------------------------------------------------------------ |
| 1    | Your system | Creates the product - once, when starting the integration                            |
| 2    | Your system | For each payment creates a subproduct with `externalId`, amount and document details |
| 3    | Paymove     | Returns a QR code redirecting to payment                                             |
| 4    | Customer    | Scans the QR code (e.g. from a payment request) and pays for the document            |

<CardGroup cols={2}>
  <Card title="DocPay: basic integration" icon="rocket" href="/en/products/docpay/tutorial">
    Step by step: create a product and a subproduct with a QR code.
  </Card>

  <Card title="REST API" icon="code" href="/en/products/docpay/rest-api">
    Full endpoint reference: pricing, forms, UI customization, webhooks, subproduct.
  </Card>
</CardGroup>

## What you need for integration

| Data        | Format                                                | Description                                        |
| ----------- | ----------------------------------------------------- | -------------------------------------------------- |
| `apiKey`    | `sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | Authorization key sent in the `X-API-KEY` header   |
| `partnerId` | `78562c79-2f5c-4415-8af4-c871eea92ef2`                | UUID identifying the partner in the Paymove system |

You will receive your `API key` and `partnerId` from Paymove. Sandbox environment URL: `https://gateway-api.sandbox.paymove.io`.
