> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Cadastrar Callback

> Cadastro, atualização e consulta da URL de callback usada para notificar eventos de portabilidade.

> 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](/e-consignado/portabilidade/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`)

<ParamField body="url" type="string" required>
  URL pública do parceiro que receberá os eventos de callback (deve estar disponível nos ambientes de homologação e produção).
</ParamField>

<ParamField body="headers" type="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: ...`).
</ParamField>

<Note>
  `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.
</Note>

## 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:

| Evento                     | Quando dispara                                                                        |
| -------------------------- | ------------------------------------------------------------------------------------- |
| `PORTABILIDADE_SOLICITADA` | A solicitação de portabilidade passou por todas as validações automáticas de recepção |
| `DOCUMENTO_ENVIADO`        | O Termo de Retenção foi enviado ao cliente pelos canais escolhidos                    |
| `ASSINATURA_COLETADA`      | O cliente assinou o Termo de Retenção                                                 |
| `TIMEOUT_ASSINATURA`       | O link de assinatura expirou (fim do D+1) sem que o cliente assinasse                 |

Veja o envelope comum, o payload completo de cada evento e exemplos de JSON em [Eventos de Callback](/e-consignado/portabilidade/eventos-de-callback).


## OpenAPI

````yaml post /api/v1/Callback/cadastro
openapi: 3.0.1
info:
  title: BMPDigitalCore.Portabilidade API
  version: '1.0'
servers:
  - url: https://api.portabilidade.moneyp.dev.br
security:
  - Bearer: []
paths:
  /api/v1/Callback/cadastro:
    post:
      tags:
        - Callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CadastroCallbackRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CadastroCallbackRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CadastroCallbackRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CadastroCallbackResponseResultResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CadastroCallbackResponseResultResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CadastroCallbackResponseResultResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Unprocessable Content
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CadastroCallbackResponseResultResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CadastroCallbackResponseResultResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CadastroCallbackResponseResultResponse'
components:
  schemas:
    CadastroCallbackRequest:
      type: object
      properties:
        url:
          type: string
          nullable: true
        headers:
          type: object
          additionalProperties:
            type: string
          nullable: true
      additionalProperties: false
    CadastroCallbackResponseResultResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/CadastroCallbackResponse'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponse'
          nullable: true
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    CadastroCallbackResponse:
      type: object
      properties:
        codigoParceiro:
          type: string
          format: uuid
        codigoCredencial:
          type: string
          format: uuid
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          nullable: true
        message:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Informe o token
      name: Authorization
      in: header

````