cURL
curl --request POST \
--url https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"headers": {}
}
'import requests
url = "https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro"
payload = {
"url": "<string>",
"headers": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', headers: {}})
};
fetch('https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'headers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"headers\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"codigoParceiro": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoCredencial": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"success": true,
"data": {
"codigoParceiro": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoCredencial": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}Portabilidade
Cadastrar Callback
Cadastro, atualização e consulta da URL de callback usada para notificar eventos de portabilidade.
cURL
curl --request POST \
--url https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"headers": {}
}
'import requests
url = "https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro"
payload = {
"url": "<string>",
"headers": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', headers: {}})
};
fetch('https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'headers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"headers\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portabilidade.moneyp.dev.br/api/v1/Callback/cadastro")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"codigoParceiro": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoCredencial": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"success": true,
"data": {
"codigoParceiro": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoCredencial": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}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 camponuPortabilidade (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 |
Esta página foi útil?

