References

PagSeguro offers three main APIs to support diverse payment and payout flows across Latin America:

• International Payin API: Accept international payments in local currencies using popular payment methods.

• Brazil Payin API: Process domestic payments in Brazil with options tailored to the Brazilian market.

• Payout API: Send funds to users, partners, or merchants across supported countries.

This reference section is your starting point to explore each API, understand how authentication works, test endpoints, and integrate with the PagSeguro platform.

Authentication

Each API requires specific credentials and authentication mechanisms. Start by reviewing the authorization guide for the API you intend to use:

• International Payin API Authentication

• Brazil Payin API Authentication

• Payout API Authentication

Environments

PagSeguro provides both Sandbox and Production environments for development and live transactions. Each environment uses different credentials and endpoints. Learn more on the API Environments page.

API References

To help you implement and troubleshoot the PagSeguro APIs, the documentation includes pages that offer detailed guidance on key aspects of configuration, validation, and integration. There are two groups of reference pages, one for the International and Brazil Payin APIs and another for the Payout API.

International and Brazil Payin APIs

• Document Validation: Understand the document types and formats required to identify payers.

• Maximum and Minimum Supported Amounts: View transaction limits per country to ensure your payments fall within allowed thresholds.

• Supported Countries: See the full list of countries where the International PayIn API can be used.

• Supported Currencies: Check which currencies are available.

• Payment Methods: Check the available payment methods enums you can use when creating a payment with PagSeguro.

• Transaction Status Description: Learn about the possible transaction and refund statuses.

• Reason Codes: Understand the detailed reason codes returned in transaction responses.

• Supported Languages: Find out which languages are supported for displaying information to payers.

Payout API

• 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.