Linhas de crédito

O serviço de Linhas de Crédito permite-lhe criar e gerenciar produtos creditícios, bem como linhas de crédito

Quer saber mais sobre as linhas de crédito? Dê uma olhada na nossa documentação.

Criar produto

O endpoint lending/v1/products permite que você crie um produto.

Neste momento, você poderá definir as datas de corte e vencimento, os limites e disponibilidades, as taxas e comissões, como se compõe o pagamento mínimo e mais.

Parâmetros disponíveis
Body Parameters
namestringrequired
Nome do produto
Exemplo: Gold Credit Card
typerequired
Tipo de produto
Exemplo: CREDIT_CARD
Enum: CREDIT_CARD
statusrequired
Status do produto
Exemplo: PAUSED
Enum: ACTIVEPAUSEDINACTIVE
countryrequired
País do produto
Exemplo: BRA
Enum: BRA
start_datestring(format: date)required
Data de entrada em vigor do produto
Exemplo: 2022-04-20
end_datestring(format: date)
Data de expiração do produto
Exemplo: 2027-04-20
grace_period_daysobjectrequired
Período após o vencimento em que um pagamento pode ser feito sem penalidades
credit_cardobjectrequired
Configuração do cartão de crédito
pricingobjectrequired
Define de forma centralizada as taxas de juros e as comissões que serão aplicadas ao produto.
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
Exemplo: RESTRICTED
Enum: RESTRICTEDEXTENDED
statementobjectrequired
Configuração dos extratos
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.
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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
}
}
Respostas de amostra
{
"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":{
...
}
}
}

Obter produtos

O endpoint lending/v1/products permite-lhe obter dados de todos os produtos criados

Parâmetros disponíveis
Detalhe de respostas
dataarray

Esta seção foi útil para você?

GET/lending/v1/products
Respostas de amostra
{
"data":[
0:{
...
}
]
}

Obter produto

O endpoint lending/v1/products/{id} permite obter dados de um produto em específico.

Parâmetros disponíveis
Path Parameters
product_idstringrequired
Identificador único do produto
Exemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

GET/lending/v1/products/{product_id}
Respostas de amostra
{
"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":{
...
}
}
}

Atualizar produto

O endpoint lending/v1/products/{id} permite atualizar os dados de um produto específico.

Parâmetros disponíveis
Body Parameters
namestring
Nome do produto
statusstring
Status do produto
Enum: ACTIVEPAUSED
start_datestring
Data de entrada em vigor do produto
Exemplo: 2022-01-01
end_datestring
Data de expiração do produto
Exemplo: 2027-04-20
grace_period_daysobject
Período após o vencimento em que um pagamento pode ser feito sem penalidades
credit_cardobject
Configuração do cartão de crédito
statementobject
Configuração dos extratos
cancellationobject
Configuración de cancelación de línea de crédito por mora. Solo disponible para Brasil.
Path Parameters
product_idstringrequired
Identificador único do produto
Exemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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
}
}
Respostas de amostra
{
"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":{
...
}
}
}

Desativar um produto

O endpoint lending/v1/products/{id} serve para desativar um produto específico.

Parâmetros disponíveis
Path Parameters
product_idstringrequired
Identificador único do produto
Exemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

DELETE/lending/v1/products/{product_id}
Respostas de amostra
{
"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":{
...
}
}
}

Obter linhas de crédito

O endpoint lending/v1/credit-lines permite obter dados de linhas de crédito com base em um critério de busca.

Filtros

Você pode encontrar mais informações sobre como aplicar filtros na seção de Filtros e paginação.

