Transaction Parameters

Payment method TAG

The payment method tag is a unique identifier for the payment methods you use to create the transaction.

It's an alternative to our payment method IDs, meaning if the payment method ID has changed on our side, the transactions would still be created by using only the payment method Tag parameter.

For new integrations from August/2024, the Payment Method Tag can be used to replace the Payment Method IDs.

Find listed below the payment method tags available in Sandbox for your testing:

Additionally, you can find the payment methods you have available in any given environment in one of two ways:

• By making a call to the Get Payment Methods endpoint.
• From the Backoffice Shop, by heading to: Payment Methods -> Export.

CPF - Brazilian personal ID

When creating a transaction there is a validation check performed on the CPF given in the request. If the CPF does not exist or is not real you will receive an error even when using testMode.

If you want to double check if the CPF used in your request is valid or not, we recommend the situacao cadastral website.

Regular Expression: ^[0-9]{3}\.?[0-9]{3}\.?[0-9]{3}\-?[0-9]{2}$

DNI - Argentinian personal ID

From the 03/07/2023 a validation check is going to be performed on the DNI given in the request. The DNI must be valid to create the transaction even when using testMode. Please check more information on ‘DNI for Argentina’

If you want to double check if the DNI used in your request is valid or not, we recommend the AFIP website (try all genres if in doubt).

Regular Expression: ^[0-9]{2}\.?[0-9]{3}\.?[0-9]{3}$

Cédula de identidad - Costa Rican personal ID

From the 31/08/2023 a validation check is going to be also performed on the cédula de identidad. The cedula must be valid even when using testMode, same as Brazil and Argentina. More information on Cédula de identidad for Costa Rica.

If you want to double check if the cedula used in your request is valid or not, we recommend the TSE website.

Regular Expression: ^[1-9]-?[0-9]{4}-?[0-9]{4}$

CURP - Mexican personal ID

From the 01/01/2024 the same validation applied to Brazil, Argentina and Costa Rica is going to be applied to the Mexican CURP, even when using testMode. Please check more information on ‘CURP for Mexico‘.

The CURP can be double-checked on the Federal government of Mexico website.

Regular Expression: ^([A-Z][AEIOUX][A-Z]{2}\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\d|3[01])[HM](?:AS|B[CS]|C[CLMSH]|D[FG]|G[TR]|HG|JC|M[CNS]|N[ETL]|OC|PL|Q[TR]|S[PLR]|T[CSL]|VZ|YN|ZS)[B-DF-HJ-NP-TV-Z]{3}[A-Z\d])(\d)$

Cédula de identidad - Personal ID Chile

From the 01/02/2024 the PersonalID field will be mandatory for transactions for Chile, even when using testMode. Please check more information on ‘Cédula de identidad for Chile‘.

Regular Expression: ^\d{2}\.\d{3}\.\d{3}-[0-9kK]$

Documento nacional de Identitad - Personal ID Peru

From the 01/02/2024 the PersonalID field will be mandatory for transactions for Peru, even when using testMode. Please check more information on ‘Documento nacional de Identitad for Peru‘.

The Carné de Identidad Para Extranjeros (CE) will also be accepted. It has the same length as the DNI, so the regex for CE can be used for both. 

But even so, we recommend allowing customers to choose the document type within a dropdown.

Link: https://www.gob.pe/235-que-es-el-documento-nacional-de-identidad-dni

Regular Expression (DNI): ^\d{8}-\d{1}$
Regular Expression (CE): ^\d{9}$

Cédula de Ciudadanía - Personal ID Colombia

From the 01/02/2024 the PersonalID field will be mandatory for transactions for Colombia, even when using testMode. Please check more information on ‘Cédula de Ciudadanía for Colombia‘. The Cedular de Extranjería will be also accepted.

Regular Expression: ^[0-9]{1}\.?[0-9]{3}\.?[0-9]{3}.?[0-9]{3}|[0-9]{3}\.?[0-9]{3}$

Cédula de Identidad - Personal ID Ecuador

From the 01/02/2024 the PersonalID field will be mandatory for transactions for Ecuador, even when using testMode. Please check more information on ‘Cédula de Identidad for Ecuador‘.

The document can be checked here: https://www.ecuadorlegalonline.com/consultas/consultar-numero-cedula/

Regular Expression: ^[0-9]{10}$

Cédula de Identidad Personal(CIP) - Personal ID Panama

From the 01/02/2024 the PersonalID field will be mandatory for transactions for Panama, even when using testMode. Please check more information on ‘Cédula de Identidad Personal(CIP) for Panama‘.

Regular Expression: ^(?:\d{1,2}-\d{2,3}-\d{4}|\d{7,9})$

Documento Personal de Identificación(DPI) - Personal ID Guatemala

From the 01/02/2024 the PersonalID field will be mandatory for transactions for Guatemala, even when using testMode. Please check more information on ‘ Documento Personal de Identificación(DPI) for Guatemala‘.

Regular Expression: ^\d{4}\s?\d{5}\s?\d{4}$|^\d{4}-?\d{5}-?\d{4}$

Language

The value of language will determine the language displayed on the payment method checkout page. As or right now you may chose between those three values:

Local Currency Codes

The parameter currency will determine the currency in which the transaction is made. You can create transactions in USD and in the local currency of the country in which you are creating the transaction. We use Oanda for currency conversion for all countries except for Argentina, for which we use blue dollar. After creating a transaction you will see it reflected in the currency of your shop.

🚧

Bear in mind that this only applies to transactions. Payouts only support local currency.

Country

"Country" is a required field for all Transactions, find below the list of supported Country Codes: