Crédito (Credit)

Os eventos relacionados a crédito disparam mensagens sempre que há atualizações referentes a:

Pré-análise de crédito (aprovação ou reprovação);
Processo de análise de crédito (criação, aprovação, reprovação, aumento e redução de limite);
Análise de contrato de crédito (aceitação, bloqueio, desbloqueio e cancelamento);
Processo de CRELIQ: bloqueio e início do cancelamento do contrato de crédito;

📘
Nota
Se o período de inadimplência atingir 71 dias, o contrato de crédito do cliente será bloqueado (envio do evento CONTRACT_CREDIT_BLOCK_REQUEST_CREATED com a reason “PRE_CRELIQ”). A partir dessa data, o cliente terá cinco dias úteis para efetuar o pagamento e desbloquear o contrato de crédito. Se o atraso exceder esses cinco dias úteis, o contrato de crédito será cancelado, disparando o evento CREDIT_CONTRACT_CRELIQ_CANCELMENT_REQUESTED, que inicia o processo de cancelamento por CRELIQ.

Faturas e pagamentos em atraso;
Início, pausa e retomada da contabilização de encargos (IOF, juros ou multa) em caso de atraso de pagamento em propostas de financiamento (rotativo e parcelado);
Negativação.

Para mais informações sobre quando essas mensagens são disparadas e sobre o seu conteúdo, consulte a página Análise de crédito - Visão geral.

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_PRE_ANALYSIS_APPROVED`	A pré-análise foi aprovada.
`Credit`	`CREDIT_CONTRACT_PRE_ANALYSIS_REPPROVED`	A pré-análise foi reprovada.
`Credit`	`CREDIT_CARD_LIMIT_CREATED`	Solicitação de limite de crédito criada.
`Credit`	`CREDIT_CARD_LIMIT_APPROVED`	Solicitação de limite de crédito aprovada.
`Credit`	`CREDIT_CARD_LIMIT_REPROVED`	Solicitação de limite de crédito reprovada de acordo com a política de crédito.
`Credit`	`CREDIT_CARD_ANALYSIS_COMPLETED`	A análise de crédito foi finalizada e pode ter sido aprovada ou reprovada.
`Credit`	`CREDIT_CARD_ANALYSIS_EXPIRED`	O período para o consentimento da análise expirou-se. Neste caso, é necessário solicitar uma nova análise.
`Credit`	`CREDIT_CARD_CONTRACT_ACCEPTED`	Contrato de limite de crédito aceito. Este evento sinaliza que o cliente aceitou a análise disponibilizada e assinou o contrato.
`Credit`	`CREDIT_CARD_CONTRACT_BLOCKED`	Contrato de crédito bloqueado devido à inadimplência por mais de 5 dias.
`Credit`	`CREDIT_CARD_CONTRACT_CANCELLED`	Contrato de crédito cancelado por solicitação do cliente ou após um período de negativação.
`Credit`	`CREDIT_CARD_CONTRACT_UNBLOCKED`	Contrato de crédito desbloqueado, pois o cliente quitou/negociou seu débito de inadimplência.
`Credit`	`CREDIT_CARD_LIMIT_INCREASE_REQUESTED`	Após reanálise, o aumento do limite de crédito do cliente foi solicitado.
`Credit`	`CREDIT_CARD_LIMIT_INCREASE_APPROVED`	Após reanálise, o aumento do limite de crédito do cliente foi aprovado.
`Credit`	`CREDIT_CARD_LIMIT_INCREASE_ACCEPTED`	O aumento do limite de crédito foi aceito. Este evento sinaliza que o cliente aceitou o aumento de limite de crédito e assinou o contrato.
`Credit`	`CREDIT_CARD_LIMIT_INCREASE_REFUSED`	Após reanálise, o aumento de limite de crédito do cliente foi recusado. Nesse caso, o contrato de crédito do cliente permanecerá o mesmo.
`Credit`	`CREDIT_CARD_LIMIT_REDUCTION_REQUESTED`	Após reanálise, a diminuição do limite é solicitada, para ocorrer 5 dias após a decisão.
`Credit`	`CREDIT_CARD_LIMIT_REDUCTION_APPLIED`	Após o tempo de requisição da redução de limite, a diminuição do limite é aplicada.
`Credit`	`INVOICE_BILLING_WAS_OVERDUE`	Fatura há X dias em atraso. Este evento informa há quantos dias a fatura está em atraso. Seu envio é diário até que a fatura seja paga.
`Credit`	`INVOICE_BILLING_WAS_PAID`	Pagamento realizado de fatura em atraso.
`Credit`	`CUSTOMER_BAD_CREDIT_APPLY_REQUESTED`	Solicitação de negativação do cliente realizada.
`Credit`	`CUSTOMER_BAD_CREDIT_REMOVE_REQUESTED`	Solicitação de remoção da negativação do cliente realizada.
`Credit`	`CUSTOMER_BILLING_CREATED`	Cliente enviado para um escritório parceiro de cobrança.
`Credit`	`CONTRACT_CREDIT_BLOCK_REQUEST_CREATED`	Solicitação de bloqueio do cartão realizada.
`Credit`	`CONTRACT_CREDIT_UNBLOCK_REQUEST_CREATED`	Solicitação de desbloqueio do cartão realizada.
`Credit`	`CONTRACT_CREDIT_CANCELLMENT_REQUESTED`	Solicitação de cancelamento do contrato de crédito do cliente realizada. Esta ação é irreversível.
`Credit`	`CREDIT_CONTRACT_CRELIQ_CANCELMENT_REQUESTED`	Início do cancelamento do contrato de crédito pelo processo de CRELIQ.

Fluxo dos eventos

Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem com base no contexto em que eles estão inseridos. Clique nas imagens para ampliá-las:

Identificador (`entityId`)

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão, conforme a tabela a seguir:

Evento	Identificador (`entityId` )	Descrição
`CREDIT_CONTRACT_PRE_ANALYSIS_APPROVED`	`documentNumber`	Número do documento do cliente.
`CREDIT_CONTRACT_PRE_ANALYSIS_REPPROVED`	`documentNumber`	Número do documento do cliente.
`CREDIT_CARD_LIMIT_CREATED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_LIMIT_APPROVED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_LIMIT_REPROVED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_ANALYSIS_COMPLETED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_ANALYSIS_EXPIRED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_CONTRACT_ACCEPTED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_CONTRACT_BLOCKED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_CONTRACT_CANCELLED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_CONTRACT_UNBLOCKED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_LIMIT_INCREASE_REQUESTED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_LIMIT_INCREASE_APPROVED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_LIMIT_INCREASE_REFUSED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_LIMIT_INCREASE_ACCEPTED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_LIMIT_REDUCTION_REQUESTED`	`contract`	Número do contrato de crédito.
`CREDIT_CARD_LIMIT_REDUCTION_APPLIED`	`contract`	Número do contrato de crédito.
`CREDIT_CONTRACT_CRELIQ_CANCELMENT_REQUESTED`	`contract`	Número do contrato de crédito.
`INVOICE_BILLING_WAS_OVERDUE`	`statementId`	Identificador único da fatura processada.
`INVOICE_BILLING_WAS_PAID`	`statementId`	Identificador único da fatura processada.
`CUSTOMER_BAD_CREDIT_APPLY_REQUESTED`	`statementId`	Identificador único da fatura processada.
`CUSTOMER_BAD_CREDIT_REMOVE_REQUESTED`	`statementId`	Identificador único da fatura processada.
`CUSTOMER_BILLING_CREATED`	`statementId`	Identificador único da fatura processada.
`CONTRACT_CREDIT_BLOCK_REQUEST_CREATED`	`statementId`	Identificador único da fatura processada.
`CONTRACT_CREDIT_UNBLOCK_REQUEST_CREATED`	`statementId`	Identificador único da fatura processada.
`CONTRACT_CREDIT_CANCELLMENT_REQUESTED`	`statementId`	Identificador único da fatura processada.

Dados dos eventos

CREDIT_CONTRACT_PRE_ANALYSIS_APPROVED

Esse evento sinaliza que uma pré-análise foi aprovada.

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
`expirestAt`	`string`	Data e hora de expiração da pré-análise, no formato ISO 8601 - UTC.
`analyzedAt`	`string`	Data e hora em que a pré-análise foi avaliada, no formato ISO 8601 - UTC.
`credit`	`object`	Objeto que contém informações sobre o limite aprovado.
`credit.value`	`number`	Valor de limite aprovado.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`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.
`holder`	`object`	Objeto que contém informações sobre o titular do cartão.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária.
`bankLicense.name`	`string`	Nome atribuído a licença bancária.
`bankLicense.value`	`string`	Número da licença bancária.
`creditEvaluation`	`object`	Objeto que contém informações sobre a análise de crédito.
`creditEvaluation.status`	`string`	Situação da análise. Neste caso, "APPROVED" (aprovada).
`creditEvaluation.evaluatedAt`	`string`	Data e hora em que a análise foi realizada, no formato ISO 8601 - UTC.
`creditEvaluation.creditValue`	`number`	Valor do limite concedido.
`creditEvaluation.policy`	`string`	Política utilizada na análise.

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

