Express Payouts

With Express Payouts, you can generate mass Payouts by simply uploading an Excel file containing your payout requests without API integration.

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.


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.


Col

Field

Required?

Description

A

Country

Yes

Country code in ISO 3166-2 format.

List of available countries

B

Amount

Yes

Amount with two decimals. Example: 100 = $1.00.

C

Currency

Yes

Origin currency ISO code.

D

destinationCurrency

Yes

Destination currency by model (USD2L, USD2USD, L2L).

E

Reason

No

Payout description.

F

Reference

Yes

Unique ID (cannot be duplicated).

G

Type

Yes

Transfer type.

H

PaymentCode

Yes5

Payment purpose code in China. One of the codes listed here must be provided.

I

Payee.FirstName

Yes²

Beneficiary first name.

J

Payee.LastName

Yes²

Beneficiary last name.

K

Payee.CompanyName

Yes²

Company name (if applicable).

L

Payee.Email

No

Beneficiary email.

M

Payee.Phone

No

Beneficiary phone number.

N

Payee.Birthday

No

Date of birth (YYYY-MM-DD).

O

Payee.Nationality

No

Nationality (2-digit ISO code).

P

Payee.Location.Address

Yes⁴

Beneficiary address.

Q

Payee.Location.City

Yes⁴

City of residence.

R

Payee.Location.ZipCode

No

Postal code.

S

Payee.Document.Type

Yes

Document type of the Payee.

T

Payee.Document.Number

Yes

Document number.

U

Payee.BankAccount.Number

Yes¹

CBU/CVU (AR), CLABE (MX), etc.

V

Payee.BankAccount.Swift

Yes³

SWIFT code (international).

W

Payee.BankAccount.Type

Yes¹

1=Checking, 2=Savings.

X

Payee.BankAccount.CodeBank

Yes¹

Bank code.

Y

Payee.BankAccount.Branch

No

Branch code (required for BR in transfers).

Z

Remitter.FirstName

Yes³

Remitter first name.

AA

Remitter.LastName

Yes³

Remitter last name.

AB

Remitter.CompanyName

Yes³

Remitter company name.

AC

Remitter.Birthday

No

Remitter date of birth.

AD

Remitter.Country

No

Remitter country of residence.

AE

Remitter.Address

Yes³

Remitter address.

AF

Remitter.ZipCode

No

Remitter postal code.

AG

Remitter.City

No

Remitter city.

AH

Notification_Url

No

Webhook for notifications.

1 When using Bank Transfers for Argentina, Chile, Colombia, Mexico, Peru, and Uruguay, these parameters are mandatory. For Instant Bank Transfers in Brazil, the payee.bankaccount object and its parameters must not be included in the request. For Bank Transfers to countries that require the bankaccount.Swift field, only bankaccount.number should be completed, and bankaccount.type and bankaccount.codebank must be left empty.

2 The fields firstName and lastName are mandatory for natural persons, and companyName is mandatory for legal entities (companies). If a payout is sent to a company, only the companyName field must be completed. If a payout is sent to an individual, only the firstName and lastName fields must be completed.

Important:

  • The fields firstName and lastName do not support numbers or special characters, only letters.
  • The field companyName accepts all types of alphanumeric characters.
  • The combined length of the fields firstName and lastName or companyName cannot exceed 35 characters.

3 These fields are required only for bank transfers to the following countries: Bosnia and Herzegovina, Bulgaria, Costa Rica, Dominican Republic, Egypt, Guatemala, Israel, Nicaragua, Norway, Paraguay, and Turkey.

Important:

  • The combined length of the fields Remitter -> firstName and Remitter -> lastName or Remitter -> companyName cannot exceed 35 characters.
  • The field Remitter → location → Address cannot exceed 35 characters.

4 These fields are required only for bank transfers to Egypt.

Important:

  • The field Location → City cannot exceed 20 characters.
  • The field Location → Address cannot exceed 35 characters.

5 This field is required **ONLY ** for China.

ℹ️

Important Information for Express Payouts

  • Do NOT modify the downloaded file by adding new columns, sheets or changing the column names.
  • The feature supports a maximum of 1.000 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 or BREB, it is necessary to set up the beneficiary’s key as explained in the section Additional columns for PIX or BREB.

Additional columns for PIX or BREB

When setting PIX or BREB as the Payout payment type (column Type with the value 4), you must include an additional column according to the beneficiary’s PIX or BREB key. You can configure any of the following columns by adding them next to the Notification_Url column, that is, column AI in the Excel file.

ColFieldRequired?Description
AIKey.DocumentYes*Add this column to set up the beneficiary’s **CPF/CNPJ **number in **PIX **or the valid document in BREB. The number of digits for **CPF **must be 11, and for **CNPJ **must be 14.
AJKey.EmailYes*Add this column to set up the beneficiary’s email address in PIX or BREB.
AKKey.PhoneYes*Add this column to set up the beneficiary’s phone number. For PIX, the number must start with +55, and for BREB, it MUST NOT include +57. The cell must be formatted as text to allow the use of the plus sign.
ALKey.RandomYes*Add this column to set up the random key generated by the beneficiary for PIX or BREB.
AMKey.CommerceYes*Add this column to set up the business identifier key for BREB.

* You must add one column for each different key in your payments. For example, if you have five beneficiaries — one uses an email address, one uses a phone number, one uses a document number, one uses a random key, and one uses a commerce key — you must include the columns as follows:


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.


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 .


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.