Latin American payments
Take payments in Latin America with additional regional functionalities and parameters, such as installment plans, combo cards or customer's tax/document reference.
Document reference
Use customer.documentReference
to supply your customer's document reference number. This is required for domestic processing in some Latin America countries in order to reduce fraud and improve approval rates.
Some example documents:
- Argentina: DNI, CUIT, CUIL or CDI
- Brazil: CPF or CNPJ
- Mexico: CURP
{
...
"customer": {
"documentReference": "12345612981"
}
}
Combo cards
Use instruction.routing.fundingType
to specify the source of funds for cards that combine multiple funding types (sometimes referred to as "combo cards").
Possible values:
credit
debit
{
...
"instruction": {
"routing": {
"fundingType": "debit"
}
}
}
Sales tax
Supply order.salesTax
with the amount of sales tax (VAT/IVA) for the transaction.
{
...
"order": {
"salesTax": 150
}
}
Installment plans
To take regional customer installment plans, supply the parameters below within the customerAgreement
object.
Note that unlike other types of installment plan, Latin America installments are supplied on Customer Initiated Transactions (CITs) only. Subsequent installments are then taken automatically by either the card issuer or the acquirer: no further action is required by you.
Parameter | Required | Description |
---|---|---|
instruction.customerAgreement | ❌ | An object containing details about processing agreements made with your customer, e.g. a request to set up an installment schedule for Latin American payments. |
customerAgreement.type | ✅ | installment |
customerAgreement.storedCardUsage | ❌ | Possible values:
|
customerAgreement.installmentType | ✅ | latinAmerica |
customerAgreement.installmentPlan | ✅ | An object containing details of the installment plan. |
installmentPlan.numberOfInstallments | ✅ | The number of installments to split the payment into. |
Installment example
{
...
"instruction": {
"customerAgreement": {
"type": "installment",
"installmentType": "latinAmerica"
"installmentPlan": {
"numberOfInstallments": 6
}
}
}
}