Líneas de crédito

El servicio de Líneas de Crédito te permite crear y administrar tanto productos crediticios como líneas de crédito

¿Quieres conocer más sobre las líneas de crédito? Mira nuestra documentación.

Crear producto

El endpoint lending/v1/products te permite crear un producto.

En este momento podrás definir las fechas de corte y vencimiento, los límites y disponibles, las tasas y comisiones, cómo se compone el pago mínimo y más.

Parámetros disponibles
Body Parameters
namestringrequired
Nombre del producto
Ejemplo: Gold Credit Card
typerequired
Tipo de producto
Ejemplo: CREDIT_CARD
Enum: CREDIT_CARD
statusrequired
Estado del producto
Ejemplo: PAUSED
Enum: ACTIVEPAUSEDINACTIVE
countryrequired
País del producto
Ejemplo: BRA
Enum: BRA
start_datestring(format: date)required
Fecha de entrada en vigencia del producto
Ejemplo: 2022-04-20
end_datestring(format: date)
Fecha de expiración del producto
Ejemplo: 2027-04-20
grace_period_daysobjectrequired
Período de tiempo después del vencimiento en el que se puede realizar un pago sin ninguna penalidad
credit_cardobjectrequired
Configuración de tarjeta de crédito
pricingobjectrequired
Define de forma centralizada las tasas de interés así como las comisiones que se aplicarán al producto.
available_balance_settingsstring
Estrategia de restitución de saldo. En CHILE Y MEXICO su único valor posible es EXTENDED. En COLOMBIA su único valor posible es RESTRICTED
Ejemplo: RESTRICTED
Enum: RESTRICTEDEXTENDED
statementobjectrequired
Configuración de estados de cuenta
refinancingobject
Configuración de refinanciación incluyendo opciones obligatorias y manuales
cancellationobject
Configuración de cancelación de línea de crédito por mora. Solo disponible para Brasil.
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/products
{
"name":
"Gold Credit Card"
"type":
"CREDIT_CARD"
"status":
"PAUSED"
"country":
"BRA"
"start_date":
"2022-04-20"
"end_date":
"2027-04-20"
"grace_period_days":{
"pausing":
10
"interest_accrual":
10
}
"credit_card":{
"max_allowed_installments":
1
"limits":{
...
}
"billing_cycle_config":{
...
}
"minimum_payment":
100
"minimum_payment_composition":{
...
}
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cSeXAmPLe"
}
"pricing":{
"rates":{
...
}
"fees":[
...
]
}
"available_balance_settings":
"RESTRICTED"
"statement":{
"generate_pdf":
"true"
"include_annual_legend":
"true"
}
"refinancing":{
"mandatory":{
...
}
"manual":{
...
}
}
"cancellation":{
"enabled":
"true"
"delinquency_days_amount":
6
}
}
Ejemplo de respuestas
{
"data":{
"id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"type":
"CREDIT_CARD"
"name":
"Gold Credit Card"
"status":
"PAUSED"
"country":
"BRA"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
"refinancing":{
...
}
"cancellation":{
...
}
}
}

Obtener productos

El endpoint lending/v1/products permite obtener datos de todos los productos creados

Parámetros disponibles
Detalle de respuestas
dataarray

¿Te resultó útil esta sección?

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

Obtener un producto

El endpoint lending/v1/products/{id} te permite obtener datos de un producto en específico.

Parámetros disponibles
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/products/{product_id}
Ejemplo de respuestas
{
"data":{
"id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"type":
"CREDIT_CARD"
"name":
"Gold Credit Card"
"status":
"PAUSED"
"country":
"BRA"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
"refinancing":{
...
}
"cancellation":{
...
}
}
}

Actualizar un producto

El endpoint lending/v1/products/{id} te permite actualizar los datos de un producto en específico.

Parámetros disponibles
Body Parameters
namestring
Nombre del producto
statusstring
Estado del producto
Enum: ACTIVEPAUSED
start_datestring
Fecha de entrada en vigencia del producto
Ejemplo: 2022-01-01
end_datestring
Fecha de expiración del producto
Ejemplo: 2027-04-20
grace_period_daysobject
Período de tiempo después del vencimiento en el que se puede realizar un pago sin ninguna penalidad
credit_cardobject
Configuración de tarjeta de crédito
statementobject
Configuración de estados de cuenta
cancellationobject
Configuración de cancelación de línea de crédito por mora. Solo disponible para Brasil.
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

