PayZu PixPagar com Pix

Consultar uma chave Pix


Mostre a quem vai confirmar o pagamento o titular e a instituição de uma chave Pix antes de enviar.

Consulte o titular e a conta

bash
curl "https://pix.sandbox.payzu.dev/v1/pix/key?pixKey=12345678901" \
  -H "Authorization: Bearer SEU_TOKEN"

Referência: Consultar o titular e a conta de uma chave Pix

CampoO que esperar
documentPode vir mascarado ou não, conforme a instituição que faz a consulta. No sandbox, o CPF vem inteiro.
branch, accountNumber, accountType, personTypeDependem da instituição e podem vir vazios.

A consulta não reserva saldo nem consome o limite diário de saque; o pagamento é outra chamada, POST /withdraw. Consulte cada chave uma vez, quando o usuário terminar de digitar.

A chave de celular precisa do código do país.

Envie +5511999999999 ou 5511999999999. Sem o 55, a API não reconhece o celular. Veja Tipos de chave Pix.

A consulta consome o limite de consultas da conta.

Ao estourar o limite, a resposta é 429, com o tempo de espera em retryAfterSeconds.

Para ver o recebedor de um QR Code, use Ler um QR Code.

Erros desta operação

CódigoHTTPMensagem
PZK400403Consulta de chave Pix não habilitada para o usuário.
PZK300404Chave Pix não encontrada.
PZK200422Chave Pix inválida.
PZI110424Erro de comunicação com a instituição financeira.
PZI111424A instituição financeira demorou para responder. Tente novamente.
PZK501424Consulta de chave Pix temporariamente indisponível. Tente novamente.
PZG429429Limite de consultas atingido. Tente novamente em breve. Tente novamente em 30s.

Os códigos de autenticação e de validação estão no Catálogo de erros.