Express Payouts
To access the Express Payouts feature, open your Merchant console and expand Payout, then Express Payouts.
Benefits
- Instant Setup without API integration.
- Speedy and Flexible using batch upload.
- Centralize your Payouts with minimum effort.
How to use Express Payouts?
Express Payouts has an easy-to-follow step sequence that allows you to create one or more payouts simultaneously. Once you complete a step, the sequence activates the next to avoid errors.
Next, we describe each step and provide you with instructions.
1. Download the template
The first step is downloading the Express Payouts template. This Excel file has all the information related to a payout and provides examples of how to fill it.
Click the Download template button to get the Excel file.
Once you have the Excel file, you can fill it with the information of the Payouts. Each row represents a new Payout request and has the following columns.
| Field | Mandatory? | Description | |
|---|---|---|---|
| Country | Yes | ISO code of the country in the format ISO 3166-2.List of countries available for Payouts. | |
| Amount | Yes | Amount of the Payout, the format has two digits for decimals. Example 100 => $ 1,00. | |
| Currency | Yes | ISO code of your account’s currency, which corresponds to the origin currency. Find the currencies list here. | |
| destinationCurrency | Yes | ISO code of the currency in which the beneficiary will receive the payout. This currency must meet the model of your account. For example:
Find the currencies list here. | |
| Reason | No | Description of the Payout. | |
| Reference | Yes | Unique identifier of the Payout defined by you. This reference should not appear more than once in the file or exist in previous Payouts.. | |
| Type | Yes | Transfer Payout type. List of countries available for Payouts. | |
| Payee.FirstName | Yes2 | First Name of the Payee. | |
| Payee.LastName | Yes2 | Last Name of the Payee. | |
| Payee.CompanyName | Yes2 | Name of the company. | |
| Payee.Email | No | Email address of the Payee. | |
| Payee.Phone | No | Phone number of the Payee. | |
| Payee.Address | No | Address of the Payee. | |
| Payee.Document.Type | Yes | Document type of the Payee. Find the document list here. | |
| Payee.Document.Number | Yes | Document number of the Payee. | |
| Payee.BankAccount.Number | Yes1 | Bank account number of the Payee. Take into account the following considerations:
| |
| Payee.BankAccount.Type | Yes1 | Account type of the Payee. Set 1 for Checking and 2 for Savings. | |
| Payee.BankAccount.CodeBank | Yes1 | Bank code of the Payee. | |
| Payee.BankAccount.Branch | No | Branch code of the Payee’s bank. This field applies only to Brazil and is mandatory when using Bank transfer as the Payout type. | |
| Notification_Url | No | Webhook to notify the result of the Payout. For more information about the configuration of this webhook, refer to this article. |
1 When using Bank transfer, these parameters are mandatory for ALL countries. For Instant Bank Transfer in Brazil, the columns Payee.BankAccount.Type, Payee.BankAccount.CodeBank, and Payee.BankAccount.Branch must not be present in the request.
2 The fields firstName and lastName for an individual and companyName for a legal person (company) are mandatory. If a payout is sent for a company only the companyName field has to be filled in, and if a payout is sent to a natural person only the firstName and lastName fields have to be filled in.
Important about Express Payouts
- Do NOT modify the downloaded file by adding new columns, sheets or changing the column names.
- The feature supports a maximum of 100 records per file. If you need to include more, repeat the procedure for the remaining payouts.
- If you already have the template downloaded, it is not required to download it again.
- You can save the file using any name of your choice.
- When using PIX, you need to configure the PIX key of the payee as explained in the Additional fields for PIX section.
Additional columns for PIX
When configuring PIX as the transfer payout type (column Type set as 4), you must include an additional column depending on the payee’s PIX key. You can configure any of the following columns, setting them next to the Notification_Url, namely the U column in the Excel file:
PixDocument: add this column to configure the CPF/CNPJ number of the payee. The number of digits for CPF must be 11, and CNPJ must be 14.PixEmail: add this column to configure the email address of the payee.PixPhone: add this column to configure the phone number of the payee. The number must start with+55, and the cell must be configured with text format to allow the use of the plus sign.PixRandom: add this column to configure the random key the payee generates.
You must add one column per different key in your payouts. For example, if you have five payees, one uses an email address, one uses the phone number, two use the CPF/CNPJ number, and one uses the random key, you need to include the columns as follows:
Do not include a column if it doesn’t have a value.
2. Select the account
The second step involves choosing the account that will debit the Payout amounts. Ensure that the selected account has a sufficient balance to process all payouts.
Open the Select the account dropdown list and select the account you want to use.
3. Upload the template
Once you select the account in step 2, the process activates this step. Click the Upload template button to upload the file created in step 1.
4. Upload results
If all the Payouts are correct and there were no errors in the file, the system prompts you with the number of Payouts created.
Otherwise, the Express Payouts feature informs the number of successful and failed Payouts. You can consult the error of the failed Payouts in the Excel file we generate using the available link.
Refer to the last column in the file to know the Payout error.
After fixing the error, save the file and upload it using the option in step 3.
Regardless if the Payout was successful or not, you can consult it in the Payouts Report. Successful Payouts have Pending status and failed Payouts have Declined status.
