Mandatory parameters by country

A lack of some parameters will not cause your requests to fail, however, you will not be authorized for live processing without providing the appropriate information in each request.

Quick links

Argentina

Argentina legislation requires Merchants and PSPs to store certain transaction data for 5 years. (Detailed information please see “Exhibit 3 – Compliance requirements LATAM”, included in contract).

Credit Card

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, should be unique for your transactions

customer.merchantCustomerId

Numeric

N11 {8,11}

Customer ID Number (DNI or CUIT)

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex: 15.00

currency

Alphanumeric

A3 [A-Z]{3}

Obligatory value = “ARS” (Argentinian pesos)

descriptor

Alphanumeric

AN127 [\s\S]{1,127}

Detailed description, Ex: “yoursstore.com - product 123 - Order number 1234”

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.

billing.street1

Alphanumeric

AN100 [\s\S]{1,100}

Street and street number of the customer.

billing.postcode

Numeric

N6 [0-9]{6}

ZIP code of the customer’s residence, Ex: 1636

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

City where the customer lives.

billing.state

Alphanumeric

AN50 [\s\S]{2,50}

Province where the customer lives.

billing.country

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “AR”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

Ex: “email@email.com”

customer.ip

IPv4 format

AN255 [\s\S]{1,255}

IP address of the shopper. Used for risk management purposes. Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}

Ex: DB or PA

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

Merchant website, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”

Brazil

Brazilian legislation requires Merchants and PSPs to store certain transaction data for 5 years. (Detailed information please see “Exhibit 3 – Compliance requirements LATAM”, included in contract).

Credit Card

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, must be unique for your transactions

customer.merchantCustomerId

Numeric

CPF: 11 digits or CNPJ: 14 digits

Customer ID Number (CPF or CNPJ) Ex:

  • CPF: 12345678909

  • CNPJ: 12345678000100

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex. 10.00

currency

Alphanumeric

A3 [a-zA-Z]{3}

Obligatory value = “BRL” (Brazilian Real)

descriptor

Alphanumeric

AN127 [\s\S]{1,127}

Detailed description, Ex: “yoursstore.com - product 123 - Order number 1234”

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.

billing.street1

Alphanumeric

AN50 [\s\S]{2,50}

Street and street number of the customer.

billing.postcode

Numeric

N8 [0-9]{8}

Postal code of the customer’s residence, Ex: 01332000

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

Customer’s city of residency.

billing.state

Alphanumeric

AN50 [a‐zA‐Z0‐9.]{1,50}

Customer's province of residency.

billing.country

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “BR”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

E.g. “email@email.com”

customer. ip

IPv4 format

IPv4: 7 to 15 digits

IP number of customer. Mandatory due to risk management purposes Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}. A2 [A-Za-z]{2}

IEx: DB or PA

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

Merchant’s URL, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”

Paypal

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, must be unique for your transactions

customer.merchantCustomerId

Numeric

CPF: 11 digits or CNPJ: 14 digits

Customer ID Number (CPF or CNPJ)

Ex:

  • CPF: 12345678909

  • CNPJ: 12345678000100

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex: 10.00

currency

Alphanumeric

A3 [a-zA-Z]{3}

Obligatory value = “BRL” (Brazilian Real)

descriptor

Alphanumeric

AN127 [\s\S]{1,127}

Detailed description, Ex: “yoursstore.com - product 123 - Order number 1234”

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.

billing.street1

Alphanumeric

AN50 [\s\S]{2,50}

Street and street number of the customer.

billing.postcode

Numeric

N8 [0-9]{8}

Postal code of the customer’s residence, E.g. 01332000

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

Customer’s city of residency.

billing.state

Alphanumeric

AN50 [a‐zA‐Z0‐9.]{1,50}

Customer's province of residency.

billing.country

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “BR”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

Ex: “email@email.com”

customer. ip

IPv4 format

IPv4: 7 to 15 digits

IP number of customer. Mandatory due to risk management purposes Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}. A2 [A-Za-z]{2}

Ex: DB or PA

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

Merchant’s URL, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”

paymentBrand

Alphanumeric

AN50 [\s\S]{2,50}

Obligatory value =“PAYPAL”

shopperResultUrl

Alphanumeric

AN2048[\s\S]{6,2048}

This URL will receive the result of an asynchronous payment. Must be sent URL encoded.

Boleto

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, must be unique for your transactions

customer.merchantCustomerId

Numeric

CPF: 11 digits or CNPJ: 14 digits

Customer ID Number (CPF or CNPJ)

