Crédito (Credit) (atualizado)

Os eventos relacionados a crédito disparam mensagens sempre que há atualizações referentes à reanálise de contrato de crédito (aumento e redução).

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

Configurar previamente o recebedor de eventos do webhook.
Conhecer a estrutura básica dos eventos que acompanha o objeto data.

Informações sobre os eventos

Contexto e nome do evento

Os campos context e name poderão variar de acordo com a tabela a seguir:

context	name	Descrição
`Credit`	`CREDIT_CONTRACT_LIMIT_CHANGE_PARTNER_RESPONSE`	Evento de início de processo que confirma o recebimento da resposta por parte do parceiro de uma solicitação de alteração de limite de crédito.
`Credit`	`CREDIT_CONTRACT_LIMIT_CHANGE_EXPIRED`	Evento final que confirma a expiração de uma solicitação de alteração de limite de crédito.
`Credit`	`CREDIT_CONTRACT_LIMIT_REDUCTION_NOT_COMMUNICATED`	Evento final que indica que parceiro informou que não conseguiu realizar a comunicação com o cliente para aplicação da redução de limite do contrato de crédito.
`Credit`	`CREDIT_CONTRACT_LIMIT_INCREASE_REJECTED`	Evento final que indica que parceiro informou que o cliente rejeitou a oferta de aumento de limite do contrato de crédito.
`Credit`	`CREDIT_CONTRACT_LIMIT_INCREASE_ACCEPTED`	Evento final que indica que a solicitação de alteração para aumento de limite do contrato de crédito foi executada.
`Credit`	`CREDIT_CONTRACT_LIMIT_REDUCTION_APPLIED`	Evento final que indica que a solicitação de alteração para redução de limite do contrato de crédito foi executada.
`Credit`	`CREDIT_CONTRACT_LIMIT_REDUCTION_ON_HOLD`	Comunica que a solicitação de redução de limite de contrato de crédito está no aguardo de notificação ao cliente através do parceiro.
`Credit`	`CREDIT_CONTRACT_LIMIT_INCREASE_ON_HOLD`	Comunica que a solicitação de aumento de limite de contrato de credito está em aguardo de resposta do cliente através do parceiro.

Dados dos eventos

CREDIT_CONTRACT_LIMIT_CHANGE_PARTNER_RESPONSE

Evento inicial do processo que confirma o recebimento da resposta por parte do parceiro de uma solicitação de alteração de limite.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	tipo	descrição
`expiresAt`	`string`	Data da expiração da solicitação.
`solicitationId`	`string`	Identificador da solicitação Bankly.
`solicitationExternalId`	`string`	Identificador da solicitação do provedor.
`newLimitToApply`	`object`	Objeto que contém informações sobre o limite de crédito para ser ajustado
`newLimitToApply.value`	`number`	Valor do limite de crédito antes do reajuste.
`newLimitToApply.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`credit`	`object`	Objeto que contém informações sobre o crédito liberado ao cliente.
`credit.value`	`number`	Limite de credito atual
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`program`	`object`	Objeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
`program.id`	`number`	Identificador único do programa.
`policy`	`string`	Política de liberação de crédito.
`origin`	`string`	Origem da solicitação de reanálise, que pode ser "COMPANY_REQUEST" (solicitação do parceiro) ou "CUSTOMER_REQUEST" (solicitação do cliente).
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Chave que identifica o parceiro referente ao contrato.
`holder.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`holder.registerName`	`string`	Nome do cliente, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`holder.socialName`	`string`	Nome pelo qual o cliente gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`holder.address`	`object`	Objeto que contém informações sobre o endereço do cliente.
`holder.address.zipCode`	`string`	Código postal do endereço.
`holder.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`holder.address.buildingNumber`	`string`	Número do imóvel.
`holder.address.complement`	`string`	Complemento do endereço.
`holder.address.neighborhood`	`string`	Nome do bairro.
`holder.address.city`	`string`	Nome da cidade.
`holder.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`holder.address.country`	`string`	Sigla do país. Exemplo: "BR".
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária relacionada ao contrato.
`bankLicense.value`	`string`	Chave da licença.
`bankLicense.name`	`string`	Tipo da licença.
`designatedFunding`	`string`	Financiadora do contrato.
`scr`	`object`	Objeto que deverá conter informações sobre a resposta do cliente quanto à consulta ao SCR (Sistema de Informação de Crédito).
`scr.collectedAt`	`string`	Data de coleta da resposta do cliente, no formato ISO 8601 - UTC.
`scr.authorized`	`boolean`	Indica se o cliente autorizou (true) ou não (false) a consulta ao SCR.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

