Pular para o conteúdo principal
Consultar chave PIX
curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.com.br/api/Chave/Consultar \
  --header 'Authorization: <api-key>'
{
  "sucesso": true,
  "mensagem": "<string>",
  "chave": "<string>",
  "nomeCorrentista": "<string>",
  "nomeFantasia": "<string>",
  "documentoFederal": "<string>",
  "banco": {
    "descricao": "<string>",
    "numero": "<string>",
    "ispb": "<string>"
  },
  "detalhesConsulta": {
    "detail": "<string>",
    "violations": {
      "violation": {
        "reason": "<string>",
        "value": "<string>"
      }
    }
  },
  "ticket": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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.

Autorizações

​
Authorization
string
header
obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

​
Chave
string

Chave PIX cadastrada à ser consultada.*

​
ContaDto.Agencia
string

Número da agência bancária.*

Observações:

  • O número da agência pode ter no máximo 4 caracteres.
​
ContaDto.AgenciaDigito
string

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.
​
ContaDto.Conta
string

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.
​
ContaDto.ContaDigito
string

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.
​
ContaDto.ContaPgto
string

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.
​
ContaDto.TipoConta
enum<integer>

Tipo da conta.*

Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario

Opções disponíveis:
1,
2,
3,
4
​
ContaDto.ModeloConta
enum<integer>

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Opções disponíveis:
1,
2,
3

Resposta

Success

​
sucesso
boolean
​
mensagem
string | null
​
chave
string | null
​
tipoChave
enum<integer>
Opções disponíveis:
0,
1,
2,
3,
4
​
nomeCorrentista
string | null
​
nomeFantasia
string | null
​
tipoPessoa
enum<integer>
Opções disponíveis:
1,
2
​
documentoFederal
string | null
​
banco
object
​
detalhesConsulta
object
​
ticket
string<uuid> | null