Express Payouts
With Express Payouts, you can effortlessly generate mass Payouts by simply sending an Excel file containing your payout requests without API integration. This streamlined process allows you to send multiple payments with ease and accuracy efficiently.
To access the Express Payouts feature, follow the steps in this guide.
Benefits
- Instant Setup without API integration.
- Speedy and Flexible.
- 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.
Next, we describe each step and provide you with instructions.
1. Download the template by clicking here.
Open the Excel file and 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. See 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: - For USD2L, the Currency column must be USD, and the destinationCurrency is optional. - For USD2USD, both Currency and destinationCurrency must be USD. - For L2L, Currency and destinationCurrency must be the chosen country’s currency. Find the document 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. See list of countries available for Payouts. |
Payee.FirstName | Yes | First Name of the Payee. |
Payee.LastName | Yes | Last Name of the Payee. |
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. Should not contain ".", "," or "-". Find the document list here. |
Payee.Document.Number | Yes | Document number of the Payee. |
Payee.BankAccount.Number | Yes* | Bank account number of the Payee. Note: - For Argentina, set the CBU/CVU. - For Mexico, set the CLABE number. Should not contain ".", "," or "-". |
Payee.BankAccount.Type | Yes* | Account type of the Payee. Set 1 for Checking and 2 for Savings. |
Payee.BankAccount.CodeBank | Yes* | 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. |
*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.
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 downloaded the template, 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 below.
- In Colombia, some banks might take up to 24 working hours.
Additional columns for PIX
When configuring PIX as the transfer payout type (column Type set as 4), additional information based on the payee's PIX key is required. Add the following columns to your Excel file, typically next to the Notification_Url
column (which could be represented as the 'T' column in Excel):
-
PixDocument: Add this column to include the CPF/CNPJ number of the payee. The CPF number should have 11 digits, and the CNPJ number should have 14 digits.
-
PixEmail: Add this column to specify the email address of the payee.
-
PixPhone: Include this column to list the phone number of the payee. The number must start with
+55
and should be set in the text format in Excel to retain the plus sign. -
PixRandom: Use this column to add the random key generated by the payee.
You should only add one column for each type of key used in your payouts. For instance, if among five payees, one uses an email address, one uses a phone number, two use CPF/CNPJ numbers, and one uses a random key, your Excel should include respective columns for each key type used:
PixDocument | PixEmail | PixPhone | PixRandom |
---|---|---|---|
12345678901 | |||
john@doe.com | |||
+5511900001111 | |||
10987654321098 | |||
randomkey123 |
Do not include a column if it doesn’t have a value.
2. Send the template via email
Once you have filled the Excel file with the Payouts information, you can send it to Rebill. To do so, follow these steps:
- Save the file in .csv or .xlsx format.
- Send it to Rebill via email to
support@rebill.com
as an attachment.
Important: Email subject format
Please send the email with the subject in the following format:
Payouts - [Your Company Name] - [Current Date]