PayZu Conta HubDICT (Diretório de Identificadores de Contas Transacionais)

Consultar o recebedor de uma chave ou QR Code

POST/transactions/pix/destination

Confira o passo a passo → https://docs.payzu.com.br/docs/account-hub/look-up-the-recipient


Body Params

pixKeystring
Chave Pix a consultar.
pixKeyTypestring enum
Tipo da chave Pix.EVPCNPJCPFEMAILPHONE
brCodestring
Código Pix copia e cola a consultar.

Headers

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

Responses

200Destinatário encontrado
sourcestringIndica se a consulta foi por chave ou por copia e cola.
PIX_KEYBR_CODE
pixKeystringChave de destino; CPF, e-mail e telefone vêm mascarados.
pixKeyTypestring | nullTipo da chave, deduzido do formato.
EVPCNPJCPFEMAILPHONE
holderobject | nullTitular da chave.
Campos do objeto 2
namestring | nullNome completo do titular.
documentstring | nullCPF ou CNPJ do titular, com o CPF mascarado.
bankobject | nullInstituição de destino do Pix.
Campos do objeto 2
namestring | nullNome da instituição.
ispbstring | nullISPB da instituição de destino.
branchstring | nullAgência da conta de destino.
accountNumberstring | nullConta de destino, com os 4 últimos dígitos visíveis.
amountinteger | nullValor fixado no código, em centavos.
isAmountFixedbooleanIndica se o código fixa o valor.
isVerifiedbooleanIndica se o nome veio do DICT, e não do QR Code.
400Requisição inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
401Credencial ausente ou inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
403Acesso negado
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
404Chave não encontrada
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
412Pré-requisito pendente
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
422Operação recusada
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
429Limite de requisições atingido
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
502Falha na instituição financeira
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
503Serviço indisponível
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.

Linguagem

Credenciais Bearer

Token de API

curl --request POST \     --url https://api.sandbox.payzu.dev/api/v1/transactions/pix/destination \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

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

application/json