General Business Overview
The Balance API allows you to view and monitor your account balances in real time.
There are two business models, each model with its own balance types:
Gateway
| Balance type | Description |
|---|---|
| Available | Funds that can be used immediately |
| Investment | Funds invested in investments |
Cross-Border
| Balance type | Description |
|---|---|
| Available | Funds released for use |
| Prefunding | Reserve for future transfers (only for Payout) |
| Reserved | Funds in settlement processing |
General applicability of the models:
| Business model | Use case |
|---|---|
| Gateway | Monitor account balances from provider partners View funds in financial investments from provider partners |
| Cross-border | Manage balances in multiple currencies Control reservations for cross-border operations |
Business models have their own credentials and impacts integration, each credential is generated according to the subsidiary's business model.
Use Requirements
To Integrate to PagSeguro's Balance API, Merchants must provide some recurrent requirements:
| Requirements | Use |
|---|---|
| Authentication | A valid (api-key, secret-key) pair must be informed in Request Headers. A valid pair is acquired after a Merchant Onboarding. |
| HTTP Connection | HTTP is the default protocol to connect to the API and access all BalancesREST endpoints available in the API. |
| JSON Payloads | JSON is the default API content-type. |
Production Domain and Sandbox Domain
| Domain | URL | Purpose |
|---|---|---|
| Production | https://api.international.pagseguro.com/v1/balances | Get balances. |
| Sandbox | https://api.sandbox.international.pagseguro.com/v1/balances | Test endpoint use case scenarios. |
Sandbox testing
It is highly recommendable that all tests are done in Sandbox before moving on to the Production Environment.
Testing in production can cause financial loss and live API degradation.
The balance values shown in Sandbox are for simulation purposes only and are not real.