PATCH/lending/v1/products/{product_id}
{
"name":
"string"
"status":
"ACTIVE"
"start_date":
"2022-01-01"
"end_date":
"2027-04-20"
"grace_period_days":{
"pausing":
5
"interest_accrual":
10
}
"credit_card":{
"max_allowed_installments":
1
"billing_cycle_config":{
...
}
"minimum_payment":
100
"minimum_payment_composition":{
...
}
"affinity_group_id":
"string"
}
"statement":{
"generate_pdf":
"true"
"include_annual_legend":
"true"
}
"cancellation":{
"enabled":
"true"
"delinquency_days_amount":
6
}
}
Ejemplo de respuestas
{
"data":{
"id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"type":
"CREDIT_CARD"
"name":
"Gold Credit Card"
"status":
"PAUSED"
"country":
"BRA"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
"refinancing":{
...
}
"cancellation":{
...
}
}
}

Desactivar un producto

El endpoint lending/v1/products/{id} te permite desactivar un producto en específico.

Parámetros disponibles
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

DELETE/lending/v1/products/{product_id}
Ejemplo de respuestas
{
"data":{
"id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"type":
"CREDIT_CARD"
"name":
"Gold Credit Card"
"status":
"PAUSED"
"country":
"BRA"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
"refinancing":{
...
}
"cancellation":{
...
}
}
}

Obtener líneas de crédito

El endpoint lending/v1/credit-lines te permite obtener datos de líneas de crédito dado un criterio de búsqueda.

Filtros

Puedes encontrar más información sobre cómo aplicar los filtros en la sección de Filtros y paginado.

Parámetros disponibles
Query Parameters
filter[id]string
Permite obtener la línea de crédito asociada al ID especificado
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
filter[user_id]string
Permite obtener las líneas de crédito asociadas al ID de usuario especificado
Ejemplo: usr-2HMvSDccc5PZzCvZ98lfeXamPle
filter[status]string
Permite obtener las líneas de crédito asociadas al estado especificado
Ejemplo: ACTIVE
Enum: OFFEREDACTIVEPAUSEDCANCELEDEXPIRED
filter[offer_start_date][from]string(format: date)
Permite obtener las líneas de crédito desde la fecha de oferta especificada
Ejemplo: 2022-03-10
filter[offer_start_date][to]string(format: date)
Permite obtener líneas de crédito hasta la fecha de oferta especificada
Ejemplo: 2022-03-20
filter[activation_date][from]string(format: date)
Permite obtener las líneas de crédito desde la fecha de activación especificada
Ejemplo: 2022-04-12
filter[activation_date][to]string(format: date)
Permite obtener las líneas de crédito hasta la fecha de activación especificada
Ejemplo: 2022-04-22
filter[user_scoring]string
Permite obtener las líneas de crédito asociadas al scoring de usuario especificado
Ejemplo: A
Detalle de respuestas
dataarray
metaobject

¿Te resultó útil esta sección?

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

Crear línea de crédito

El endpoint lending/v1/credit-lines te permite crear una línea de crédito.

Parámetros disponibles
Body Parameters
user_idstringrequired
Identificador del usuario beneficiario
Ejemplo: usr-2HMwJZo114goVi7xdSseYfujP79
product_idstringrequired
Identificador del producto
Ejemplo: lpr-2HMvSzWjc5La6WDTlgFweXAmPle
segment_idstring
Identificador del segmento
Ejemplo: lsg-2HMvSzWjc5La6WDTlgFweXAmPle
limitsoneOf
offer_start_datestringrequired
Fecha de inicio de la oferta
Ejemplo: 2022-04-20
offer_end_datestring
Fecha de finalización de la oferta
Ejemplo: 2023-05-20
due_dateintegerrequired
Fecha de vencimiento
Ejemplo: 28
user_scoringstringrequired
Identificador del scoring del usuario
Ejemplo: A
person_typestring
Tipo de persona
Ejemplo: NATURAL
Enum: LEGALNATURAL
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines
{
"user_id":
"usr-2HMwJZo114goVi7xdSseYfujP79"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"segment_id":
"lsg-2HMvSzWjc5La6WDTlgFweXAmPle"
"offer_start_date":
"2022-04-20"
"offer_end_date":
"2023-05-20"
"due_date":
28
"user_scoring":
"A"
"person_type":
"NATURAL"
}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"segment_id":
"lsg-2HMvSzWjc5La6WDTlgFweXAmPle"
"status":
"ACTIVE"
"status_detail":{
...
}
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"due_date":
28
"due_date_last_update":
"2022-04-12"
"user_scoring":
"A"
"delinquency":{
...
}
"clearance_date_at":
"2024-07-01T20:37:33.180085009Z"
"pricing":{
...
}
}
}

