Create Payout

The customer's first name.</br><strong>Data validation:</strong> [A-Z] </br><strong>Length : AR, BR</strong>: 255 | <strong>CL, MX, CO, EC, PE</strong>: 32

The customer's last name.</br><strong>Data validation:</strong> [A-Z] </br><strong>Length : AR, BR</strong>: 255 | <strong>CL, MX, CO, EC, PE</strong>: 32

The type of document used to identify the customer</br><strong>Length : AR</strong>: 1 | <strong>BR</strong>: 1 | <strong>CL</strong>: 6 | <strong>MX, CO, EC, PE</strong>: 2</br><strong>Value per country:</strong> <a href="https://payretailers.readme.io/reference/payout-parameters#document-type">AR</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#document-type-1">BR</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#document-type-2">CL</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#document-type-3">MX</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#document-type-4">CO</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#document-type-5">EC</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#document-type-6">PE</a>

<strong style="color:red;">CL Only. Required.</strong></br>Used to define if your customer is a physical person or a company.<strong></br>Values:</strong> person | company

The personal ID of the customer.</br><strong>Data validation:</strong> [A-Z][0-9]</br><strong>Length : AR</strong>: 8 | <strong>BR</strong>: 11 | <strong>CL</strong>: 9 | <strong>MX</strong>: 18 | <strong>CO</strong>: 6-10 | <strong>EC</strong>: 10 | <strong>PE</strong>: 9

The customer's email address.</br><strong>Data validation:</strong> [A-Z][0-9][-&_]@[A-Z][0-9].[A-Z]</br><strong>Length:</strong> 255

<strong style="color:red;">Required in BR, PE and AFRICA. Optional in AR, CL & MX. Do not include for CO.</strong></br>The customer's phone number. Can include special characters like +().</br><strong>Data validation:</strong> [0-9][()+]</br><strong>Length : AR, BR, CL, MX</strong>: 13 | <strong>PE</strong>: 9-11

<strong style="color:red;">AR BR CL MX Only. Optional.</strong></br>The gender of the customer.</br><strong>Data validation:</strong> *</br><strong>Length:</strong> 20

The country code of the payout. </br><strong>Length:</strong> 2</br><strong>Values</strong>: AR | BR | CL | CO | EC | MX | PE

<strong style="color:red;">Do not include for CO.</strong></br>The city of the customer.</br><strong>Data validation:</strong> *</br><strong>Length:</strong> 150

<strong style="color:red;">Do not include for CO.</strong></br>The billing address of the customer.</br><strong>Data validation:</strong> *</br><strong>Length : AR, BR</strong>: 255 | <strong>CL, MX, EC, PE</strong>: 70

The currency code of the currency used for the payout.</br><strong>Length:</strong> 3</br><strong>Values: AR:</strong> ARS | <strong>BR:</strong> BRL | <strong>CL:</strong> CLP | <strong>CO:</strong> COP | <strong>EC:</strong> USD | <strong>MX:</strong> MXN | <strong>PE:</strong> PEN | ALL: USD

The amount of the payout</br><strong>Data validation:</strong> [0-9]</br><strong>Length : AR, BR, CL, MX</strong>: 18,2 | <strong>CO, EC, PE</strong>: 11,2

The URL used to send <a href="https://payretailers.readme.io/reference/notifications">notifications</a> when a payout is created and changes status.</br><strong>Data validation:</strong> [0-9] [a-z] [(-), (_), (.), (~)]</br><strong>Length:</strong> 255

Channel through which the payout will be processed.</br>ONLINE for traditional bank transfers. PIX included for BR. BREB included for CO.</br><strong>Values: </strong>ONLINE, PIX, BREB

<strong style="color:red;">BR Only. Optional.</strong></br>The PIX key of the customer. Include if the payout must be done via PIX payout.</br><strong>Data validation:</strong> [A-Z][-][0-9]</br><strong>Length:</strong> MAX</br><strong>Value: </strong><a href="https://payretailers.readme.io/reference/payout-parameters#recipient-pix-key">Recipient Pix Key</a>

The recipient's Bre-B key: phone, email, national document, or alphanumeric prefixed with "@" (e.g. @VUZ8FX8R).

The account number of the customer.</br><strong>Data validation:</strong> [0-9]</br><strong>Length : AR</strong>: 22 | <strong>BR</strong>: 13 | <strong>CL:</strong> See special requirements | <strong>CO</strong>: 16 | <strong>MX</strong>: 16 or 18 (See special requirements) | <strong>EC</strong>: 12 | <strong>PE</strong>: see special requirements</br><strong style="color:red;">Some countries have special requirements: </strong><a href="https://payretailers.readme.io/reference/payout-parameters#account-number">AR</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#account-number-requirements">PE</a> | <a href="https://www.payretailers.dev/reference/payout-parameters#/account-type-2">MX</a> | <a href="https://www.payretailers.dev/reference/payout-parameters#/chile">CL</a>

<strong style="color:red;">BR Only. Required.</strong></br>The agency code of the bank provided by the bank.</br><strong>Length:</strong> 6</br><strong>Value: </strong><a href="https://payretailers.readme.io/reference/payout-parameters#account-agency-number">Account Agency Number</a>

A code that identifies the type of account used by the user.</br><strong>Length : AR</strong>: 1 | <strong>BR, CL, MX, CO, EC, PE</strong>: 4</br><strong>Value per country: </strong><a href="https://payretailers.readme.io/reference/payout-parameters#bank-name-and-payout-account-type-code">AR</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#account-type">BR</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#account-type-1">CL</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#account-type-2">MX</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#account-type-3">CO</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#account-type-4">EC</a> | <a href="https://payretailers.readme.io/reference/payout-parameters#account-type-5">PE</a>

The code that identified the bank used by the customer.</br><strong>Length : AR</strong>: 1 | <strong>BR, CL</strong>: 3 | <strong>MX</strong>: 5 | <strong>CO, EC, PE</strong>: 4 </br><strong>Value per country: </strong><a href="https://payretailers.readme.io/reference/payout-parameters#bank-name-and-payout-account-type-code">AR</a> | <a href="https://www.payretailers.dev/reference/payout-parameters#bank-name">BR</a> | <a href="https://www.payretailers.dev/reference/payout-parameters#bank-name-1">CL</a> | <a href="https://www.payretailers.dev/reference/payout-parameters#bank-name-2">MX</a> | <a href="https://www.payretailers.dev/reference/payout-parameters#bank-name-3">CO</a> | <a href="https://www.payretailers.dev/reference/payout-parameters#bank-name-4">EC</a> | <a href="https://www.payretailers.dev/reference/payout-parameters#bank-name-5">PE</a>

<strong style="color:red;">BR only. Optional.</strong></br>The swift number of the bank used by the customer.</br><strong>Data validation:</strong> [A-Z][0-9]</br><strong>Length:</strong> 50

Optional external reference that can be used to track the payout.</br><strong>Data validation:</strong> *</br><strong>Length:</strong> 255

A reason for the payment.</br><strong>Data validation:</strong> *</br><strong>Length : AR, BR, CL, CO, EC, PE</strong>: MAX | <strong>MX</strong>: 40

Used to make the difference between real payouts and test payouts. Check the <a href="https://payretailers.readme.io/reference/test-mode">Test Mode</a> page for more details.

The status that you want to receive in your callback when testing your payout. Check the <a href="https://payretailers.readme.io/reference/test-mode">Test Mode</a> page for more details.

Required only for payouts in USD

Unique payout quote ID returned from the Payout Quote end point, locking the FX rate, fee and values to those specified in the quote. Time limit from receiving Payout Quote to submitting Payout referencing Quote ID is 5 minutes.