Získanie stavu platby

HTTP metóda

GET

URL

{server_address}/api/v1/payments/qr/{transactionId}?await={await}

Požiadavka

Hlavičky

Kľúč	Hodnota	Popis
`Content-Type`	`application/json`	Telo požiadavky je vo formáte JSON.

Parametre cesty (Path parametre)

Názov	Typ	Povinné	Popis
`transactionId`	`string`	Áno	ID platby (napríklad _QR-5aab8a57dbf34436bb642ed76c249ab1)

Parametre dopytu (Query parametre)

Názov	Typ	Povinné	Popis
`await`	`bool`	Nie	Uveďte hodnotu `false`, ak má byť odpoveď z API vrátená bezprostredne a bude obsahovať okamžitý stav platby. Uveďte hodnotu `true`, pre vrátenie odpovede z API vrátená až po dokončení platby (teda po prechode do konečného stavu `paid`, `overpaid` alebo `expired`). Predvolená hodnota je `false`.

Odpoveď

Odpoveď HTTP 200 (OK)

Dátový model QrPayment

{
    "transactionId": "QR-5aab8a57dbf34436bb642ed76c249ab1",
    "amount": 19.90,
    "currencyCode": "EUR",
    "merchant": {
        "iban": {
            "value": "SK4811000000002944116480"
        },
        "name": {
            "value": "Merchant Name, s.r.o."
        }
    },
    "cashRegisterCode": "88812345678900001",
    "createdAt": "2025-10-24T13:24:35+02:00",
    "expiresAt": "2025-10-24T13:26:35+02:00",
    "payments": [],
    "status": "Expired",
    "paidAmount": 0.00,
    "remainingAmount": 19.90,
    "overpaidAmount": 0.00,
    "recipientMessage": "eKasa QR platba",
    "links": [
        {
            "provider": "payme",
            "version": "2.0",
            "url": "https://payme.sk/2/m/PME?IBAN=SK4811000000002944116480&AM=19.90&CC=EUR&PI=QR-5aab8a57dbf34436bb642ed76c249ab1&CN=Merchant+Name%2C+s.r.o."
        },
        {
            "provider": "payme",
            "version": "1.3",
            "url": "https://payme.sk/?V=1&IBAN=SK4811000000002944116480&AM=19.90&CC=EUR&CN=Merchant+Name%2C+s.r.o."
        }
    ]
}

Get Payment Status

HTTP Method

GET

URL

{server_address}/api/v1/payments/qr/{transactionId}?await={await}

Request

Headers

Key	Value	Description
`Content-Type`	`application/json`	The request body is JSON formatted.

Path Parameters

Name	Type	Required	Description
`transactionId`	`string`	Yes	Payment ID (e.g., _QR-5aab8a57dbf34436bb642ed76c249ab1).

Query Parameters

Name	Type	Required	Description
`await`	`bool`	No	Specify `false` to return an immediate response containing the current payment status. Specify `true` to return the response only after the payment is completed (that is, when it transitions to a final state: `paid`, `overpaid`, or `expired`). The default value is `false`.

Response

HTTP 200 (OK)

Data model QrPayment

{
    "transactionId": "QR-5aab8a57dbf34436bb642ed76c249ab1",
    "amount": 19.90,
    "currencyCode": "EUR",
    "merchant": {
        "iban": {
            "value": "SK4811000000002944116480"
        },
        "name": {
            "value": "Merchant Name, s.r.o."
        }
    },
    "cashRegisterCode": "88812345678900001",
    "createdAt": "2025-10-24T13:24:35+02:00",
    "expiresAt": "2025-10-24T13:26:35+02:00",
    "payments": [],
    "status": "Expired",
    "paidAmount": 0.00,
    "remainingAmount": 19.90,
    "overpaidAmount": 0.00,
    "recipientMessage": "eKasa QR platba",
    "links": [
        {
            "provider": "payme",
            "version": "2.0",
            "url": "https://payme.sk/2/m/PME?IBAN=SK4811000000002944116480&AM=19.90&CC=EUR&PI=QR-5aab8a57dbf34436bb642ed76c249ab1&CN=Merchant+Name%2C+s.r.o."
        },
        {
            "provider": "payme",
            "version": "1.3",
            "url": "https://payme.sk/?V=1&IBAN=SK4811000000002944116480&AM=19.90&CC=EUR&CN=Merchant+Name%2C+s.r.o."
        }
    ]
}