maib MIA QR API
EN
EN
  • Overview
    • General Technical Specifications
    • MIA QR Types
  • Endpoints
    • Authentication
      • Obtain Authentication Token
    • Payment Initiation
      • Create QR Code (Static, Dynamic)
      • Create Hybrid QR Code
        • Create Extension for QR Code by ID
    • Payment Cancellation
      • Cancel Active QR (Static, Dynamic)
      • Cancel Active QR Extension (Hybrid)
    • Payment Refund
      • Refund Completed Payment
    • Information Retrieval (GET)
      • Display List of QR Codes with Filtering Options
      • Retrieve QR Details by ID
      • Retrieve List of Payments with Filtering Options
      • Retrieve Payment Details by ID
  • Payment Simulation (Sandbox)
  • Notifications on Callback URL
  • Errors
    • API Errors
    • HTTP Status Codes
  • Glossary
  • maib e-commerce API
Powered by GitBook
On this page
  1. Endpoints
  2. Payment Cancellation

Cancel Active QR (Static, Dynamic)

POST /v2/mia/qr/{qrId}/cancel

Allows cancellation of an active Static or Dynamic QR code. After cancellation, the QR code can no longer be used for payments.


Request parameters (path)

Name
Type
Required
Description

qrId

string (guid)

Yes

Unique identifier of the QR code.


Requests parameters (body)

Name
Type
Required
Description

reason

string (max. 500)

Yes

Reason for the cancellation request.

Request example

{
  "reason": "Client cancelled the order"
}

Response parameters

Name
Type
Description

result

obiect

The result object of the response.

result.qrId

string (guid)

Unique identifier of the QR code.

result.status

string (enum)

QR status. Possible values: Cancelled.

ok

boolean

true – no errors, false - with errors.

errors

array

List of processing errors, if any.

errors.errorCode

string

Error code.

errors.errorMessage

string

Error message.


Response example

{
  "result": {
    "qrId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "Cancelled"
  },
  "ok": true
}
PreviousPayment CancellationNextCancel Active QR Extension (Hybrid)

Last updated 1 day ago