Consultar el estado de un QR

Nivel de seguridad requerida para este servicio

Medio Medio (accessToken)

Objetivo

Devuelve el estado actual de un QR de cobro. Es una de las dos formas de saber si un QR fue cobrado; la otra es suscribirse al evento NEW_MONEY_MOVEMENT de Webhooks.

Request

Method: GET

/external/api/get-qr-status

curl -X GET "https://$env/external/api/get-qr-status?portfolioId=$portfolioId&personId=$personId&propagoQrId=$propagoQrId" \
    -H 'Authorization: $YOUR_ACCESS_TOKEN'

env: Entorno de la API, como producción o desarrollo.
YOUR_ACCESS_TOKEN: Token obtenido en el servicio de autenticación.

Parámetros

Parámetro	Tipo	Obligatorio	Descripción
`portfolioId`	int	Sí	Cuenta de cobro.
`personId`	int	Sí	Titular de la cuenta.
`propagoQrId`	string	Sí	El `order_id` devuelto por Generar un QR.

Estados posibles

Estado	Significado
`PENDING`	Vigente, sin cobrar. QR de un solo uso con vencimiento.
`ACTIVE`	Vigente, sin cobrar. QR reutilizable con vencimiento.
`UNDEFINED`	Vigente, sin cobrar, sin fecha límite.
`COLLECTED`	Cobrado.
`EXPIRED`	Venció sin cobrarse.
`NOTFOUND`	No existe, o no pertenece a la cuenta indicada.

El estado depende del tipo de QR que hayas generado. Ver estados para la explicación completa.

Ejemplo de Respuestas:

JSON

{
    "state": "COLLECTED",
    "amount": 1500.50,
    "movementId": 445566
}

Información adicional sobre campos

state: uno de los estados de la tabla de arriba.
movementId: identificador del movimiento generado por el cobro. Solo viene cuando el estado es COLLECTED. Sirve para conciliar contra Detalle de un cobro.

⚠️

Si vas a consultar en polling, usá un intervalo prudente, por ejemplo cada 3 a 5 segundos, hasta obtener COLLECTED o EXPIRED. Si generás QR sin vencimiento, tené en cuenta que el estado UNDEFINED no tiene condición de corte: tu polling necesita un límite propio de intentos o de tiempo. Con webhooks te evitás las dos cosas.

Generar un QR Listar cobros