Title
Page icon
Create new category
Edit page index title
Edit category
Edit link
List QR Codes
Overview
This endpoint gives a paginated list of all created QR codes, including details like type (STATIC / DYNAMIC), state, merchant information, and extra data (like invoice number and transaction purpose).
Endpoint Details
Definition | Description |
|---|---|
Endpoint | |
Method | GET |
Headers | Content-Type: application/json, Authorization |
Authentication | Access Token (Bearer Token) |
Query Parameters
Pagination Parameters
Parameter | Description |
|---|---|
page_params.page_size | Number of records to return per page. |
page_params.page_number | Page number to retrieve. |
page_params.first_request_timestamp.seconds | UTC seconds since Unix epoch ( |
page_params.first_request_timestamp.nanos | Nanosecond fraction (0 to 999,999,999). Must be a non-negative value and represents fractional seconds at nanosecond resolution. |
Ordering Parameters
Parameter | Description |
|---|---|
order_params.order_key | Field used to sort the results. |
order_params.order_direction | Sort direction. Allowed values: |
QR Code Filters
Parameter | Description |
|---|---|
qr_code_id | Filters by the unique QR code identifier. |
customer_id | Filters by the customer identifier associated with the QR code. |
key_id | Filters by the key identifier associated with the QR code. |
type | Filters by QR code type (for example, based on the types supported by the integration). |
key_value | Filters by the key value associated with the QR code. |
key_type | Filters by the key type associated with the QR code (for example, phone, email, document, etc., depending on supported values). |
Request Body
This endpoint does not require a request body.
Example Request
Response
HTTP Code: 200 OK.
Example of Response
Common Errors and Handling
HTTP Status Code | Meaning | Description |
|---|---|---|
400 | Bad Request | Invalid parameters or malformed request |
401 | Unauthorized | Missing/expired bearer token, or token lacks |
403 | Forbidden | Caller does not have permission to view QR Codes |
404 | Not Found | No QR Codes exist for the entity |
500 | Server Error | Unexpected error; retry or contact support |
Best Practices
Use
pagination_infoto iterate through multiple pages when many QR Codes exist.Leverage type (
STATICvsDYNAMIC) to determine use cases (POS, MPOS, invoice collection).Track created_at and id values for reconciliation with transaction logs.