Ex:

  • CPF: 12345678909

  • CNPJ: 12345678000100

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex: 10.00

currency

Alphanumeric

A3 [a-zA-Z]{3}

Obligatory value = “BRL” (Brazilian Real)

descriptor

Alphanumeric

AN127 [\s\S]{1,127}

Detailed description, Ex: “yoursstore.com - product 123 - Order number 1234”*

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.*

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.*

billing.street1

Alphanumeric

AN50 [\s\S]{2,50}

Street and street number of the customer.*

billing.postcode

Numeric

N8 [0-9]{8}

Postal code of the customer’s residence, Ex: 01332000

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

Customer’s city of residency.*

billing.state

Alphanumeric

AN50 [a‐zA‐Z0‐9.]{1,50}

Customer's province of residency.

billing.country

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “BR”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

Ex: “email@email.com”

customer. ip

IPv4 format

IPv4: 7 to 15 digits

IP number of customer. Mandatory due to risk management purposes Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}. A2 [A-Za-z]{2}

Obligatory value = “PA”

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

Merchant’s URL, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”

paymentBrand

Alphanumeric

AN50 [\s\S]{2,50}

Obligatory value=“BOLETO”

shopperResultUrl

Alphanumeric

AN2048[\s\S]{6,2048}

This URL will receive the result of an asynchronous payment. Must be sent URL encoded.

customParameters[CUSTOM_CPF_number]

Numeric

CPF: 11 digits or CNPJ: 14 digits.

Customer ID Number (CPF or CNPJ)

Ex:

  • CPF: 12345678909

  • CNPJ: 12345678000100

customParameters[CUSTOM_due_date]

Date (DD/MM/YYYY)

{10}

Expiry Date, Format DD/MM/YYYY, Ex: 31/12/2020 **

  • Brazilian banks do not support special characters for Boletos. Ex: !, @, #, $, %, ¨, &, * , (, ), _ , +, = , ´ , “ , ‘ , ] ,[ , ^,? ,: , >, <, TM, ®, º, °, /, |, \, {, }, ª, ¢, ¬, £, etc, then you must ensure that the customer does not enter special character in these fields.

  • Expiry date: Payment of the Boleto is possible up to this date. At least 3 days from issuing date is recommended, so that the customer has enough time to conclude the payment.

Chile

Chile legislation requires Merchants and PSPs to store certain transaction data for 5 years. (Detailed information please see “Exhibit 3 – Compliance requirements LATAM”, included in contract).

Credit Card

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, should be unique for your transactions

customer.merchantCustomerId

Numeric

N8-9 [0-9] {8,9}

Customer ID Number (RUT), Ex: 24794213 or 354625490

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex: 1000.00

currency

Alphanumeric

A3 [A-Z]{3}

Obligatory value = “CLP” (Chilean pesos)

descriptor

Alphanumeric

AN127 [\s\S]{1,127}

Detailed description, Ex: “yoursstore.com - product 123 - Order number 1234”

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.

billing.street1

Alphanumeric

AN100 [\s\S]{1,100}

Street and street number of the customer.

billing.postcode

Numeric

N4 [0-9]{4}

ZIP code of the customer’s residence, Ex: 9500

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

City where the customer lives.

billing.country

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “CL”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

Ex: “email@email.com”

customer.ip

IPv4 format

AN255 [\s\S]{1,255}

IP address of the shopper. Used for risk management purposes. Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}

Ex: DB or PA

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

Merchant website, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”

Colombia

Colombia legislation requires Merchants and PSPs to store certain transaction data for 5 years. (Detailed information please see “Exhibit 3 – Compliance requirements LATAM”, included in contract).

Credit Card

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, should be unique for your transactions

customer.merchantCustomerId

Numeric

ID: 10 digits

Customer ID Number (Cédula de Ciudadanía, Tarjeta de Identidad, Cédula de Extranjería, NIT or passport), Ex: 1234567890

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex: 15.00 (Minimum amount for VISA 15.00 COP)

currency

Alphanumeric

A3 [A-Z]{3}

Obligatory value = “COP” (Colombian pesos)

descriptor

Alphanumeric

AN127 [\s\S]{1,127}

Detailed description, Ex: “yoursstore.com - product 123 - Order number 1234”

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.

billing.street1

Alphanumeric

AN100 [\s\S]{1,100}

Street and street number of the customer.

billing.postcode

Numeric

N6 [0-9]{6}

ZIP code of the customer’s residence, Ex: 112211

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

City where the customer lives.

billing.country

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “CO”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

Ex: “email@email.com”

customer.ip

IPv4 format

AN255 [\s\S]{1,255}

IP address of the shopper. Used for risk management purposes. Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}

Ex: DB or PA

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

Merchant website, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”

Mexico

Credit Card

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, should be unique for your transactions

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex: 10.00

currency

Alphanumeric

A3 [A-Z]{3}

Obligatory value = “MXN” (Mexican Peso)

descriptor

Alphanumeric

AN127 [\s\S]{1,127}

Detailed description, Ex: “yoursstore.com - product 123 - Order number 1234”

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.

billing.street1

Alphanumeric

AN100 [\s\S]{1,100}

Street and street number of the customer.

billing.postcode

Numeric

N5 [0-9]{5}

ZIP code of the customer’s residence, Ex: 64410

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

City where the customer lives.

billing.state

Alphanumeric

A2 [A-Za-z]{2}

State of the customer’s residence.

billing.country

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “MX”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

Ex: “email@email.com”

customer.ip

IPv4 format

AN255 [\s\S]{1,255}

IP address of the shopper. Used for risk management purposes. Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}

Ex: DB or PA

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

Merchant website, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”

Oxxo

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, should be unique for your transactions

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.

billing.street

Alphanumeric

AN100 [\s\S]{1,100}

Street and street number of the customer.

billing.postcode

Numeric

N8 [0-9]{5}

ZIP code of the customer’s residence, Ex: 01309

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

City where the customer lives.

billing.state

Alphanumeric

A2 [A-Z]{2}

State of the customer’s residence.

billing.country

Alphanumeric

A2 [A-Z]{2}

Obligatory value = “MX”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

Ex: “email@email.com”

customer.ip

IPv4 format

AN255 [\s\S]{1,255}

IP address of the shopper. Used for risk management purposes. Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “PA”

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex: 10.00

currency

Alphanumeric

A3 [a-zA-Z]{3}

Obligatory value = “MXN”

customParameters[CUSTOM_due_date]

Date (DD/MM/YYYY)

{10}

Due Date, Format DD/MM/YYYY, ex 20/12/2018 *

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

merchant website, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”

  • Expiry date: Payment of the Oxxo is possible up to this date. At least 3 days from issuing date is recommended, so that the customer has enough time to conclude the payment.

Peru

Credit Card

Peru legislation requires Merchants and PSPs to store certain transaction data for 5 years. (Detailed information please see “Exhibit 3 – Compliance requirements LATAM”, included in contract).

Mandatory parameters

Data Type

Format

Description

merchantTransactionId

Alphanumeric

AN127 [\s\S]{1,127}

Merchant-provided reference number, should be unique for your transactions

customer.merchantCustomerId

Numeric

N11 {8,11}

Customer ID Number (RUC, DNI or Cédula de Extranjería)

amount

#0.00

N13 [0-9]{1,10}.[0-9]{2}

Ex: 15.00 (Minimum amount for VISA 15.00 PEN)

currency

Alphanumeric

A3 [A-Z]{3}

Obligatory value = “PEN”

descriptor

Alphanumeric

AN127 [\s\S]{1,127}

Detailed description, Ex: “yoursstore.com - product 123 - Order number 1234”

customer.givenName

Alphanumeric

AN50 [\s\S]{2,50}

Given (first) name of the customer.

customer.surname

Alphanumeric

AN50 [\s\S]{2,50}

Family name of the customer.

billing.street1

Alphanumeric

AN100 [\s\S]{1,100}

Street and street number of the customer.

billing.postcode

Numeric

N6 [0-9]{6}

ZIP code of the customer’s residence, Ex: 15001

billing.city

Alphanumeric

AN30 [\s\S]{2,30}

City where the customer lives.

billing.state

Alphanumeric

AN50 [\s\S]{2,50}

Province where the customer lives.

billing.country

Alphanumeric

A2 [A-Za-z]{2}

Obligatory value = “PE”

customer.email

Alphanumeric

AN128 [\s\S]{6,128}

Ex: “email@email.com”

customer.ip

IPv4 format

AN255 [\s\S]{1,255}

IP address of the shopper. Used for risk management purposes. Ex: 123.123.123.123

paymentType

Alphanumeric

A2 [A-Za-z]{2}

Ex: DB or PA

customParameters[merchant_sitename]

Alphanumeric

AN50 [\s\S]{2,50}

Merchant website, Ex: “www.yourstore.com”

customParameters[product]

Alphanumeric

AN50 [\s\S]{2,50}

product description, Ex: “product 123”