CREDIT_CONTRACT_LIMIT_CHANGE_EXPIRED

Evento final que confirma a expiração de uma solicitação de alteração de limite de crédito.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	tipo	descrição
`expiresAt`	`string`	Data da expiração da solicitação.
`solicitationId`	`string`	Identificador da solicitação Bankly.
`solicitationExternalId`	`string`	Identificados da solicitação do provedor.
`newLimitToApply`	`object`	Objeto que contém informações sobre o limite de crédito para ser ajustado.
`newLimitToApply.value`	`number`	Valor do limite de crédito antes do reajuste.
`newLimitToApply.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`credit`	`object`	Objeto que contém informações sobre o crédito liberado ao cliente.
`credit.value`	`number`	Novo limite de crédito do cliente, após a redução.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`program`	`object`	Objeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
`program.id`	`number`	Identificador único do programa.
`policy`	`string`	Política de liberação de crédito.
`origin`	`string`	Origem da solicitação de reanálise, que pode ser "COMPANY_REQUEST" (solicitação do parceiro) ou "CUSTOMER_REQUEST" (solicitação do cliente).
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Chave que identifica o parceiro referente ao contrato.
`holder.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`holder.registerName`	`string`	Nome do cliente, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`holder.socialName`	`string`	Nome pelo qual o cliente gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social .
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`holder.address`	`object`	Objeto que contém informações sobre o endereço do cliente.
`holder.address.zipCode`	`string`	Código postal do endereço.
`holder.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`holder.address.buildingNumber`	`string`	Número do imóvel.
`holder.address.complement`	`string`	Complemento do endereço.
`holder.address.neighborhood`	`string`	Nome do bairro.
`holder.address.city`	`string`	Nome da cidade.
`holder.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`holder.address.country`	`string`	Sigla do país. Exemplo: "BR".
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária relacionada ao contrato.
`bankLicense.value`	`string`	Chave da licença.
`bankLicense.name`	`string`	Tipo da licença.
`designatedFunding`	`string`	Financiadora do contrato.
`scr`	`object`	Objeto que deverá conter informações sobre a resposta do cliente quanto à consulta ao SCR (Sistema de Informação de Crédito).
`scr.collectedAt`	`string`	Data de coleta da resposta do cliente, no formato ISO 8601 - UTC.
`scr.authorized`	`boolean`	Indica se o cliente autorizou (true) ou não (false) a consulta ao SCR.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

CREDIT_CONTRACT_LIMIT_REDUCTION_NOT_COMMUNICATED

Evento final que indica que o parceiro informou que não conseguiu realizar a comunicação com o cliente para aplicação da redução de limite do contrato de crédito.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	tipo	descrição
`expiresAt`	`string`	Data da expiração da solicitação.
`solicitationId`	`string`	Identificador da solicitação Bankly.
`solicitationExternalId`	`string`	Identificador da solicitação do provedor.
`newLimitToApply`	`object`	Objeto que contém informações sobre o limite de crédito para ser ajustado.
`newLimitToApply.value`	`number`	Valor do limite de crédito antes do reajuste.
`newLimitToApply.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`credit`	`object`	Objeto que contém informações sobre o crédito liberado ao cliente.
`credit.value`	`number`	Limite de credito atual.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`program`	`object`	Objeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
`program.id`	`number`	Identificador único do programa.
`policy`	`string`	Política de liberação de crédito.
`origin`	`string`	Origem da solicitação de reanálise, que pode ser "COMPANY_REQUEST" (solicitação do parceiro) ou "CUSTOMER_REQUEST" (solicitação do cliente).
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Chave que identifica o parceiro referente ao contrato.
`holder.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`holder.registerName`	`string`	Nome do cliente, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`holder.socialName`	`string`	Nome pelo qual o cliente gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social .
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`holder.address`	`object`	Objeto que contém informações sobre o endereço do cliente.
`holder.address.zipCode`	`string`	Código postal do endereço.
`holder.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`holder.address.buildingNumber`	`string`	Número do imóvel.
`holder.address.complement`	`string`	Complemento do endereço.
`holder.address.neighborhood`	`string`	Nome do bairro.
`holder.address.city`	`string`	Nome da cidade.
`holder.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`holder.address.country`	`string`	Sigla do país. Exemplo: "BR".
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária relacionada ao contrato.
`bankLicense.value`	`string`	Chave da licença.
`bankLicense.name`	`string`	Tipo da licença.
`designatedFunding`	`string`	Financiadora do contrato.
`scr`	`object`	Objeto que deverá conter informações sobre a resposta do cliente quanto à consulta ao SCR (Sistema de Informação de Crédito).
`scr.collectedAt`	`string`	Data de coleta da resposta do cliente, no formato ISO 8601 - UTC.
`scr.authorized`	`boolean`	Indica se o cliente autorizou (true) ou não (false) a consulta ao SCR.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

