General Business Overview
We have two business models, and each of these models has its own credentials, which impact the integration. Each credential is generated according to the subsidiary and the business model (cross-border or gateway).
| Business model | Description | Key Features | Ideal for | Case Use |
|---|---|---|---|---|
| Cross-border | Facilitates international transactions, involving multiple countries and currencies. | - Transactions across countries - Bank accounts in multiple countries - Currency conversion - Settlements in foreign accounts | - Businesses operating in multiple countries - Companies accepting payments in various currencies - Global customer base | Global E-commerce. Online stores selling internationally, accepting payments in different currencies, and shipping worldwide. |
| Gateway | Acts as a local intermediary between your business and domestic payment systems. | - Local transaction processing - Local bank accounts - No currency conversion - Direct settlement to local bank accounts | - Businesses operating primarily in one country - Companies requiring compliance with local regulations | Betting in Brazil. Required for betting platforms due to local regulations. Ensures transactions are processed within Brazil’s financial system using methods like PIX. |
Use Requirements
To Integrate to PagSeguro's Payout 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 Payout REST endpoints available in the API. |
| JSON Payloads | JSON is the default API content-type. |
| Unique Code References | Unique code references for every batch and every Payout. Code references are further used for queries. |
| Notification URL | URL for further notifications about batch status change. |
| Payee Data | For each Payout (payee Pagbank email / PIX key, money amount and currency). |
Production Domain and Sandbox Domain
| Domain | URL | Purpose |
|---|---|---|
| Production | https://api.international.pagseguro.com/payouts | Send payouts. |
| Sandbox | https://api.sandbox.boacompra.com/payouts | 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.