Parâmetros disponíveis
Query Parameters
filter[id]string
Permite obter a linha de crédito associada ao ID especificado
Exemplo: lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe
filter[user_id]string
Permite obter as linhas de crédito associadas ao ID do usuário especificado
Exemplo: usr-2HMvSDccc5PZzCvZ98lfeXamPle
filter[status]string
Permite obter as linhas de crédito associadas ao status especificado
Exemplo: ACTIVE
Enum: OFFEREDACTIVEPAUSEDCANCELEDEXPIRED
filter[offer_start_date][from]string(format: date)
Permite obter as linhas de crédito a partir da data de oferta especificada
Exemplo: 2022-03-10
filter[offer_start_date][to]string(format: date)
Permite obter linhas de crédito até a data da oferta especificada
Exemplo: 2022-03-20
filter[activation_date][from]string(format: date)
Permite obter as linhas de crédito a partir da data de ativação especificada
Exemplo: 2022-04-12
filter[activation_date][to]string(format: date)
Permite obter as linhas de crédito até a data de ativação especificada
Exemplo: 2022-04-22
filter[user_scoring]string
Permite obter as linhas de crédito associadas ao scoring do usuário especificado
Exemplo: A
Detalhe de respostas
dataarray
metaobject

Esta seção foi útil para você?

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

Criar linha de crédito

O endpoint lending/v1/credit-lines lhe permite criar uma linha de crédito.

Parâmetros disponíveis
Body Parameters
user_idstringrequired
Identificador de usuário do beneficiário
Exemplo: usr-2HMwJZo114goVi7xdSseYfujP79
product_idstringrequired
Identificador do produto
Exemplo: lpr-2HMvSzWjc5La6WDTlgFweXAmPle
limitsoneOf
offer_start_datestringrequired
Data de início da oferta
Exemplo: 2022-04-20
offer_end_datestring
Data de término da oferta
Exemplo: 2023-05-20
due_dateintegerrequired
Data de vencimento
Exemplo: 28
user_scoringstringrequired
Identificador do scoring do usuário
Exemplo: A
person_typestring
Tipo de pessoa
Exemplo: NATURAL
Enum: LEGALNATURAL
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/lending/v1/credit-lines
{
"user_id":
"usr-2HMwJZo114goVi7xdSseYfujP79"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"offer_start_date":
"2022-04-20"
"offer_end_date":
"2023-05-20"
"due_date":
28
"user_scoring":
"A"
"person_type":
"NATURAL"
}
Respostas de amostra
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-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
"user_scoring":
"A"
"delinquency":{
...
}
"clearance_date_at":
"2024-07-01T20:37:33.180085009Z"
"pricing":{
...
}
}
}

Obter linha de crédito

O endpoint lending/v1/credit-lines/{id} permite que você obtenha dados de uma linha de crédito específica.

Nessa instância, você poderá definir o limite e a data de vencimento específicos para essa linha de crédito, sempre dentro dos parâmetros que você definiu para o produto.

Quer saber mais sobre as linhas de crédito? Dê uma olhada na nossa documentação.

Parâmetros disponíveis
Path Parameters
credit_line_idstringrequired
Identificador único da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

GET/lending/v1/credit-lines/{credit_line_id}
Respostas de amostra
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-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
"user_scoring":
"A"
"delinquency":{
...
}
"clearance_date_at":
"2024-07-01T20:37:33.180085009Z"
"pricing":{
...
}
}
}

Atualizar linhas de crédito

O endpoint lending/v1/credit-lines/{id} permite atualizar os dados de uma linha de crédito em específico.

Parâmetros disponíveis
Body Parameters
limitsoneOf
statusstring
Status da linha de crédito
Exemplo: PAUSED
Enum: ACTIVEPAUSED
status_detailobject
Informações sobre a mudança de status
offer_start_datestring
Data de início da oferta
Exemplo: 2022-04-20
offer_end_datestring
Data de término da oferta
Exemplo: 2023-05-20
due_dateinteger
Data de vencimento
Exemplo: 28
user_scoringstring
Identificador do scoring do usuário
Exemplo: A
person_typestring
Tipo de pessoa
Exemplo: NATURAL
Enum: LEGALNATURAL
Path Parameters
credit_line_idstringrequired
Identificador único da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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"
}
Respostas de amostra
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-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
"user_scoring":
"A"
"delinquency":{
...
}
"clearance_date_at":
"2024-07-01T20:37:33.180085009Z"
"pricing":{
...
}
}
}

Cancelar linhas de crédito

O endpoint lending/v1/credit-lines/{id} permite cancelar uma linha de crédito.

Parâmetros disponíveis
Body Parameters
reasonstring
Motivo do cancelamento da linha 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 da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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

Atualizar Data de Vencimento

O endpoint lending/v1/credit-lines/{id}/config/due-date permite alterar a data de vencimento de uma linha de crédito selecionando entre as opções que você definiu no Produto. Se necessário, você pode realizar simulações utilizando o endpoint: lending/v1/credit-lines/{id}/config/due-date/simulation.

Confira todas as condições aplicáveis à atualização da data de vencimento na nossa documentação.

Parâmetros disponíveis
Body Parameters
due_dateint(minimum: 1, maximum: 28)
Nuevo día de vencimiento de la línea de crédito
Exemplo: 28
Path Parameters
credit_line_idstringrequired
Identificador único da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

POST/lending/v1/credit-lines/{credit_line_id}/config/due-date
{
"due_date":
28
}
Respostas de amostra
{
"data":{
"id":
"lcr-2HMvRUOZ9C3fbsrkdeyOexAmpLe"
"user_id":
"usr-2HMvSDccc5PZzCvZ98lfeXamPle"
"country":
"MEX"
"person_type":
"NATURAL"
"product_id":
"lpr-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
"user_scoring":
"A"
"delinquency":{
...
}
"clearance_date_at":
"2024-07-01T20:37:33.180085009Z"
"pricing":{
...
}
}
}

Simular Atualização de Data de Vencimento

O endpoint lending/v1/credit-lines/{id}/config/due-date/simulation permite simular uma alteração na data de vencimento de uma linha de crédito e visualizar quais seriam as datas de fechamento e vencimento do próximo ciclo de faturamento.

Parâmetros disponíveis
Body Parameters
due_dateint(minimum: 1, maximum: 28)
Nuevo día de vencimiento de la línea de crédito
Exemplo: 28
Path Parameters
credit_line_idstringrequired
Identificador único da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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

Criar atualização de preço

O endpoint /products/{product_id}/pricing permite criar novas atualizações de preço para produtos com o status ACTIVE ou PAUSED

Parâmetros disponíveis
Body Parameters
start_datestring(format: date)required
Data de entrada em vigor da atualização de preço
Exemplo: 2022-04-30
ratesobjectrequired
Configuração das taxas
feesarrayrequired
Configuração das comissões
Path Parameters
product_idstringrequired
Identificador único do produto
Exemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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

Obter histórico de atualizações de preço

O endpoint /products/{product_id}/pricing permite-lhe obter o histórico de atualizações de preço de um produto

Parâmetros disponíveis
Path Parameters
product_idstringrequired
Identificador único do produto
Exemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataarray

Esta seção foi útil para você?

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

Modificar atualização de preço pendente

O endpoint /products/{product_id}/pricing/{start_date} permite-lhe modificar uma atualização de preço pendente

Parâmetros disponíveis
Body Parameters
ratesobject
Configuração das taxas
feesarray
Configuração das comissões
Path Parameters
product_idstringrequired
Identificador único do produto
Exemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
start_datestringrequired
Data de entrada em vigor da atualização de preço
Exemplo: 2022-04-30
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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

Notificações de mudanças de status

Informe-nos este endpoint para receber notificações sobre mudanças de status nas linhas de crédito.

Se você tiver dúvidas sobre como configurar um webhook, visite nossa documentação.

Você deve nos responder com um código HTTP 2xx para que não enviemos a notificação novamente. Caso contrário, enviaremos repetidamente.

Parâmetros disponíveis
Header Parameters
X-Api-Keystringrequired
Este header permitirá identificar qual api-secret deve-se usar, caso vários pares de api-key e api-secret tenham sido configurados.
Exemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
este header contém a assinatura digital (body + timestamp + endpoint) que deve ser verificada para garantir a integridade da solicitação. Se a assinatura não corresponder, você deve rejeitar a solicitação.
Exemplo: X-Signature: hmac-sha256 N70BkBKch1gwQDPj0jF0ooB9QQVXBEp5VQE+SGe6Z0k=
X-Timestampstringrequired
Este header contém a hora em que a solicitação foi assinada, no formato unix-epoch, para que você possa verificar se a assinatura não expirou.
Exemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
O endpoint que você usou para gerar a assinatura, e para o qual é feita a solicitação. Use este header para gerar novamente a assinatura a ser validada, e compare-o com o endpoint do seu serviço para verificar se eles correspondem.
Exemplo: X-Endpoint: /<client-url>/credit-lines
Body Parameters
event_idstringrequired
Identificador de evento.
Exemplo: credit_line_paused
Enum: credit_line_pausedcredit_line_unpausedcredit_line_canceled
idempotency_keystringrequired
Identificador idempotente para criar o evento.
Exemplo: lcr-27KxRhP9YB4ouoyt6a5vVJlY9fR
dataobject
Informações da linha de crédito afetada

Esta seção foi útil para você?

POST/lending/v1/<client-url>/credit-lines
{
"event_id":
"credit_line_paused"
"idempotency_key":
"lcr-27KxRhP9YB4ouoyt6a5vVJlY9fR"
"data":{
"credit_line_id":
"lcr-27KxRhP9YB4ouoyt6a5vVJlY9fR"
"status":
"PAUSED"
"reason":
"IN_ARREARS"
}
}
Respostas de amostra

Notificações de entrada, saída ou permanência de mora um usuário

Você precisará nos informar este endpoint para receber as notificações de entrada, saída ou permanência em inadimplência de um usuário.

Se você tiver dúvidas sobre como configurar um webhook, visite nossa documentação.

Você deve nos responder com um código HTTP 2xx para que não enviemos a notificação novamente. Caso contrário, enviaremos repetidamente.

Parâmetros disponíveis
Header Parameters
X-Api-Keystringrequired
Este header permitirá identificar qual api-secret deve-se usar, caso vários pares de api-key e api-secret tenham sido configurados.
Exemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
este header contém a assinatura digital (body + timestamp + endpoint) que deve ser verificada para garantir a integridade da solicitação. Se a assinatura não corresponder, você deve rejeitar a solicitação.
Exemplo: X-Signature: hmac-sha256 N70BkBKch1gwQDPj0jF0ooB9QQVXBEp5VQE+SGe6Z0k=
X-Timestampstringrequired
Este header contém a hora em que a solicitação foi assinada, no formato unix-epoch, para que você possa verificar se a assinatura não expirou.
Exemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
O endpoint que você usou para gerar a assinatura, e para o qual é feita a solicitação. Use este header para gerar novamente a assinatura a ser validada, e compare-o com o endpoint do seu serviço para verificar se eles correspondem.
Exemplo: X-Endpoint: /<client-url>/credit-lines
Body Parameters
event_idstringrequired
Identificador de evento.
Exemplo: user_in_arrears
Enum: user_in_arrearsuser_out_of_arrearsuser_remains_in_arrears
idempotency_keystringrequired
Identificador idempotente para criar o evento.
Exemplo: 27KxRhP9YB4ouoyt6a5vVJlY9fR
dataobject
Informações do usuário afetado

Esta seção foi útil para você?

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

Simulación de deuda

O endpoint /lending/v1/credit-lines/{credit_line_id}/debt/simulation permite simular a dívida de uma linha de crédito ao antecipar alguns ou todos os planos de parcelas vigentes. Essa simulação NÃO executa a aceleração.

Parâmetros disponíveis
Query Parameters
transaction_idsstring
Identificadores de las transacciones, separadas por comas
Exemplo: ctx-2utzQVe7X7RfXrVUOPIJgCzRtx1,ctx-2utzQZBjBp3v2nzg1XsKgYGo9JL
Path Parameters
credit_line_idstringrequired
Identificador único da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

GET/lending/v1/credit-lines/{credit_line_id}/debt/simulation
Respostas de amostra
{
"data":{
"total":{
...
}
"current":{
...
}
"acceleration":{
...
}
"has_pending_operations":
true
}
}

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.

Parâmetros disponíveis
Body Parameters
transaction_idsarray
Path Parameters
credit_line_idstringrequired
Identificador único da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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