Este fluxo descreve como o parceiro acompanha o andamento de uma portabilidade de crédito, recebe eventos assíncronos de mudança de status e conduz a retenção do cliente por meio de assinatura digital do Termo de Retenção.
Visão Geral do Produto
A Portabilidade de Crédito permite que um cliente transfira um contrato de crédito consignado de uma Instituição Financeira Originadora para uma Instituição Financeira Proponente, através da Central de Transferência de Crédito (CTC) da Núclea. Quando a BMP atua como Instituição Originadora, o parceiro precisa acompanhar as solicitações de portabilidade recebidas e, quando aplicável, reter o cliente — isto é, formalizar que o contrato permanecerá com a instituição de origem. A BMP oferece um fluxo de retenção 100% digital: o parceiro aciona a inclusão de um assinante, a BMP notifica o cliente pelo canal escolhido (E-mail, SMS ou WhatsApp) e acompanha a assinatura do Termo de Retenção até sua conclusão, cumprindo o prazo regulatório.Prazos regulatórios
O fluxo de retenção digital opera dentro de uma janela regulatória de D+2 dias úteis (excluindo sábados, domingos e feriados nacionais), contada a partir do início da retenção:Fluxo
1. Consultar
Acompanhar as portabilidades, sua etapa e status de assinatura.
2. Cadastrar Callback
Registrar, a URL que receberá os eventos de cada portabilidade.
3. Incluir Assinante
Iniciar a retenção digital, notificando o cliente para assinatura do Termo.
1. Consulta gerencial
O endpointGET /api/v1/Portabilidade/Listar retorna as portabilidades, com filtros por período, CPF, etapa (statusOperacao) e número de proposta. É o ponto de partida para identificar quais portabilidades estão, por exemplo, na etapa Retida e ainda sem termo assinado (statusAssinatura nulo).
2. Cadastro de callback
O cadastro de callback é feito uma única vez emPOST /api/v1/Callback/cadastro — a mesma URL é reutilizada em todas as notificações daquela credencial. A rota também permite atualizar (PUT) e consultar (GET) o cadastro vigente. Sem uma URL cadastrada, o parceiro simplesmente não recebe as notificações — o fluxo de retenção continua normalmente e o parceiro precisa acompanhar o andamento pela consulta gerencial.
3. Retenção — inclusão do assinante
Quando o parceiro decide reter um contrato, ele chamaPOST /api/v1/Portabilidade/Retencao/IncluirAssinante informando os dados de contato do cliente e os canais de notificação desejados. A partir disso, a BMP conduz toda a jornada automaticamente:
- Gera o PDF pré-preenchido do Termo de Retenção.
- Envia o link de assinatura pelos canais indicados (simultaneamente, quando mais de um for marcado) — o link expira ao final de D+1.
- Coleta a assinatura digital do cliente e consolida o PDF com o código de autenticação (Hash).
- Envia a evidência assinada ao Repositório de Evidências da Núclea e aguarda o aceite.
- Monta e envia a estrutura de retenção à CTC, dentro do D+2.
statusAssinatura na consulta gerencial.
Ciclo de vida da assinatura (statusAssinatura)
Referências de API
- Consultar Portabilidades - Consulta gerencial das solicitações de portabilidade de crédito.
- Cadastrar Callback - Cadastro, atualização e consulta da URL de callback usada para notificar eventos de portabilidade.
- Retenção — Incluir Assinante - Inclusão de assinante na retenção de portabilidade.
- Eventos de Callback - Documentação dos eventos de callback enviados pelo sistema.