Mass Payout
CSV Mass Payout
The Mass Payout can only process a CSV file where the fields are separated by semicolon. The file can have up to ten thousand payments.
- The fields required in the file are:
- Each line in the file must be a payee payment.
- The file must contain the following header (country;currency;paymentMethod;paymentKey;payeeName;payeeDocumentType;payeeDocumentValue)
- The delimiter will be the character “;” (semicolon)
- For values, the separator must be used. (dot) and for decimal places, (comma) should be used
- For PagBank key, the email registered in the Payee account must be used
- For the pix key, the following pattern should be used:
| Fields | Accepted Values | Description |
|---|---|---|
| Country | BR | Payee payout destination country. Enum values are ISO 3166 Standard. |
| Currency | BRL | Merchant currency of one Payout. Enum values are ISO 4217 Standard. |
| Amount | Between 0.01 and 20000.00 BRL | Money value to be transferred for certain Payee. |
| Payment Method | One of Pix and PagBank | Payment method for processing the payout. |
| Payment Key | * | This field tells the payment destination identifier. |
| Payee Name | String (max 64) | The payee's full name. |
| Payee Document Type | One of CPF and CNPJ | Payee type document: CPF (individual taxpayer registry) or CNPJ (registry of legal entities). |
| Payee Document Value | String (CPF: 11 characters | CNPJ: 14 characters) | The number of the payee's document. |
Payment Method
For PagBank
The value of the Payment Key can only be an email registered in PagBank
| Key type | Regular Expression (ECMAScript (JavaScript)) | Example |
|---|---|---|
^[a-z0-9.!#$&'*+\/=?^_{}~-]+@[a-z0-9?(?:.a-z0-9?)]*$` | [email protected] |
For PIX:
The value of the Payment Key can be an email, a cell phone number, a CPF, a CNPJ or a random key using uuid format.
Examples:
| Key type | Regular Expression (ECMAScript (JavaScript)) | Example |
|---|---|---|
| CPF | ^[0-9]{11}$ | 12345678901 |
| CNPJ | ^[0-9]{14}$ | 12345678901234 |
| Phone | ^\+[1-9][0-9]\d{1,14}$ | +5510998765432 |
^[a-z0-9.!#$&'*+\/=?^_{}~-]+@[a-z0-9?(?:.a-z0-9?)]*$` | [email protected] | |
| Random | [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} | 123e4567-e89b-12d3-a456-426655440000 |
Country code required for Phone PIX keys
When providing a phone number as a key, it MUST be provided with the country IDD (International Direct Dialing) at the beginning of the number.
For Brazillian phone numbers, for example, the field should start with “+55”.
Updated about 2 months ago