Todo callback é um JSON plano: os campos do evento entram no mesmo nível dos campos do envelope comum. O envio é feito para a URL cadastrada em Cadastrar Callback.
Envelope comum
Todos os eventos compartilham estes campos, com os campos específicos de cada evento achatados no mesmo nível:
Convenções de formato:
- Datas sempre como string no formato
yyyy-MM-dd HH:mm:ss, no horário de Brasília. - Campos opcionais sem valor são enviados como
null— excetodetalhe, que é omitido do JSON quando vazio. - Acentuação é enviada crua, em UTF-8, sem escaping (ex.:
"João Conceição").
PORTABILIDADE_SOLICITADA
Disparado depois que a solicitação de portabilidade passa por todas as validações automáticas de recepção.
PORTABILIDADE_SOLICITADA
DOCUMENTO_ENVIADO
Disparado quando o Termo de Retenção é enviado ao cliente (etapa que segue a chamada de Retenção — Incluir Assinante).
DOCUMENTO_ENVIADO
O
assinaturaId retornado por Retenção — Incluir Assinante não vem como campo separado no envelope — ele aparece embutido na URL de linkAssinatura. A correlação entre os eventos e a chamada de inclusão do assinante é feita por nuPortabilidade.ASSINATURA_COLETADA
Disparado quando o cliente assina o Termo de Retenção.
ASSINATURA_COLETADA
TIMEOUT_ASSINATURA
Disparado quando o link de assinatura expira (fim do prazo D+1) sem que o cliente tenha assinado.
TIMEOUT_ASSINATURA