Diccionario de Datos
A continuación se detalla cada una de las variables utilizadas en las peticiones y respuestas de la API.
| Variable | Tipo de Dato | Descripción |
|---|---|---|
qr_image | Cadena | String en Base64 con la imagen del QR generado. |
qr_url | Cadena | URL pública de la imagen del QR. |
qr_id | Cadena / Numérico | Identificador único del QR generado. |
business_code | Alfanumérico | Código de negocio (Dato provisto por Vendis a la empresa). |
amount | Decimal | Monto por el cual se generará el cobro. |
payment_date | Y-m-d H:i:s | Fecha y hora en la que se realizó el pago en el banco. |
modify_amount | Boolean | Bandera que indica si el cliente podrá modificar el monto al momento de escanear el QR. |
is_multi_use | Boolean | Bandera que indica si el QR podrá recibir más de un pago (QR multiuso). |
qr_expiration | Y-m-d H:i:s | Fecha y hora límite de validez del QR. |
payment_amount | Decimal | Monto real que el cliente canceló a través del QR. |
payment_name | Cadena | Nombre del cliente/persona que realizó el pago. |
payment_bank | Cadena | Nombre del banco desde el cual se originó el pago. |
description | Cadena | La glosa o concepto que tendrá el QR. Este dato se visualizará en la app bancaria (Ej. si envías "PAGOS EMPRESA CUSTOM", aparecerá "SN<####> PAGOS EMPRESA CUSTOM"). |
status | Cadena | Estado actual del QR. Los posibles estados son: • Pendiente: Solicitado pero no pagado. • Anulado: El QR fue cancelado. • Pagado: El QR ha sido pagado exitosamente. • Fallido: Hubo un error al crear o procesar el QR en el banco. |