Obtener una línea de crédito

El endpoint lending/v1/credit-lines/{id} te permite obtener datos de una línea de crédito en específico.

En esta instancia podrás definir el límite y la fecha de cierre específicos para esta línea de crédito, siempre dentro de los parámetros que hayas definido para el producto.

¿Quieres conocer más sobre las líneas de crédito? Mira nuestra documentación.

Parámetros disponibles
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/credit-lines/{credit_line_id}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"segment_id":
"lsg-2HMvSzWjc5La6WDTlgFweXAmPle"
"status":
"ACTIVE"
"status_detail":{
...
}
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"due_date":
28
"due_date_last_update":
"2022-04-12"
"user_scoring":
"A"
"delinquency":{
...
}
"clearance_date_at":
"2024-07-01T20:37:33.180085009Z"
"pricing":{
...
}
}
}

Actualizar líneas de crédito

El endpoint lending/v1/credit-lines/{id} te permite actualizar los datos de una línea de crédito en específico.

Parámetros disponibles
Body Parameters
limitsoneOf
statusstring
Estado de la línea de crédito
Ejemplo: PAUSED
Enum: ACTIVEPAUSED
status_detailobject
Información acerca del cambio de estado
offer_start_datestring
Fecha de inicio de la oferta
Ejemplo: 2022-04-20
offer_end_datestring
Fecha de finalización de la oferta
Ejemplo: 2023-05-20
due_dateinteger
Fecha de vencimiento
Ejemplo: 28
user_scoringstring
Identificador del scoring del usuario
Ejemplo: A
person_typestring
Tipo de persona
Ejemplo: NATURAL
Enum: LEGALNATURAL
update_segmentobject
Actualización de segmento
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

PATCH/lending/v1/credit-lines/{credit_line_id}
{
"status":
"PAUSED"
"status_detail":{
"reason":
"FRAUD"
"text":
"Additrional information"
}
"offer_start_date":
"2022-04-20"
"offer_end_date":
"2023-05-20"
"due_date":
28
"user_scoring":
"A"
"person_type":
"NATURAL"
"update_segment":{
"segment_id":
"lsg-2HMvSzWjc5La6WDTlgFweXAmPle"
}
}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"segment_id":
"lsg-2HMvSzWjc5La6WDTlgFweXAmPle"
"status":
"ACTIVE"
"status_detail":{
...
}
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"due_date":
28
"due_date_last_update":
"2022-04-12"
"user_scoring":
"A"
"delinquency":{
...
}
"clearance_date_at":
"2024-07-01T20:37:33.180085009Z"
"pricing":{
...
}
}
}

Cancelar líneas de crédito

El endpoint lending/v1/credit-lines/{id} te permite cancelar una linea de crédito.

Parámetros disponibles
Body Parameters
reasonstring
Razon de cancelación de la línea de crédito
Enum: BY_USER_WITHOUT_DEBT_ACCELERATIONBY_USER_WITH_DEBT_ACCELERATION_REQUESTBY_CLIENT_WITHOUT_DEBT_ACCELERATION
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

DELETE/lending/v1/credit-lines/{credit_line_id}
{
"reason":
"BY_USER_WITHOUT_DEBT_ACCELERATION"
}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
}
}

Actualizar fecha de vencimiento

El endpoint lending/v1/credit-lines/{id}/config/due-date te permite cambiar la fecha de vencimiento de una línea de crédito seleccionando entre las opciones que definiste en el Producto. Si lo necesitas, podrás realizar simulaciones interactuando con el endpoint: lending/v1/credit-lines/{id}/config/due-date/simulation.

