Skip to main content
Listar chaves PIX
curl --request GET \
  --url https://api.ext.pix.dbs.moneyp.com.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, the partner can query and list the Pix keys associated with their account. Both customers and partners can perform this verification, as long as 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.*

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

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

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Available options:
1,
2,
3

Response

200 - application/json

Success

sucesso
boolean
mensagem
string | null
chaves
object[] | null
I