PomeloEx.Cards.Credits.CreditLines (PomeloEx v0.1.0)

View Source

Credit line management (V1 API).

Provides endpoints for creating, updating, canceling credit lines, as well as debt simulation and acceleration (early payment), refinancing, expiration date changes, and pricing updates.

Note: This module also includes credit product operations for convenience.

Credit line lifecycle

  1. create_product/1 — Define a credit product with terms and pricing
  2. create_credit_line/1 — Issue a credit line under a product
  3. get_credit_line/1 — Query credit line details
  4. Use debt_simulation/1 or refinancing simulation before confirmation
  5. Confirm debt operations via confirmation endpoints

Summary

Functions

cancel_credit_line(payload)

Cancel credit lines The lending/v1/credit-lines/{id} endpoint allows you to cancel a credit line.

confirm_acceleration_of_debt_for_specific_installments(payload)

Confirm acceleration of debt for specific installments The /credit-lines/{credit_line_id}/debt/acceleration/installments/confirmation endpoint allows you to confirm and execute acceleration for specific installment plans.

confirm_debt_refinancing(payload)

Confirm debt refinancing The /credit-lines/{credit_line_id}/debt/refinance/confirmation endpoint allows you to confirm total debt refinancing for a credit line.

confirm_total_debt_acceleration(payload)

Confirm total debt acceleration The /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation endpoint allows you to confirm and execute total debt acceleration for a credit line.

create_credit_line(payload)

Create line of credit The lending/v1/products endpoint allows you to create a credit line.

create_price_update(payload)

Create price update The /products/{product_id}/pricing endpoint allows you to create new price updates for products with ACTIVE or PAUSED status

create_product(payload)

Create Product The lending/v1/products endpoint allows you to create a product.

deactivating_product(payload)

Deactivating a product The endpoint lending/v1/products/{id} allows you to deactivate a specific product.

debt_acceleration(payload)

Debt acceleration The /credit-lines/{credit_line_id}/debt/acceleration endpoint allows you to confirm debt acceleration for a credit line.

debt_simulation(payload)

Debt simulation The /credit-lines/{credit_line_id}/debt/simulation endpoint allows you to simulate total debt acceleration or specific installment plan acceleration.

get_credit_line(payload)

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

get_credit_lines(payload)

Get credit lines The lending/v1/products endpoint allows you to retrieve data on credit lines according to specific search criteria.

get_price_update_history(payload)

Get price update history The endpoint /products/{product_id}/pricing allows you to obtain the price update history related to a product

get_product(payload)

Get product The lending/v1/products/{id} endpoint allows you to retrieve data from a specific product.

get_products(payload)

Get products The endpoint lending/v1/products allows you to retrieve data from all products created

modify_pending_price_update(payload)

Modify pending price update The endpoint /products/{product_id}/pricing/{start_date} enables you to modify a pending price update

simulate_acceleration_of_specific_installments(payload)

Simulate acceleration of specific installments The /credit-lines/{credit_line_id}/debt/acceleration/installments/simulation endpoint allows you to simulate acceleration of specific installment plans.

simulate_debt_refinancing(payload)

Simulate debt refinancing The /credit-lines/{credit_line_id}/debt/refinance/simulation endpoint allows you to simulate total debt refinancing for a credit line.

simulate_expiration_date_update(payload)

Simulate expiration date update The /credit-lines/{credit_line_id}/config/due-date/simulation endpoint allows you to simulate a change in the due date of a credit line.

simulate_total_debt_acceleration(payload)

Simulate total debt acceleration The /credit-lines/{credit_line_id}/debt/acceleration/total/simulation endpoint allows you to simulate total debt acceleration for a credit line.

update_credit_line(payload)

Update credit lines The lending/v1/credit-lines/{id} endpoint allows you to update data for a specific credit line.

update_expiration_date(payload)

Update expiration date The /credit-lines/{credit_line_id}/config/due-date endpoint allows you to change the due date of a credit line.

update_product(payload)

Update product The lending/v1/products/{id} endpoint allows you to update data for a specific product.

Functions

cancel_credit_line(payload)

Cancel credit lines The lending/v1/credit-lines/{id} endpoint allows you to cancel a credit line.

confirm_acceleration_of_debt_for_specific_installments(payload)

Confirm acceleration of debt for specific installments The /credit-lines/{credit_line_id}/debt/acceleration/installments/confirmation endpoint allows you to confirm and execute acceleration for specific installment plans.

confirm_debt_refinancing(payload)

Confirm debt refinancing The /credit-lines/{credit_line_id}/debt/refinance/confirmation endpoint allows you to confirm total debt refinancing for a credit line.

confirm_total_debt_acceleration(payload)

Confirm total debt acceleration The /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation endpoint allows you to confirm and execute total debt acceleration for a credit line.

create_credit_line(payload)

Create line of credit The lending/v1/products endpoint allows you to create a credit line.

create_price_update(payload)

Create price update The /products/{product_id}/pricing endpoint allows you to create new price updates for products with ACTIVE or PAUSED status

create_product(payload)

Create Product The lending/v1/products endpoint allows you to create a product.

At this moment, you will be able to define the cutoff and due dates, limits and available balances, rates and fees, how the minimum payment is composed and more.

deactivating_product(payload)

Deactivating a product The endpoint lending/v1/products/{id} allows you to deactivate a specific product.

debt_acceleration(payload)

Debt acceleration The /credit-lines/{credit_line_id}/debt/acceleration endpoint allows you to confirm debt acceleration for a credit line.

debt_simulation(payload)

Debt simulation The /credit-lines/{credit_line_id}/debt/simulation endpoint allows you to simulate total debt acceleration or specific installment plan acceleration.

get_credit_line(payload)

Get line of credit 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 documentation.

get_credit_lines(payload)

Get credit lines The lending/v1/products endpoint allows you to retrieve data on credit lines according to specific search criteria.

Filters# You can find more information on how to apply filters in the section Filters and pagination.

get_price_update_history(payload)

Get price update history The endpoint /products/{product_id}/pricing allows you to obtain the price update history related to a product

get_product(payload)

Get product The lending/v1/products/{id} endpoint allows you to retrieve data from a specific product.

get_products(payload)

Get products The endpoint lending/v1/products allows you to retrieve data from all products created

modify_pending_price_update(payload)

Modify pending price update The endpoint /products/{product_id}/pricing/{start_date} enables you to modify a pending price update

simulate_acceleration_of_specific_installments(payload)

Simulate acceleration of specific installments The /credit-lines/{credit_line_id}/debt/acceleration/installments/simulation endpoint allows you to simulate acceleration of specific installment plans.

simulate_debt_refinancing(payload)

Simulate debt refinancing The /credit-lines/{credit_line_id}/debt/refinance/simulation endpoint allows you to simulate total debt refinancing for a credit line.

simulate_expiration_date_update(payload)

Simulate expiration date update The /credit-lines/{credit_line_id}/config/due-date/simulation endpoint allows you to simulate a change in the due date of a credit line.

simulate_total_debt_acceleration(payload)

Simulate total debt acceleration The /credit-lines/{credit_line_id}/debt/acceleration/total/simulation endpoint allows you to simulate total debt acceleration for a credit line.

update_credit_line(payload)

Update credit lines The lending/v1/credit-lines/{id} endpoint allows you to update data for a specific credit line.

update_expiration_date(payload)

Update expiration date The /credit-lines/{credit_line_id}/config/due-date endpoint allows you to change the due date of a credit line.

update_product(payload)

Update product The lending/v1/products/{id} endpoint allows you to update data for a specific product.