Revisa todas las condiciones que aplican a la actualización de la fecha de vencimiento en nuestra documentación.

Parámetros disponibles
Body Parameters
due_dateint(minimum: 1, maximum: 28)
Nuevo día de vencimiento de la línea de crédito
Ejemplo: 28
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/config/due-date
{
"due_date":
28
}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"segment_id":
"lsg-2HMvSzWjc5La6WDTlgFweXAmPle"
"status":
"ACTIVE"
"status_detail":{
...
}
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"due_date":
28
"due_date_last_update":
"2022-04-12"
"user_scoring":
"A"
"delinquency":{
...
}
"clearance_date_at":
"2024-07-01T20:37:33.180085009Z"
"pricing":{
...
}
}
}

Simular actualización de fecha de vencimiento

El endpoint lending/v1/credit-lines/{id}/config/due-date/simulation te permite simular un cambio en la fecha de vencimiento de una línea de crédito y ver cuáles serían las fechas de corte y vencimiento del siguiente ciclo de facturación.

Parámetros disponibles
Body Parameters
due_dateint(minimum: 1, maximum: 28)
Nuevo día de vencimiento de la línea de crédito
Ejemplo: 28
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/config/due-date/simulation
{
"due_date":
28
}
Ejemplo de respuestas
{
"data":{
"old":{
...
}
"new":{
...
}
}
}

Crear actualización de precio

El endpoint /products/{product_id}/pricing te permite crear nuevas actualizaciones de precio para productos con estado ACTIVE o PAUSED

Parámetros disponibles
Body Parameters
start_datestring(format: date)required
Fecha de entrada en vigencia de la actualización de precio
Ejemplo: 2022-04-30
ratesobjectrequired
Configuración de tasas
feesarrayrequired
Configuración de comisiones
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/products/{product_id}/pricing
{
"start_date":
"2022-04-30"
"rates":{
"financing":
"15.00"
"late_fee":
"25.00"
"cash_advance":
"50.00"
"revolving":
"100.00"
}
"fees":[
0:{
...
}
]
}
Ejemplo de respuestas
{
"data":{
"start_date":
"2022-04-30"
"rates":{
...
}
"fees":[
...
]
"issuer_installment_rates":[
...
]
}
}

Obtener historial de actualizaciones de precio

El endpoint /products/{product_id}/pricing te permite obtener el historial de actualizaciones de precio de un producto

Parámetros disponibles
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataarray

¿Te resultó útil esta sección?

GET/lending/v1/products/{product_id}/pricing
Ejemplo de respuestas
{
"data":[
0:{
...
}
]
}

Modificar actualización de precio pendiente

El endpoint /products/{product_id}/pricing/{start_date} te permite modificar una actualización de precio pendiente

Parámetros disponibles
Body Parameters
ratesobject
Configuración de tasas
feesarray
Configuración de comisiones
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
start_datestringrequired
Fecha de entrada en vigencia de la actualización de precio
Ejemplo: 2022-04-30
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

PATCH/lending/v1/products/{product_id}/pricing/{start_date}
{
"rates":{
"financing":
"15.00"
"late_fee":
"25.00"
"cash_advance":
"50.00"
"revolving":
"100.00"
}
"fees":[
0:{
...
}
]
}
Ejemplo de respuestas
{
"data":{
"start_date":
"2022-04-30"
"rates":{
...
}
"fees":[
...
]
"issuer_installment_rates":[
...
]
}
}

Crear segmento

El endpoint lending/v1/products/{product_id}/segments te permite crear un nuevo segmento para un producto con una configuración de pricing específica.

Parámetros disponibles
Body Parameters
namestringrequired
Nombre del segmento
Ejemplo: Premium Segment
pricingobjectrequired
Define de forma centralizada las tasas de interés así como las comisiones que se aplicarán al producto.
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/products/{product_id}/segments
{
"name":
"Premium Segment"
"pricing":{
"rates":{
...
}
"fees":[
...
]
}
}
Ejemplo de respuestas
{
"data":{
"id":
"lsg-3mkvSzWjc5La6WDTlgFweXAmP23"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"name":
"Premium Segment"
"status":
"ACTIVE"
"pricing":{
...
}
"created_at":
"2022-04-30T00:00:00Z"
"updated_at":
"2022-04-30T00:00:00Z"
}
}

