Overview
This page describes how merchants can implement credit card installment payments.
The merchant’s acquirer bank must support processing a payment using installments; otherwise, installment payments are not available.
The merchant can set the number of installments in the:
- Payment Page request URL
addendums.localPayment
class in the/payment
request (REST API) or the/openOrder
request (Web SDK or Simply Connect)- Simply Connect
cardInstallments
class
This page also describes how merchants can process local payment transactions in Colombia by using the addendums.localPayment
class.
Supported Countries
Brazil, Mexico, Colombia, Chile, Peru, Israel
Implementation
Press tab to open…
To implement credit card installment payment using Payment Page, send the following parameters in the Payment Page request URL:
allow_installments=1
(enables installment payment)max_num_installments
Example Payment Page Request URL
To implement credit card installment payments using REST API, send a /payment
request with its mandatory parameters and include:
addendums.localPayment
class containing:
numberOfInstallments
– The total number of installments (including the first installment).
nationalId
– The user’s national ID number.
installmentType
– The type of installment.
Possible values:
1 – Deferred with interest
2 – Deferred without interest
3 – Deferred without interest and months of grace
debitType
: “2”
Example /payment
Request
{ "sessionToken": "<sessionToken from /getSessionToken>", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "clientRequestId": "<unique request ID in merchant system>", "clientUniqueId": "<unique transaction ID in merchant system>", "userTokenId": "<unique customer identifier in merchant system>", "currency": "USD", "amount": "10.37", "paymentOption": { "card": { "cardNumber": "4444493318246892", "cardHolderName": "John Smith", "expirationMonth": "12", "expirationYear": "25", "CVV": "670" } }, "billingAddress": { "firstName": "John", "lastName": "Smith", "email": "[email protected]", "country": "CL" }, "deviceDetails": { "ipAddress": "<customer's IP address>" }, "addendums": { "localPayment": { "numberOfInstallments": "121", "nationalId": "123456789", "installmentType": "3", "debitType": "2" } }, "urlDetails": { "notificationUrl": "<URL to which DMNs are sent>" }, "timeStamp": "<YYYYMMDDHHmmss>", "checksum": "<calculated checksum>" }
Example /payment
Response
{ "reason":"", "orderId":"38606501", "customData":"Custom Data Inserted By Darin!", "merchantSiteId":"126006", "gwExtendedErrorCode":0, "merchantId":"2502136204546424962", "paymentOption":{ "userPaymentOptionId":"8414971", "card":{ "issuerBankName":"BANCO DE CHILE", "ccCardNumber":"4444493318246892", "bin":"548652", "avsCode":"S", "threeD":{ }, "cardType":"Credit", "ccExpMonth":"12", "ccExpYear":"25", "issuerCountry":"CL", "isPrepaid":"false", "acquirerId":"99", "cardBrand":"MASTERCARD", "cvv2Reply":"P", "last4Digits":"4763" } }, "externalTransactionId":"211008371893", "authCode":"416380", "transactionStatus":"APPROVED", "issuerDeclineCode":"", "clientRequestId":"D6F0GRT5D", "internalRequestId":24583551, "version":"1.0", "transactionId":"2110000000008371893", "transactionType":"Sale", "gwErrorCode":0, "externalSchemeTransactionId":"MCS00LNQW0120 ", "clientUniqueId":"695701003", "errCode":0, "sessionToken":"96fd6575-6533-4791-a106-c1bf2d82ad23", "userTokenId":"X874NSXD6VK0", "issuerDeclineReason":"", "fraudDetails":{ "score":"0", "finalDecision":"Accept" }, "status":"SUCCESS" }
To implement credit card installment payments using Web SDK, send an /openOrder
request with its mandatory parameters and include:
addendums.localPayment
class containing:
numberOfInstallments
– The total number of installments (including the first installment).nationalId
– The user’s national ID number.installmentType
– The type of installment.
Possible values:
1 – Deferred with interest
2 – Deferred without interest
3 – Deferred without interest and months of gracedebitType
: “2“minNumberofInstallments
– Minimum number of installments offered to users.maxNumberofInstallments
– Maximum number of installments offered to users.
Example /openOrder
Request
{ "merchantId": "<your merchantId goes here>", "merchantSiteId": "<your merchantSiteId goes here>", "clientUniqueId": "<unique transaction ID in merchant system>", "clientRequestId": "<unique request ID in merchant system>", "currency": "MXN", "amount": "200", "timeStamp": "<YYYYMMDDHHmmss>", "checksum": "<calculated checksum>", "addendums": { "localPayment": { "numberOfInstallments": "121", "nationalId": "123456789", "installmentType": "3", "debitType": "2", "minNumberofInstallments": "1", "maxNumberofInstallments": "10" } } }
For information about implementing credit card installment payments using Simply Connect, press here.
- Payment Page
- REST API
-
To implement credit card installment payments using REST API, send a
/payment
request with its mandatory parameters and include:addendums.localPayment
class containing:numberOfInstallments
– The total number of installments (including the first installment).
nationalId
– The user’s national ID number.
installmentType
– The type of installment.
Possible values:
1 – Deferred with interest
2 – Deferred without interest
3 – Deferred without interest and months of grace
debitType
: “2”
Example
/payment
Request{ "sessionToken": "<sessionToken from /getSessionToken>", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "clientRequestId": "<unique request ID in merchant system>", "clientUniqueId": "<unique transaction ID in merchant system>", "userTokenId": "<unique customer identifier in merchant system>", "currency": "USD", "amount": "10.37", "paymentOption": { "card": { "cardNumber": "4444493318246892", "cardHolderName": "John Smith", "expirationMonth": "12", "expirationYear": "25", "CVV": "670" } }, "billingAddress": { "firstName": "John", "lastName": "Smith", "email": "[email protected]", "country": "CL" }, "deviceDetails": { "ipAddress": "<customer's IP address>" }, "addendums": { "localPayment": { "numberOfInstallments": "121", "nationalId": "123456789", "installmentType": "3", "debitType": "2" } }, "urlDetails": { "notificationUrl": "<URL to which DMNs are sent>" }, "timeStamp": "<YYYYMMDDHHmmss>", "checksum": "<calculated checksum>" }
Example
/payment
Response{ "reason":"", "orderId":"38606501", "customData":"Custom Data Inserted By Darin!", "merchantSiteId":"126006", "gwExtendedErrorCode":0, "merchantId":"2502136204546424962", "paymentOption":{ "userPaymentOptionId":"8414971", "card":{ "issuerBankName":"BANCO DE CHILE", "ccCardNumber":"4444493318246892", "bin":"548652", "avsCode":"S", "threeD":{ }, "cardType":"Credit", "ccExpMonth":"12", "ccExpYear":"25", "issuerCountry":"CL", "isPrepaid":"false", "acquirerId":"99", "cardBrand":"MASTERCARD", "cvv2Reply":"P", "last4Digits":"4763" } }, "externalTransactionId":"211008371893", "authCode":"416380", "transactionStatus":"APPROVED", "issuerDeclineCode":"", "clientRequestId":"D6F0GRT5D", "internalRequestId":24583551, "version":"1.0", "transactionId":"2110000000008371893", "transactionType":"Sale", "gwErrorCode":0, "externalSchemeTransactionId":"MCS00LNQW0120 ", "clientUniqueId":"695701003", "errCode":0, "sessionToken":"96fd6575-6533-4791-a106-c1bf2d82ad23", "userTokenId":"X874NSXD6VK0", "issuerDeclineReason":"", "fraudDetails":{ "score":"0", "finalDecision":"Accept" }, "status":"SUCCESS" }
- Web SDK
-
To implement credit card installment payments using Web SDK, send an
/openOrder
request with its mandatory parameters and include:addendums.localPayment
class containing:numberOfInstallments
– The total number of installments (including the first installment).nationalId
– The user’s national ID number.installmentType
– The type of installment.
Possible values:
1 – Deferred with interest
2 – Deferred without interest
3 – Deferred without interest and months of gracedebitType
: “2“minNumberofInstallments
– Minimum number of installments offered to users.maxNumberofInstallments
– Maximum number of installments offered to users.
Example
/openOrder
Request{ "merchantId": "<your merchantId goes here>", "merchantSiteId": "<your merchantSiteId goes here>", "clientUniqueId": "<unique transaction ID in merchant system>", "clientRequestId": "<unique request ID in merchant system>", "currency": "MXN", "amount": "200", "timeStamp": "<YYYYMMDDHHmmss>", "checksum": "<calculated checksum>", "addendums": { "localPayment": { "numberOfInstallments": "121", "nationalId": "123456789", "installmentType": "3", "debitType": "2", "minNumberofInstallments": "1", "maxNumberofInstallments": "10" } } }
- Simply Connect
-
For information about implementing credit card installment payments using Simply Connect, press here.
Local Transaction Processing – Colombia
To process local transactions in Colombia, merchants can use the addendums.localPayment
class and include the following optional parameters:
nationalId
– The user’s national ID number.vatAmount
– VAT tax calculated by the merchant in domestic currency.nationalConsumptionTaxAmount
– Consumption tax calculated by the merchant in domestic currency.taxAmountBase
– The purchase amount in domestic currency and the amount based on the taxes that were calculated.tipAmount
– Tip amount paid during the purchase transaction.taxCurrencyCodeBase
– ISO Alpha 3 currency code.airportChargeAmount
– The amount of the airport charge part when purchasing an airline ticket.
For REST API integration, include the addendums.localPayment
class with these parameters in the /payment
request.
For WEB SDK and Simply Connect, include the addendums.localPayment
class with these parameters in the /openOrder
request.
Example /payment
Request
{ "sessionToken": "<sessionToken from /getSessionToken>", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "clientRequestId": "<unique request ID in merchant system>", "clientUniqueId": "<unique transaction ID in merchant system>", "userTokenId": "<unique customer identifier in merchant system>", "currency": "USD", "amount": "10.37", "paymentOption": { "card": { "cardNumber": "4444493318246892", "cardHolderName": "John Smith", "expirationMonth": "12", "expirationYear": "25", "CVV": "670" } }, "billingAddress": { "firstName": "John", "lastName": "Smith", "email": "[email protected]", "country": "CO" }, "deviceDetails": { "ipAddress": "<customer's IP address>" }, "addendums": { "localPayment": { "nationalId": "123456789", "vatAmount": "20", "nationalConsumptionTaxAmount": "19", "taxAmountBase": "18", "tipAmount": "17", "taxCurrencyCodeBase": "USD", "airportChargeAmount": "15" } }, "urlDetails": { "notificationUrl": "<URL to which DMNs are sent>" }, "timeStamp": "<YYYYMMDDHHmmss>", "checksum": "<calculated checksum>" }