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.boacompra.com/payouts | Send payouts. |
| Sandbox | https://api.sandbox.boacompra.com/payouts | Test endpoint use case scenarios. |
Sandbox testingIt 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.