PayZu Conta HubPagar com Pix

Enviar um Pix para uma chave


Nesta páginaEnvie o PixConfirme a entregaErros desta operação

Envie dinheiro da sua conta para uma chave Pix de qualquer instituição, informando o valor que o destino recebe e contando com a tarifa debitada além dele.

Envie o Pix

CampoRegra
Idempotency-KeyCabeçalho. Gere uma nova por saque e guarde-a com o pedido.
amountValor em centavos.
pixKeyChave de destino.
pixKeyTypeInforme sempre que souber. Sem ele, a API deduz pelo formato, e uma chave de 11 dígitos pode ser lida como CPF ou como celular.
commentOpcional.

Para mostrar o titular da chave antes de confirmar, veja Consultar o recebedor.

bash
IDEMPOTENCY_KEY=$(uuidgen)

curl --request POST \
  --url 'https://api.sandbox.payzu.dev/api/v1/transactions/withdraw' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 10000,
    "pixKey": "fulano@exemplo.com",
    "pixKeyType": "EMAIL",
    "comment": "Repasse semanal"
  }'

Referência: Enviar um Pix para uma chave

Se a chamada falhar ou ficar sem resposta, repita com a mesma Idempotency-Key e os mesmos dados.

A rota retorna o saque existente, no estado em que estiver. Reaproveitar a mesma chave com outro valor ou destino dá 409. A cota é de 5 saques por minuto por credencial e 10 por conta, contando também pagamentos de copia e cola e devoluções.

Confirme a entrega

Dê o pagamento como feito só quando chegar WITHDRAW_COMPLETED.

AvisoQuando chega
WITHDRAW_CREATEDA reserva saiu do saldo.
WITHDRAW_COMPLETEDO dinheiro chegou.
WITHDRAW_FAILEDO saque não saiu e a reserva voltou, com o motivo em reason.
WITHDRAW_REFUND_RECEIVEDQuem recebeu devolveu o valor, inteiro ou em parte. Traz withdrawId e o depositId da entrada.

Os corpos estão em Saque criado, Saque concluído, Saque falhou e Devolução de saque recebida. A consulta do saque serve para conciliar e para o caso de um aviso não chegar.

O saque não tem externalRef.

Guarde o id da resposta com o seu pedido para casar os avisos.

Erros desta operação

CódigoHTTPMensagem
WITHDRAW_INVALID_PIX_KEY400A chave PIX é inválida: CPF ou CNPJ com dígito verificador errado, ou 11 dígitos que não são CPF nem celular com DDD.
WITHDRAW_PIX_KEY_TYPE_MISMATCH400O tipo informado não corresponde ao formato da chave PIX.
WITHDRAW_DISABLED403Saque desabilitado para esta conta.
WITHDRAW_ABOVE_TICKET_MAX422O valor excede o máximo permitido para saque.
WITHDRAW_BELOW_TICKET_MIN422O valor é inferior ao mínimo permitido para saque.
WITHDRAW_DAILY_LIMIT422O limite diário de saque desta conta foi atingido.
WITHDRAW_INSUFFICIENT_BALANCE422Saldo insuficiente para este saque.
WITHDRAW_INSUFFICIENT_PROVIDER_BALANCE422O saldo desta conta não cobre este saque agora.
WITHDRAW_PIX_KEY_REFUSED_BY_PROVIDER422A chave PIX de destino foi recusada.
WITHDRAW_UNRECOGNIZED_PIX_KEY422A chave PIX informada não corresponde a nenhum formato válido.

Todos os códigos do PayZu Conta Hub estão no Catálogo de erros.