Genera un código QR con monto, moneda, glosa y tiempo de vida definidos por el comercio.
API Cobros QR
API REST para generación y consulta de transacciones QR. Permite a un comercio crear un código QR con monto específico y verificar su estado posteriormente.
REST JSON
x-api-key
Generación QR
Consulta de estado
Callback
Guarda el PDF con ese nombre dentro de la carpeta docs.
Endpoints disponibles
Operaciones principales del producto.
POST
Generar transacción QR
/atc/generarQr
GET
Verificar estado QR
/atc/verificaQr/{numeroReferencia}
Consulta el estado de una transacción QR usando el número de referencia generado por ATC.
Autenticación y callback
Requisitos básicos para integración.
Header requerido
| Header | Valor | Uso |
|---|---|---|
| x-api-key | Token provisto por ATC | Autenticación obligatoria en cada solicitud |
Callback del comercio
El comercio debe exponer un endpoint para recibir la confirmación automática del pago.
https://dominio.com/qr/confirmed o https://ip/qr/confirmed
Ejemplo de request
Generación de transacción QR.
{
"numeroReferencia": 203414,
"glosa": "298414|JHIRAFAS CHICKENS|MISCELANEAS|TRANSACCION QR CON Comercio x",
"monto": 20.00,
"moneda": "BOB",
"canal": "WEB",
"tiempoQr": "23:59:59",
"campoExtra": ""
}
Ejemplo de response
Respuesta al generar QR.
{
"moneda": "BOB",
"monto": 20.0,
"origenNumeroReferencia": "203414",
"numeroReferencia": "6780",
"codigoRespuesta": "PENDING",
"detalleRespuesta": "Estado en espera de la confirmacion pago QR",
"imagen": "{cadenaQR} en base64"
}
Campos clave de entrada
Parámetros más importantes para generar QR.
| Campo | Tipo | Descripción | Requerido |
|---|---|---|---|
| numeroReferencia | Long | Código único transaccional del comercio | Sí |
| glosa | String | Texto estructurado con sucursal, nombre, rubro y detalle | Sí |
| monto | BigDecimal | Monto de la transacción | Sí |
| moneda | String | BOB o USD | Sí |
| canal | String | WEB, MOVIL o DESKTOP | Sí |
| tiempoQr | String | Tiempo de vida del QR | Sí |
| campoExtra | String | Campo opcional para visualización en destinatario | No |
Estados
Estados devueltos por la API.
| Código | Descripción |
|---|---|
| PENDING | Transacción dada de alta pero aún no cobrada |
| NOTFOUND | Servicio QR inactivo |
| ERROR | Error de servicio |
| SUCCESS | Transacción completada satisfactoriamente |
| CANCELLED | Transacción cancelada |
| CLOSED | Transacción cerrada por ciclo completo |
| EXPIRED | Código QR expirado |
Ambientes
Rutas por entorno.
| Operación | Sandbox | Producción |
|---|---|---|
| Generar QR | https://appcobranzacert.redenlace.com.bo/cobranza-0.0.1/atc/generarQr |
https://appcobranza.redenlace.com.bo/cobranza-0.0.1/atc/generarQr |
| Verificar estado QR | https://appcobranzacert.redenlace.com.bo/cobranza-0.0.1/atc/verificaQr/{numeroReferencia} |
https://appcobranza.redenlace.com.bo/cobranza-0.0.1/atc/verificaQr/{numeroReferencia} |