In Mexico, shoppers can use most credit cards to make payments in installments. Combo cards that have both a debit and a credit functionality can also be used to pay in installments.
If a shopper chooses to pay in installments, you receive the full amount. However, you are responsible for the installment fees charged by the issuer.
This page explains how to flag in-store card payments as credit or debit and make credit card installment payments in a Terminal API integration.
Requirements
Requirement | Description |
---|---|
Integration type | Make sure you have an existing Terminal API integration. |
Limitations | Supported in Mexico with specific issuing banks. See the list of supported cards. |
How it works
-
Your store staff asks the shopper how they prefer to pay:
- Do they want to pay by debit or credit?
- If credit, do they want to make a one-off payment of the total amount or do they want to pay in installments?
- If installments, how many installments?
-
Your store staff enters this information into your POS app.
-
Your POS app passes this information in the payment request.
-
The shopper presents their card to the terminal and completes the payment.
-
When the transaction is approved, you receive a response containing installment and receipt data.
Make a payment
The Terminal API payment request needs to contain a flag to indicate a debit or credit card payment. When paying by credit in installments, the request also needs to contain an object to define the installments.
-
Make sure that your POS app collects the following information and passes it to the Terminal API payment request:
- Whether the shopper is going to pay by debit or credit.
- If credit: whether the shopper wants to pay in installments.
- If credit installments: how many installments.
-
Make a POST request to a Terminal API endpoint, specifying:
-
MessageHeader
: the standardSaleToPOIRequest.MessageHeader
object. Specify:Parameter Required Description ProtocolVersion
3.0 MessageClass
Service MessageCategory
Payment MessageType
Request ServiceID
Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal ( POIID
) being used.SaleID
Your unique ID for the POS system component to send this request from. POIID
The unique ID of the terminal to send this request to. Format: [device model]-[serial number].
-
PaymentRequest: The request body. This must include:
Parameter Required Description SaleData.SaleTransactionID
An object with: TransactionID
: your reference to identify a payment. We recommend using a unique value per payment. In your Customer Area and Adyen reports, this will show as the merchant reference for the transaction.TimeStamp
: date and time of the request in UTC format.
PaymentTransaction.AmountsReq
An object with: Currency
: the transaction currency.RequestedAmount
: The final transaction amount.
-
-
Add a flag to specify if the shopper wants to pay by debit or credit:
TransactionConditions.DebitPreferredFlag
:- true: makes a debit card payment.
- false: makes a credit card payment.
For a debit card payment or a one-off credit card payment, no further parameters are required.
-
If the shopper is paying by credit card in installments, define the installments by adding:
PaymentData
: the installment details. This contains:PaymentType
: InstalmentInstalment.TotalNbOfPayments
: the number of installments. The minimum is 3, the maximum 18.
Here are some sample requests:
-
Check the payment result.
If the payment is successful, the terminal shows the payment is approved, and you receive a Terminal API response. This response contains:-
PaymentReceipt
: dynamically generated receipt data that you can use for printing (or emailing) receipts. Both the merchant receipt and the shopper receipt have additional required keys:productType
: indicates if the shopper paid by debit, credit, or credit in a specified number of installments.
-
If the shopper paid in installments, the response also includes:
PaymentResult.PaymentType
: InstalmentPaymentResult.Instalment
: object containing the same installment details that you defined in thePaymentData
of yourPaymentRequest
.
Here is a sample response for a credit card payment with 12 installments:
-
Reconciling installments
If a shopper chooses to pay in installments, the full purchase amount is deducted from their credit card limit. The issuing bank then deducts the amount for each monthly installment from their debit account. Typically, shoppers choose to pay in 3 to 18 monthly installments.
You as the merchant receive the full purchase amount from the issuing bank. However, you are responsible for the installment fees charged by the issuer.
Supported cards
Adyen currently supports card installment payments made with cards issued by the following banks:
Afirme
Banco Azteca
BanBajio
Banjercito
Banregio
Banorte
Falabella
Hey Banco
HSBC
Inbursa
Invex
Konfio
Liverpool
Mifel
Multiva
RappiCard
Santander
Scotiabank
Suburbia
To accept installment payments made with cards issued by other banks, you must have a legal agreement directly with the bank that issued the card.