MIA POS terminal API (0.1.4)

APIs for operating Pos terminals according to the MIA standard. This version adds support for working with Hybrid and Static QR codes. A separate API for working with dynamic QR codes is considered deprecated, but is still supported.

1. POS Activation

   • Initialize Terminal Activation: Perform a request to POST /pos/api/v1/terminal-activation/init to initialize terminal activation. The response will include the operation result and an activation identifier.
   • Confirm Terminal Activation: Perform a request to POST /pos/api/v1/terminal-activation/confirm to confirm the POS terminal.

2. Operator Authorization and Access Token Retrieval

   • Operator Login: Perform a request to POST /pos/api/v1/seller/login to authorize the operator and retrieve access tokens.
   • Refresh Tokens: Perform a request to POST /pos/api/v1/seller/refresh to obtain a new pair of tokens based on the refresh token.

3. Operator Shift Management

   • Check Shift Status: Perform a request to GET /pos/api/v1/shift/check to check the status of the current shift.
   • Open Shift: Perform a request to POST /pos/api/v1/shift/open to open a new shift.

4. Query version for working with Dynamic, Hybrid, Static QR codes

   • Receiving active QR codes: POS terminal allows you to work with only one active Static or Hybrid QR code at a time. If the terminal already has a generated active static QR code, it will not be possible to create another hybrud QR code. Using this request, you can get a list of active QR codes on the POS terminal GET /pos/api/v2/qr/active. There are no restrictions on the number of active dynamic QR codes.
   • Generate QR Code: Perform a request to POST /pos/api/v2/qr to create a QR code of the desired type in the specified type of amount.
     This request allows you to:
     Generate a dynamic QR with a fixed amount type: one-time QR code for payment. The user will have to pay the exact amount.
     Hybrid QR code with a fixed amount type: QR code that can be used to set multiple payments. The user must pay a fixed payment amount. After payment, you need to create a new payment request using QR.
     Hybrid QR code with a controlled amount: the user will be able to enter an amount from a specified range when paying.
     Static QR with a fixed amount: a QR code that can make several simultaneous payments. The user must pay a set amount.
     Static QR code with controlled amount: You can make several simultaneous payments using QR. The user can pay an amount from the specified range.
     Static QR code with free amount: The user can pay the merchant any amount.

   Extension model transmits information about the amount of payment charged. When generating a hybrid QR code or a static QR with a free amount, the extension object is not transmitted.

   • Creates a new QR code extension: Perform a request to /pos/api/v2/qr/{qrId}/extension to create a new payment request using a static or hybrid QR code. This request does not apply to dynamic QR.
   • Check QR Code extension status: Perform a request to GET /pos/api/v2/qr/extension/{extensionId}/check to check the status of a payment request using a QR code.
   • Cancel hybrid QR code extension: Perform a request to DELETE /pos/api/v2/qr/extension/{extensionId} to cancel all active hybrid QR code extensions. This request is prohibited for other types of QR codes.
   • Cancel QR Code: Perform a request to DELETE /pos/api/v2/qr/{qrId} to cancel the QR code.

5. Close Shift

   • Close Shift: Perform a request to POST /pos/api/v1/shift/close to close the current shift.

6. Retrieve Z-Report

   • Get Z-Report: Perform a request to GET /pos/api/v2/shift/{shiftId}/z-report to retrieve the Z-report for a specific shift.

7. Operator Logout

   • Logout: Perform a request to POST /pos/api/v1/seller/logout to log the operator out of the system.