CREDIT_CONTRACT_LIMIT_INCREASE_REJECTED

Evento final que indica que o parceiro informou que o cliente rejeitou a oferta de aumento de limite do contrato de crédito.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	tipo	descrição
`expiresAt`	`string`	Data da expiração da solicitação.
`solicitationId`	`string`	Identificador da solicitação Bankly.
`solicitationExternalId`	`string`	Identificador da solicitação do provedor
`newLimitToApply`	`object`	Objeto que contém informações sobre o limite de crédito a ser ajustado.
`newLimitToApply.value`	`number`	Valor do limite de crédito antes do reajuste.
`newLimitToApply.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`credit`	`object`	Objeto que contém informações sobre o crédito liberado ao cliente.
`credit.value`	`number`	Limite de crédito atual.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`program`	`object`	Objeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
`program.id`	`number`	Identificador único do programa.
`policy`	`string`	Política de liberação de crédito.
`origin`	`string`	Origem da solicitação de reanálise, que pode ser "COMPANY_REQUEST" (solicitação do parceiro) ou "CUSTOMER_REQUEST" (solicitação do cliente).
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Chave que identifica o parceiro referente ao contrato.
`holder.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`holder.registerName`	`string`	Nome do cliente, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`holder.socialName`	`string`	Nome pelo qual o cliente gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social .
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`holder.address`	`object`	Objeto que contém informações sobre o endereço do cliente.
`holder.address.zipCode`	`string`	Código postal do endereço.
`holder.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`holder.address.buildingNumber`	`string`	Número do imóvel.
`holder.address.complement`	`string`	Complemento do endereço.
`holder.address.neighborhood`	`string`	Nome do bairro.
`holder.address.city`	`string`	Nome da cidade.
`holder.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`holder.address.country`	`string`	Sigla do país. Exemplo: "BR".
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária relacionada ao contrato.
`bankLicense.value`	`string`	Chave da licença.
`bankLicense.name`	`string`	Tipo da licença.
`designatedFunding`	`string`	Financiadora do contrato.
`scr`	`object`	Objeto que deverá conter informações sobre a resposta do cliente quanto à consulta ao SCR (Sistema de Informação de Crédito).
`scr.collectedAt`	`string`	Data de coleta da resposta do cliente, no formato ISO 8601 - UTC.
`scr.authorized`	`boolean`	Indica se o cliente autorizou (true) ou não (false) a consulta ao SCR.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

CREDIT_CONTRACT_LIMIT_INCREASE_ACCEPTED

Evento final que indica que a solicitação de alteração para aumento de limite do contrato de crédito foi executada.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	tipo	descrição
`expiresAt`	`string`	Data da expiração da solicitação.
`solicitationId`	`string`	Identificador da solicitação Bankly.
`solicitationExternalId`	`string`	Identificador da solicitação do provedor.
`previousLimit`	`object`	Objeto que contém informações sobre o limite anterior do cartão, antes de ser alterado.
`previousLimit.value`	`number`	Valor do limite antes de ser alterado.
`previousLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`credit`	`object`	Objeto que contém informações sobre o crédito liberado ao cliente.
`credit.value`	`number`	Valor de crédito liberado ao cliente.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`increasedLimit`	`object`	Objeto que contém informações sobre o valor que foi adicionado ao limite anterior.
`increasedLimit.value`	`number`	Valor adicionado ao limite, sendo a soma entre o novo limite de crédito e o limite de crédito anterior.
`increasedLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`policy`	`string`	Política de liberação de crédito.
`origin`	`string`	Origem da solicitação de reanálise.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Chave que identifica o parceiro referente ao contrato.
`holder.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`holder.registerName`	`string`	Nome do cliente, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`holder.socialName`	`string`	Nome pelo qual o cliente gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social .
`holder.birthDate`	`string`	Data de nascimento do cliente, no formato ISO 8601 - UTC.
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`holder.adress`	`object`	Objeto que contém informações sobre o endereço do cliente.
`holder.adress.zipCode`	`string`	Código postal do endereço.
`holder.adress.adressLinepCode`	`string`	Logradouro (nome da rua, avenida etc.).
`holder.adress.buildingNumber`	`string`	Número do imóvel.
`holder.adress.complement`	`string`	Complemento do endereço.
`holder.adress.neighborhood`	`string`	Nome do bairro.
`holder.adress.city`	`string`	Nome da cidade.
`holder.adress.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`holder.adress.country`	`string`	Sigla do país. Exemplo: "BR".
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária relacionada ao contrato.
`bankLicense.value`	`string`	Chave da licença.
`bankLicense.name`	`string`	Tipo da licença.
`designatedFunding`	`string`	Financiadora do contrato.
`scr`	`object`	Objeto que contém informações sobre a resposta do cliente quanto à consulta ao SCR (Sistema de Informação de Crédito).
`scr.collectedAt`	`string`	Data de coleta da resposta do cliente, no formato ISO 8601 - UTC.
scr.`authorized`	`boolean`	Indica se o cliente autorizou (true) ou não (false) a consulta ao SCR.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

