Imputaciones

Este servicio te permite informar los pagos realizados por los usuarios y los beneficios o cargos sobre una línea de crédito. Encuentra más información sobre imputaciones en nuestra documentación.

Generar imputación

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

Parámetros disponibles
Header Parameters
x-idempotency-keystring(format: uuid)required
Para asegurarnos de que una solicitud no se ejecute más de una vez, te pediremos que envíes el header: x-idempotency-key con un ID único para usar nuestro esquema de idempotencia, evitando crear dos recursos para el mismo pedido durante las siguientes 24hs.
Ejemplo: fRwX12Dg3345AD
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 del monto de la operación
Ejemplo: BRL
Enum: BRL
operation_datestringrequired
Fecha y hora en formato ISO-8601 de cuando se concretó la operación. Debe especificar el offset de UTC como la diferencia, que puede ser 0 (Z) o en horas y minutos (+/-[hh][mm]), por ejemplo +0300 son 3 horas adelante de UTC y -1235 son 12 horas y 35 minutos atrás.
Pattern: ^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(Z|(\+|\-\d{4}))$
Ejemplo: 2022-08-03T15:07:09Z
descriptionstring(maxLength: 22)required
Breve descripción que permita reconocer la operación
Ejemplo: BILL PAYMENT
Detalle de respuestas
idstring
Identificador de la operación
Ejemplo: lco-edeESDira4dpZv8nZ6vwMb8Kjyf
credit_line_idstring
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
operation_datestring
Fecha y hora local en formato ISO-8601 de cuando se concretó la operación
Ejemplo: 2022-08-03T15:07:09
creation_datestring
Fecha y hora local en formato ISO-8601 en la cual se solicitó la operación
Ejemplo: 2022-08-03T15:07:09
cancellation_datestring
Fecha y hora local en formato ISO-8601 de cancelación de la operación
Ejemplo: 2022-08-21T15:07:09
typestring
Tipo de la operación
Ejemplo: PAYMENT
Enum: PAYMENTCHARGEDISCOUNT
amountstring
Monto de la operación
Ejemplo: 737.94
currencystring
Divisa del monto de la operación
Ejemplo: BRL
Enum: BRL
descriptionstring(maxLength: 22)
Breve descripción que permita reconocer la operación
Ejemplo: BILL PAYMENT
statusstring
Estado de la operación
Ejemplo: CREATED
Enum: CREATEDCANCELLED

¿Te resultó útil esta sección?

POST/lending/v1/collections
{
"operation_date":
"2022-08-03T15:07:09Z"
"credit_line_id":
"lcr-h4xWg6e8CiRcpHd8A6JE8MW8wSZ"
"external_id":
"90bd079e-3c60-4896-a12f-1c08dff488ea"
"type":
"PAYMENT"
"amount":
"737.94"
"currency":
"BRL"
"description":
"BILL PAYMENT"
}
Ejemplo de respuestas
{
"id":
"lco-edeESDira4dpZv8nZ6vwMb8Kjyf"
"credit_line_id":
"lcr-h4xWg6e8CiRcpHd8A6JE8MW8wSZ"
"external_id":
"90bd079e-3c60-4896-a12f-1c08dff488ea"
"operation_date":
"2022-08-03T15:07:09"
"creation_date":
"2022-08-03T15:07:09"
"cancellation_date":
"2022-08-21T15:07:09"
"type":
"PAYMENT"
"amount":
"737.94"
"currency":
"BRL"
"description":
"BILL PAYMENT"
"status":
"CREATED"
}

Obtener imputaciones

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
Permite obtener las cobranzas asociadas al ID de la línea de crédito especificada.
Ejemplo: lcr-h4xWg6e8CiRcpHd8A6JE8MW8wSZ
Detalle de respuestas
dataarray
metaobject

¿Te resultó útil esta sección?

GET/lending/v1/collections
Ejemplo de respuestas
{
"data":[
0:{
...
}
]
"meta":{
"pagination":{
...
}
}
}

Cancelar imputación

El endpoint /lending/v1/collections/{id}/cancel te permite cancelar una imputación que nos hayas informado, simplemente especificando su ID.
Parámetros disponibles
Path Parameters
idstringrequired
Identificador de la cobranza a cancelar
Ejemplo: lco-edeESDira4dpZv8nZ6vwMb8Kjyf
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/collections/{id}/cancel
Ejemplo de respuestas
{
"data":{
"id":
"lco-edeESDira4dpZv8nZ6vwMb8Kjyf"
"credit_line_id":
"lcr-h4xWg6e8CiRcpHd8A6JE8MW8wSZ"
"external_id":
"90bd079e-3c60-4896-a12f-1c08dff488ea"
"operation_date":
"2022-07-24T23:59:59"
"creation_date":
"2022-07-25T09:00:00"
"cancellation_date":
"2022-07-26T14:15:15"
"type":
"PAYMENT"
"amount":
"737.94"
"currency":
"BRL"
"description":
"BILL PAYMENT"
"status":
"CANCELLED"
}
}

Obtener imputación por ID

El endpoint /lending/v1/collections/{id} te permite consultar una imputación específica indicando el ID asignado al momento de generarla.
Parámetros disponibles
Path Parameters
idstringrequired
Identificador de la cobranza a cancelar
Ejemplo: lco-edeESDira4dpZv8nZ6vwMb8Kjyf
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/collections/{id}
Ejemplo de respuestas
{
"data":{
"id":
"lco-edeESDira4dpZv8nZ6vwMb8Kjyf"
"credit_line_id":
"lcr-h4xWg6e8CiRcpHd8A6JE8MW8wSZ"
"external_id":
"90bd079e-3c60-4896-a12f-1c08dff488ea"
"operation_date":
"2022-08-03T15:07:09"
"creation_date":
"2022-08-03T15:07:09"
"cancellation_date":
"2022-08-21T15:07:09"
"type":
"PAYMENT"
"amount":
"737.94"
"currency":
"BRL"
"description":
"BILL PAYMENT"
"status":
"CREATED"
}
}