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.
Parâmetros da Requisição
Todos os parâmetros abaixo são enviados via query string e são opcionais.date (yyyy-MM-dd)
Início do período, considerando a data de solicitação da portabilidade.
date (yyyy-MM-dd)
Fim do período, considerando a data de solicitação da portabilidade. Se enviado sem
dataInicio, é ignorado — veja regras abaixo.string
CPF do cliente, com ou sem máscara.
string (repetível)
Etapa gerencial da portabilidade. Repita o parâmetro para filtrar mais de uma etapa. Case-insensitive. Valores aceitos:Também são aceitos
Recepcao
ConsultaRestricoes
AguardandoAssinatura
EmAceite
EmRetencao
EmLiquidacao
EmRegistro
Bloqueada
Retida
RetencaoRecusada
Portada
Cancelada
Refinanciada
RETIDA e PORTADA (equivalentes a Retida e Portada).string (repetível)
Número da proposta no CaaS (
CodigoPropostaAN). Repita o parâmetro para consultar mais de uma proposta.int
padrão:"1"
Página da consulta (mínimo 1). Cada página tem 20 registros.
Regras de negócio
- Filtros informados em conjunto são cumulativos (AND).
- Sem
dataInicioe semdataFim: retorna no máximo as 50 portabilidades mais recentes da carteira, ordenadas pordataSolicitacaodecrescente, paginadas de 20 em 20. - Somente
dataInicioinformado (semdataFim):dataFimassume a data corrente no horário de Brasília. dataFimanterior adataInicio→400.- Sem resultado →
200comitems: []. numeroPropostainformado como lista vazia →400.- CPF inválido →
400. statusOperacaofora da lista aceita →400, com os valores aceitos na mensagem de erro.
Campos do item retornado
Todo campo abaixo está sempre presente na resposta. Quando não se aplica ao registro, o valor énull — o campo não é omitido.
| Campo | Tipo | Descrição |
|---|---|---|
nuPortabilidade | string | Número CTC da portabilidade |
etapa | string | Etapa gerencial (mesmos valores de statusOperacao) |
statusPortabilidade | int | Status interno da operação |
taxaJurosMensal | decimal? | Taxa mensal do contrato (CaaS) |
cetMensal | decimal? | CET mensal do contrato (CaaS) |
qtdeParcelas | int? | Quantidade de parcelas (CaaS) |
vlrParcela | decimal? | Valor da parcela (CaaS) |
valorFinanciado | decimal? | Valor financiado (CaaS) |
dtVencimentoUltimaParcela | date? | Vencimento da última parcela da agenda (yyyy-MM-dd) |
nomeEmitente | string? | Nome do cliente |
documentoFederal | string | CPF/CNPJ |
dataSolicitacao | datetime | Data de criação da portabilidade (UTC) |
numeroProposta | string? | Número da proposta no CaaS |
codigoProposta | guid? | Id interno da proposta |
dtLimiteRetencao | datetime? | Prazo X03; null quando não aplicável |
motivoRetencao | int? | Código CTC MtvRetenContrto; null quando não aplicável — ver domínio abaixo |
motivoCancelamento | int? | Código CTC mtvCanceltPortldd; null quando não aplicável — ver domínio abaixo |
statusAssinatura | int? | Situação do Termo de Retenção; null quando não há assinatura em curso — ver ciclo de vida da assinatura |
dtLimiteAssinatura | datetime? | Prazo para assinar o Termo; null quando não há assinatura em curso |
Respostas de erro (400)
| Código | Mensagem |
|---|---|
CONSULTA_001 | O campo ‘dataFim’ não pode ser anterior a ‘dataInicio’. |
CONSULTA_002 | O ‘cpfEmitente’ informado não é um CPF válido. |
CONSULTA_003 | O campo ‘numeroProposta’ foi informado como lista vazia. |
CONSULTA_004 | O valor '' não é válido para ‘statusOperacao’. Valores aceitos: … |
CONSULTA_006 | O campo ‘page’ deve ser maior ou igual a 1. |
Domínio — motivoRetencao
Código CTC (MtvRetenContrto). Inteiro. null quando a operação não está em retenção.
| Valor | Significado |
|---|---|
| 1 | Cliente aceitou as novas condições |
| 2 | Contrato não encontrado / modalidade divergente |
| 6 | Garantia em execução |
| 9 | CPF/CNPJ não é o titular |
| 11 | Variação de saldo/parcelas acima do permitido |
| 12 | Cliente com ação judicial |
| 13 | Contrato cedido sem coobrigação |
| 16 | Contrato já liquidado |
| 17 | Cliente não solicitou a portabilidade |
| 18 | IF credora original incorreta |
| 25 | Portabilidade em andamento |
Domínio — motivoCancelamento
Código CTC (mtvCanceltPortldd). Inteiro. Preenchido apenas quando o cancelamento veio do ACTC104.
| Valor | Significado |
|---|---|
| 3 | Saldo devedor |
| 6 | STR não liquidado |
| 7 | Cancelado pela IF proponente |
| 10 | Decurso de prazo, STR devolvida |
| 11 | Decurso de prazo |
| 14 | Decurso de prazo, garantia |
Decurso de prazo simples (
statusPortabilidade 910) devolve motivoCancelamento = null.Autorizações
Informe o token
Parâmetros de consulta
Esta página foi útil?

