Credit lines

The Credit Lines service allows you to create and manage both credit products and credit lines.

Do you want to know more about credit lines? Check our documentation.

Create product

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

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

Available parameters
Body Parameters
namestringrequired
Product name
Example: Gold Credit Card
typerequired
Type of product
Example: CREDIT_CARD
Enum: CREDIT_CARD
statusrequired
Product status
Example: PAUSED
Enum: ACTIVEPAUSEDINACTIVE
countryrequired
Country of the product
Example: BRA
Enum: BRA
start_datestring(format: date)required
Effective date of the product
Example: 2022-04-20
end_datestring(format: date)
Expiration date of the product
Example: 2027-04-20
grace_period_daysobjectrequired
Period of time after the due date in which a payment can be made without any penalty
credit_cardobjectrequired
Credit card configuration
pricingobjectrequired
Interest rates and fees that apply to the line.
available_balance_settingsstring
Balance restitution strategy. In CHILE AND MEXICO its only possible value is EXTENDED. In COLOMBIA its only possible value is RESTRICTED
Example: RESTRICTED
Enum: RESTRICTEDEXTENDED
statementobjectrequired
Statement configuration
refinancingobject
Refinancing configuration including mandatory and manual options
cancellationobject
Configuration for credit line cancellation due to default. Only available for Brazil.
Response details
dataobject

Was this section helpful to you?

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
}
}
Response examples
{
"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":{
...
}
}
}

Get products

The endpoint lending/v1/products allows you to obtain data on all created products.

Available parameters
Response details
dataarray

Was this section helpful to you?

GET/lending/v1/products
Response examples
{
"data":[
0:{
...
}
]
}

Get a product

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

Available parameters
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

GET/lending/v1/products/{product_id}
Response examples
{
"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":{
...
}
}
}

Update a product

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

Available parameters
Body Parameters
namestring
Product name
statusstring
Product status
Enum: ACTIVEPAUSED
start_datestring
Effective date of the product
Example: 2022-01-01
end_datestring
Expiration date of the product
Example: 2027-04-20
grace_period_daysobject
Period of time after the due date in which a payment can be made without any penalty
credit_cardobject
Credit card configuration
statementobject
Statement configuration
refinancingobject
Refinancing configuration including mandatory and manual options
cancellationobject
Configuration for credit line cancellation due to default. Only available for Brazil.
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

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"
}
"refinancing":{
"mandatory":{
...
}
"manual":{
...
}
}
"cancellation":{
"enabled":
"true"
"delinquency_days_amount":
6
}
}
Response examples
{
"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":{
...
}
}
}

Deactivate a product

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

Available parameters
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

DELETE/lending/v1/products/{product_id}
Response examples
{
"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":{
...
}
}
}

Get credit lines

The endpoint lending/v1/credit-lines allows you to obtain data on credit lines given a search criterion.

Filters

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

Available parameters
Query Parameters
filter[id]string
Allows obtaining the credit line associated with the specified ID
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
filter[user_id]string
Allows obtaining the credit lines associated with the specified user ID
Example: usr-2HMvSDccc5PZzCvZ98lfeXamPle
filter[status]string
Allows obtaining the credit lines associated with the specified status
Example: ACTIVE
Enum: OFFEREDACTIVEPAUSEDCANCELEDEXPIRED
filter[offer_start_date][from]string(format: date)
Allows obtaining the credit lines from the specified offer date
Example: 2022-03-10
filter[offer_start_date][to]string(format: date)
Allows obtaining credit lines until the specified offer date
Example: 2022-03-20
filter[activation_date][from]string(format: date)
Allows obtaining the credit lines from the specified activation date
Example: 2022-04-12
filter[activation_date][to]string(format: date)
Allows obtaining the credit lines until the specified activation date
Example: 2022-04-22
filter[user_scoring]string
Allows obtaining the credit lines associated with the specified user scoring
Example: A
Response details
dataarray
metaobject

Was this section helpful to you?

