Cobranzas

Este servicio permite informar los pagos realizados por los usuarios, como así también beneficios o cargos sobre una línea de crédito

Generar cobranza

El endpoint /lending/v1/collections te permite informar el pago de uno de tus usuarios, como así bonificaciones o recargos que tengas que hacer en su línea de crédito.

Parámetros disponibles
Body Parameters
credit_line_idstringrequired
Identificador de la línea de crédito
Ejemplo: lcr-h4xWg6e8CiRcpHd8A6JE8MW8wSZ
external_idstring
Identificador externo que permita realizar trazabilidad
Ejemplo: 90bd079e-3c60-4896-a12f-1c08dff488ea
typestringrequired
Tipo de operación a realizar
Ejemplo: PAYMENT
Enum: PAYMENTCHARGEDISCOUNT
amountstringrequired
Monto de la operación
Ejemplo: 737.94
currencystringrequired
Divisa en la que está valuado el monto de la operación
Ejemplo: BRL
Enum: BRL
operation_datestringrequired
Fecha y hora en formato ISO-8601 correspondiente a la efectivización de la operación
Pattern: ^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})$
Ejemplo: 2022-08-03T15:07:09
descriptionstring(maxLength: 22)required
Breve descripción que permita reconocer la operación
Ejemplo: BILL PAYMENT
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
POST/lending/v1/collections
{
"credit_line_id":
"lcr-h4xWg6e8CiRcpHd8A6JE8MW8wSZ"
"external_id":
"90bd079e-3c60-4896-a12f-1c08dff488ea"
"type":
"PAYMENT"
"amount":
"737.94"
"currency":
"BRL"
"operation_date":
"2022-08-03T15:07:09"
"description":
"BILL PAYMENT"
}
Ejemplo de respuestas

Obtener cobranzas

El endpoint /lending/v1/collections devolverá todas las operaciones que hayas informado y cumplan con los criterios de búsqueda que determinaste en los parámetros.

Parámetros disponibles
Query Parameters
filter[credit_line_id]stringrequired
Ejemplo: lcr-h4xWg6e8CiRcpHd8A6JE8MW8wSZ
Detalle de respuestas
dataarray
¿Te resultó útil esta sección?
GET/lending/v1/collections
Ejemplo de respuestas

Cancelar cobranza

En el caso en que debas cancelar una collection informada a Lending, podrás hacerlo utilizando el endpoint /lending/v1/collections/{id}/cancel especificando el ID de la misma.

Parámetros disponibles
Path Parameters
idstringrequired
Identificador de la cobranza a cancelar
Ejemplo: lcc-edeESDira4dpZv8nZ6vwMb8Kjyf
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
POST/lending/v1/collections/{id}/cancel
Ejemplo de respuestas

Obtener cobranza por ID

Si necesitas consultar una collection en particular podes hacerlo a través de /lending/v1/collections/{id} indicando el ID que se le asignó a la collection que informaste al momento de la generación.

Parámetros disponibles
Path Parameters
idstringrequired
Identificador de la cobranza a cancelar
Ejemplo: lcc-edeESDira4dpZv8nZ6vwMb8Kjyf
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
GET/lending/v1/collections/{id}
Ejemplo de respuestas