{settings.title} API documentation.
The Gateway API lets you integrate payments and financial management into your application, including Pix, boleto, card, and crypto payments, subscriptions, withdrawals, transfers, balance queries, transaction queries, and webhooks.
This documentation covers only the Gateway. The sub/acquirer documentation rendered through Swagger/Scalar is not included here.
Base URL
Use the base URL below for all requests:REST format
The API follows REST principles and uses standard HTTP status codes to indicate success or failure.Best practices
- Use webhooks to track status changes.
- Avoid frequent polling on query endpoints.
- Never expose private keys in source code, frontend code, or repositories.
- Use
callbackUrlper operation when you need specific URLs for notifications.