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

Product Setup

Para cada producto deberá definirse el sistema de amortización, sistema de mora, tabla de pricing, tipo de vencimiento (fijo o por buckets), tipo de línea (revolvente, de un solo uso, múltiples uso no revolvente), monto mínimo y máximo para la línea, monto mínimo y máximo para préstamos, fees o cargos a aplicarse en el producto, jerarquía de asignación de pagos, cálculo del pago mínimo para TC, cantidad de cuotas y tabla a de collateral, fecha de vigencia de las condiciones.

Creación de Credit Lines

De la misma manera que en la configuración del producto se definen las características marco del mismo, las credit lines contienen las características a nivel usuario. Para tener esta cuenta, tus usuarios deberán:

  • Estar registrados en Pomelo.
  • Encontrarse en estado “Activo”.
  • Tener verificada su identidad. Esta verificación solo la hacemos si contrataste nuestro producto de Identity.

Aquí deberás crear las líneas para cada uno de tus usuarios, una vez que hayas definido a quién estas dispuesto a darle el producto y en qué condiciones.

Un usuario puede tener más de una línea en caso de que le ofrezcas más de un producto. Pero solo puede existir una combinación entre Línea Activa - Producto - Usuario.

La línea contiene características específicas para un usuario. Como por ejemplo, Product ID (relación con la configuración del producto), monto/límite, fecha de inicio, fecha fin, fecha de vencimiento asignada, cantidad de cuotas (puede definirse a nivel de producto o a nivel de usuario), collateral, status.

Asociación de tarjetas a la línea de crédito

Para poder activar la línea de crédito es necesario asociar la o las tarjetas que previamente fueron creadas y activadas en el módulo de cards.

Una vez asociada una tarjeta a la línea de crédito la misma esta estará disponible para ser utilizada, el módulo de autorización está activo y listo para recibir transacciones.

Crear producto

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

Parámetros disponibles
Body Parameters
namestringrequired
Nombre del producto
Ejemplo: Gold Credit Card
typerequired
Tipo de producto
Enum: CREDIT_CARD
statusrequired
Estado del producto
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_cardobject
pricingobjectrequired
available_balance_settingsstring

'Estrategia de restitución de balance' \ *EXTENDED - Solo BR

Enum: RESTRICTEDEXTENDED
statementobjectrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/products
{
"name":
"Gold Credit Card"
"type":
"CREDIT_CARD"
"status":
"ACTIVE"
"country":
"MEX"
"start_date":
"2022-04-20"
"end_date":
"2022-04-20"
"grace_period_days":{
"pausing":
1
}
"credit_card":{
"max_allowed_installments":
1
"limits":{
...
}
"collateral":[
...
]
"billing_cycle_config":{
...
}
"minimum_payment":
100
"minimum_payment_composition":{
...
}
"affinity_group_id":
"afg-20MpN8vmIPj77ujhb9cS8ctstN2"
}
"pricing":{
"rates":{
...
}
"fees":[
...
]
}
"available_balance_settings":
"RESTRICTED"
"statement":{
"generate_pdf":
true
}
}
Ejemplo de respuestas
{
"data":{
"id":
"lpr-2HMvSzWjc5La6WDTlgFw2Kqk2Q9"
"type":
"CREDIT_CARD"
"name":
"Gold Credit Card"
"status":
"ACTIVE"
"country":
"MEX"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
}
}

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
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

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

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 inicio del producto
end_datestring
Fecha de expiración del producto
grace_period_daysobject
Período de tiempo después del vencimiento en el que se puede realizar un pago sin ninguna penalidad
credit_cardobject
Path Parameters
product_idstringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

PATCH/lending/v1/products/{product_id}
{
"name":
"string"
"status":
"ACTIVE"
"start_date":
"string"
"end_date":
"string"
"grace_period_days":{
"pausing":
1
}
"credit_card":{
"max_allowed_installments":
1
"collateral":[
...
]
"billing_cycle_config":{
...
}
"minimum_payment":
1
"minimum_payment_composition":{
...
}
"affinity_group_id":
"string"
"statement":{
...
}
}
}
Ejemplo de respuestas
{
"data":{
"id":
"lpr-2HMvSzWjc5La6WDTlgFw2Kqk2Q9"
"type":
"CREDIT_CARD"
"name":
"Gold Credit Card"
"status":
"ACTIVE"
"country":
"MEX"
"start_date":
"2022-04-20"
"end_date":
"2024-05-17"
"credit_card":{
...
}
"grace_period_days":{
...
}
"pricing":{
...
}
"available_balance_settings":
"RESTRICTED"
"statement":{
...
}
}
}

Desactivar un producto

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

Parámetros disponibles
Path Parameters
product_idstringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

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

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.

Parámetros disponibles
Body Parameters
Detalle de respuestas
dataarray

¿Te resultó útil esta sección?

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

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-2HMwKzetERdOEhbT86UwHfAhCHf
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
closing_dateintegerrequired
Fecha de cierre
Ejemplo: 28
collateralobject
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-2HMwKzetERdOEhbT86UwHfAhCHf"
"offer_start_date":
"2022-04-20"
"offer_end_date":
"2022-04-20"
"closing_date":
28
"collateral":{
"key":
"DAI"
"amount":
"10000.00"
}
"user_scoring":
"A"
}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOK5W0op0"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfuChe8Uc"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFw2Kqk2Q9"
"status":
"ACTIVE"
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"closing_date":
28
"collateral":{
...
}
"user_scoring":
"A"
}
}

Obtener una línea 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.

Parámetros disponibles
Path Parameters
credit_line_idstringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/lending/v1/credit-lines/{credit_line_id}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOK5W0op0"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfuChe8Uc"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFw2Kqk2Q9"
"status":
"ACTIVE"
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"closing_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
offer_start_datestring
offer_end_datestring
closing_datenumber
collateralobject
status_detailobject
user_scoringstring
Path Parameters
credit_line_idstringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

PATCH/lending/v1/credit-lines/{credit_line_id}
{
"status":
"string"
"offer_start_date":
"string"
"offer_end_date":
"string"
"closing_date":
"number"
"collateral":{
"key":
"DAI"
"amount":
"10000.00"
}
"status_detail":{
"reason":
"string"
"text":
"string"
}
"user_scoring":
"string"
}
Ejemplo de respuestas
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOK5W0op0"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfuChe8Uc"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFw2Kqk2Q9"
"status":
"ACTIVE"
"offer_start_date":
"2022-04-12"
"offer_end_date":
"2022-04-12"
"activation_date":
"2022-04-12"
"balances":{
...
}
"closing_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 del pricing
Ejemplo: 2022-04-30
ratesobjectrequired
feesarrayrequired
Path Parameters
product_idstringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/lending/v1/products/{product_id}/pricing
{
"start_date":
"2022-04-30"
"rates":{
"financing":
"number"
"late_fee":
"number"
"cash_advance":
"number"
"revolving":
"number"
}
"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
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
feesarray
Path Parameters
product_idstringrequired
start_datestringrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

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