Loading...
In this guide you will learn how to offer installment plans and make a charge using a selected plan
For more information on Installments, see our Overview
Before starting the steps in this guide, you must do the following:
First you will need to send a request to retrieve the eligible plans that are available to a customer.
Note: Availability of Installment plans is dependent on multiple factors such as the transaction amount, date, issuer etc. If Installment plans are not returned, then most likely the transaction did not meet the criteria for plans.
{
"account_name": "transaction_processing",
"channel": "CNP",
"amount": "11099",
"currency": "MXN",
"country": "MX",
"reference": "becf9f3e-4d33-459c-8ed2-0c4affc9555e",
"payment_method": {
"entry_mode": "ECOM",
"card": {
"number": "4263970000005262",
"expiry_month": "12",
"expiry_year": "29"
}
}
}{
"id": "INS_6cFkx9FcSBwHDTzC6tN90KANILMzOj",
"time_created": "2026-01-26T20:35:14.056Z",
"type": "INSTALLMENT_QUERY",
"status": "AVAILABLE",
"channel": "CNP",
"amount": "101",
"currency": "MXN",
"country": "MX",
"merchant_id": "MER_20c2b3fcfedd484e9c3723347db56b71",
"merchant_name": "UCP_Test_Automation_Merchant",
"account_id": "TRA_89e47e02d3954f4c9999006e23b22375",
"account_name": "IPP_Transaction_Processing_MP",
"reference": "96be3927-c360-4c4d",
"terms_and_conditions_url": "",
"provider_image_url": "",
"terms": [
{
"reference": "33f7c8c8-61ec-4972-9395-6885f78d67a2",
"name": "RD MWI Plan",
"mode": "NO_INTEREST",
"count": 3,
"grace_period_count": 0
},
{
"reference": "606d9d3c-49cc-44ae-8fed-a5f850dbfa05",
"name": "ibukun_test",
"mode": "NO_INTEREST",
"count": 2,
"grace_period_count": 0
},
{
"reference": "6e5bb620-6263-4ab4-a00e-e01315905477",
"name": "TEST Antoine",
"mode": "BNPL",
"count": 6,
"grace_period_count": 2
},
{
"reference": "85fa3383-ab2e-4b60-b30c-d3f4b3b57478",
"name": "HSBC Diwali 02",
"mode": "BNPL",
"count": 5,
"grace_period_count": 2
},
{
"reference": "cf1610cf-2f2c-4f75-a7bb-8f45cd691fa5",
"name": "New plan",
"mode": "BNPL",
"count": 9,
"grace_period_count": 2
},
{
"reference": "e061e99e-0283-4d2d-9125-8dd2de97b349",
"name": "HSBC Diwali 03",
"mode": "BNPL",
"count": 5,
"grace_period_count": 2
}
],
"payment_method": {
"entry_mode": "MOTO",
"card": {
"masked_number_last4": "XXXXXXXXXXXX5678",
"expiry_month": "09",
"expiry_year": "25",
"funding": "DEBIT",
"brand": "VISA",
"issuer": "BBVA",
"country": "MX",
"currency": "MXN"
}
},
"action": {
"id": "ACT_6cFkx9FcSBwHDTzC6tN90KANILMzOj",
"type": "INSTALLMENT_QUERY",
"time_created": "2026-01-26T20:35:14.056Z",
"result_code": "SUCCESS",
"app_id": "hkjrcsGDhWiDt8GEhoDMKy3pzFz5R0Bo",
"app_name": "UCP_Test_Automation_App_1"
}
}{
"account_id": "TRA_ff583a33641544e4ae53a62315f9e843",
"channel": "CNP",
"amount": "50000",
"currency": "GBP",
"country": "GB",
"reference": "96be3927-c360-4c4d-8ace-f53b20ec296f",
"program": "VIS",
"payment_method": {
"usage_mode": "USE_CARD_NUMBER",
"entry_mode": "ECOM",
"card": {
"number": "4263970000005262",
"brand": "VISA",
"expiry_month": "09",
"expiry_year": "25"
}
},
"funding_mode": "MERCHANT_FUNDED",
"eligible_plans": "LIMITED",
"terms": {
"max_time_unit_number": 24,
"max_amount": 100000
}
}{
"id": "INS_XPhhl0RiQnbhfpZ0ieHKVsU7MTSRNg",
"time_created": "2025-10-24T12:20:38.958Z",
"type": "INSTALLMENT_QUERY",
"status": "AVAILABLE",
"channel": "CNP",
"amount": "50000",
"currency": "GBP",
"country": "GB",
"merchant_id": "MER_969b3cebc1664e7980f3a9a5226b3767",
"merchant_name": "tokenizationmerchant777",
"account_id": "TRA_ff583a33641544e4ae53a62315f9e843",
"account_name": "VisaGunjanINS",
"reference": "96be3927-c360-4c4d-8ace-f53b20ec296f",
"program": "VIS",
"terms": [
{
"name": "plan12CnoAPR",
"reference": "109bbbf5-c027-de5e-50c1-153dafa9ac06",
"mode": "MARKET",
"time_unit": "MONTH",
"terms_and_conditions": [
{
"url": "https://www.visa.co.uk/how-you-pay-matters/pay-instalments.html",
"version": "5",
"description": "You are selecting a 12-month installment plan. The total purchase amount will be deducted from your available credit limit. As set forth in your terms, your installment fee will be APR calculated for 12 months. If you miss an installment payment, the standard rate of purchases will apply to the remaining installment balance.",
"language": "EN"
},
{
"url": "https://www.visa.co.uk/how-you-pay-matters/pay-instalments.html",
"version": "5",
"description": "Vous sélectionnez un plan de versement de 12 mois. Le montant total de l'achat sera déduit de votre limite de crédit disponible. Comme indiqué dans vos conditions, vos frais de versement seront APR calculés pour 12 mois. Si vous manquez un paiement échelonné, le taux standard des achats s'appliquera au solde restant du versement.",
"language": "FR"
}
],
"count": 12,
"cost_percentage": "0.00",
"total_plan_cost": "54000",
"plan_amount": "4163",
"fees": {
"fee_info": [
{
"type": "MERCHANT_FUNDING",
"interest_rate": "3.00",
"flat_amount": "150"
},
{
"type": "MERCHANT_SERVICE",
"interest_rate": "0.10",
"flat_amount": "0"
}
],
"total_amount": "4000",
"total_subsequent_amount": "4000",
"subsequent_amount": "334",
"total_upfront_amount": "0",
"upfront_amount": "100000"
},
"currency": "GBP"
}
],
"payment_method": {
"entry_mode": "ECOM",
"card": {
"brand": "VISA",
"masked_number_last4": "XXXXXXXXXXXX5262",
"expiry_month": "09",
"expiry_year": "25"
}
},
"action": {
"id": "ACT_XPhhl0RiQnbhfpZ0ieHKVsU7MTSRNg",
"type": "INSTALLMENT_QUERY",
"time_created": "2025-10-24T12:20:38.958Z",
"result_code": "SUCCESS",
"app_id": "WBLHjFlm87vIQ3F9CdwUA704KGcP3uE8",
"app_name": "DEV_ECOMvisaInsstllamentapp"
}
}Once you have displayed the Installment plans to the consumer, you can now process a charge which includes the installment fields to process the Installment transaction.
{
"account_id": "TRA_37b072da4e5e436293dce254e95f69ee",
"channel": "CNP",
"capture_mode": "AUTO",
"type": "SALE",
"amount": "1000",
"currency": "MXN",
"country": "MX",
"reference": "TRANS-202302271030111001",
"payment_method": {
"name": "Jane Doe",
"entry_mode": "ECOM",
"card": {
"number": "4512971111111113",
"expiry_month": "12",
"expiry_year": "30",
"cvv": "123"
}
},
"installment": {
"id" : "INS_iiOG5yfxJQnGtopjFiOy5nVAc4vYS1",
"reference" : "7533d4f7-6a10-5557-2e92-132d06157502"
}{
"id": "TRN_SK9cRUlnUYmyyxefWlmN39sRC5mNqj",
"time_created": "2026-01-26T20:51:53.770Z",
"time_last_updated": "2026-01-26T20:51:53.770Z",
"type": "SALE",
"status": "CAPTURED",
"channel": "CNP",
"capture_mode": "AUTO",
"amount": "2000",
"currency": "GBP",
"country": "US",
"merchant_id": "MER_1e4049f6f33145b2a5891332e9783bd9",
"merchant_name": "UCP_Test_Automation_Merchant",
"account_id": "TRA_1e0a2fdfd79d4013b87d47c4c43882f6",
"account_name": "Portico_Transaction_Processing",
"reference": "96be3927-c360-4c4d-8ace-f53b20ec296f",
"payment_method": {
"result": "00",
"message": "APPROVAL",
"entry_mode": "MOTO",
"card": {
"funding": "CREDIT",
"brand": "VISA",
"masked_number_last4": "XXXXXXXXXXXX1112",
"authcode": "VI2000",
"brand_reference": "306026440007914",
"brand_time_created": "",
"issuer": "",
"country": "",
"currency": "",
"provider": {
"result": "00",
"avs_result": "0"
},
"commercial_level": "LEVEL_1"
}
},
"installment": {
"id": "INS_QSTi1Rx1FVWN7WeI8PF4As9iUs7v0E",
"program": "",
"term": {
"id": "",
"time_unit": "",
"time_unit_number": "",
"interest_rate": "",
"first_amount": "",
"subsequent_amount": "",
"last_amount": "",
"total_amount": ""
},
"mode": "MWI",
"count": "1",
"grace_period_count": "0"
},
"batch_id": "BAT_1276709-38",
"action": {
"id": "ACT_SK9cRUlnUYmyyxefWlmN39sRC5mNqj",
"type": "AUTHORIZE",
"time_created": "2026-01-26T20:51:53.770Z",
"result_code": "SUCCESS",
"app_id": "hlZAokTftDazLlWDPe8E6VAz5g9rSDPg",
"app_name": "UCP_Test_Automation_App"
}
}{
"account_id": "TRA_37b072da4e5e436293dce254e95f69ee",
"channel": "CNP",
"capture_mode": "AUTO",
"type": "SALE",
"amount": "1000",
"currency": "EUR",
"country": "IE",
"reference": "TRANS-202302271030111001",
"payment_method": {
"name": "Jane Doe",
"entry_mode": "ECOM",
"card": {
"number": "4512971111111113",
"expiry_month": "12",
"expiry_year": "30",
"cvv": "123"
}
},
"installment": {
"id" : "INS_iiOG5yfxJQnGtopjFiOy5nVAc4vYS1",
"reference" : "7533d4f7-6a10-5557-2e92-132d06157502",
"terms" :
}
"language": "en"
"version": "2"
}
}
}{
"id": "TRN_AfauPfMZmR9NSpeSjkyEMqQ0pQcZt3_114123459878",
"time_created": "2026-01-26T21:10:47.678Z",
"type": "SALE",
"status": "CAPTURED",
"channel": "CNP",
"capture_mode": "AUTO",
"amount": "100000",
"currency": "GBP",
"country": "GB",
"merchant_id": "MER_20c2b3fcfedd484e9c3723347db56b71",
"merchant_name": "UCP_Test_Automation_Merchant",
"account_id": "TRA_1750765a32b34cdf9ecd5d0c643fc99a",
"account_name": "GPECOM_Installments_Processing",
"reference": "TRANS-20180114123459878",
"payment_method": {
"result": "00",
"message": "[ test system ] Authorised",
"entry_mode": "ECOM",
"id": "PMT_9258ab95-cd99-4521-9840-584d2cc0f791",
"card": {
"brand": "VISA",
"masked_number_last4": "XXXXXXXXXXXX2828",
"authcode": "123456",
"brand_reference": "zvTXC2AYiHXmIZEC",
"brand_time_created": "",
"cvv_result": "NOT_CHECKED",
"avs_address_result": "NOT_CHECKED",
"avs_postal_code_result": "NOT_CHECKED",
"avs_action": "",
"provider": {
"result": "00",
"cvv_result": "U",
"avs_address_result": "U",
"avs_postal_code_result": "U"
}
}
},
"installment": {
"id": "INS_0H2BJOVtcIOO2EelUokUWcdhoHcuZf",
"program": "VIS",
"count": "12"
},
"platforms": [
{
"type": "ECOM",
"transaction_id": "",
"order_id": "TRN_AfauPfMZmR9NSpeSjkyEMqQ0pQcZt3_114123459878",
"authcode": "123456",
"pasref": "1769461847235764"
}
],
"risk_assessment": [
{
"mode": "ACTIVE",
"result": "ACCEPTED",
"rules": [
{
"reference": "0c93a6c9-7649-4822-b5ea-1efa356337fd",
"description": "Cardholder Name Rule",
"mode": "ACTIVE",
"result": "ACCEPTED"
},
{
"reference": "a539d51a-abc1-4fff-a38e-b34e00ad0cc3",
"description": "CardNumber block",
"mode": "ACTIVE",
"result": "ACCEPTED"
},
{
"reference": "d023a19e-6985-4fda-bb9b-5d4e0dedbb1e",
"description": "Amount test",
"mode": "ACTIVE",
"result": "ACCEPTED"
}
]
}
],
"batch_id": "BAT_1633946",
"action": {
"id": "ACT_AfauPfMZmR9NSpeSjkyEMqQ0pQcZt3",
"type": "AUTHORIZE",
"time_created": "2026-01-26T21:10:47.678Z",
"result_code": "SUCCESS",
"app_id": "hkjrcsGDhWiDt8GEhoDMKy3pzFz5R0Bo",
"app_name": "UCP_Test_Automation_App_1"
}
}Our Installments solution is available for testing in our Sandbox environment for registered users of this developer portal. Use our test cards to try different scenarios for your application to handle. For the full list of card numbers, see Test Cards.
Valid amounts to get plans in the sandbox:
100000, 200000, 160000, 80000, 75000, 50000, 45000