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

Endpoints

This section provides an overview of the functionalities exposed through the QR MIA API, presenting the complete list of available endpoints. Each endpoint is defined by the HTTP method, URL path, and its main purpose within the flow of generating and managing QR codes and associated payments. The endpoints cover operations such as authentication, QR code generation (static, dynamic, hybrid), extending or canceling codes, retrieving details, transaction listing, and payment simulation.

The QR MIA API exposes the following endpoints:

  • Authentication

    • Obtain authentication token

  • Generate and manage QR codes

    • Create QR code

    • Create hybrid QR code

    • Get QR details by ID

    • Cancel active QR code by ID

    • Create QR code extension

    • Cancel active QR code extension

    • Get list of QR codes (with filters)

    • Get list of QR code extensions (with filters)

  • Payment management

    • Get payment details by ID

    • Get list of payments (with filters)

    • Refund payment by ID

  • Testing

    • Simulate payment (test)

The table below presents all available endpoints:

HTTP Method
URL
Description

POST

/v2/auth/token

Get Authentication Token

POST

/v2/mia/qr

Create QR Code

POST

/v2/mia/qr/hybrid

Create Hybrid QR Code

GET

/v2/mia/qr/{qrId}

Get QR Details by ID

POST

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

Cancel Active QR Code by ID

POST

/v2/mia/qr/{qrId}/extension

Create QR Code Extension

POST

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

Cancel Active QR Code Extension

GET

/v2/mia/qr

Get QR Code List (with filter)

GET

/v2/mia/payments/{payId}

Get Payment Details by ID

GET

/v2/mia/payments

Get Payment List (with filter)

POST

/v2/mia/payments/{payId}/refund

Refund Payment by ID

GET

/v2/mia/qr/extension

Get QR Extensions List

POST

/v2/mia/test-pay

Simulate Payment in Test Environment

PreviousMIA QR TypesNextAuthentication

Last updated 1 day ago