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

DefinitionDescription
Endpointhttps://api.paas.sandbox.co.passportfintech.com/v1/qrcodes
MethodGET
HeadersContent-Type: application/json, Authorization
AuthenticationAccess Token (Bearer Token)

Query Parameters

Pagination Parameters

ParameterDescription
page_params.page_sizeNumber of records to return per page.
page_params.page_numberPage number to retrieve.
page_params.first_request_timestamp.secondsUTC seconds since Unix epoch (1970-01-01T00:00:00Z). Must be between 0001-01-01T00:00:00Z and 9999-12-31T23:59:59Z(inclusive).
page_params.first_request_timestamp.nanosNanosecond fraction (0 to 999,999,999). Must be a non-negative value and represents fractional seconds at nanosecond resolution.

Ordering Parameters

ParameterDescription
order_params.order_keyField used to sort the results.
order_params.order_directionSort direction. Allowed values: ORDER_DIRECTION_ENUM_UNSPECIFIED, ASC, DESC.

QR Code Filters

ParameterDescription
qr_code_idFilters by the unique QR code identifier.
customer_idFilters by the customer identifier associated with the QR code.
key_idFilters by the key identifier associated with the QR code.
typeFilters by QR code type (for example, based on the types supported by the integration).
key_valueFilters by the key value associated with the QR code.
key_typeFilters 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

JSON
Copy

Response

  • HTTP Code: 200 OK.

Example of Response

JSON
Copy

Common Errors and Handling

HTTP Status CodeMeaningDescription
400Bad RequestInvalid parameters or malformed request
401UnauthorizedMissing/expired bearer token, or token lacks paas.core.qrcodes.list.get scope
403ForbiddenCaller does not have permission to view QR Codes
404Not FoundNo QR Codes exist for the entity
500Server ErrorUnexpected error; retry or contact support

Best Practices

  • Use pagination_info to iterate through multiple pages when many QR Codes exist.
  • Leverage type (STATIC vs DYNAMIC) to determine use cases (POS, MPOS, invoice collection).
  • Track created_at and id values for reconciliation with transaction logs.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard