cURL
curl --request GET \
--url https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar \
--header 'Authorization: <api-key>'import requests
url = "https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar', 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/Portabilidade/listar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"items": [
{
"nuPortabilidade": "<string>",
"etapa": 10,
"statusPortabilidade": 123,
"taxaJurosMensal": 123,
"cetMensal": 123,
"qtdeParcelas": 123,
"vlrParcela": 123,
"valorFinanciado": 123,
"dtVencimentoUltimaParcela": "2023-12-25",
"nomeEmitente": "<string>",
"documentoFederal": "<string>",
"dataSolicitacao": "2023-11-07T05:31:56Z",
"numeroProposta": "<string>",
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtLimiteRetencao": "2023-11-07T05:31:56Z",
"motivoRetencao": 123,
"motivoCancelamento": 123,
"statusAssinatura": 123,
"dtLimiteAssinatura": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"pageSize": 123,
"totalPages": 123
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"success": true,
"data": {
"items": [
{
"nuPortabilidade": "<string>",
"etapa": 10,
"statusPortabilidade": 123,
"taxaJurosMensal": 123,
"cetMensal": 123,
"qtdeParcelas": 123,
"vlrParcela": 123,
"valorFinanciado": 123,
"dtVencimentoUltimaParcela": "2023-12-25",
"nomeEmitente": "<string>",
"documentoFederal": "<string>",
"dataSolicitacao": "2023-11-07T05:31:56Z",
"numeroProposta": "<string>",
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtLimiteRetencao": "2023-11-07T05:31:56Z",
"motivoRetencao": 123,
"motivoCancelamento": 123,
"statusAssinatura": 123,
"dtLimiteAssinatura": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"pageSize": 123,
"totalPages": 123
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Portabilidade
Consultar Portabilidades
Consulta gerencial das portabilidades de crédito da carteira do parceiro autenticado.
cURL
curl --request GET \
--url https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar \
--header 'Authorization: <api-key>'import requests
url = "https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar', 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/Portabilidade/listar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portabilidade.moneyp.dev.br/api/v1/Portabilidade/listar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"items": [
{
"nuPortabilidade": "<string>",
"etapa": 10,
"statusPortabilidade": 123,
"taxaJurosMensal": 123,
"cetMensal": 123,
"qtdeParcelas": 123,
"vlrParcela": 123,
"valorFinanciado": 123,
"dtVencimentoUltimaParcela": "2023-12-25",
"nomeEmitente": "<string>",
"documentoFederal": "<string>",
"dataSolicitacao": "2023-11-07T05:31:56Z",
"numeroProposta": "<string>",
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtLimiteRetencao": "2023-11-07T05:31:56Z",
"motivoRetencao": 123,
"motivoCancelamento": 123,
"statusAssinatura": 123,
"dtLimiteAssinatura": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"pageSize": 123,
"totalPages": 123
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"success": true,
"data": {
"items": [
{
"nuPortabilidade": "<string>",
"etapa": 10,
"statusPortabilidade": 123,
"taxaJurosMensal": 123,
"cetMensal": 123,
"qtdeParcelas": 123,
"vlrParcela": 123,
"valorFinanciado": 123,
"dtVencimentoUltimaParcela": "2023-12-25",
"nomeEmitente": "<string>",
"documentoFederal": "<string>",
"dataSolicitacao": "2023-11-07T05:31:56Z",
"numeroProposta": "<string>",
"codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtLimiteRetencao": "2023-11-07T05:31:56Z",
"motivoRetencao": 123,
"motivoCancelamento": 123,
"statusAssinatura": 123,
"dtLimiteAssinatura": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"page": 123,
"pageSize": 123,
"totalPages": 123
},
"errors": [
{
"code": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}
Retorna somente as portabilidades da carteira do parceiro autenticado (client_id), com filtros por período, CPF, etapa e número de proposta.
Endpoint
GET /api/v1/Portabilidade/Listar
Autenticação
Authorization: Bearer <token>
client_id.
| Situação | HTTP |
|---|---|
| Sem token | 401 |
| Token inválido ou expirado | 401 |
Token sem client_id | 401 |
401: Token não informado, Token inválido ou expirado, Token não contém client_id.
Enums do campo etapa
Mostrar Tabela 'etapa'
Mostrar Tabela 'etapa'
| Valor | Etapa | Significado |
|---|---|---|
| 10 | Recepcao | Portabilidade recebida, em análise inicial. |
| 20 | ConsultaRestricoes | Consulta de restrições do contrato em andamento. |
| 30 | AguardandoAssinatura | Termo de Retenção enviado; aguardando o cliente assinar. |
| 40 | EmAceite | Em aceite da solicitação junto à CTC (sem retenção em curso). |
| 50 | EmRetencao | Retenção em andamento (termo, evidência ou envio à CTC). Ainda não retida. |
| 60 | EmLiquidacao | Aceite concluído; em liquidação do contrato. |
| 70 | EmRegistro | Contrato em registro após a liquidação. |
| 80 | Bloqueada | Operação travada (integridade ou recusa da CTC no aceite). |
| 90 | Retida | Retenção aceita. Cliente permanece na originadora. |
| 91 | RetencaoRecusada | CTC recusou a retenção. |
| 95 | Portada | Portabilidade efetivada. |
| 99 | Cancelada | Operação cancelada (decurso de prazo, solicitada pelo proponente, STR não liquidado, etc.). |
Autorizações
Informe o token
Parâmetros de consulta
Esta página foi útil?

