curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/Chave/Consultar \
  --header 'Authorization: <api-key>'
{
  "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"
}

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.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
Chave
string

Chave PIX cadastrada à ser consultada.

​
ContaDto.Agencia
string

Número da Agência Bancária.

​
ContaDto.AgenciaDigito
string

Dígito verificador da Agência Bancária.

​
ContaDto.Conta
string

Número da Conta Bancária.

​
ContaDto.ContaDigito
string

Dígito verificador do número da Conta Bancária.

​
ContaDto.ContaPgto
string

Número da Conta Bancária seguido do dígito verificador.

​
ContaDto.TipoConta
enum<integer>

1 = Corrente<br>2 = Poupanca<br>3 = Pagamento<br>4 = Salario

Available options:
1,
2,
3,
4
​
ContaDto.ModeloConta
enum<integer>

1 = Movimento<br>2 = Escrow<br>3 = Vinculada

Available options:
1,
2,
3

Response

200 - application/json
Success
​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
chave
string | null

Chave PIX consultada.

​
tipoChave
enum<integer>

0 = CPF; 1 = CNPJ; 2 = TELEFONE; 3 = EMAIL; 4 = EVP

Available options:
0,
1,
2,
3,
4
​
nomeCorrentista
string | null

Nome completo do correntista associado à chave.

​
nomeFantasia
string | null

Nome fantasia do correntista associado à chave. Obs.: Apenas para chaves de correntistas PJ

​
tipoPessoa
enum<integer>

1 = PF; 2 = PJ

Available options:
1,
2
​
documentoFederal
string | null

Documento do correntista associado à chave. CPF ou CNPJ, à depender da natureza do correntista.

​
conta
object
​
banco
object
​
detalhesConsulta
object
​
ticket
string | null

Identificador UUID da consulta de uma Chave PIX, usado para rastrear a consulta de Chave feita e recuperar essas informações ao enviar uma Transação PIX.

Esta página foi útil?