GET/lending/v1/credit-lines
Response examples
{
"data":[
0:{
...
}
]
"meta":{
"pagination":{
...
}
}
}

Create credit line

The endpoint lending/v1/credit-lines allows you to create a credit line.

Available parameters
Body Parameters
user_idstringrequired
Identifier of the beneficiary user
Example: usr-2HMwJZo114goVi7xdSseYfujP79
product_idstringrequired
Credit product identifier
Example: lpr-2HMvSzWjc5La6WDTlgFweXAmPle
segment_idstring
Segment identifier
Example: lsg-2HMvSzWjc5La6WDTlgFweXAmPle
limitsoneOf
offer_start_datestringrequired
Start date of the offer
Example: 2022-04-20
offer_end_datestring
Completion date of the offer
Example: 2023-05-20
due_dateintegerrequired
Due date
Example: 28
user_scoringstringrequired
User scoring identifier
Example: A
person_typestring
Type of person
Example: NATURAL
Enum: LEGALNATURAL
Response details
dataobject

Was this section helpful to you?

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"
}
Response examples
{
"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":{
...
}
}
}

Get a credit line

The endpoint lending/v1/credit-lines/{id} allows you to obtain data from a specific credit line.

In this instance, you will be able to define the specific limit and closing date for this credit line, always within the parameters you have defined for the product.

Do you want to know more about credit lines? Check our documentation.

Available parameters
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

GET/lending/v1/credit-lines/{credit_line_id}
Response examples
{
"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":{
...
}
}
}

Update credit line

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

Available parameters
Body Parameters
limitsoneOf
statusstring
Credit line status
Example: PAUSED
Enum: ACTIVEPAUSED
status_detailobject
Information about the status change
offer_start_datestring
Start date of the offer
Example: 2022-04-20
offer_end_datestring
Completion date of the offer
Example: 2023-05-20
due_dateinteger
Due date
Example: 28
user_scoringstring
User scoring identifier
Example: A
person_typestring
Type of person
Example: NATURAL
Enum: LEGALNATURAL
update_segmentobject
Segment update
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

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"
}
}
Response examples
{
"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":{
...
}
}
}

Cancel credit lines

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

Available parameters
Body Parameters
reasonstring
Reason for cancellation of the credit line
Enum: BY_USER_WITHOUT_DEBT_ACCELERATIONBY_USER_WITH_DEBT_ACCELERATION_REQUESTBY_CLIENT_WITHOUT_DEBT_ACCELERATION
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

DELETE/lending/v1/credit-lines/{credit_line_id}
{
"reason":
"BY_USER_WITHOUT_DEBT_ACCELERATION"
}
Response examples
{
"data":{
"id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
}
}

Update expiration date

The endpoint lending/v1/credit-lines/{id}/config/due-date allows you to change the due date of a credit line by selecting from the options you defined in the Product. If needed, you can perform simulations by interacting with the endpoint: lending/v1/credit-lines/{id}/config/due-date/simulation.

Review all the conditions that apply to the expiration date update in our documentation.

Available parameters
Body Parameters
due_dateint(minimum: 1, maximum: 28)
New expiration date of the credit line
Example: 28
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

POST/lending/v1/credit-lines/{credit_line_id}/config/due-date
{
"due_date":
28
}
Response examples
{
"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":{
...
}
}
}

Simulate expiration date update

The endpoint lending/v1/credit-lines/{id}/config/due-date/simulation allows you to simulate a change in the due date of a credit line and see what the closing dates and due dates of the next billing cycle would be.

Available parameters
Body Parameters
due_dateint(minimum: 1, maximum: 28)
New expiration date of the credit line
Example: 28
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

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

Create price update

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

Available parameters
Body Parameters
start_datestring(format: date)required
Effective date of the price update
Example: 2022-04-30
ratesobjectrequired
Rate configuration
feesarrayrequired
Fee configuration
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

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:{
...
}
]
}
Response examples
{
"data":{
"start_date":
"2022-04-30"
"rates":{
...
}
"fees":[
...
]
"issuer_installment_rates":[
...
]
}
}

