API
Status PageSuporte

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

post
https://sandbox.openfinance.celcoin.dev/pix/v1/dict/v2/key

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 deve ser preenchido com o seu próprio CNPJ (apenas números) para realizar a consulta a uma chave Pix.

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

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

Headers
boolean
Defaults to false

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

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

Updated 3 months ago