Payout API
The PagSeguro Payout API enables global businesses and platforms to send fast, compliant payouts to recipients in Brazil and LATAM. With local settlement and a developer-friendly REST API, you can transfer funds directly to individuals or businesses, without delays or high international fees. The Payout API supports the following payment methods:
- For Brazil, PagSeguro supports PIX, PagBank, and Bank Transfer.
- For Colombia, PagSeguro supports Bank Transfer.
This API is ideal for companies that need to automate disbursements such as freelancer payments, betting winnings, marketplace earnings, refunds, or incentive programs.
When to Use the API vs. MyAccount
- Use MyAccount if you prefer a web interface to manage occasional payouts manually.
- Use the Payout API to programmatically issue high-volume or recurring payouts from your platform.
Business Models
PagSeguro supports two distinct payout models. Each model uses separate credentials and is subject to different compliance rules and settlement behaviors.
| Model | Description | Ideal For |
|---|---|---|
| Cross-border | Supports international transactions, currency conversion, and settlement in foreign accounts. | Global e-commerce, freelance marketplaces, SaaS, and platforms without a local entity in Brazil. |
| Gateway | Supports local transactions, Brazilian real (BRL) payouts, and settlement to Brazilian bank accounts. | Betting and gaming platforms operating in Brazil, or companies needing strict local compliance. |
Important
You must select the appropriate business model before integration. Credentials are not interchangeable. Contact your PagSeguro representative for access and onboarding.
Credentials & Requirements
To integrate with the Payout API, you must:
- Complete business onboarding and verification (KYC/KYB).
- Obtain the correct credential set (Cross-border or Gateway).
- Ensure recipient information complies with local data requirements (e.g., CPF/CNPJ for Brazil)
PagSeguro enforces strict compliance and data validation, including PIX key verification and document type checks. Make sure your integration handles validation errors appropriately.
Supported Payout Methods
Payout options may vary depending on your business model. Common methods include:
| Method | Description | Availability | Supported Countries |
|---|---|---|---|
| PIX | Instant local transfers | Gateway and Cross-Border | Brazil |
| PagBank | Instant local transfers | Cross-Border only | Brazil |
| Bank Transfer | - Brazil: Instant local transfers - Colombia: Bank transfer | Gateway and Cross- Border | Brazil and Colombia |
Bank Transfer in Colombia
For additional information about the time to execute the bank transfer, get in touch with your account manager.
Reference Pages for Payout API
To help you implement and troubleshoot the Payout API, the following pages offer detailed guidance on key aspects of configuration, validation, and integration:
- Payout Authorization: Learn how to authenticate API requests using Basic Authentication with your API key and secret.
- Payout API Environments: Understand the differences between Sandbox and Production environments.
- Amount Value Validation: Explains minimum and maximum limits for payout amounts by country and business model.
- Bank Transfer Validation: Overview of required formats for bank codes, branches, and account numbers.
- Payout API Status Codes: Describes the HTTP response codes the Payout API may return.
- Payout Status Description: Detailed table of all possible payout statuses.
- PIX Key Formats and Validation Rules: Lists supported PIX key types and the regex used to validate each format.
- Payee Document Formats and Validation Rules: Country-specific rules document types, including format descriptions and regex.
Next Steps
To learn how to use the Payout API, access the guides available to create or search created payouts:
-
Create a Payout: Learn how to issue a payout using the API, including required fields, validation, and sample requests.
-
Search for Payouts: Retrieve details and statuses of previously created payouts.
-
Search for Payout CSV Reports: Generate and download reports for payout activity directly via the API.
Updated 25 days ago