Obtain rate updates

The endpoint /products/{product_id}/pricing allows you to obtain the pricing update history of a specific product.

Available parameters
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataarray

Was this section helpful to you?

GET/lending/v1/products/{product_id}/pricing
Response examples
{
"data":[
0:{
...
}
]
}

Modify pending price update

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

Available parameters
Body Parameters
ratesobject
Rate configuration
feesarray
Fee configuration
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
start_datestringrequired
Effective date of the price update
Example: 2022-04-30
Response details
dataobject

Was this section helpful to you?

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:{
...
}
]
}
Response examples
{
"data":{
"start_date":
"2022-04-30"
"rates":{
...
}
"fees":[
...
]
"issuer_installment_rates":[
...
]
}
}

Create segment

The endpoint lending/v1/products/{product_id}/segments allows you to create a new segment for a product with a specific pricing configuration.

Available parameters
Body Parameters
namestringrequired
Segment name
Example: Premium Segment
pricingobject
Interest rates and fees that apply to the line.
credit_cardobject
Credit card configuration
refinancingobject
Refinancing configuration including mandatory and manual options
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

POST/lending/v1/products/{product_id}/segments
{
"name":
"Premium Segment"
"pricing":{
"rates":{
...
}
"fees":[
...
]
}
"credit_card":{
"minimum_payment":
100
"minimum_payment_composition":{
...
}
}
"refinancing":{
"mandatory":{
...
}
"manual":{
...
}
}
}
Response examples
{
"data":{
"id":
"lsg-3mkvSzWjc5La6WDTlgFweXAmP23"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"name":
"Premium Segment"
"status":
"ACTIVE"
"pricing":{
...
}
"credit_card":{
...
}
"refinancing":{
...
}
"created_at":
"2022-04-30T00:00:00Z"
"updated_at":
"2022-04-30T00:00:00Z"
}
}

Get segments

The endpoint lending/v1/products/{product_id}/segments allows you to obtain all segments associated with a specific product.

Available parameters
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataarray
List of segments

Was this section helpful to you?

GET/lending/v1/products/{product_id}/segments
Response examples
{
"data":[
0:{
...
}
]
}

Get a segment

The endpoint lending/v1/products/{product_id}/segments/{segment_id} allows you to obtain the data of a specific segment for a given credit product.

Available parameters
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
segment_idstringrequired
Unique segment identifier
Example: lsg-3JswKtetEReOEssT86UweXa4do2
Response details
dataobject

Was this section helpful to you?

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

Update segment

The endpoint lending/v1/products/{product_id}/segments/{segment_id} allows you to update the configurations of a specific segment.

Available parameters
Body Parameters
namestring
Segment name
Example: Premium Segment
pricingobject
Interest rates and fees that apply to the line.
credit_cardobject
Credit card configuration
refinancingobject
Refinancing configuration including mandatory and manual options
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
segment_idstringrequired
Unique segment identifier
Example: lsg-3JswKtetEReOEssT86UweXa4do2
Response details
dataobject

Was this section helpful to you?

PATCH/lending/v1/products/{product_id}/segments/{segment_id}
{
"name":
"Premium Segment"
"pricing":{
"start_date":
"2022-04-30"
"rates":{
...
}
"fees":[
...
]
}
"credit_card":{
"minimum_payment":
100
"minimum_payment_composition":{
...
}
}
"refinancing":{
"mandatory":{
...
}
"manual":{
...
}
}
}
Response examples
{
"data":{
"id":
"lsg-3mkvSzWjc5La6WDTlgFweXAmP23"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"name":
"Premium Segment"
"status":
"ACTIVE"
"pricing":{
...
}
"credit_card":{
...
}
"refinancing":{
...
}
"created_at":
"2022-04-30T00:00:00Z"
"updated_at":
"2022-04-30T00:00:00Z"
}
}

Get segment rate updates

The endpoint lending/v1/products/{product_id}/segments/{segment_id}/pricing allows you to obtain the rate updates for the segment, whether applied or upcoming.

