Cobro
QR dinámico
Consultar una deuda
GET
/bindentidad-deuda-v2/v2/api/v1.201/Deuda[?deudaId][&codigoDeuda]
Consulta la información de una deuda, filtrando por su id o el código externo indicado por la entidad al momento de su creación.
Tiene los datos necesarios para poder proceder con exponer cada medio de cobro a los clientes para que puedan pagar la deuda.
Request
deudaId int
— OPCIONAL
Id de la deuda.
codigoDeuda string
— OPCIONAL
Código externo de la deuda.
curl request
Copy code
Response
id int
Id de la deuda.
codigo string
Identificador guid de la deuda.
codigoExterno object
Contiene información externa de la deuda.
codigoExterno.codigoDeuda string
Código externo de la Entidad.
codigoExterno.codigoAuxiliar1 string
Código informativo adicional.
codigoExterno.codigoAuxiliar2 string
Código informativo adicional.
codigoExterno.Contexto object
Contiene datos sólo informativos asociados a la deuda.
codigoExterno.Contexto.additionalProp1 string
Información adicional.
codigoExterno.Contexto.additionalProp2 string
Información adicional.
codigoExterno.Contexto.additionalProp3 string
Información adicional.
codigoCaja string
Código de la caja del comercio.
codigoSucursal string
Código de la sucursal del comercio.
codigoComercio string
Código del comercio .
codigoEntidad string
Código de la entidad.
montoTotal decimal
Monto actual a cobrar.
moneda int
— REQUERIDO
Identificador de moneda del importe a cobrar.
Valores permitidos: 0 (Pesos Argentinos)
motivo string
Descripción de la deuda.
tipoOrden int
Identificador del tipo de orden de deuda.
Valores posibles: 0 (Deuda de pago único)
estado int
Identificador estado en que se encuentra la deuda.
Valores posibles:
1 (Precargado - Recién se creó la deuda pero aún no se generó la información de todos los medios de pago indicados. Consultar nuevamente),
2 (Pendiente - La deuda aún no se ha pagado pero ya generó toda la información para el pago),
3 (En proceso - Se está procesando un pago),
4 (Pagada),
5 (Pagada parcialmente),
6 (Cancelada manual) ,
7 (Cancelado)
estadoDescripcion string
Nombre del estado de la deuda.
fechaCreacion datetime
Fecha y hora de creación de la deuda.
fechaBaja datetime
Fecha y hora de baja de la deuda.
vencimientos int
Cantidad de vencimientos que registra la deuda.
montoVencimiento1 decimal
Importe a cobrar hasta que se cumpla fecha y hora del primer vencimiento.
fechaVencimiento1 datetime
Fecha y hora del primer vencimiento.
montoVencimiento2 decimal
Importe a cobrar hasta que se cumpla fecha y hora del segundo vencimiento.
fechaVencimiento2 datetime
Fecha y hora del segundo vencimiento.
montoVencimiento3 decimal
Importe a cobrar hasta que se cumpla fecha y hora del tercer vencimiento.
fechaVencimiento3 datetime
Fecha y hora del tercer vencimiento.
montoProximoVencimiento decimal
Importe vigente según la fecha de vencimiento más próxima.
fechaProximoVencimiento datetime
Fecha y hora actual de vencimiento más próxima.
medioPagoDisponibles array of objects
Array de objetos que contiene información de los medios de pago habilitados para esta deuda. Deben incluirse las distintas opciones como distintas instancias nombre-formaPago.
medioPagoDisponibles[{}].id int
Identificador del medio de pago registrado.
medioPagoDisponibles[{}].nombre string
Nombre del medio de pago. Por ejemplo: "QR".
medioPagoDisponibles[{}].formaPago int
Identificador del medio de pago.
Valores posibles: 1 (QR)
medioPagoDisponibles[{}].habilitado boolean
Indica si el medio de pago está habilitado o no.
medioPagoDisponibles[{}].formaPagoDescripcion string
Descripción de la forma de pago.
medioPagoDisponibles[{}].DetalleEspecifico object
Contiene información necesaria para poder realizar el cobro. Es específico por cada medio de pago.
medioPagoDisponibles[{}].DetalleEspecifico.data string
La información en este campo es específico dependiendo de cada medio de pago.
Valores posibles: Para QR, contiene el qr_raw que es el string normalzado según el EMVCo utilizado para generar la imagen del código QR.
pagos[{}] array of objects
Contiene información de los intentos de pago asociados a la deuda. Habrá una instancia por cada intento de pago que exista. Si la deuda no registra ningún pago, este objeto está vacío.
pagos[{}].id int
Identificador del intento de pago de una deuda.
pagos[{}].montoPagado decimal
Importe del intento de pago.
pagos[{}].fechaDePago datetime
Fecha y hora en que se realizó el intento de pago.
pagos[{}].iDReferenciaTx string
Identificador de referencia para realizar el pago con su procesador correspondiente.
pagos[{}].jsonDetalleTx string
Contiene el json con toda la información registrada de la transacción.
pagos[{}].estado string
Identificador estado en que se encuentra el intento de pago.
Valores posibles: 1 (En proceso), 2 (Aprobado), 3 (Rechazado).
pagos[{}].fechaAnulacion datetime
Fecha y hora en que falló el intento de pago.
pagos[{}].motivoAnulacion datetime
Descripción del motivo por el cual falló el intento de pago.
pagos[{}].deudaId int
Id de la deuda que se intentó pagar.
pagos[{}].medioPagoDisponibleId int
Id del medio de pago registrado para este intento de pago de la deuda.
esBoton20 boolean
Valor fijo: false.
codigoBs20 string
Valor fijo: null.
HTTP 201
Consulta exitosa
HTTP 401
Token de autenticación inválido