{
      "entityId": "47742663023",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CONTRACT_PRE_ANALYSIS_APPROVED",
      "data": {
      "expiresAt": "2024-04-26T23:59:14.537Z",
            "analyzedAt": "2024-04-26T19:23:33.606Z",
            "credit": {
                   "value": 5900,
                   "currency": "BRL"
            },
            "program": {
                   "id": 585
            },
            "holder": {
                   "document": {
                          "type": "CPF",
                          "value": "47742663023"
                   }
            },
            "bankLicense": {
                   "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",
                   "name": "BV"
            },
            "creditEvaluation": {
                   "status": "Approved",
                   "evaluatedAt": "2024-04-26T19:23:33.606Z",
                   "creditValue": 5900,
                   "policy": "Bolsao Meliuz BV"
            }
      },
      "metadata": {},
      "version": "1",
      "timestamp": "2024-04-26T19:23:33.616Z",
      "correlationId": "6f9be592-3cd1-4c16-b2e3-db4e3235f2db",
      "idempotencyKey": "a32d000b-cc94-4d1e-89c9-cc79fd4c3b13"
}

CREDIT_CONTRACT_PRE_ANALYSIS_REPROVED

Esse evento sinaliza que uma pré-análise foi reprovada.

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
`expirestAt`	`string`	Data e hora de expiração da pré-análise, no formato ISO 8601 - UTC.
`analyzedAt`	`string`	Data e hora em que a pré-análise foi avaliada, no formato ISO 8601 - UTC.
`credit`	`object`	Objeto que contém informações sobre o limite que foi reprovado.
`credit.value`	`number`	Valor do limite reprovado.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`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.
`holder`	`object`	Objeto que contém informações sobre o titular do cartão.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`holder.document.value`	`string`	Número do documento.
`bankLicense`	`object`	Objeto que contém informações sobre a licença bancária.
`bankLicense.name`	`string`	Nome atribuído à licença bancária.
`bankLicense.value`	`string`	Valor da licença bancária.
`reasonRefusal`	`string`	Motivo pelo qual o limite foi negado, que pode ser “ProgramId não cadastrado”, “Oferta Grupo controle”, “Lista Restritivo BV” ou “Política BV”.
`policy`	`string`	Política utilizada na análise.

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

{
      "entityId": "47742663023",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CONTRACT_PRE_ANALYSIS_REPROVED",
      "data": {
            "expiresAt": "2024-04-26T23:59:14.537Z",
            "analyzedAt": "2024-04-26T19:19:14.537Z",
            "credit": {
                   "value": 0,
                   "currency": "BRL"
            },
            "policy": "nome",
            "reasonRefusal": "Política BV",
            "program": {
                   "id": 585
            },
            "holder": {
                   "document": {
                          "type": "CPF",
                          "value": "47742663023"
                   }
            },
            "bankLicense": {
                   "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",
                   "name": "BV"
            }
      },
      "metadata": {},
      "version": "1",
      "timestamp": "2024-04-26T19:19:14.547Z",
      "correlationId": "aa83db86-4a94-4828-ae91-bd0ffb4c5655",
      "idempotencyKey": "45794574-0e2d-4128-8624-3a6dba0c24a7"
}

CREDIT_CARD_LIMIT_CREATED

Este evento sinaliza que uma solicitação de limite de crédito foi criada.

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
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	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.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".
`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.
`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 a 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

 {
      "name": "CREDIT_CARD_LIMIT_CREATED",
      "entityId": "021157",
      "idempotencyKey": "b3b42c0c-02b8-4e00-90aa-233d06cb1806",
      "companyKey": "FLORESTA_ED",
      "timestamp": "2022-10-02T00:00:04.9037184Z",
      "correlationId": "70352fbc-291d-4474-bf8d-eb8028ab89c5",
      "version": "1",
      "metadata": {},
      "context": "Credit",
      "data": {
         "contract": "000001",
         "version": 1,
         "holder": {
            "companyKey": "FLORESTA_ED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "motherName": "Dionísia Gonçalves Pinto",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
            "zipcode": "68060100",
            "addressLine": "6 de Março",
            "buildingNumber": "2500",
            "neighborhood": "Alter do Chão",
            "complement": "string",
            "country": "BR",
            "state": "PA",
            "city": "Santarém"
           },
         },
         "program": {
            "id": 117
         },
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
         "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
  			}
      }
   }

CREDIT_CARD_LIMIT_APPROVED

Este evento sinaliza que a solicitação de limite de crédito foi aprovada.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`expirationDate`	`string`	Data de expiração do contrato, no formato ISO 8601 - UTC.
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`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".
`policy`	`string`	Politica de liberação de crédito.
`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.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	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.
`scr`	`object`	Objeto que contém informações sobre a resposta do cliente quanto a 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

 {
      "entityId": "000810",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CARD_LIMIT_APPROVED",
      "correlationId": "512bf2d4-12a1-11ed-861d-0242ac120002",
      "timestamp": "2022-08-31T19:47:28.8684256Z",
      "idempotencyKey": "48a427e7-8c28-4c21-9822-db340641d2b6",
      "version": "1",
      "metadata": {},
      "data": {
         "analyzedAt": "2022-09-08T14:23:53.209-03:00",
         "expirationDate": "2022-09-08T14:23:53.209-03:00", 
         "contract": "000001",
         "version": 1,
         "credit": {
            "value": 500,
            "currency": "BRL"
         },
         "policy": "string",
         "program": {
            "id": 117
         },
         "holder": {
            "companyKey": "FLORESTA_ED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "birthDate": "1810-10-12T00:00:00",
            "motherName": "Dionísia Gonçalves Pinto",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipcode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "complement": "string",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém"
            },
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
         "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
         }
      }
   }

CREDIT_CARD_LIMIT_REPROVED

Este evento sinaliza que a solicitação de limite de crédito foi reprovada.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`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".
`policy`	`string`	Política de liberação de crédito.
`reasonRefusal`	`string`	Motivo de reprovação.
`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.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	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.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 contém informações sobre a resposta do cliente quanto a 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

{
      "entityId": "000810",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CARD_LIMIT_REPROVED",
      "correlationId": "512bf2d4-12a1-11ed-861d-0242ac120002",
      "timestamp": "2022-08-31T19:47:28.8684256Z",
      "idempotencyKey": "48a427e7-8c28-4c21-9822-db340641d2b6",
      "version": "1",
      "metadata": {},
      "data": {
         "analyzedAt": "2022-09-08T14:23:53.209-03:00",
         "contract": "000001",
         "version": 1,
         "credit": {
            "value": 0,
            "currency": "BRL"
         },
         "policy": "string",
         "reasonRefusal": "string",
         "program": {
            "id": 117
         },
         "holder": {
            "companyKey": "FLORESTA_ED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "motherName": "Dionísia Gonçalves Pinto",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipcode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "complement": "string",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém"
            },
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
         "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
         }
      }
   }

CREDIT_CARD_ANALYSIS_COMPLETED

Este evento sinaliza que a análise de crédito foi finalizada e pode ter sido aprovada ou reprovada.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`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".
`policy`	`string`	Política de liberação de crédito.
`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.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	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.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 contém informações sobre a resposta do cliente quanto a 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

{
      "entityId": "000810",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CARD_ANALYSIS_COMPLETED",
      "correlationId": "512bf2d4-12a1-11ed-861d-0242ac120002",
      "timestamp": "2022-08-31T19:47:28.8684256Z",
      "idempotencyKey": "48a427e7-8c28-4c21-9822-db340641d2b6",
      "version": "1",
      "metadata": {},
      "data": {
         "analyzedAt": "2022-09-08T14:23:53.209-03:00",
         "contract": "000001",
         "version": 1,
         "credit": {
            "value": 500,
            "currency": "BRL"
         },
         "policy": "string",
         "program": {
            "id": 117
         },
         "holder": {
            "companyKey": "FLORESTA_ED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "motherName": "Dionísia Gonçalves Pinto",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipcode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "complement": "string",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém"
            },
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
         "scr": {
           "collectedAt": "2023-08-17T16:36:20.717Z",
           "authorized": true,
         }
      }
   }

CREDIT_CARD_ANALYSIS_EXPIRED

Este evento sinaliza que o período para o consentimento da análise expirou-se.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`expirationDate`	`string`	Data de expiração do contrato, no formato ISO 8601 - UTC.
`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".
`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`	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.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 contém informações sobre a resposta do cliente quanto a 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