Available parameters
Path Parameters
product_idstringrequired
Unique product identifier
Example: lpr-2HMwKzetERdOEhbT86UweXamPle
segment_idstringrequired
Unique segment identifier
Example: lsg-3JswKtetEReOEssT86UweXa4do2
Response details
dataarray

Was this section helpful to you?

GET/lending/v1/products/{product_id}/segments/{segment_id}/pricing
Response examples
{
"data":[
0:{
...
}
]
}

Status change notifications

Please provide us this endpoint to receive notifications for changes in the status of the credit lines.

If you have questions about how to set up a webhook, visit our documentation.

You must respond with an HTTP 2xx code so that we do not resend the notification. Otherwise, we will resend it infinitely.

Available parameters
Header Parameters
X-Api-Keystringrequired
This header will allow you to identify which api-secret you need to use in case multiple pairs of api-key and api-secret have been configured.
Example: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
This header contains the digital signature (body + timestamp + endpoint) that you must verify to ensure the integrity of the request. If the signature does not match, you must reject the order.
Example: X-Signature: hmac-sha256 N70BkBKch1gwQDPj0jF0ooB9QQVXBEp5VQE+SGe6Z0k=
X-Timestampstringrequired
This header contains the moment when the order was signed in unix-epoch format so you can verify that the signature has not expired.
Example: X-Timestamp: 1637117179
X-Endpointstringrequired
The endpoint to which the request is made and you used to generate the signature. Use this header to regenerate the signature to validate, compare it with your service endpoint, and verify that they match.
Example: X-Endpoint: /<client-url>/credit-lines
Body Parameters
event_idstringrequired
Event identifier.
Example: credit_line_paused
Enum: credit_line_pausedcredit_line_unpausedcredit_line_canceled
idempotency_keystringrequired
Idempotent identifier for event creation.
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
dataobject
Information of the affected credit line

Was this section helpful to you?

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"
}
}
Response examples

Notifications of entry, exit, or remaining in default of a user

You must provide us this endpoint to receive notifications of entry, exit, or remaining in default of a user.

If you have questions about how to set up a webhook, visit our documentation.

You must respond with an HTTP 2xx code so that we do not resend the notification. Otherwise, we will resend it infinitely.

Available parameters
Header Parameters
X-Api-Keystringrequired
This header will allow you to identify which api-secret you need to use in case multiple pairs of api-key and api-secret have been configured.
Example: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
This header contains the digital signature (body + timestamp + endpoint) that you must verify to ensure the integrity of the request. If the signature does not match, you must reject the order.
Example: X-Signature: hmac-sha256 N70BkBKch1gwQDPj0jF0ooB9QQVXBEp5VQE+SGe6Z0k=
X-Timestampstringrequired
This header contains the moment when the order was signed in unix-epoch format so you can verify that the signature has not expired.
Example: X-Timestamp: 1637117179
X-Endpointstringrequired
The endpoint to which the request is made and you used to generate the signature. Use this header to regenerate the signature to validate, compare it with your service endpoint, and verify that they match.
Example: X-Endpoint: /<client-url>/credit-lines
Body Parameters
event_idstringrequired
Event identifier.
Example: user_in_arrears
Enum: user_in_arrearsuser_out_of_arrearsuser_remains_in_arrears
idempotency_keystringrequired
Idempotent identifier for event creation.
Example: 27KxRhP9YB4ouoyt6a5vVJlY9fR
dataobject
Information of the affected user

Was this section helpful to you?

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"
}
}
Response examples

Debt simulation