CREDIT_CONTRACT_LIMIT_REDUCTION_APPLIED

Evento final que indica que a solicitação de alteração para redução de limite do contrato de crédito foi executada.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	tipo	descrição
`expiresAt`	`string`	Data da expiração da solicitação.
`solicitationId`	`string`	Identificador da solicitação Bankly.
`solicitationExternalId`	`string`	Identificador da solicitação do provedor.
`previousLimit`	`object`	Objeto que contém informações sobre o limite de crédito antes do reajuste.
`previousLimit.value`	`number`	Valor do limite de crédito antes do reajuste.
`previousLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`credit`	`object`	Objeto que contém informações sobre o crédito liberado ao cliente.
`credit.value`	`number`	Novo limite de crédito do cliente, após a redução.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`decreasedLimit`	`object`	Objeto que contém informações sobre o valor que foi retirado do limite anterior.
`decreasedLimit.value`	`number`	Valor retirado do limite, sendo a diferença entre o novo limite de crédito e o limite de crédito anterior.
`decreasedLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`program`	`object`	Objeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
`program.id`	`number`	Identificador único do programa.
`policy`	`string`	Política de liberação de crédito.
`origin`	`string`	Origem da solicitação de reanálise, que pode ser "COMPANY_REQUEST" (solicitação do parceiro) ou "CUSTOMER_REQUEST" (solicitação do cliente).
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Chave que identifica o parceiro referente ao contrato.
`holder.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`holder.registerName`	`string`	Nome do cliente, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`holder.socialName`	`string`	Nome pelo qual o cliente gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social .
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`holder.address`	`object`	Objeto que contém informações sobre o endereço do cliente.
`holder.address.zipCode`	`string`	Código postal do endereço.
`holder.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`holder.address.buildingNumber`	`string`	Número do imóvel.
`holder.address.complement`	`string`	Complemento do endereço.
`holder.address.neighborhood`	`string`	Nome do bairro.
`holder.address.city`	`string`	Nome da cidade.
`holder.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`holder.address.country`	`string`	Sigla do país. Exemplo: "BR".
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária relacionada ao contrato.
`bankLicense.value`	`string`	Chave da licença.
`bankLicense.name`	`string`	Tipo da licença.
`designatedFunding`	`string`	Financiadora do contrato.
`scr`	`object`	Objeto que deverá conter informações sobre a resposta do cliente quanto à consulta ao SCR (Sistema de Informação de Crédito).
`scr.collectedAt`	`string`	Data de coleta da resposta do cliente, no formato ISO 8601 - UTC.
`scr.authorized`	`boolean`	Indica se o cliente autorizou (true) ou não (false) a consulta ao SCR.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

CREDIT_CONTRACT_LIMIT_REDUCTION_ON_HOLD

Comunica que a solicitação de redução de limite de contrato de crédito está no aguardo de notificação ao cliente por parte do parceiro.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	tipo	descrição
`expiresAt`	`string`	Data da expiração da solicitação.
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`program`	`object`	Objeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
`program.id`	`number`	Identificador único do programa.
`origin`	`string`	Origem da solicitação de reanálise.
`policy`	`string`	Política de liberação de crédito.
`solicitationId`	`string`	Identificador da solicitação Bankly.
`solicitationExternalId`	`string`	Identificador da solicitação do provedor.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Chave que identifica o parceiro referente ao contrato.
`holder.registerName`	`string`	Nome do cliente, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`holder.socialName`	`string`	Nome pelo qual o cliente gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social.
`holder.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`holder.birthDate`	`string`	Data de nascimento do cliente, no formato ISO 8601 - UTC.
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`holder.address`	`object`	Objeto que contém informações sobre o endereço do cliente.
`holder.address.zipCode`	`string`	Código postal do endereço.
`holder.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`holder.address.buildingNumber`	`string`	Número do imóvel.
`holder.address.complement`	`string`	Complemento do endereço.
`holder.address.neighborhood`	`string`	Nome do bairro.
`holder.address.city`	`string`	Nome da cidade.
`holder.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`holder.address.country`	`string`	Sigla do país. Exemplo: "BR".
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária relacionada ao contrato.
`bankLicense.value`	`string`	Chave da licença.
`bankLicense.name`	`string`	Tipo da licença.
`designatedFunding`	`string`	Financiadora do contrato.
`currentCreditLimit`	`object`	Objeto que contém informações sobre o crédito atual do cliente
`currentCreditLimit.value`	`number`	Limite atual de crédito do cliente.
`currentCreditLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`newCreditLimit`	`object`	Objeto que contém informações sobre novo limite.
`newCreditLimit.value`	`number`	Novo limite de crédito do cliente
`newCreditLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

