v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Retornar informações do DICT utilizando uma chave cadastrada no Pix

Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude.

post/pix/v1/dict/v2/key

Headers

includeStatisticsboolean

Quando enviado o IncludeStatistics como True, retornará as estatísticas da chave.

Request body

payerIdstring required

PayerId deve ser preenchido com o seu próprio CNPJ (apenas números) para realizar a consulta a uma chave Pix.

keystring required

Chave Pix a ser consultada. Poderá ser dos tipos CPF/CPNJ, e-mail, EVP (aleatória) ou telefone (com o código de país "+55")

ownerTaxIdstring

ownerTaxId deve ser preenchido com CPF ou CNPJ (apenas números) do titular da conta que pretende realizar o pagamento, será comparado com o documento do proprietário da chave

Response

keystring

keyTypestring

endtoendidstring

creationDatestring

keyOwnershipDatestring

statisticsstring

isSameTaxIdboolean

Example response

{
  "key": "teste@celcoin.com.br",
  "keyType": "EMAIL",
  "account": {
    "accountNumber": "********",
    "accountType": "********",
    "participant": "18236120"
  },
  "owner": {
    "type": "********",
    "taxIdNumber": "***778477**",
    "name": "teste celcoin"
  },
  "endtoendid": "E13935893202603231528o285mxZkw7t",
  "isSameTaxId": true
}