{{El endpoint /credit-lines/{credit_line_id}/debt/simulation te permite simular la aceleración total de deuda o de algunos planes de cuota de una línea de crédito. Esta simulación NO ejecuta la aceleración y tiene vigencia hasta las 00:00 hs.

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

Available parameters
Query Parameters
transaction_idsstringrequired
Identifiers of the transactions, separated by commas
Example: ctx-2utzQVe7X7RfXrVUOPIJgCzRtx1,ctx-2utzQZBjBp3v2nzg1XsKgYGo9JL,lrp-2HMvSzWjc5La6WDTlgFweXAmPle
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

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

Debt acceleration

The endpoint /lending/v1/credit-lines/{credit_line_id}/debt/acceleration allows you to confirm the acceleration of the debt of a credit line, advancing some or all of the current installment plans, depending on what you indicate.

The endpoint /credit-lines/{credit_line_id}/debt/simulation allows you to simulate the total debt acceleration or some installment plans of a credit line. This simulation does NOT execute the acceleration and is valid until 00:00 hrs..

Available parameters
Body Parameters
transaction_idsarrayrequired
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

POST/lending/v1/credit-lines/{credit_line_id}/debt/acceleration
{
"transaction_ids":[
0
:
"ctx-2utzQVe7X7RfXrVUOPIJgCzRtx1"
1
:
"ctx-2utzQVe7X7RfXrVUOPIJgCzRtx2"
2
:
"lrp-200kirg6qicg1qHSCbgaStrEHjI"
]
}
Response examples
{
"data":{
"message":
"string"
}
}

Simulate debt refinancing

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

Esta simulación NO ejecuta la aceleración y tiene vigencia hasta las 00:00 hs.

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

Available parameters
Body Parameters
typestringrequired
Type of refinancing - currently only TOTAL_DEBT is implemented
Example: TOTAL_DEBT
Enum: TOTAL_DEBT
credit_line_idstringrequired
Credit line ID
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
installment_quantityinteger(minimum: 1)required
Number of installments for refinancing
Example: 12
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

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

Confirm debt refinancing

{{El endpoint /credit-lines/{credit_line_id}/debt/refinance/confirmation te permite confirmar la refinanciación total de deuda de una línea de crédito y pausar la línea para evitar que ingresen nuevas transacciones.

Importante: La refinanciación se confirma cuando registramos el pago por el monto exacto.

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

Available parameters
Body Parameters
typestringrequired
Type of refinancing - currently only TOTAL_DEBT is implemented
Example: TOTAL_DEBT
Enum: TOTAL_DEBT
credit_line_idstringrequired
Credit line ID
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
installment_quantityinteger(minimum: 1)required
Number of installments for refinancing
Example: 12
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
datastring
Example: Refinancing confirmed successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

Was this section helpful to you?

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

Simulate total debt acceleration

{{El endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/simulation te permite simular la aceleración total de deuda de una línea de crédito. Esta simulación NO ejecuta la aceleración y tiene vigencia hasta las 00:00 hs.

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

Available parameters
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

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

Confirm total debt acceleration

{{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. Es decir, que al ejecutarlo, aceleraremos la totalidad de la deuda y pasa al estado de cuenta en curso.

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

Available parameters
Body Parameters
transaction_idsarray
List of transaction IDs to accelerate
Example: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
datastring
Example: Total debt accelerated successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

Was this section helpful to you?

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

Simulate acceleration of specific installments

{{El endpoint /credit-lines/{credit_line_id}/debt/acceleration/installments/simulation te permite simular el anticipo de algunos planes de cuota de una línea de crédito. Esta simulación NO ejecuta la aceleración y tiene vigencia hasta las 00:00 hs.

Importante: Tendrás que indicar los transaction_ids de los planes de cuotas específicas a anticipar.

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

Available parameters
Body Parameters
transaction_idsarrayrequired
List of transaction IDs for fees to accelerate
Example: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
dataobject

Was this section helpful to you?

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

Confirm acceleration of debt for specific installments

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

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

Available parameters
Body Parameters
transaction_idsarray
List of transaction IDs to accelerate
Example: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Unique credit line identifier
Example: lcr-2HMwKzetERdOEhbT86UweXamPle
Response details
datastring
Example: Acceleration of installments [ctx-2uoYnNyBsHaADF7fSHvkXykD6EY, ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ] accelerated successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

Was this section helpful to you?

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