Obtener segmentos

El endpoint lending/v1/products/{product_id}/segments te permite obtener todos los segmentos asociados a un producto específico.

Parámetros disponibles
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataarray
Lista de segmentos

¿Te resultó útil esta sección?

GET/lending/v1/products/{product_id}/segments
Ejemplo de respuestas
{
"data":[
0:{
...
}
]
}

Obtener un segmento

El endpoint lending/v1/products/{product_id}/segments/{segment_id} te permite obtener los datos de un segmento específico para un producto determinado.

Parámetros disponibles
Path Parameters
product_idstringrequired
Identificador único de producto
Ejemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
segment_idstringrequired
ID del segmento
Ejemplo: lsg-123456
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/products/{product_id}/segments/{segment_id}
Ejemplo de respuestas
{
"data":{
"id":
"lsg-3mkvSzWjc5La6WDTlgFweXAmP23"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"name":
"Premium Segment"
"status":
"ACTIVE"
"pricing":{
...
}
"created_at":
"2022-04-30T00:00:00Z"
"updated_at":
"2022-04-30T00:00:00Z"
}
}

Notificaciones de cambios de estado

Indícanos este endpoint para recibir notificaciones por cambios de estado en las líneas de crédito.

Si tienes dudas sobre cómo configurar un webhook, visita nuestra documentación.

Deberás respondernos un código HTTP 2xx para que no volvamos a enviar la notificación. Caso contrario, volveremos a enviarla infinitamente.

Parámetros disponibles
Header Parameters
X-Api-Keystringrequired
Este header te permitirá identificar qué api-secret tenés que usar en el caso que se hayan configurado múltiples pares de api-key y api-secret.
Ejemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
Este header contiene la firma digital (body + timestamp + endpoint) que deberás verificar para asegurar la integridad del request. Si la firma no coincide, deberás rechazar el pedido.
Ejemplo: X-Signature: hmac-sha256 N70BkBKch1gwQDPj0jF0ooB9QQVXBEp5VQE+SGe6Z0k=
X-Timestampstringrequired
Este header contiene el momento en el que se firmó el pedido en formato unix-epoch para que puedas corroborar que la firma no expiró.
Ejemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
El endpoint al que se realiza el pedido y usaste para generar la firma. Usa este header para regenerar la firma a validar, compararlo con el endpoint de tu servicio y verificar que coinciden.
Ejemplo: X-Endpoint: /<client-url>/credit-lines
Body Parameters
event_idstringrequired
Identificador de evento.
Ejemplo: credit_line_paused
Enum: credit_line_pausedcredit_line_unpausedcredit_line_canceled
idempotency_keystringrequired
Identificador idempotente de creación del evento.
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
dataobject
Información de la línea de crédito afectada

¿Te resultó útil esta sección?

POST/lending/v1/<client-url>/credit-lines
{
"event_id":
"credit_line_paused"
"idempotency_key":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"data":{
"credit_line_id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"status":
"PAUSED"
"reason":
"IN_ARREARS"
}
}
Ejemplo de respuestas

Notificaciones de entrada, salida o permanencia en mora de un usuario

Deberás indicarnos este endpoint para recibir las notificaciones de entrada, salida o permanencia en mora de un usuario.

Si tienes dudas sobre cómo configurar un webhook, visita nuestra documentación.

Deberás respondernos un código HTTP 2xx para que no volvamos a enviar la notificación. Caso contrario, volveremos a enviarla infinitamente.

