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ámetroDescripción
Endpointhttps://api.paas.sandbox.co.passportfintech.com/v1/qrcodes
MétodoGET
EncabezadosContent-Type: application/json, Authorization
AutenticaciónToken de Acceso (Bearer Token)

Parámetros de Consulta

Parámetros de Paginación

ParámetroDescripción
page_params.page_sizeCantidad de registros a retornar por página.
page_params.page_numberNúmero de página a consultar.
page_params.first_request_timestamp.secondsSegundos UTC desde Unix epoch (1970-01-01T00:00:00Z). Debe estar en el rango de 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z (inclusive).
page_params.first_request_timestamp.nanosFracció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ámetroDescripción
order_params.order_keyCampo 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_directionDirección del ordenamiento. Valores permitidos: ORDER_DIRECTION_ENUM_UNSPECIFIED, ASC, DESC.

Filtros de Códigos QR

ParámetroDescripción
qr_code_idFiltra por el identificador único del código QR.
customer_idFiltra por el identificador del cliente asociado al código QR.
key_idFiltra por el identificador de la llave asociada al código QR.
typeFiltra por el tipo de código QR (por ejemplo, según el tipo soportado por la integración).
key_valueFiltra por el valor de la llave asociada al código QR.
key_typeFiltra por el tipo de llave asociada al código QR.

Cuerpo de la Solicitud

  • No requiere cuerpo de solicitud.

Ejemplo de Solicitud

JSON
Copy

Cuerpo de la Respuesta

  • Código HTTP: 200 OK

Ejemplo de Respuesta

JSON
Copy

Errores Comunes y Manejo

Código HTTPSignificadoDescripción
400Bad RequestParámetros inválidos o solicitud malformada.
401UnauthorizedToken Bearer ausente, expirado o sin el alcance paas.core.qrcodes.list.get.
403ForbiddenEl solicitante no tiene permisos para listar Códigos QR.
404Not FoundNo existen Códigos QR para la entidad.
500Server ErrorError inesperado; reintente o contacte soporte.

Buenas Prácticas

  • Utiliza pagination_info para iterar entre múltiples páginas cuando existan muchos Códigos QR.
  • Apóyate en el campo type (STATIC vs DYNAMIC) para determinar los casos de uso (POS, MPOS, recaudo con factura).
  • Registra los valores de created_ate id para conciliación con los logs de transacciones.
  • Controla el acceso a esta información ya que contiene datos sensibles de clientes y comercios.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard