Consultar chave PIX
curl --request GET \
--url https://api.ext.pix.dbs.moneyp.com.br/api/Chave/Consultar \
--header 'Authorization: <api-key>'import requests
url = "https://api.ext.pix.dbs.moneyp.com.br/api/Chave/Consultar"
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/Chave/Consultar', 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/Chave/Consultar",
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/Chave/Consultar"
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/Chave/Consultar")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.pix.dbs.moneyp.com.br/api/Chave/Consultar")
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>",
"chave": "<string>",
"tipoChave": 0,
"nomeCorrentista": "<string>",
"nomeFantasia": "<string>",
"tipoPessoa": 1,
"documentoFederal": "<string>",
"conta": {
"conta": "<string>",
"tipoConta": 1,
"agencia": "<string>",
"ispb": "<string>"
},
"banco": {
"descricao": "<string>",
"numero": "<string>",
"ispb": "<string>"
},
"detalhesConsulta": {
"detail": "<string>",
"violations": {
"violation": {
"reason": "<string>",
"value": "<string>"
}
}
},
"ticket": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}PIX
2 - Consultar Chave Pix
Scopes:
api.pix api.chave.consultarConsultar chave PIX
curl --request GET \
--url https://api.ext.pix.dbs.moneyp.com.br/api/Chave/Consultar \
--header 'Authorization: <api-key>'import requests
url = "https://api.ext.pix.dbs.moneyp.com.br/api/Chave/Consultar"
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/Chave/Consultar', 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/Chave/Consultar",
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/Chave/Consultar"
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/Chave/Consultar")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ext.pix.dbs.moneyp.com.br/api/Chave/Consultar")
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>",
"chave": "<string>",
"tipoChave": 0,
"nomeCorrentista": "<string>",
"nomeFantasia": "<string>",
"tipoPessoa": 1,
"documentoFederal": "<string>",
"conta": {
"conta": "<string>",
"tipoConta": 1,
"agencia": "<string>",
"ispb": "<string>"
},
"banco": {
"descricao": "<string>",
"numero": "<string>",
"ispb": "<string>"
},
"detalhesConsulta": {
"detail": "<string>",
"violations": {
"violation": {
"reason": "<string>",
"value": "<string>"
}
}
},
"ticket": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"sucesso": true,
"mensagem": "<string>"
}{
"sucesso": true,
"mensagem": "<string>"
}Por meio deste endpoint, o parceiro pode consultar uma chave Pix, ampliando suas opções de recebimento. As opções de chave incluem: CPF/CNPJ, e-mail, número de celular ou uma chave aleatória.
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/Chave/Consultar | Chave inválida |
| /api/Chave/Consultar | Necessário informar ContaDto |
| /api/Chave/Consultar | Não foi possível identificar a conta para efetuar a consulta |
| /api/Chave/Consultar | Erro Generico |
| /api/Chave/Consultar | Erro Generico |
Autorizações
Copie 'Bearer ' + token
Parâmetros de consulta
Chave PIX cadastrada à ser consultada.*
Número da agência bancária.*
Observações:
- O número da agência pode ter no máximo 4 caracteres.
Dígito verificador da agência bancária.
Observações:
- O dígito verificador da agência bancária pode ter no máximo 1 caracter.
Número da conta bancária.
Observações:
- O número da conta bancária pode ter no máximo 12 caracteres.
- Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (
contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito). - Caso o 'número da conta com dígito' (
contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito). - Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.
Dígito verificador do número da conta bancária.
Observações:
- O dígito verificador do número da conta bancária pode ter no máximo 1 caracter.
Número da conta bancária seguido do dígito verificador.
Observações:
- O número da conta seguido do dígito verificador pode ter no máximo 20 caracteres.
Tipo da conta.*
Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario
Opções disponíveis:
1, 2, 3, 4 Modelo da conta.*
Valores: 1 - Movimento 2 - Escrow 3 - Vinculada
Opções disponíveis:
1, 2, 3 Resposta
Success
Opções disponíveis:
0, 1, 2, 3, 4 Opções disponíveis:
1, 2 Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Esta página foi útil?

