curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.dev.br/api/Chave/Listar \
  --header 'Authorization: <api-key>'
{
  "sucesso": true,
  "mensagem": "<string>",
  "chaves": [
    {
      "chave": "<string>",
      "tipoChave": 0,
      "nomeCorrentista": "<string>",
      "tipoPessoa": 1,
      "documentoFederal": "<string>"
    }
  ]
}

Through this endpoint, partners can query and list the Pix keys associated with their account. Both clients and partners can perform this check, provided they have previously registered their keys.

Authorizations

Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

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.

chaves
object[] | null

Lista de Chaves PIX.

Was this page helpful?