PayZuDocs

Digital Account

One account per store, operated through the API: Pix charges, withdrawals, Pix copy-and-paste payments, transfers and statement.

Each credential operates a single account: no route takes accountId. To operate two accounts, use two credentials.

Where to start

If you want toStart with
Make the first callGetting started → Authentication
Receive by PixPix charges
Pay someonePix withdrawals or Pay a Pix copy-and-paste code
Move balance between storesTransfers between accounts
ReconcileBalance, statement and limits
Follow every changeWebhooks
Go straight to the routesAPI reference

Conventions

ItemRule
Base URLhttps://api.hub.payzu.com.br/api/v1
AmountsIntegers, in cents: 1500 is R$ 15.00.
PercentagesIn basis points: 150 is 1.5%.
DatesISO 8601 in UTC, such as 2026-10-05T14:32:05.123Z.
ListsPaginated by cursor: send the nextCursor from the response in the cursor parameter of the next call. It does not come on the last page.
Errors{ "message", "code", "details" }. Handle them by code; message is text for display.

When the balance changes

OperationThe balance changes
ChargeWhen the customer pays. The PAYMENT_PAID webhook arrives.
Withdrawal and Pix copy-and-paste paymentAt the time of the request: the amount and the fee leave the available balance. If the operation fails, they come back.
Transfer between accountsRight away: the response already carries the result.
Pix received without a chargeWhen the Pix lands in the account. The DEPOSIT_RECEIVED webhook arrives.
Refund and deposit returnAt the time of the request: the amount and the fee leave the available balance. If the refund fails, they come back.

What the API does not do

  • Boleto and card. The API does not issue boletos or charge cards. For cards, see the Cards API.
  • Respond to a MED dispute. The API shows the dispute; the response is given in the dashboard.
  • Create or change a credential. Done by the account holder, in the dashboard at hub.payzu.com.br.

Help

On this page