PayZu PixDICT (Diretório de Identificadores de Contas Transacionais)

Consultar o titular e a conta de uma chave Pix

GET/pix/key

Confira o passo a passo → https://docs.payzu.com.br/docs/pix/look-up-key-or-qr-code


Query Params

pixKeystringobrigatório
Chave Pix a consultar.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Chave encontrada
pixKeystringChave consultada.
documentstringCPF ou CNPJ do titular, mascarado.
namestringTitular da chave.
branchstringAgência, mascarada.
accountNumberstringConta, mascarada.
personTypestringTipo de pessoa; vazio quando não informado.
PFPJ""
accountTypestringTipo de conta no DICT.
institutionIspbstringISPB da instituição da conta.
institutionCodestringCódigo COMPE da instituição.
institutionNamestringInstituição da conta.
400Requisição inválida
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsarray of objectsErros de validação por campo.
Campos de cada item 2
fieldstringCampo rejeitado.
messagestringMotivo da rejeição.
401Token ausente ou inválido
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
403Acesso negado
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
404Chave não encontrada
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
422Chave inválida
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
424Falha na instituição financeira
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
429Limite de requisições atingido
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
retryAfterSecondsintegerSegundos de espera antes de tentar de novo.
500Erro interno
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.

Linguagem

Credenciais Bearer

Token de API

Gerar credencial de sandbox

curl --request GET \     --url https://pix.sandbox.payzu.dev/v1/pix/key \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json