{
      "entityId": "000810",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CARD_ANALYSIS_EXPIRED",
      "correlationId": "512bf2d4-12a1-11ed-861d-0242ac120002",
      "timestamp": "2022-08-31T19:47:28.8684256Z",
      "idempotencyKey": "48a427e7-8c28-4c21-9822-db340641d2b6",
      "version": "1",
      "metadata": {},
      "data": {
         "analyzedAt": "2022-09-08T14:23:53.209-03:00",
         "contract": "000001",
         "version": 1,
         "expirationDate": "2022-09-08T14:23:53.209-03:00", 
         "credit": {
            "value": 500,
            "currency": "BRL"
         },
         "policy": "string",
         "holder": {
            "companyKey": "FLORESTA_ED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "motherName": "Dionísia Gonçalves Pinto",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipcode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "complement": "string",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém"
            },
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
          "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
  			 }
      }
   }

CREDIT_CARD_CONTRACT_ACCEPTED

Este evento sinaliza que o contrato de limite de crédito foi aceito pelo cliente.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`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".
`policy`	`string`	Política de liberação de crédito.
`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.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	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.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 contém informações sobre a resposta do cliente quanto a 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

{
      "entityId": "000810",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CARD_CONTRACT_ACCEPTED",
      "correlationId": "512bf2d4-12a1-11ed-861d-0242ac120002",
      "timestamp": "2022-08-31T19:47:28.8684256Z",
      "idempotencyKey": "48a427e7-8c28-4c21-9822-db340641d2b6",
      "version": "1",
      "metadata": {},
      "data": {
         "analyzedAt": "2022-09-08T14:23:53.209-03:00",
         "contract": "000001",
         "version": 1,
         "credit": {
            "value": 500,
            "currency": "BRL"
         },
         "policy": "string",
         "program": {
            "id": 117
         },
         "holder": {
            "companyKey": "FLORESTA_ED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "motherName": "Dionísia Gonçalves Pinto",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipcode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "complement": "string",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém"
            },
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
         "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
  			}
      }
   }

CREDIT_CARD_CONTRACT_BLOCKED

Este evento sinaliza que o contrato de crédito do cliente foi bloqueado devido a inadimplência por mais de 5 dias.

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
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`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.
`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.
`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.
`status`	`string`	Situação do contrato de crédito. Neste caso, "Blocked" (bloqueado).
`statusReason`	`string`	Motivo pelo qual ocorreu o bloqueio, que pode ser "INACTIVITY" (inatividade), "HOLDER_REQUEST" (solicitação do titular), "PARTNER_REQUEST"" (solicitação do parceiro), "LACK_OF_PAYMENT" (inadimplência), "CRELIQ" e "PRE_CRELIQ".
`scr`	`object`	Objeto que contém informações sobre a resposta do cliente quanto a 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

{
      "name": "CREDIT_CARD_CONTRACT_BLOCKED",
      "entityId": "021157",
      "idempotencyKey": "b3b42c0c-02b8-4e00-90aa-233d06cb1806",
      "companyKey": "FLORESTA_ED",
      "timestamp": "2022-10-02T00:00:04.9037184Z",
      "correlationId": "70352fbc-291d-4474-bf8d-eb8028ab89c5",
      "version": "1",
      "metadata": {},
      "context": "Credit",
      "data": {
         "holder": {
            "document": {
               "type": "CPF",
               "value": "47742663023"
            }
         },
         "program": {
            "id": 117
         },
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
         "status": "Blocked",
         "statusReason": "INACTIVITY",
         "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
  			}
      }
   }

CREDIT_CARD_CONTRACT_CANCELLED

Este evento sinaliza que o contrato de crédito do cliente foi cancelado.

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
`contract`	`string`	Número do contrato de crédito.
`version`	`number`	Versão do contrato.
`credit`	`object`	Objeto que contém informações sobre o limite de crédito definido no contrato.
`credit.value`	`number`	Valor do limite de crédito.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`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.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	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.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".
`statusReason`	`string`	Motivo do cancelamento do contrato.
`status`	`string`	Situação do contrato de crédito. Neste caso, "Canceled" (cancelado).
`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 a 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

{
      "entityId": "000810",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CARD_CONTRACT_CANCELLED",
      "correlationId": "512bf2d4-12a1-11ed-861d-0242ac120002",
      "timestamp": "2022-08-31T19:47:28.8684256Z",
      "idempotencyKey": "48a427e7-8c28-4c21-9822-db340641d2b6",
      "version": "1",
      "metadata": {},
      "data": {
         "contract": "000001",
         "version": 1,
         "credit": {
            "value": 2200,
            "currency": "BRL"
            },
         "program": {
            "id": 107
         },
         "holder": {
            "companyKey": "FLORESTA_ED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "motherName": "Dionísia Gonçalves Pinto",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipcode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "complement": "string",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém"
            }
         },
         "statusReason": "Solicitado pelo cliente",
         "status": "Canceled",
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
         "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
  			}
      }
   }

CREDIT_CARD_CONTRACT_UNBLOCKED

Este evento sinaliza que o contrato de crédito foi desbloqueado, pois o cliente quitou/negociou seu débito de inadimplência.

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
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`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.
`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.
`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 a 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

{
      "name": "CREDIT_CARD_CONTRACT_UNBLOCKED",
      "entityId": "021157",
      "idempotencyKey": "b3b42c0c-02b8-4e00-90aa-233d06cb1806",
      "companyKey": "FLORESTA_ED",
      "timestamp": "2022-10-02T00:00:04.9037184Z",
      "correlationId": "70352fbc-291d-4474-bf8d-eb8028ab89c5",
      "version": "1",
      "metadata": {},
      "context": "Credit",
      "data": {
         "holder": {
            "document": {
               "type": "CPF",
               "value": "47742663023"
            }
         },
         "program": {
            "id": 117
         },
         "bankLicense": {  
      		 "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      		 "name": "ACESSO"  
         },  
    		 "designatedFunding": "ACESSO",
         "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
  			}
      }
   }

CREDIT_CARD_LIMIT_INCREASE_REQUESTED

Este evento sinaliza que foi solicitado um aumento no limite de crédito do cliente.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`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".
`policy`	`string`	Política de liberação de crédito.
`origin`	`string`	Origem da solicitação de reanálise.
`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.
`mustAccept`	`boolean`	Flag para identificar se o aceite é requisitado para o aumento de limite.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	Parceiro referente ao contrato.
`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.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.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.adressLine`	`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 a 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

{  
  "name": "CREDIT_CARD_LIMIT_INCREASE_REQUESTED",  
  "entityId": "021157",  
  "idempotencyKey": "b3b42c0c-02b8-4e00-90aa-233d06cb1806",  
  "companyKey": "FLORESTA_ED",  
  "timestamp": "2022-10-02T00:00:04.9037184Z",  
  "correlationId": "70352fbc-291d-4474-bf8d-eb8028ab89c5",  
  "version": "1",  
  "metadata": {},  
  "context": "Credit",  
  "data": {  
    "analyzedAt": "2022-09-08T14:23:53.209-03:00",  
    "credit": {  
      "value": 500,  
      "currency": "BRL"  
    },  
    "contract": "000001",  
    "version": 1,  
    "program": {  
      "id": 117  
    },  
    "policy": "string",  
    "origin": "COMPANY_REQUEST",  
    "mustAccept": false,  
    "holder": {  
      "companyKey": "FLORESTA_ED",  
      "registerName": "Nísia Floresta",  
      "socialName": "Nísia",  
      "motherName": "Dionísia Gonçalves Pinto",  
      "birthDate": "1810-10-12T00:00:00",  
      "document": {  
        "type": "CPF",  
        "value": "47742663023"  
      },  
      "address": {  
        "zipCode": "68060100",  
        "addressLine": "6 de Março",  
        "buildingNumber": "2500",  
        "complement": "string",  
        "neighborhood": "Alter do Chão",  
        "city": "Santarém",  
        "state": "PA",  
        "country": "BR"  
      }  
    },  
    "bankLicense": {  
      "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
      "name": "ACESSO"  
    },  
    "designatedFunding": "ACESSO",
    "scr": {
       "collectedAt": "2023-08-17T16:36:20.717Z",
       "authorized": true,
  	}
  }  
 }

CREDIT_CARD_LIMIT_INCREASE_APPROVED

Este evento sinaliza que, após reanálise, o aumento do limite de crédito do cliente foi aprovado.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`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.
`newLimitEffectiveAt`	`string`	Data em que o novo limite de crédito passará a vigorar, no formato ISO 8601 - UTC.
`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`	Valor de crédito liberado ao cliente.
`credit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`incresedLimit`	`object`	Objeto que contém informações sobre o valor acrescentado ao limite anterior.
`incresedLimit.value`	`number`	Valor acrescentado ao limite, sendo a diferença entre o novo limite de crédito e o limite de crédito anterior.
`incresedLimit.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`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`	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 contém informações sobre a resposta do cliente quanto a 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

{
      "entityId": "000810",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CARD_LIMIT_INCREASE_APPROVED",
      "correlationId": "512bf2d4-12a1-11ed-861d-0242ac120002",
      "timestamp": "2022-08-31T19:47:28.8684256Z",
      "idempotencyKey": "48a427e7-8c28-4c21-9822-db340641d2b6",
      "version": "1",
      "metadata": {},
      "data": {
         "analyzedAt": "2022-09-08T14:23:53.209-03:00",
         "newLimitEffectiveAt": "2022-09-08T14:23:53.209-03:00",
         "contract": "000001",
         "version": 1,
         "program": {
            "id": 107
         },
         "previousLimit": {
            "value": 500,
            "currency": "BRL"
         },
         "credit": {
            "value": 500,
            "currency": "BRL"
         },
         "incresedLimit": {
            "value": 500,
            "currency": "BRL"
         },
         "origin": "COMPANY_REQUEST",
         "policy": "string",
         "holder": {
            "companyKey": "FLORESTA_ED",
            "motherName": "Maria Quitéria de Jesus",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipcode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "complement": "string",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém"
            }
         },
         "bankLicense": {
           "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",
           "name": "ACESSO"
        },
       "designatedFunding": "ACESSO",
       "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
  			}
      }
   }

CREDIT_CARD_LIMIT_INCREASE_ACCEPTED

Este evento sinaliza que o aumento no limite de crédito foi aceito pelo cliente.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`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`	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 a 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

{
  "name": " CREDIT_CARD_LIMIT_INCREASE_ACCEPTED",
  "entityId": "021157",
  "idempotencyKey": "b3b42c0c-02b8-4e00-90aa-233d06cb1806",
  "companyKey": "FLORESTA_ED",
  "timestamp": "2022-10-02T00:00:04.9037184Z",
  "correlationId": "70352fbc-291d-4474-bf8d-eb8028ab89c5",
  "version": "1",
  "licenses": [],
  "metadata": {},
  "context": "Credit",
  "data": {
    "analyzedAt": "2022-09-08T14:23:53.209-03:00",
    "previousLimit": {
      "value": 500,
      "currency": "BRL"
    },
    "credit": {
      "value": 1000,
      "currency": "BRL"
    },
    "incresedLimit": {
      "value": 500,
      "currency": "BRL"
    },
    "contract": "000001",
    "version": 1,
    "policy": "string",
    "origin": "COMPANY_REQUEST",
    "holder": {
      "companyKey": "FLORESTA_ED",
      "registerName": "Nísia Floresta",
      "socialName": "Nísia",
      "motherName": "Dionísia Gonçalves Pinto",
      "birthDate": "1810-10-12T00:00:00",
      "document": {
        "type": "CPF",
        "value": "47742663023"
      },
      "address": {
        "zipCode": "68060100",
        "addressLine": "6 de Março",
        "buildingNumber": "2500",
        "complement": "string",
        "neighborhood": "Alter do Chão",
        "city": "Santarém",
        "state": "PA",
        "country": "BR"
      }
    },
    "bankLicense": {
      "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",
      "name": "ACESSO"
    },
    "designatedFunding": "ACESSO",
    "scr": {
      "collectedAt": "2023-08-17T16:36:20.717Z",
      "authorized": true
    }
  }
}

CREDIT_CARD_LIMIT_INCREASE_REFUSED

Este evento sinaliza que, após reanálise, o aumento de limite de crédito do cliente foi recusado.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`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.
`mustAccept`	`boolean`	Indica se o cliente deve assinar novamente o contrato após a análise (true) ou não (false).
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.companyKey`	`string`	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.
`scr`	`object`	Objeto que contém informações sobre a resposta do cliente quanto a 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

{
      "entityId": "000810",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CREDIT_CARD_LIMIT_INCREASE_REFUSED",
      "correlationId": "512bf2d4-12a1-11ed-861d-0242ac120002",
      "timestamp": "2022-08-31T19:47:28.8684256Z",
      "idempotencyKey": "48a427e7-8c28-4c21-9822-db340641d2b6",
      "version": "1",
      "metadata": {},
      "data": {
         "analyzedAt": "2022-09-08T14:23:53.209-03:00",
         "contract": "000001",
         "version": 1,
         "program": {
            "id": 107
         },
         "origin": "COMPANY_REQUEST",
         "policy": "string",
         "mustAccept": true,
         "holder": {
            "companyKey": "FLORESTA_ED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "motherName": "Dionísia Gonçalves Pinto",
            "birthDate": "1810-10-12T00:00:00",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipcode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "complement": "string",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém"
            }
         },  
         "bankLicense": {  
          "value": "98ef2f35-8a19-4a27-940b-633f3330d8db",  
          "name": "ACESSO"  
         },  
         "designatedFunding": "ACESSO",
         "scr": {
      		 "collectedAt": "2023-08-17T16:36:20.717Z",
      		 "authorized": true,
  			}
      }
   }

CREDIT_CARD_LIMIT_REDUCTION_REQUESTED

Este evento sinaliza que, após reanálise, a diminuição do limite foi solicitada.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`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".
`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`	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.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 contém informações sobre a resposta do cliente quanto a 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

{
  "name": "CREDIT_CARD_LIMIT_REDUCTION_REQUESTED",
  "entityId": "021157",
  "idempotencyKey": "b3b42c0c-02b8-4e00-90aa-233d06cb1806",
  "companyKey": "FLORESTA_ED",
  "timestamp": "2022-10-02T00:00:04.9037184Z",
  "correlationId": "70352fbc-291d-4474-bf8d-eb8028ab89c5",
  "version": "1",
  "metadata": {},
  "context": "Credit",
  "data": {
    "analyzedAt": "2022-09-08T14:23:53.209-03:00",
    "credit": {
      "value": 500,
      "currency": "BRL"
    },
    "contract": "000001",
    "version": 1,
    "program": {
      "id": 117
    },
    "policy": "string",
    "origin": "COMPANY_REQUEST",
    "holder": {
      "companyKey": "FLORESTA_ED",
      "registerName": "Nísia Floresta",
      "socialName": "Nísia",
      "motherName": "Dionísia Gonçalves Pinto",
      "birthDate": "1810-10-12T00:00:00",
      "document": {
        "type": "CPF",
        "value": "47742663023"
      },
      "address": {
        "zipCode": "68060100",
        "addressLine": "6 de Março",
        "buildingNumber": "2500",
        "complement": "string",
        "neighborhood": "Alter do Chão",
        "city": "Santarém",
        "state": "PA",
        "country": "BR"
      }
    },
    "bankLicense": {
      "value": "string",
      "name": "ACESSO"
    },  
    "designatedFunding": "ACESSO",
    "scr": {
      "collectedAt": "2023-08-17T16:36:20.717Z",
      "authorized": true,
   }
  }
 }

CREDIT_CARD_LIMIT_REDUCTION_APPLIED

Este evento sinaliza que a diminuição do limite foi aplicada.

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
`analyzedAt`	`string`	Data da análise de crédito, no formato ISO 8601 - UTC.
`newLimitEffectiveAt`	`string`	Data em que o novo limite de crédito passará a vigorar, no formato ISO 8601 - UTC.
`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`	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`	Nome da rua.
`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 a 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

{
  "name": "CREDIT_CARD_LIMIT_REDUCTION_APPLIED",
  "entityId": "021157",
  "idempotencyKey": "b3b42c0c-02b8-4e00-90aa-233d06cb1806",
  "companyKey": "FLORESTA_ED",
  "timestamp": "2022-10-02T00:00:04.9037184Z",
  "correlationId": "70352fbc-291d-4474-bf8d-eb8028ab89c5",
  "version": "1",
  "licenses": [],
  "metadata": {},
  "context": "Credit",
  "data": {
    "analyzedAt": "2022-09-08T14:23:53.209-03:00",
    "newLimitEffectiveAt": "2022-09-08T14:23:53.209-03:00",
    "previousLimit": {
      "value": 500,
      "currency": "BRL"
    },
    "credit": {
      "value": 500,
      "currency": "BRL"
    },
    "decreasedLimit": {
      "value": 500,
      "currency": "BRL"
    },
    "contract": "000001",
    "version": 1,
    "program": {
      "id": 117
    },
    "policy": "string",
    "origin": "COMPANY_REQUEST",
    "holder": {
      "companyKey": "FLORESTA_ED",
      "registerName": "Nísia Floresta",
      "socialName": "Nísia",
      "motherName": "Dionísia Gonçalves Pinto",
      "document": {
        "type": "CPF",
        "value": "47742663023"
      },
      "address": {
        "zipCode": "68060100",
        "addressLine": "6 de Março",
        "buildingNumber": "2500",
        "complement": "string",
        "neighborhood": "Alter do Chão",
        "city": "Santarém",
        "state": "PA",
        "country": "BR"
      }
    },
    "bankLicense": {
      "value": "string",
      "name": "ACESSO"
    },  
    "designatedFunding": "ACESSO",
    "scr": {
      "collectedAt": "2023-08-17T16:36:20.717Z",
      "authorized": true
    }
  }
}

INVOICE_BILLING_WAS_OVERDUE

Este evento notifica a quantidade de dias em que a fatura está em atraso.

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
`statementId`	`string`	Identificador único da fatura processada.
`daysInDelay`	`number`	Quantidade de dias em que a fatura está em atraso (no momento da emissão do evento).
`amount`	`object`	Objeto que contém informações sobre o valor da fatura.
`amount.value`	`string`	Valor da fatura.
`amount.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`closedAt`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".

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

{
      "entityId": "10",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "INVOICE_BILLING_WAS_OVERDUE",
      "timestamp": "2021-12-06T11:10:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {},
      "version": "1",
      "data": {
         "statementId": "10",
         "daysInDelay": 3,
         "amount": {
            "value": "1000.00",
            "currency": "BRL"
         },
         "closedAt": "2021-10-06T00:00:00",
         "dueDate": "2021-10-06T00:00:00",
         "holder": {
            "document": {
               "value": "47742663023",
               "type": "CPF"
            }
         }
      }
   }

INVOICE_BILLING_WAS_PAID

Este evento notifica o pagamento da fatura em atraso.

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
`statementId`	`string`	Identificador único da fatura processada.
`amount`	`object`	Objeto que contém informações sobre o valor da fatura.
`amount.value`	`string`	Valor da fatura.
`amount.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`closedAt`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.
`dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.
`paymentDate`	`date`	Data de pagamento da fatura em atraso, no formato ISO 8601 - UTC.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".

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

{
      "entityId": "10",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "INVOICE_BILLING_WAS_PAID",
      "timestamp": "2021-12-06T11:10:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {},
      "version": "1",
      "data": {
         "statementId": "10",
         "amount": {
            "value": "1000.00",
            "currency": "BRL"
         },
         "closedAt": "2021-10-06T00:00:00",
         "dueDate": "2021-10-06T00:00:00",
         "paymentDate": "2022-03-29T00:00:00+00:00",
         "holder": {
            "document": {
               "value": "47742663023",
               "type": "CPF"
            }
         }
      }
   }

CUSTOMER_BAD_CREDIT_APPLY_REQUESTED

Este evento notifica que a negativação do cliente foi solicitada.

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
`debt`	`object`	Objeto que contém informações sobre a dívida do cliente.
`debt.amount`	`object`	Objeto que contém informações sobre o valor da dívida.
`debt.amount.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`debt.amount.value`	`number`	Valor da dívida.
`debt.dueDate`	`string`	Data de vencimento da dívida, no formato ISO 8601 - UTC.
`debt.id`	`string`	Identificador único da dívida (neste caso, o número do contrato de crédito).
`debtor`	`object`	Objeto que contém informações sobre o devedor.
`debtor.birthDate`	`string`	Data de nascimento do devedor, no formato ISO 8601 - UTC.
`debtor.email`	`string`	Endereço de e-mail.
`debtor.motherName`	`string`	Nome da mãe conforme consta no documento de identificação.
`debtor.name`	`string`	Nome do devedor.
`debtor.phone`	`string`	Número de telefone.
`debtor.document`	`object`	Objeto que contém informações sobre o documento do devedor.
`debtor.document.value`	`string`	Número do documento.
`debtor.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`debtor.address`	`object`	Objeto que contém informações sobre o endereço do devedor.
`debtor.address.zipCode`	`string`	Código postal do endereço.
`debtor.address.buildingNumber`	`string`	Número do imóvel.
`debtor.address.country`	`string`	Sigla do país. Exemplo: "BR".
`debtor.address.city`	`string`	Nome da cidade.
`debtor.address.fullAddress`	`string`	Endereço completo do devedor.
`debtor.address.neighborhood`	`string`	Nome do bairro.
`debtor.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`debtor.address.complement`	`string`	Complemento do endereço.
`designatedFunding`	`string`	Financiadora do contrato.

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

{
      "entityId": "10",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CUSTOMER_BAD_CREDIT_APPLY_REQUESTED",
      "timestamp": "2021-12-06T11:10:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {},
      "version": "1",
      "data": {
         "debt": {
            "amount": {
               "currency": "BRL",
               "value": 116.02
            },
            "dueDate": "2022-10-03T00:00:00",
            "id": "000255"
         },
         "debtor": {
            "birthDate": "1990-12-25T00:00:00",
            "email": "[email protected]",
            "motherName": "Maria Quitéria de Jesus",
            "name": "Nísia Floresta",
            "phone": "23415162342",
            "document": {
               "type": "CPF",
               "value": "47742663023"
            },
            "address": {
               "zipCode": "68060100",
               "buildingNumber": "2500",
               "country": "BR",
               "city": "Santarém",
               "fullAddress": "Rua do 01070970522",
               "neighborhood": "Alter do Chão",
               "state": "PA",
               "complement": "string"
            }
         },
         "designatedFunding": "string"
      }
   }

CUSTOMER_BAD_CREDIT_REMOVE_REQUESTED

Este evento notifica que a remoção da negativação do cliente foi solicitada.

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
`debt`	`object`	Objeto que contém informações sobre a dívida do cliente.
`debt.id`	`string`	Identificador único da dívida.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`holder.document`	`object`	Objeto que contém informações sobre o documento do cliente.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`designatedFunding`	`string`	Financiadora do contrato.

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

{
      "entityId": "10",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CUSTOMER_BAD_CREDIT_REMOVE_REQUESTED",
      "timestamp": "2021-12-06T11:10:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {},
      "version": "1",
      "data": {
         "debt": {
            "id": "000255"
         },
         "holder": {
            "document": {
               "type": "CPF",
               "value": "47742663023"
            }
         },
        "designatedFunding": "string"
      }
   }

CUSTOMER_BILLING_CREATED

Este evento notifica que o cliente foi enviado para um escritório parceiro de cobrança.

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
`customer`	`object`	Objeto que contém informações sobre o cliente.
`customer.document`	`string`	Objeto que contém informações sobre o documento do cliente.
`customer.profile`	`string`	Perfil do cadastro, que pode ser “COMPLETE” (completo) ou “SIMPLE” (simples).
`customer.status`	`string`	Situação do cadastro, que pode ser “PENDING_APPROVAL” (aprovação pendente), "APPROVED" (aprovado), "REPROVED” (reprovado) e "IN_ANALISIS" (em análise).
`customer.registerName`	`string`	Nome conforme consta no documento de identificação (RG, CNH, RNE, DNI ou CRNM).
`customer.socialName`	`string`	Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social.
`customer.phone`	`object`	Objeto que contém informações sobre o telefone do cliente.
`customer.phone.countryCode`	`string`	Código DDI do país. Por exemplo, 55 ou +55 para números do Brasil.
`customer.phone.number`	`string`	Número de telefone incluindo o DDD.
`customer.address`	`object`	Objeto que contém informações sobre o endereço do cliente.
`customer.address.zipCode`	`string`	Código postal do endereço.
`customer.address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`customer.address.buildingNumber`	`string`	Número do imóvel.
`customer.address.neighborhood`	`string`	Nome do bairro.
`customer.address.country`	`string`	Sigla do país. Exemplo: "BR".
`customer.address.state`	`string`	Sigla do estado brasileiro, conforme a ISO 3166-2. Exemplo: "MG".
`customer.address.city`	`string`	Nome da cidade.
`customer.address.complement`	`string`	Complemento do endereço.
`customer.email`	`string`	Endereço de e-mail.
`customer.isPoliticallyExposedPerson`	`boolean`	Indica se o cliente é uma pessoa politicamente exposta (true) ou não (false).
`invoice`	`object`	Objeto que contém informações sobre a fatura.
`invoice.id`	`string`	Identificador único da fatura.
`invoice.amount`	`object`	Objeto que contém informações sobre o valor da fatura.
`invoice.amount.value`	`number`	Valor da fatura.
`invoice.amount.currency`	`string`	Código da moeda com base na ISO - 4217. Exemplo: "BRL".
`invoice.closedAt`	`string`	Data de fechamento da fatura, no formato ISO 8601 - UTC.
`invoice.dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.
`invoice.status`	`string`	Situação da fatura, que pode ser "PAID" (paga), "PENDING" (pendente), "OVERDUE" (atrasada) ou "NEGOTIATED" (negociada).
`collectionOffice`	`string`	Escritório de cobrança responsável por contatar o cliente e negociar o pagamento da dívida.
`designatedFunding`	`string`	Financiadora do contrato.

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

{
      "entityId": "10",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CUSTOMER_BILLING_CREATED",
      "timestamp": "2021-12-06T11:10:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "daysInDelay": 50
      },
      "version": "1",
      "data": {
         "customer": {
            "document": "47742663023",
            "profile": "SIMPLE",
            "status": "APPROVED",
            "registerName": "Nísia Floresta",
            "socialName": "Nísia",
            "phone": {
               "countryCode": "55",
               "number": "23415162342"
            },
            "address": {
               "zipCode": "68060100",
               "addressLine": "6 de Março",
               "buildingNumber": "2500",
               "neighborhood": "Alter do Chão",
               "country": "BR",
               "state": "PA",
               "city": "Santarém",
               "complement": "string"
            },
            "email": "[email protected]",
            "isPoliticallyExposedPerson": true
         },
         "invoice": {
            "id": "13314",
            "amount": {
               "value": 48.8,
               "currency": "BRL"
            },
            "closedAt": "2022-05-01T00:00:00",
            "dueDate": "2022-06-22T00:00:00",
            "status": "Overdue"
         },
         "collectionOffice": "BELLINATI",
         "designatedFunding": "string"
      }
   }

CONTRACT_CREDIT_BLOCK_REQUEST_CREATED

Este evento notifica que o bloqueio do cartão foi solicitado.

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
`credit`	`object`	Objeto que contém informações sobre o contrato de crédito do cliente.
`credit.contract`	`string`	Número do contrato de crédito.
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`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.
`reason`	`string`	Motivo pelo qual o contrato de crédito do cliente deverá ser bloqueado, que pode ser "PRE_CRELIQ" (bloqueio por inadimplência de 71 dias) ou "LACK_OF_PAYMENT" (falta de pagamento).

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

