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

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

The type of document used to identify the customer
Length : AR: 1 | BR: 1 | CL: 6 | MX, CO, EC, PE: 2
Value per country: AR | BR | CL | MX | CO | EC | PE

CL Only. Required.
Used to define if your customer is a physical person or a company.
Values: person | company

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

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

Required in BR, PE and AFRICA. Optional in AR, CL & MX. Do not include for CO.
The customer's phone number. Can include special characters like +().
Data validation: [0-9][()+]
Length : AR, BR, CL, MX: 13 | PE: 9-11

AR BR CL MX Only. Optional.
The gender of the customer.
Data validation: *
Length: 20

The country code of the payout.
Length: 2
Values: AR | BR | CL | CO | EC | MX | PE

Do not include for CO.
The city of the customer.
Data validation: *
Length: 150

Do not include for CO.
The billing address of the customer.
Data validation: *
Length : AR, BR: 255 | CL, MX, EC, PE: 70

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

The URL used to send notifications when a payout is created and changes status.
Data validation: [0-9] [a-z] [(-), (_), (.), (~)]
Length: 255

Channel through which the payout will be processed.
ONLINE for traditional bank transfers. PIX included for BR.
Values: ONLINE

BR Only. Optional.
The PIX key of the customer. Include if the payout must be done via PIX payout.
Data validation: [A-Z][-][0-9]
Length: MAX
Value: Recipient Pix Key

The account number of the customer.
Data validation: [0-9]
Length : AR: 22 | BR: 13 | CL: See special requirements | CO: 16 | MX: 16 or 18 (See special requirements) | EC: 12 | PE: see special requirements
Some countries have special requirements: AR | PE | MX | CL

BR Only. Required.
The agency code of the bank provided by the bank.
Length: 6
Value: Account Agency Number

A code that identifies the type of account used by the user.
Length : AR: 1 | BR, CL, MX, CO, EC, PE: 4
Value per country: AR | BR | CL | MX | CO | EC | PE

The code that identified the bank used by the customer.
Length : AR: 1 | BR, CL: 3 | MX: 5 | CO, EC, PE: 4
Value per country: AR | BR | CL | MX | CO | EC | PE

BR only. Optional.
The swift number of the bank used by the customer.
Data validation: [A-Z][0-9]
Length: 50

Optional external reference that can be used to track the payout.
Data validation: *
Length: 255

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

The status that you want to receive in your callback when testing your payout. Check the Test Mode page for more details.

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.

The subscription key has a length of 32 characters and will be provided within the API keys. Will be available for new integrations from July 24th onwards.

Generated from available response content types