API endpoints
Find the route you need and see the scope, fields, responses and rejections of each one.
Base URL: https://api.hub.payzu.com.br/api/v1. GET /status needs no credential; the other routes use the credential, as in Authentication. Each route states the scope it requires.
Typical integration flow
Authentication
Charges
POSTCreate Pix charge/transactions/paymentGETList charges/transactions/paymentGETGet charge/transactions/payment/{paymentId}GETCharge receipt/transactions/payment/{paymentId}/receiptPOSTRefund charge/transactions/payment/{paymentId}/refund
Withdrawals
POSTWithdraw to Pix key/transactions/withdrawGETList withdrawals/transactions/withdrawGETGet withdrawal/transactions/withdraw/{withdrawId}GETWithdrawal receipt/transactions/withdraw/{withdrawId}/receipt
Pix copy-and-paste code and recipient
POSTDecode Pix code/transactions/pix/decodePOSTLook up recipient/transactions/pix/destinationPOSTPay Pix code/transactions/pix/qr-payments
Pix keys
GETList Pix keys/transactions/pix-keysPOSTCreate Pix key/transactions/pix-keysPUTSet default key/transactions/pix-keys/{pixKeyId}/defaultDELETEDelete Pix key/transactions/pix-keys/{pixKeyId}
Transfers between accounts
POSTTransfer to another PayZu account/transactions/internal-transferGETList transfers/transactions/internal-transferGETGet transfer/transactions/internal-transfer/{transferId}GETTransfer receipt/transactions/internal-transfer/{transferId}/receipt
Deposits
GETGet deposit/transactions/deposit/{depositId}GETDeposit receipt/transactions/deposit/{depositId}/receiptPOSTReturn deposit/transactions/deposit/{depositId}/refund
Balance, statement and limits
GETGet balance/transactions/balanceGETGet statement/transactions/statementGETGet limits and fees/transactions/limitsGETGet metrics/transactions/metrics
MED disputes
Webhooks
GETList webhook endpoints/transactions/webhooksPOSTRegister webhook endpoint/transactions/webhooksPUTUpdate webhook endpoint/transactions/webhooks/{webhookId}DELETEDelete webhook endpoint/transactions/webhooks/{webhookId}GETGet callback secret status/transactions/callback-secretPOSTIssue callback secret/transactions/callback-secretPOSTRotate callback secret/transactions/callback-secret/rotate
Status
Webhook events
What reaches your endpoint for each event. How to check the signature and when there is a new attempt: Webhooks.
PAYMENT_CREATEDPAYMENT_PAIDPAYMENT_REFUNDEDPAYMENT_EXPIREDWITHDRAW_CREATEDWITHDRAW_COMPLETEDWITHDRAW_FAILEDREFUND_COMPLETEDREFUND_FAILEDDEPOSIT_RECEIVEDINTERNAL_TRANSFER_SENTINTERNAL_TRANSFER_RECEIVEDWITHDRAW_REFUND_RECEIVEDINFRACTION_OPENEDINFRACTION_CLOSEDINFRACTION_DEADLINEACCOUNT_BLOCKEDACCOUNT_UNBLOCKED