Endpoints da API
Encontre a rota que você precisa e veja o escopo, os campos, as respostas e as recusas de cada uma.
Base URL: https://api.hub.payzu.com.br/api/v1. GET /status dispensa credencial; as demais rotas usam a credencial, como em Autenticação. Cada rota informa o escopo que exige.
Fluxo típico de integração
Autenticação
Cobranças
POSTCriar cobrança Pix/transactions/paymentGETListar cobranças/transactions/paymentGETConsultar cobrança/transactions/payment/{paymentId}GETComprovante da cobrança/transactions/payment/{paymentId}/receiptPOSTEstornar cobrança/transactions/payment/{paymentId}/refund
Saques
POSTSacar para chave Pix/transactions/withdrawGETListar saques/transactions/withdrawGETConsultar saque/transactions/withdraw/{withdrawId}GETComprovante do saque/transactions/withdraw/{withdrawId}/receipt
Pix copia e cola e destinatário
POSTLer Pix copia e cola/transactions/pix/decodePOSTConsultar destinatário/transactions/pix/destinationPOSTPagar Pix copia e cola/transactions/pix/qr-payments
Chaves Pix
GETListar chaves Pix/transactions/pix-keysPOSTCriar chave Pix/transactions/pix-keysPUTDefinir chave padrão/transactions/pix-keys/{pixKeyId}/defaultDELETEApagar chave Pix/transactions/pix-keys/{pixKeyId}
Transferências entre contas
POSTTransferir para outra conta PayZu/transactions/internal-transferGETListar transferências/transactions/internal-transferGETConsultar transferência/transactions/internal-transfer/{transferId}GETComprovante da transferência/transactions/internal-transfer/{transferId}/receipt
Depósitos
GETConsultar depósito/transactions/deposit/{depositId}GETComprovante do depósito/transactions/deposit/{depositId}/receiptPOSTDevolver depósito/transactions/deposit/{depositId}/refund
Saldo, extrato e limites
GETConsultar saldo/transactions/balanceGETConsultar extrato/transactions/statementGETConsultar limites e tarifas/transactions/limitsGETConsultar métricas/transactions/metrics
Contestações MED
GETListar contestações MED/transactions/infractionsGETConsultar contestação MED/transactions/infractions/{protocol}
Webhooks
GETListar endpoints de webhook/transactions/webhooksPOSTCadastrar endpoint de webhook/transactions/webhooksPUTAlterar endpoint de webhook/transactions/webhooks/{webhookId}DELETEExcluir endpoint de webhook/transactions/webhooks/{webhookId}GETConsultar segredo de callback/transactions/callback-secretPOSTEmitir segredo de callback/transactions/callback-secretPOSTRotacionar segredo de callback/transactions/callback-secret/rotate
Status
Eventos de webhook
O que chega ao seu endpoint em cada evento. Como conferir a assinatura e quando há nova tentativa: Webhooks.
PAYMENT_CREATEDPAYMENT_PAIDPAYMENT_REFUNDEDPAYMENT_EXPIREDWITHDRAW_CREATEDWITHDRAW_COMPLETEDWITHDRAW_FAILEDREFUND_COMPLETEDREFUND_FAILEDDEPOSIT_RECEIVEDINTERNAL_TRANSFER_SENTINTERNAL_TRANSFER_RECEIVEDWITHDRAW_REFUND_RECEIVEDINFRACTION_OPENEDINFRACTION_CLOSEDINFRACTION_DEADLINEACCOUNT_BLOCKEDACCOUNT_UNBLOCKED