CREDIT_CONTRACT_LIMIT_INCREASE_ON_HOLD

Comunica quando a solicitação de aumento de limite de contrato de credito está em aguardo de resposta do cliente através do parceiro.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	tipo	descrição
`expiresAt`	`string`	Data da expiração da solicitação.
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`program`	`object`	Objeto que contém informação sobre o ID do programa atrelado ao contrato de crédito.
`program.id`	`number`	Identificador único do programa.
`origin`	`string`	Origem da solicitação de reanálise.
`policy`	`string`	Política de liberação de crédito.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Chave que identifica o parceiro referente ao contrato.
`holder.registerName`	`string`	Nome do cliente, conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`holder.socialName`	`string`	Nome pelo qual o cliente gostaria de ser chamado. Saiba mais consultando a Cartilha do nome social .
`holder.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`holder.birthDate`	`string`	Data de nascimento do cliente, no formato ISO 8601 - UTC.
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`holder.address`	`object`	Objeto que contém informações sobre o endereço do cliente.
`holder.address.zipCode`	`string`	Código postal do endereço.
`holder.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`holder.address.buildingNumber`	`string`	Número do imóvel.
`holder.address.complement`	`string`	Complemento do endereço.
`holder.address.neighborhood`	`string`	Nome do bairro.
`holder.address.city`	`string`	Nome da cidade.
`holder.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`holder.address.country`	`string`	Sigla do país. Exemplo: "BR".
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária relacionada ao contrato.
`bankLicense.value`	`string`	Chave da licença.
`bankLicense.name`	`string`	Tipo da licença.
`designatedFunding`	`string`	Financiadora do contrato.
`currentCreditLimit`	`object`	Objeto que contém informações sobre o crédito atual do cliente.
`currentCreditLimit.value`	`number`	Limite atual de crédito do cliente.
`currentCreditLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`newCreditLimit`	`object`	Objeto que contém informações sobre novo limite.
`newCreditLimit.value`	`number`	Novo limite de crédito do cliente.
`newCreditLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`solicitationId`	`string`	Identificador da solicitação Bankly.
`solicitationExternalId`	`string`	Identificador da solicitação do provedor.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

Pré-requisitos

Informações sobre os eventos

Contexto e nome do evento

Dados dos eventos

CREDIT_CONTRACT_LIMIT_CHANGE_PARTNER_RESPONSE

Descrição do objeto data do evento

Payload do evento

CREDIT_CONTRACT_LIMIT_CHANGE_EXPIRED

Descrição do objeto data do evento

Payload do evento

CREDIT_CONTRACT_LIMIT_REDUCTION_NOT_COMMUNICATED

Descrição do objeto data do evento

Payload do evento

CREDIT_CONTRACT_LIMIT_INCREASE_REJECTED

Descrição do objeto data do evento

Payload do evento

CREDIT_CONTRACT_LIMIT_INCREASE_ACCEPTED

Descrição do objeto data do evento

Payload do evento

CREDIT_CONTRACT_LIMIT_REDUCTION_APPLIED

Descrição do objeto data do evento

Payload do evento

CREDIT_CONTRACT_LIMIT_REDUCTION_ON_HOLD

Descrição do objeto data do evento

Payload do evento

CREDIT_CONTRACT_LIMIT_INCREASE_ON_HOLD

Descrição do objeto data do evento

Payload do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento