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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Esse endpoint utiliza o “sistema de baldes e fichas", em conformidade com o Manual Operacional do DICT.

Para mais informações sobre o funcionamento do sistema de baldes e fichas acesse Balde de Fichas. As regras de Balde de Fichas são aplicadas tanto para clientes BaaS quanto para clientes que utilizam APIs de Pix independente do BaaS.

Body Params
string
required

PayerId identificador do usuário final vinculado ao PSP. Deve o documento do usuário, em 14 dígitos, preenchidos com zero a esquerda.

string
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")

string

Identificador de transações para quem for iniciador ITP

Headers
boolean
Defaults to false

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

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json