Parámetros disponibles
Header Parameters
X-Api-Keystringrequired
Este header te permitirá identificar qué api-secret tenés que usar en el caso que se hayan configurado múltiples pares de api-key y api-secret.
Ejemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
Este header contiene la firma digital (body + timestamp + endpoint) que deberás verificar para asegurar la integridad del request. Si la firma no coincide, deberás rechazar el pedido.
Ejemplo: X-Signature: hmac-sha256 N70BkBKch1gwQDPj0jF0ooB9QQVXBEp5VQE+SGe6Z0k=
X-Timestampstringrequired
Este header contiene el momento en el que se firmó el pedido en formato unix-epoch para que puedas corroborar que la firma no expiró.
Ejemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
El endpoint al que se realiza el pedido y usaste para generar la firma. Usa este header para regenerar la firma a validar, compararlo con el endpoint de tu servicio y verificar que coinciden.
Ejemplo: X-Endpoint: /<client-url>/credit-lines
Body Parameters
event_idstringrequired
Identificador de evento.
Ejemplo: user_in_arrears
Enum: user_in_arrearsuser_out_of_arrearsuser_remains_in_arrears
idempotency_keystringrequired
Identificador idempotente de creación del evento.
Ejemplo: 27KxRhP9YB4ouoyt6a5vVJlY9fR
dataobject
Información del usuario afectado

¿Te resultó útil esta sección?

POST/lending/v1/<client-url>/debt
{
"event_id":
"user_in_arrears"
"idempotency_key":
"27KxRhP9YB4ouoyt6a5vVJlY9fR"
"data":{
"user_id":
"usr-27KxRhP9YB4ouoyt6a5vVJlY9fR"
"credit_line_id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"effective_at":
"2022-12-15T13:55:00"
}
}
Ejemplo de respuestas

Simulación de deuda

El endpoint /credit-lines/{credit_line_id}/debt/simulation te permite simular la aceleración total de deuda y el anticipo de cuotas de una línea de crédito en Brasil.

Esta simulación no ejecuta cambios reales y tiene vigencia hasta las 00:00.

Parámetros disponibles
Query Parameters
transaction_idsstring
Identificadores de las transacciones, separadas por comas
Ejemplo: ctx-2utzQVe7X7RfXrVUOPIJgCzRtx1,ctx-2utzQZBjBp3v2nzg1XsKgYGo9JL
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/credit-lines/{credit_line_id}/debt/simulation
Ejemplo de respuestas
{
"data":{
"total":{
...
}
"current":{
...
}
"acceleration":{
...
}
"has_pending_operations":
true
"installments":[
...
]
}
}

Aceleración de deuda

El endpoint /lending/v1/credit-lines/{credit_line_id}/debt/acceleration te permite confirmar la aceleración de la deuda de una línea de crédito, adelantando algunos o todos los planes de cuota vigentes, dependiendo de lo que indiques.

Por el momento, este servicio solo está disponible para Brasil.

Parámetros disponibles
Body Parameters
transaction_idsarray
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/debt/acceleration
{
"transaction_ids":[
0
:
"ctx-2utzQVe7X7RfXrVUOPIJgCzRtx1"
1
:
"ctx-2utzQVe7X7RfXrVUOPIJgCzRtx2"
]
}
Ejemplo de respuestas
{
"data":{
"message":
"string"
}
}

Simular refinanciación de deuda

El endpoint /credit-lines/{credit_line_id}/debt/refinance/simulation te permite simular el proceso de refinanciación de deuda de una línea de crédito.

Actualmente solo está implementado el tipo la refinanciación de deuda total.

La simulación te mostrará cómo quedaría distribuida la deuda actual, el monto total y cualquier aceleración necesaria, sin ejecutar cambios reales.

Por el momento, este servicio solo está disponible para Chile.

Parámetros disponibles
Body Parameters
typestringrequired
Tipo de refinanciación - actualmente solo TOTAL_DEBT está implementado
Ejemplo: TOTAL_DEBT
Enum: TOTAL_DEBT
credit_line_idstringrequired
ID de la línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
installment_quantityinteger(minimum: 1)required
Cantidad de cuotas para la refinanciación
Ejemplo: 12
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/debt/refinance/simulation
{
"type":
"TOTAL_DEBT"
"credit_line_id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"installment_quantity":
12
}
Ejemplo de respuestas
{
"data":{
"total":{
...
}
"current":{
...
}
"acceleration":{
...
}
"has_pending_operations":
false
}
}

Confirmar refinanciación de deuda

El endpoint /credit-lines/{credit_line_id}/debt/refinance/confirmation te permite confirmar el proceso de refinanciación total de deuda de una línea de crédito.

