Consultar una deuda
Productos en los que aplica:
Descripción
Consulta la información de una deuda.
Tiene los datos necesarios para poder proceder con exponer cada medio de cobro a los clientes para que puedan pagar la deuda.
Endpoint
GET
/bindentidad-deuda-v2/v2/api/v1.201/Deuda[?DeudaId][&IdentificadorOrden]
Request
DeudaId
int
— OPCIONAL
Id de la deuda. Es el respondido al momento de crear la deuda.
IdentificadorOrden
string
— OPCIONAL
Código de deuda interno de la Entidad. Enviado como "codigoDeuda" en creación de la deuda.
Ejemplo de request
Copy code
Response
id
int
Id de la deuda.
codigo
string
Identificador guid de la deuda.
codigoExterno
object
Contiene información interna de la Entidad.
codigoDeuda
string
Código de deuda interno de la Entidad.
codigoAuxiliar1
string
Código informativo adicional.
codigoAuxiliar2
string
Código informativo adicional.
Contexto
object
Contiene datos sólo informativos que se guardarán asociados a la deuda.
additionalProp1
string
Información adicional.
additionalProp2
string
Información adicional.
additionalProp3
string
Información adicional.
codigoCaja
string
Código de la caja.
codigoSucursal
string
Código de la sucursal.
codigoComercio
string
Código del comercio
codigoEntidad
string
Código de la entidad.
montoTotal
decimal
Monto actual a cobrar. Es el monto que se cobró o que está pendiente de cobrar dependiendo de la fecha de vencimiento vigente.
moneda
int
Identificador de moneda del importe a cobrar.
Valores posibles:
Pesos argentinos = 0
motivo
string
Descripción de la deuda.
tipoOrden
int
Identificador del tipo de orden de deuda.
Valores permitidos:
Deuda de pago único = 0
estado
int
Identificador estado en que se encuentra la deuda.
Valores posibles:
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 = 1
Pendiente - La deuda aún no se ha pagado pero ya generó toda la información para el pago = 2
En proceso - Se está procesando un pago = 3
Pagada = 4
Pagada parcialmente = 5
Cancelada = 6
estadoDescripcion
string
Descripción del estado 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
object
Contiene información de los medios de pago habilitados para esta deuda. Se obtiene una instancia con la información necesaria para cobrar con cada medio de pago solicitado.
id
int
Identificador del medio de pago registrado.
nombre
string
Nombre del medio de pago.
formaPago
int
Identificador del tipo de medio de pago.
Valores posibles:
QR = 1
formaPagoDescripcion
string
Descripción interna del medio de pago.
DetalleEspecifico
object
Contiene información necesaria para poder realizar el cobro. Es específico por cada medio de pago.
data
string
La información en este campo es específico dependiendo de cada medio de pago.
Valores posibles:
QR interoperable = Contiene el qr_raw que es el string normalziado según el EMVCo utilizado para generar la imagen del código QR.
pagos
object
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.
id
int
Identificador del intento de pago de una deuda.
montoPagado
decimal
Importe del pago.
fechaDePago
datetime
Fecha y hora en que se realizó el pago (UTC 0).
iDReferenciaTx
string
Identificador de referencia para realizar el pago con su procesador correspondiente.
jsonDetalleTx
string
Contiene el json con toda la información registrada de la transacción.
estado
string
Identificador estado en que se encuentra el intento de pago.
Valores posibles:
En proceso = 1
Aprobado = 2
Rechazado = 3
fechaAnulacion
datetime
Fecha y hora en que la deuda fue eliminada (UTC 0).
motivoAnulacion
datetime
Descripción del motivo por el cual la deuda fue eliminada (UTC 0).
deudaId
int
Id de la deuda que se intentó pagar.
medioPagoDisponibleId
int
Id del medio de pago registrado para pagar la deuda.
Ejemplo de request