Consulta detalhes específicos de uma solicitação de portabilidade de chave Pix.
curl --request GET \
--url https://api.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo} \
--header 'Authorization: <api-key>'import requests
url = "https://api.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}', 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.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}",
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.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}"
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.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}")
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{
"sucesso": true,
"mensagem": "<string>",
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoContaChavePix": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperador": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chave": "<string>",
"tipoChave": 0,
"tipoReivindicacao": 1,
"idReivindicacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"participanteSolicitante": "<string>",
"agenciaSolicitante": "<string>",
"contaSolicitante": "<string>",
"nomeSolicitante": "<string>",
"documentoSolicitante": "<string>",
"tipoPessoaSolicitante": 1,
"statusReivindicacao": 0,
"prazoResolucao": "2023-11-07T05:31:56Z",
"prazoConclusao": "2023-11-07T05:31:56Z",
"dtModificacao": "2023-11-07T05:31:56Z",
"motivoConfirmacao": 0,
"motivoCancelamento": 0,
"solicitanteCancelamento": 0,
"dtInclusao": "2023-11-07T05:31:56Z",
"situacao": 0,
"msgSituacao": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}PIX
6 - Consultar Portabilidade
Scopes:
api.pix api.doacao.consultardoacaoConsulta detalhes específicos de uma solicitação de portabilidade de chave Pix.
curl --request GET \
--url https://api.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo} \
--header 'Authorization: <api-key>'import requests
url = "https://api.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}', 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.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}",
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.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}"
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.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.pix.dbs.moneyp.com.br/api/Doacao/Consultar/{codigo}")
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{
"sucesso": true,
"mensagem": "<string>",
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoConta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoContaChavePix": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoOperador": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chave": "<string>",
"tipoChave": 0,
"tipoReivindicacao": 1,
"idReivindicacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"participanteSolicitante": "<string>",
"agenciaSolicitante": "<string>",
"contaSolicitante": "<string>",
"nomeSolicitante": "<string>",
"documentoSolicitante": "<string>",
"tipoPessoaSolicitante": 1,
"statusReivindicacao": 0,
"prazoResolucao": "2023-11-07T05:31:56Z",
"prazoConclusao": "2023-11-07T05:31:56Z",
"dtModificacao": "2023-11-07T05:31:56Z",
"motivoConfirmacao": 0,
"motivoCancelamento": 0,
"solicitanteCancelamento": 0,
"dtInclusao": "2023-11-07T05:31:56Z",
"situacao": 0,
"msgSituacao": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}Por meio deste endpoint, o parceiro pode verificar a situação em que se encontram as solicitações de portabilidade de chave pix, ou seja, pode consultar um “status” das portabilidades.
Mostrar Mensagens de requisições com erro
Mostrar Mensagens de requisições com erro
O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:
| Endpoint | Mensagem de erro |
|---|---|
| /api/Doacao/Consultar/ | Nenhuma doação foi encontrada com estes parâmetros |
| /api/Doacao/Consultar/ | Código inválido |
Autorizações
Copie 'Bearer ' + token
Parâmetros de caminho
Código UUID identificador da solicitação de portabilidade de chave Pix a ser consultada.
Resposta
Success
Opções disponíveis:
0, 1, 2, 3, 4 Opções disponíveis:
1, 2 Opções disponíveis:
1, 2 Opções disponíveis:
0, 1, 2, 3, 4, 5 Opções disponíveis:
0, 1, 2, 3, 4 Opções disponíveis:
0, 1, 2, 3, 4 Opções disponíveis:
0, 1 Opções disponíveis:
0, 1, 2, 3, 4, 5, 6, 7, 8, 50, 60, 97, 98, 99 Esta página foi útil?

