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: MEX
Enum: BRAMEX
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: 2022-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. Solo seleccionable para productos de BRASIL, en otros países su único valor posible es RESTRICTED
Ejemplo: RESTRICTED
Enum: RESTRICTEDEXTENDED
statementobjectrequired
Configuración de estados de cuenta
refinancingobject
Configuración de refinanciación obligatoria solo para BRA
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/products
{
"name":
"Gold Credit Card"
"type":
"CREDIT_CARD"
"status":
"PAUSED"
"country":
"MEX"
"start_date":
"2022-04-20"
"end_date":
"2022-04-20"
"grace_period_days":{
"pausing":
10
"compensatory_interest":
10
"late_interest":
10
}
"credit_card":{
"max_allowed_installments":
1
"limits":{
...
}
"collateral":[
...
]
"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"
}
"refinancing":{
"mandatory":{
...
}
}
}
Ejemplo de respuestas
{
"data":{
"id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"type":
"CREDIT_CARD"
"name":
"Gold Credit Card"
"status":
"PAUSED"
"country":
"MEX"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
"refinancing":{
...
}
}
}

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":
"MEX"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
"refinancing":{
...
}
}
}

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: 2022-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
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":
"2022-04-20"
"grace_period_days":{
"pausing":
5
"compensatory_interest":
10
"late_interest":
10
}
"credit_card":{
"max_allowed_installments":
1
"collateral":[
...
]
"billing_cycle_config":{
...
}
"minimum_payment":
100
"minimum_payment_composition":{
...
}
"affinity_group_id":
"string"
"statement":{
...
}
}
}
Ejemplo de respuestas
{
"data":{
"id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"type":
"CREDIT_CARD"
"name":
"Gold Credit Card"
"status":
"PAUSED"
"country":
"MEX"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
"refinancing":{
...
}
}
}

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":
"MEX"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
"refinancing":{
...
}
}
}

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-2HMvRUOZ9C3fbsrkdeyOexAmpLe
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: ACTIVEOFFEREDPAUSEDCANCELEDFINISHED
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
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: 2022-04-20
due_dateintegerrequired
Fecha de vencimiento
Ejemplo: 28
collateralobject
Configuración del colateral
user_scoringstringrequired
Identificador del scoring del usuario
Ejemplo: A
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/credit-lines
{
"user_id":
"usr-2HMwJZo114goVi7xdSseYfujP79"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"offer_start_date":
"2022-04-20"
"offer_end_date":
"2022-04-20"
"due_date":
28
"collateral":{
"key":
"DAI"
"amount":
"10000.00"
}
"user_scoring":
"A"
}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"status":
"ACTIVE"
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"due_date":
28
"collateral":{
...
}
"user_scoring":
"A"
}
}

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-2HMvRUOZ9C3fbsrkdeyOexAmpLe"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"status":
"ACTIVE"
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"due_date":
28
"collateral":{
...
}
"user_scoring":
"A"
}
}

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: INACTIVE
offer_start_datestring
Fecha de inicio de la oferta
Ejemplo: 2022-04-20
offer_end_datestring
Fecha de finalización de la oferta
Ejemplo: 2022-04-20
due_dateinteger
Fecha de vencimiento
Ejemplo: 28
collateralobject
Configuración del colateral
status_detailobject
Información acerca del cambio de estado
user_scoringstring
Identificador del scoring del usuario
Ejemplo: A
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":
"INACTIVE"
"offer_start_date":
"2022-04-20"
"offer_end_date":
"2022-04-20"
"due_date":
28
"collateral":{
"key":
"DAI"
"amount":
"10000.00"
}
"status_detail":{
"reason":
"Sample reason for the change"
"text":
"More information about the change"
}
"user_scoring":
"A"
}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"status":
"ACTIVE"
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"due_date":
28
"collateral":{
...
}
"user_scoring":
"A"
}
}

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":[
...
]
}
}

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":[
...
]
}
}