Skip to main content
cURL
Registra a URL (e headers de autenticação, se aplicável) que a BMP utilizará para notificar o parceiro sobre eventos assíncronos do fluxo de retenção de portabilidade.

Regras de negócio

  • O cadastro é por credencial — uma única URL é armazenada e reutilizada em todas as notificações daquela credencial.
  • Alterar a URL (PUT) é refletido imediatamente nos próximos disparos — não é necessário recadastrar por portabilidade em andamento.
  • Se não houver URL cadastrada, o parceiro simplesmente não recebe as notificações — o fluxo principal de retenção não é bloqueado; a ausência de callback é apenas registrada em log internamente. Nesse caso, o acompanhamento deve ser feito via Consultar Portabilidades.
  • Falha no disparo de um evento de callback (indisponibilidade da URL do parceiro, timeout etc.) não interrompe o fluxo principal — fica registrada em log para diagnóstico.

Cadastrar (POST)

string
obrigatório
URL pública do parceiro que receberá os eventos de callback (deve estar disponível nos ambientes de homologação e produção).
object
Conjunto de pares chave/valor (string) enviados como headers HTTP em toda chamada de callback feita pela BMP — use para transportar um método de autenticação próprio (ex.: Authorization: Bearer ..., X-API-Key: ...).
codigoParceiro identifica o parceiro na BMP e codigoCredencial identifica a credencial de callback criada — recomenda-se armazená-los para referência em chamados de suporte.

Atualizar (PUT)

Mesmo corpo de requisição e mesmo formato de resposta do POST, usado para substituir a url e/ou os headers já cadastrados para a credencial.

Consultar (GET)

Retorna a URL e os headers atualmente cadastrados para a credencial do parceiro autenticado.

Eventos

Cada evento é um POST em JSON para a URL cadastrada nesta credencial, correlacionado pelo campo nuPortabilidade (presente no envelope comum a todos os eventos). Atualmente a Portabilidade envia ao parceiro os seguintes eventos: Veja o envelope comum, o payload completo de cada evento e exemplos de JSON em Eventos de Callback.

Autorizações

Authorization
string
header
obrigatório

Informe o token

Corpo

url
string | null
headers
object | null

Resposta

OK

success
boolean
data
object
errors
object[] | null