Saltar al contenido principal

Diccionario de Datos

A continuación se detalla cada una de las variables utilizadas en las peticiones y respuestas de la API.

VariableTipo de DatoDescripción
qr_imageCadenaString en Base64 con la imagen del QR generado.
qr_urlCadenaURL pública de la imagen del QR.
qr_idCadena / NuméricoIdentificador único del QR generado.
business_codeAlfanuméricoCódigo de negocio (Dato provisto por Vendis a la empresa).
amountDecimalMonto por el cual se generará el cobro.
payment_dateY-m-d H:i:sFecha y hora en la que se realizó el pago en el banco.
modify_amountBooleanBandera que indica si el cliente podrá modificar el monto al momento de escanear el QR.
is_multi_useBooleanBandera que indica si el QR podrá recibir más de un pago (QR multiuso).
qr_expirationY-m-d H:i:sFecha y hora límite de validez del QR.
payment_amountDecimalMonto real que el cliente canceló a través del QR.
payment_nameCadenaNombre del cliente/persona que realizó el pago.
payment_bankCadenaNombre del banco desde el cual se originó el pago.
descriptionCadenaLa 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").
statusCadenaEstado 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.