---
title: "Create Payouts"
method: POST
path: "/payouts"
---

# Create Payouts

`POST /payouts`

## Request

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

> 📘 Authorization
>
> Make sure your requests are properly authenticated, check the [Payout API Authorization](ref:payout-authentication) before executing your first request.

> 📘 Data Requirements
>
> Ensure your request body follows the correct format and validation rules:
>
> - [Amount Value Validation](ref:amount-value-validation)
> - [Bank Transfer Validation](ref:bank-transfer-validation)
> - [PIX Key Formats and Validation Rules](ref:pix-key-formats-and-validation-rules)
> - [Payee Document Validation and RegEx](ref:payee-document-validation-and-regex)

> 📘 Understanding Responses
>
> Learn how to interpret the status of your requests and individual payout items:
>
> - [Payout API Status Codes](ref:payout-api-status-codes)
> - [Payout Status Description](ref:payout-status-description)

## Headers

- `Content-Type` string, required
- `Authorization` string, required
- `X-Api-Version` string, required

## Request body

- object
  - `reference` string, required: Unique Reference for a Batch. It must be generated and informed by the Merchant. Accepts alphanumeric and hyphen.
  - `notification_url` string, required: URL for further notifications.
  - `items` object[], required: Array of items containing every payout of one batch.
    - `reference` string, required: Unique Reference for one Payout. It must be generated and informed by the Merchant. Accepts alphanumeric and hyphen.
    - `method` 'PAGBANK' | 'PIX' | 'BANK_TRANSFER', required: Payment method for processing the payout.
    - `country` 'BR' | 'CO', required: Payee payout destination country. Enum values are ISO 3166 Standard.
    - `destination` object
      - `email` string: <span class="text-highlight-red">Mandatory only for PagBank</span> payouts.<br /> Email that identifies a Payout to be claimed by its Payee.
      - `key` string: <span class="text-highlight-red">Mandatory only for PIX</span> payouts.<br />PIX key that identifies a PIX Payout to be claimed by its Payee.<br />_For more info on PIX key validation and regex, click **[here](ref:pix-key-validation-and-regex)**_.
      - `bank` object: <span class="text-highlight-red">Mandatory only for Bank Transfer</span><br />Payee bank parameters.<br />_For more info on bank parameters validation and regex, click **[here](ref:bank-parameters-validation-and-regex)**_.
        - `code` string, required: <span class="text-highlight-red">Mandatory for Bank Transfer</span><br />Payee bank code. />_For more info on bank code validation and regex, click **[here](ref:bank-parameters-validation-and-regex)**_.
        - `account` object
          - `type` string, required: <span class="text-highlight-red">Mandatory for Bank Transfer.</span><br />Payee account type.<br />_For more info on account type validation and regex, click **[here](ref:bank-parameters-validation-and-regex)**_.
          - `branch` string, required: <span class="text-highlight-red">Mandatory for Bank Transfer.</span><br />Payee branch number.<br />_For more info on branch number validation and regex, click **[here](ref:bank-parameters-validation-and-regex)**_.
          - `number` string: <span class="text-highlight-red">Mandatory for Bank Transfer.</span><br />Payee account number.<br />_For more info on account number validation and regex, click **[here](ref:bank-parameters-validation-and-regex)**_.
    - `amount` object
      - `value` number, float, required: <span class="text-highlight-red"></span><br />Money value to be transferred for certain Payee,<br />_For more info on amount value validation and regex, click **[here](ref:amount-value-validation-and-regex)**_.
      - `currency` 'BRL' | 'COP', required: Merchant currency of one Payout. Enum values are ISO 4217 Standard.
    - `payee` object
      - `name` string, required: Payee name. Regex pattern /^[a-zA-ZàáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ð ']+$/u
      - `document` object
        - `type` 'CPF' | 'CNPJ' | 'CC' | 'CE' | 'TI' | 'NIT', required: Payee type document
        - `value` string, required: <span class="text-highlight-red"></span><br />Payee document number.<br />_For more info on payee document validation and regex, click **[here](ref:payee-document-validation-and-regex)**_.

## Response `204`

204

## Other responses

- `400`: 400
- `401`: 401
- `403`: 403 - Forbidden

---

[API](https://skmtc.dev/pagseguro/apis/payout-api.md) - [All operations](https://skmtc.dev/pagseguro/apis/payout-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pagseguro/apis/payout-api/revisions/e09f41f79fa0?raw)