Permite pausar la línea para evitar que ingresen nuevas transacciones. La refinanciación se hará efectiva una vez que se registre el pago por el monto exacto.

Por el momento, este servicio solo está disponible para Chile.

Parámetros disponibles
Body Parameters
typestringrequired
Tipo de refinanciación - actualmente solo TOTAL_DEBT está implementado
Ejemplo: TOTAL_DEBT
Enum: TOTAL_DEBT
credit_line_idstringrequired
ID de la línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
installment_quantityinteger(minimum: 1)required
Cantidad de cuotas para la refinanciación
Ejemplo: 12
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
datastring
Ejemplo: Refinancing confirmed successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/debt/refinance/confirmation
{
"type":
"TOTAL_DEBT"
"credit_line_id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"installment_quantity":
12
}
Ejemplo de respuestas
{
"data":
"Refinancing confirmed successfully for c ..."
}

Simular aceleración total de deuda

El endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/simulation te permite obtener una simulación completa de la aceleración total de deuda de una línea de crédito.

Esta simulación no ejecuta cambios reales y tiene vigencia hasta las 00:00.

Por el momento, este servicio solo está disponible para Chile.

Parámetros disponibles
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/debt/acceleration/total/simulation
Ejemplo de respuestas
{
"data":{
"total":{
...
}
"current":{
...
}
"acceleration":{
...
}
"has_pending_operations":
true
"acceleration_fee":{
...
}
}
}

Confirmar aceleración total de deuda

El endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation te permite confirmar y ejecutar la aceleración total de deuda para una línea de crédito.

Este endpoint acelera automáticamente toda la deuda pendiente de la línea de crédito especificada. Una vez ejecutado, toda la deuda será acelerada inmediatamente.

Por el momento, este servicio solo está disponible para Chile.

Parámetros disponibles
Body Parameters
transaction_idsarray
Lista de IDs de transacción a acelerar
Ejemplo: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
datastring
Ejemplo: Total debt accelerated successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/debt/acceleration/total/confirmation
{
"transaction_ids":[
0
:
"ctx-2uoYnNyBsHaADF7fSHvkXykD6EY"
1
:
"ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"
]
}
Ejemplo de respuestas
{
"data":
"Total debt accelerated successfully for ..."
}

Simular aceleración de cuotas específicas

El endpoint /credit-lines/{credit_line_id}/debt/acceleration/installments/simulation te permite simular el anticipo de cuotas de una línea de crédito.

Debes proporcionar los transaction_ids de las cuotas específicas a anticipar.

Esta simulación no ejecuta cambios reales y tiene vigencia hasta las 00:00.

Por el momento, este servicio solo está disponible para Chile.

Parámetros disponibles
Body Parameters
transaction_idsarrayrequired
Lista de IDs de transacción de cuotas a acelerar
Ejemplo: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/debt/acceleration/installments/simulation
{
"transaction_ids":[
0
:
"ctx-2uoYnNyBsHaADF7fSHvkXykD6EY"
1
:
"ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"
]
}
Ejemplo de respuestas
{
"data":{
"total":{
...
}
"current":{
...
}
"acceleration":{
...
}
"has_pending_operations":
true
"installments_advanced":[
...
]
"advance_fee":{
...
}
}
}

Confirmar aceleración de deuda de cuotas específicas

El endpoint /credit-lines/{credit_line_id}/debt/acceleration/installments/confirmation te permite confirmar y ejecutar la aceleración de deuda para cuotas específicas de una línea de crédito.

Una vez ejecutado, las cuotas especificadas serán aceleradas inmediatamente.

Parámetros disponibles
Body Parameters
transaction_idsarray
Lista de IDs de transacción a acelerar
Ejemplo: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Identificador único de línea de crédito
Ejemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalle de respuestas
datastring
Ejemplo: Acceleration of installments [ctx-2uoYnNyBsHaADF7fSHvkXykD6EY, ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ] accelerated successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines/{credit_line_id}/debt/acceleration/installments/confirmation
{
"transaction_ids":[
0
:
"ctx-2uoYnNyBsHaADF7fSHvkXykD6EY"
1
:
"ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"
]
}
Ejemplo de respuestas
{
"data":
"Acceleration of installments [ctx-2uoYnN ..."
}