{
      "entityId": "10",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CONTRACT_CREDIT_BLOCK_REQUEST_CREATED",
      "timestamp": "2021-12-06T11:10:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {},
      "version": "1",
      "data": {
         "credit": {
            "contract": "000258"
         },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "program": {
            "id": 107
         },
         "reason": "PRE_CRELIQ"
      }
   }

CONTRACT_CREDIT_UNBLOCK_REQUEST_CREATED

Este evento notifica que o desbloqueio do cartão foi solicitado.

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
`credit`	`object`	Objeto que contém informações sobre o contrato de crédito do cliente.
`credit.contract`	`string`	Número do contrato de crédito.
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`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.

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

{
      "entityId": "10",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CONTRACT_CREDIT_UNBLOCK_REQUEST_CREATED",
      "timestamp": "2021-12-06T11:10:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {},
      "version": "1",
      "data": {
         "credit": {
            "contract": "000258"
         },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "program": {
            "id": 107
         }
      }
   }

CONTRACT_CREDIT_CANCELLMENT_REQUESTED

Este evento notifica que o cancelamento do contrato de crédito do cliente solicitado.

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
`credit`	`object`	Objeto que contém informações sobre o contrato de crédito do cliente.
`credit.contract`	`string`	Número do contrato de crédito.
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento. Neste caso, "CPF".
`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.
`daysInDelay`	`number`	Quantidade de dias de atraso no pagamento.
`paymentDeadline`	`string`	Data de vencimento da fatura do cartão de crédito, no formato ISO 8601 - UTC.
`reason`	`string`	Motivo pelo qual ocorreu o cancelamento.

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

{
      "entityId": "10",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "FLORESTA_ED",
      "context": "Credit",
      "name": "CONTRACT_CREDIT_CANCELLMENT_REQUESTED",
      "timestamp": "2021-12-06T11:10:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {},
      "version": "1",
      "data": {
         "credit": {
            "contract": "000258"
         },
         "document": {
            "value": "47742663023",
            "type": "CPF"
         },
         "program": {
            "id": 107
         },
         "daysInDelay": 23,
   			 "paymentDeadline": "2023-02-28T00:00:00.000Z",
         "reason": "Decision Engine - Invoice wasn't paid"
      }
   }

CREDIT_CONTRACT_CRELIQ_CANCELMENT_REQUESTED

Este evento sinaliza o Início do cancelamento do contrato de crédito pelo processo de CRELIQ.

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
`contract`	`string`	Número do contrato de crédito.
`holder`	`object`	Objeto que contém informações sobre o cliente (titular do cartão).
`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.
`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.
`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`	Nome da instituição financeira detentora da licença.
`designatedFunding`	`string`	Financiadora do contrato.

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

{ 
  "entityId": "006214", 
  "companyKey": "ACESSO", 
  "context": "Credit", 
  "name": "CREDIT_CONTRACT_CRELIQ_CANCELMENT_REQUESTED", 
  "data": { 
    "contract": "006214", 
    "holder": { 
      "document": { 
        "type": "CPF", 
        "value": "47742663023" 
      }, 
    "program": { 
      "id": 107 
    }, 
    "bankLicense": { 
      "value": "24ac71da-4309-4348-9cc0-a0c88f867993", 
      "name": "ACESSO" 
    }, 
    "designatedFunding": "ACESSO" 
  }, 
  "licenseUuid": "", 
  "metadata": {}, 
  "version": "1.0", 
  "timestamp": "2024-02-15T15:03:28.011Z", 
  "correlationId": "25ea6ac1-5a4c-44c8-8ace-d901a6da10c4", 
  "idempotencyKey": "6a24df59-283e-49da-9c4e-d3dc01ada75c" 
  } 
}

📘Nota

Pré-requisitos

Informações sobre os eventos

Contexto e nome do evento

Fluxo dos eventos

Identificador (entityId)

Dados dos eventos

CREDIT_CONTRACT_PRE_ANALYSIS_APPROVED

Descrição do objeto data do evento

Payload do evento

CREDIT_CONTRACT_PRE_ANALYSIS_REPROVED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_CREATED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_APPROVED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_REPROVED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_ANALYSIS_COMPLETED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_ANALYSIS_EXPIRED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_CONTRACT_ACCEPTED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_CONTRACT_BLOCKED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_CONTRACT_CANCELLED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_CONTRACT_UNBLOCKED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_INCREASE_REQUESTED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_INCREASE_APPROVED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_INCREASE_ACCEPTED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_INCREASE_REFUSED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_REDUCTION_REQUESTED

Descrição do objeto data do evento

Payload do evento

CREDIT_CARD_LIMIT_REDUCTION_APPLIED

Descrição do objeto data do evento

Payload do evento

INVOICE_BILLING_WAS_OVERDUE

Descrição do objeto data do evento

Payload do evento

INVOICE_BILLING_WAS_PAID

Descrição do objeto data do evento

Payload do evento

CUSTOMER_BAD_CREDIT_APPLY_REQUESTED

Descrição do objeto data do evento

Payload do evento

CUSTOMER_BAD_CREDIT_REMOVE_REQUESTED

Descrição do objeto data do evento

Payload do evento

CUSTOMER_BILLING_CREATED

Descrição do objeto data do evento

Payload do evento

CONTRACT_CREDIT_BLOCK_REQUEST_CREATED

Descrição do objeto data do evento

Payload do evento

CONTRACT_CREDIT_UNBLOCK_REQUEST_CREATED

Descrição do objeto data do evento

Payload do evento

CONTRACT_CREDIT_CANCELLMENT_REQUESTED

📘
Nota

Identificador (`entityId`)

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

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

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

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento