Linhas de crédito

O serviço de Linhas de Crédito permite criar e gerenciar tanto produtos de crédito quanto linhas de crédito.

Você quer saber mais sobre as linhas de crédito? Veja nossa documentação.

Criar produto

O endpoint lending/v1/products permite criar um produto.

Neste momento, você poderá definir. as datas de fechamento e vencimento, os limites e disponíveis, as taxas e comissões, como é composto 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
Estado 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 de tempo após o vencimento em que é possível realizar um pagamento sem nenhuma penalidade
credit_cardobjectrequired
Configuração de cartão de crédito
pricingobjectrequired
Defina de forma centralizada as taxas de juros assim como as comissões que serão aplicadas ao produto.
available_balance_settingsstring
Estratégia de restituição de saldo. No CHILE E MÉXICO seu único valor possível é EXTENDED. Na COLÔMBIA seu único valor possível é RESTRICTED
Exemplo: RESTRICTED
Enum: RESTRICTEDEXTENDED
statementobjectrequired
Configuração de extratos
refinancingobject
Configuração de refinanciamento incluindo opções obrigatórias e manuais
cancellationobject
Configuração de cancelamento de limite de crédito por atraso. Somente disponível para o 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 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 um produto

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

Parâmetros disponíveis
Path Parameters
product_idstringrequired
Identificador único de 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 um 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
Estado 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 de tempo após o vencimento em que é possível realizar um pagamento sem nenhuma penalidade
credit_cardobject
Configuração de cartão de crédito
statementobject
Configuração de extratos
cancellationobject
Configuração de cancelamento de limite de crédito por atraso. Somente disponível para o Brasil.
Path Parameters
product_idstringrequired
Identificador único de 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} permite desativar um produto específico.

Parâmetros disponíveis
Path Parameters
product_idstringrequired
Identificador único de 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 dado um critério de busca.

Filtros

Você pode encontrar mais informações sobre como aplicar os 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-2HMwKzetERdOEhbT86UweXamPle
filter[user_id]string
Permite obter as linhas de crédito associadas ao ID de usuário especificado
Exemplo: usr-2HMvSDccc5PZzCvZ98lfeXamPle
filter[status]string
Permite obter as linhas de crédito associadas ao estado especificado
Exemplo: ACTIVE
Enum: OFFEREDACTIVEPAUSEDCANCELEDEXPIRED
filter[offer_start_date][from]string(format: date)
Permite obter as linhas de crédito desde a 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 de oferta especificada
Exemplo: 2022-03-20
filter[activation_date][from]string(format: date)
Permite obter as linhas de crédito desde a 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 de 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 permite criar uma linha de crédito.

Parâmetros disponíveis
Body Parameters
user_idstringrequired
Identificador do usuário beneficiário
Exemplo: usr-2HMwJZo114goVi7xdSseYfujP79
product_idstringrequired
Identificador do produto
Exemplo: lpr-2HMvSzWjc5La6WDTlgFweXAmPle
segment_idstring
Identificador do segmento
Exemplo: lsg-2HMvSzWjc5La6WDTlgFweXAmPle
limitsoneOf
offer_start_datestringrequired
Data de início da oferta
Exemplo: 2022-04-20
offer_end_datestring
Data de finalização 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"
"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"
}
Respostas de amostra
{
"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":{
...
}
}
}

Obter uma linha de crédito

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

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

Você quer saber mais sobre as linhas de crédito? Veja nossa documentação.

Parâmetros disponíveis
Path Parameters
credit_line_idstringrequired
Identificador único de 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-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":{
...
}
}
}

Atualizar limites de crédito

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

Parâmetros disponíveis
Body Parameters
limitsoneOf
statusstring
Estado da linha de crédito
Exemplo: PAUSED
Enum: ACTIVEPAUSED
status_detailobject
Informação sobre a mudança de estado
offer_start_datestring
Data de início da oferta
Exemplo: 2022-04-20
offer_end_datestring
Data de finalização 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
update_segmentobject
Atualização de segmento
Path Parameters
credit_line_idstringrequired
Identificador único de 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"
"update_segment":{
"segment_id":
"lsg-2HMvSzWjc5La6WDTlgFweXAmPle"
}
}
Respostas de amostra
{
"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":{
...
}
}
}

Cancelar limites de crédito

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

Parâmetros disponíveis
Body Parameters
reasonstring
Razão de 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 de 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 mudar a data de vencimento de uma linha de crédito selecionando entre as opções que você definiu no Produto. Se necessário, você poderá realizar simulações interagindo com o endpoint: lending/v1/credit-lines/{id}/config/due-date/simulation.

Revise todas as condições que se aplicam à atualização da data de vencimento em nossa documentação.

Parâmetros disponíveis
Body Parameters
due_dateint(minimum: 1, maximum: 28)
Novo dia de vencimento da linha de crédito
Exemplo: 28
Path Parameters
credit_line_idstringrequired
Identificador único de 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-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":{
...
}
}
}

Simular atualização da data de vencimento

O endpoint lending/v1/credit-lines/{id}/config/due-date/simulation permite simular uma mudança na data de vencimento de uma linha de crédito e ver 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)
Novo dia de vencimento da linha de crédito
Exemplo: 28
Path Parameters
credit_line_idstringrequired
Identificador único de 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 estado 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 de taxas
feesarrayrequired
Configuração de comissões
Path Parameters
product_idstringrequired
Identificador único de 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 obter o histórico de atualizações de preço de um produto

Parâmetros disponíveis
Path Parameters
product_idstringrequired
Identificador único de 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 modificar uma atualização de preço pendente

Parâmetros disponíveis
Body Parameters
ratesobject
Configuração de taxas
feesarray
Configuração de comissões
Path Parameters
product_idstringrequired
Identificador único de 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":[
...
]
}
}

Criar segmento

O endpoint lending/v1/products/{product_id}/segments permite criar um novo segmento para um produto com uma configuração de pricing específica.

Parâmetros disponíveis
Body Parameters
namestringrequired
Nome do segmento
Exemplo: Premium Segment
pricingobjectrequired
Defina de forma centralizada as taxas de juros assim como as comissões que serão aplicadas ao produto.
Path Parameters
product_idstringrequired
Identificador único de produto
Exemplo: lpr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
dataobject

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

POST/lending/v1/products/{product_id}/segments
{
"name":
"Premium Segment"
"pricing":{
"rates":{
...
}
"fees":[
...
]
}
}
Respostas de amostra
{
"data":{
"id":
"lsg-3mkvSzWjc5La6WDTlgFweXAmP23"
"product_id":
"lpr-2HMvSzWjc5La6WDTlgFweXAmPle"
"name":
"Premium Segment"
"status":
"ACTIVE"
"pricing":{
...
}
"created_at":
"2022-04-30T00:00:00Z"
"updated_at":
"2022-04-30T00:00:00Z"
}
}

Obter segmentos

O endpoint lending/v1/products/{product_id}/segments permite obter todos os segmentos associados a um produto específico.

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

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

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

Obter um segmento

O endpoint lending/v1/products/{product_id}/segments/{segment_id} permite obter os dados de um segmento específico para um produto determinado.

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

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

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

Notificações de mudanças de estado

Indique-nos este endpoint para receber notificações por mudanças de estado nas linhas de crédito.

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

Você deve nos responder um código HTTP 2xx para que não voltemos a enviar a notificação. Caso contrário, voltaremos a enviá-la infinitamente.

Parâmetros disponíveis
Header Parameters
X-Api-Keystringrequired
Este header permitirá identificar qual api-secret você deve usar no caso de múltiplos pares de api-key e api-secret terem sido configurados.
Exemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
Este header contém a assinatura digital (body + timestamp + endpoint) que você deve verificar para garantir a integridade da solicitação. Se a assinatura não coincidir, você deve rejeitar o pedido.
Exemplo: X-Signature: hmac-sha256 N70BkBKch1gwQDPj0jF0ooB9QQVXBEp5VQE+SGe6Z0k=
X-Timestampstringrequired
Este header contém o momento em que o pedido foi assinado em formato unix-epoch para que você possa verificar se a assinatura não expirou.
Exemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
O endpoint para o qual o pedido é feito e que você usou para gerar a assinatura. Use este cabeçalho para regenerar a assinatura a ser validada, compará-la com o endpoint do seu serviço e verificar se coincidem.
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 de criação do evento.
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
dataobject
Informação 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-2HMwKzetERdOEhbT86UweXamPle"
"data":{
"credit_line_id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"status":
"PAUSED"
"reason":
"IN_ARREARS"
}
}
Respostas de amostra

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

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

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

Você deve nos responder um código HTTP 2xx para que não voltemos a enviar a notificação. Caso contrário, voltaremos a enviá-la infinitamente.

Parâmetros disponíveis
Header Parameters
X-Api-Keystringrequired
Este header permitirá identificar qual api-secret você deve usar no caso de múltiplos pares de api-key e api-secret terem sido configurados.
Exemplo: X-Api-Key: h3Ws4Cv09JcCdw7732ig+1Eq3I2b+IWOI1anUu1A4dE=
X-Signaturestringrequired
Este header contém a assinatura digital (body + timestamp + endpoint) que você deve verificar para garantir a integridade da solicitação. Se a assinatura não coincidir, você deve rejeitar o pedido.
Exemplo: X-Signature: hmac-sha256 N70BkBKch1gwQDPj0jF0ooB9QQVXBEp5VQE+SGe6Z0k=
X-Timestampstringrequired
Este header contém o momento em que o pedido foi assinado em formato unix-epoch para que você possa verificar se a assinatura não expirou.
Exemplo: X-Timestamp: 1637117179
X-Endpointstringrequired
O endpoint para o qual o pedido é feito e que você usou para gerar a assinatura. Use este cabeçalho para regenerar a assinatura a ser validada, compará-la com o endpoint do seu serviço e verificar se coincidem.
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 de criação do evento.
Exemplo: 27KxRhP9YB4ouoyt6a5vVJlY9fR
dataobject
Informação 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-2HMwKzetERdOEhbT86UweXamPle"
"effective_at":
"2022-12-15T13:55:00"
}
}
Respostas de amostra

Simulação de dívida

O endpoint /credit-lines/{credit_line_id}/debt/simulation permite simular a aceleração total de dívida e a antecipação de parcelas de uma linha de crédito no Brasil.

Esta simulação não executa mudanças reais e tem validade até as 00:00.

Parâmetros disponíveis
Query Parameters
transaction_idsstring
Identificadores das transações, separados por vírgulas
Exemplo: ctx-2utzQVe7X7RfXrVUOPIJgCzRtx1,ctx-2utzQZBjBp3v2nzg1XsKgYGo9JL
Path Parameters
credit_line_idstringrequired
Identificador único de 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
"installments":[
...
]
}
}

Aceleração de dívida

O endpoint /lending/v1/credit-lines/{credit_line_id}/debt/acceleration permite confirmar a aceleração da dívida de uma linha de crédito, antecipando alguns ou todos os planos de parcela vigentes, dependendo do que você indicar.

O endpoint /credit-lines/{credit_line_id}/debt/simulation permite simular a aceleração total da dívida ou de alguns planos de parcelas de uma linha de crédito. Essa simulação NÃO executa a aceleração e é válida até às 00:00 hs. Por enquanto, este serviço está disponível apenas para o Brasil..

Parâmetros disponíveis
Body Parameters
transaction_idsarray
Path Parameters
credit_line_idstringrequired
Identificador único de 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"
}
}

Simular refinanciação da dívida

O endpoint /credit-lines/{credit_line_id}/debt/refinance/simulation permite simular o processo de refinanciamento de dívida de uma linha de crédito.

Atualmente, apenas está implementado o tipo de refinanciamento de dívida total.

A simulação mostrará como ficaria distribuída a dívida atual, o montante total e qualquer aceleração necessária, sem executar mudanças reais.

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation permite confirmar e executar a aceleração total da dívida de uma linha de crédito. Ou seja, ao executá-lo, aceleraremos a totalidade da dívida e ela passa para o estado de conta em andamento. Por enquanto, este serviço está disponível apenas para o Chile..

Parâmetros disponíveis
Body Parameters
typestringrequired
Tipo de refinanciação - atualmente apenas TOTAL_DEBT está implementado
Exemplo: TOTAL_DEBT
Enum: TOTAL_DEBT
credit_line_idstringrequired
ID da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
installment_quantityinteger(minimum: 1)required
Quantidade de parcelas para a refinanciação
Exemplo: 12
Path Parameters
credit_line_idstringrequired
Identificador único de 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/refinance/simulation
{
"type":
"TOTAL_DEBT"
"credit_line_id":
"lcr-2HMwKzetERdOEhbT86UweXamPle"
"installment_quantity":
12
}
Respostas de amostra
{
"data":{
"total":{
...
}
"current":{
...
}
"acceleration":{
...
}
"has_pending_operations":
false
}
}

Confirmar refinanciação de dívida

O endpoint /credit-lines/{credit_line_id}/debt/refinance/confirmation permite confirmar o processo de refinanciamento total de dívida de uma linha de crédito.

Permite pausar a linha para evitar que novas transações sejam inseridas. O refinanciamento será efetivo uma vez que o pagamento pelo montante exato for registrado.

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation permite confirmar e executar a aceleração total da dívida de uma linha de crédito. Ou seja, ao executá-lo, aceleraremos a totalidade da dívida e ela passa para o estado de conta em andamento. Por enquanto, este serviço está disponível apenas para o Chile..

Parâmetros disponíveis
Body Parameters
typestringrequired
Tipo de refinanciação - atualmente apenas TOTAL_DEBT está implementado
Exemplo: TOTAL_DEBT
Enum: TOTAL_DEBT
credit_line_idstringrequired
ID da linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
installment_quantityinteger(minimum: 1)required
Quantidade de parcelas para a refinanciação
Exemplo: 12
Path Parameters
credit_line_idstringrequired
Identificador único de linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
datastring
Exemplo: Refinancing confirmed successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

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

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

Simular aceleração total da dívida

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/simulation permite obter uma simulação completa da aceleração total de dívida de uma linha de crédito.

Esta simulação não executa mudanças reais e tem validade até as 00:00.

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation permite confirmar e executar a aceleração total da dívida de uma linha de crédito. Ou seja, ao executá-lo, aceleraremos a totalidade da dívida e ela passa para o estado de conta em andamento. Por enquanto, este serviço está disponível apenas para o Chile..

Parâmetros disponíveis
Path Parameters
credit_line_idstringrequired
Identificador único de 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/total/simulation
Respostas de amostra
{
"data":{
"total":{
...
}
"current":{
...
}
"acceleration":{
...
}
"has_pending_operations":
true
"acceleration_fee":{
...
}
}
}

Confirmar aceleração total de dívida

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation permite confirmar e executar a aceleração total de dívida para uma linha de crédito.

Este endpoint acelera automaticamente toda a dívida pendente da linha de crédito especificada. Uma vez executado, toda a dívida será acelerada imediatamente.

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation permite confirmar e executar a aceleração total da dívida de uma linha de crédito. Ou seja, ao executá-lo, aceleraremos a totalidade da dívida e ela passa para o estado de conta em andamento. Por enquanto, este serviço está disponível apenas para o Chile..

Parâmetros disponíveis
Body Parameters
transaction_idsarray
Lista de IDs de transação a acelerar
Exemplo: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Identificador único de linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
datastring
Exemplo: Total debt accelerated successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

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

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

Simular aceleração de parcelas específicas

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/installments/simulation permite simular a antecipação de parcelas de uma linha de crédito.

Você deve fornecer os transaction_ids das parcelas específicas a antecipar.

Esta simulação não executa mudanças reais e tem validade até as 00:00.

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/total/confirmation permite confirmar e executar a aceleração total da dívida de uma linha de crédito. Ou seja, ao executá-lo, aceleraremos a totalidade da dívida e ela passa para o estado de conta em andamento. Por enquanto, este serviço está disponível apenas para o Chile..

Parâmetros disponíveis
Body Parameters
transaction_idsarrayrequired
Lista de IDs de transação de parcelas a acelerar
Exemplo: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Identificador único de 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/installments/simulation
{
"transaction_ids":[
0
:
"ctx-2uoYnNyBsHaADF7fSHvkXykD6EY"
1
:
"ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"
]
}
Respostas de amostra
{
"data":{
"total":{
...
}
"current":{
...
}
"acceleration":{
...
}
"has_pending_operations":
true
"installments_advanced":[
...
]
"advance_fee":{
...
}
}
}

Confirmar aceleração de dívida de parcelas específicas

O endpoint /credit-lines/{credit_line_id}/debt/acceleration/installments/confirmation permite confirmar e executar a aceleração de dívida para parcelas específicas de uma linha de crédito.

Uma vez executado, as parcelas especificadas serão aceleradas imediatamente.

Parâmetros disponíveis
Body Parameters
transaction_idsarray
Lista de IDs de transação a acelerar
Exemplo: ["ctx-2uoYnNyBsHaADF7fSHvkXykD6EY","ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ"]
Path Parameters
credit_line_idstringrequired
Identificador único de linha de crédito
Exemplo: lcr-2HMwKzetERdOEhbT86UweXamPle
Detalhe de respostas
datastring
Exemplo: Acceleration of installments [ctx-2uoYnNyBsHaADF7fSHvkXykD6EY, ctx-3vpZoOzCtIbBEG8gTIwlYzlE7FZ] accelerated successfully for credit line [lcr-2HMwKzetERdOEhbT86UweXamPle]

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

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