Title
Page icon
Create new category
Edit page index title
Edit category
Edit link
Listar Códigos QR
Visión General
Este endpoint permite crear un Cliente (Customer) dentro de la API de Passport proporcionando los datos de identificación necesarios. Una solicitud exitosa retorna el ID del cliente y la información de confirmación del recurso creado.
Detalles del Endpoint
Parámetro | Descripción |
|---|---|
Endpoint | |
Método | GET |
Encabezados | Content-Type: application/json, Authorization |
Autenticación | Token de Acceso (Bearer Token) |
Parámetros de Consulta
Parámetros de Paginación
Parámetro | Descripción |
|---|---|
page_params.page_size | Cantidad de registros a retornar por página. |
page_params.page_number | Número de página a consultar. |
page_params.first_request_timestamp.seconds | Segundos UTC desde Unix epoch ( |
page_params.first_request_timestamp.nanos | Fracción en nanosegundos (0 a 999,999,999). Debe ser un valor no negativo y representa la fracción de segundo con resolución de nanosegundos. |
Parámetros de Ordenamiento
Parámetro | Descripción |
|---|---|
order_params.order_key | Campo utilizado para ordenar los resultados (por ejemplo, por fecha de creación o actualización, según los valores soportados por el backend). |
order_params.order_direction | Dirección del ordenamiento. Valores permitidos: |
Filtros de Códigos QR
Parámetro | Descripción |
|---|---|
qr_code_id | Filtra por el identificador único del código QR. |
customer_id | Filtra por el identificador del cliente asociado al código QR. |
key_id | Filtra por el identificador de la llave asociada al código QR. |
type | Filtra por el tipo de código QR (por ejemplo, según el tipo soportado por la integración). |
key_value | Filtra por el valor de la llave asociada al código QR. |
key_type | Filtra por el tipo de llave asociada al código QR. |
Cuerpo de la Solicitud
No requiere cuerpo de solicitud.
Ejemplo de Solicitud
Cuerpo de la Respuesta
Código HTTP: 200 OK
Ejemplo de Respuesta
Errores Comunes y Manejo
Código HTTP | Significado | Descripción |
|---|---|---|
400 | Bad Request | Parámetros inválidos o solicitud malformada. |
401 | Unauthorized | Token Bearer ausente, expirado o sin el alcance |
403 | Forbidden | El solicitante no tiene permisos para listar Códigos QR. |
404 | Not Found | No existen Códigos QR para la entidad. |
500 | Server Error | Error inesperado; reintente o contacte soporte. |
Buenas Prácticas
Utiliza
pagination_infopara iterar entre múltiples páginas cuando existan muchos Códigos QR.Apóyate en el campo type (
STATICvsDYNAMIC) para determinar los casos de uso (POS,MPOS, recaudo con factura).Registra los valores de
created_ateidpara conciliación con los logs de transacciones.Controla el acceso a esta información ya que contiene datos sensibles de clientes y comercios.