Create Payouts

📘 Authorization

Make sure your requests are properly authenticated, check the Payout API Authorization before executing your first request.

📘 Data Requirements

Ensure your request body follows the correct format and validation rules:

  • Amount Value Validation
  • Bank Transfer Validation
  • PIX Key Formats and Validation Rules
  • Payee Document Validation and RegEx

📘 Understanding Responses

Learn how to interpret the status of your requests and individual payout items:

  • Payout API Status Codes
  • Payout Status Description
post/payouts

Request

  • Base URL
    https://api.sandbox.international.pagseguro.com
  • URL
    https://api.sandbox.international.pagseguro.com/payouts
  • Auth
    none required

Headers

Content-Typestring required
Authorizationstring required

Your Authorization header, calculated with your api-key and your secret-key. Please refer to the recipe above on how to generate it.

X-Api-Versionstring required

Request body

referencestring required

Unique Reference for a Batch. It must be generated and informed by the Merchant. Accepts alphanumeric and hyphen.

notification_urlstring required

URL for further notifications.

Response

204

Changes

No recorded changes to this operation across all 1 revision of this API.