PayZuDocs

API endpoints

View as Markdown
PortuguêsEnglish中文

Every route of the card API, from the token to the refund.

Getting startedAuthenticationTest cardsWebhooks

Typical integration flow

You get a token, create the charge, receive the webhook with the result, query the state whenever you need and reverse it if applicable.

Token

API authentication: exchange client_id and client_secret for a JWT token.

POSTGet API token

Charges

Creation, query and reversal of credit card charges.

POSTCreate chargeGETList chargesGETGet chargePUTReverse charge

Recurrences

Management of subscriptions created with the recurrence node in POST /charges.

GETGet recurrencePUTChange recurrence amountPUTDeactivate recurrencePUTReactivate recurrence

Currencies

Reference rates and conversion for international charges.

GETGet currency rateGETConvert amountGETList currency rates

Conventions

ItemValue
Base URL (production)https://api.payzu.io/v1
Base URL (sandbox)https://api.sandbox.payzu.io/v1
AuthenticationmTLS (client certificate) + Authorization: Bearer YOUR_TOKEN, obtained from POST /token. See Authentication
Content-Typeapplication/json
AmountsIn cents (10000 = R$ 100.00). Exchange rates (rate.bid, rate.ask) are decimals