Global Payments API
GP Developer PortalGP API reference
HomeAPI ReferenceSDKsContext Plugin
Installments

Get Available Installment Plans

POST
/installments

Confirm installment plans available

Confirm which installments plans are available to the cardholder for a specific transaction. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.

Authorization

bearerAuth
AuthorizationBearer <token>

Access token from POST /accesstoken, sent as Authorization: Bearer <token>.

In: header

Header Parameters

X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"

Request Body

application/json

account_name?string

A meaningful label that better identifies the account.

Length1 <= length <= 50
channel?string

Describes whether the transaction was processed in a face to face(CP) scenario or a Customer Not Present (CNP) scenario. * CP - A Customer Present transaction is when the payer and the merchant are in direct face to face contact when exchanging payment method information to fulfill a transaction. e.g. in a store and paying at the counter that is attended by a clerk. * CNP - A Customer NOT Present transaction is when the payer and the merchant are not together when exchanging payment method information to fulfill a transaction. e.g. a transaction executed from a merchant's website or over the phone

Length1 <= length <= 50

Value in

  • "CP"
  • "CNP"
amount?string

The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomination of the related currency. and with no decimal point.

Length1 <= length <= 50
currency?string

The currency of the amount in ISO-4217(alpha-3).

Length3 <= length <= 3

Value in

  • "USD"
  • "EUR"
  • "GBP"
  • "CAD"
  • "CHF"
  • "HKD"
  • "SGD"
  • "MOPetc."
country?string

This is the country the merchant is domiciled in. For example, If if the merchant is based in Canada it must be set to CA.If if the merchant is based in England it must be set to GB.If if the merchant is based in USA it must be set to US.The country in ISO-3166-1(alpha-2 code) format.

Length2 <= length <= 2

Value in

  • "US"
  • "BG"
  • "CA"
  • "HK"
  • "etc."
reference?string

Merchant defined field to reference the transaction.

Length1 <= length <= 50
program?"VIS"

This field indicates the installment program the merchant is participating in.

  • VIS - Visa Installments

Value in

  • "VIS"
payment_method?
funding_mode?string

Indicated the funding mode of the Installment plan. Availablity of each funding mode is based on your live configuration

  • MERCHANT_FUNDED - This will return merchant funded plans only
  • CONSUMER_FUNDED - This will return consumer funded plans only
  • HYBRID_FUNDED - This will return both merchant and consumer funded plans
  • BILATERAL - This will return BILATERAL plans only
  • ANY - This will return all available plans

Value in

  • "MERCHANT_FUNDED"
  • "CONSUMER_FUNDED"
  • "HYBRID_FUNDED"
  • "BILATERAL"
  • "ANY"
eligible_plans?string

This is used to specify the number of plans returned.

  • LIMITED- Returns two plans.
  • FULL - Returns all available plans

Value in

  • "LIMITED"
  • "FULL"
terms?

Response Body

application/json

curl -X POST "https://example.com/installments" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{    "account_name": "transaction_processing",    "channel": "CP",    "amount": "11099",    "currency": "USD",    "country": "US",    "reference": "becf9f3e-4d33-459c-8ed2-0c4affc9555e",    "payment_method": {      "entry_mode": "ECOM",      "card": {        "number": "4263970000005262",        "expiry_month": "12",        "expiry_year": "30"      }    }  }'
{  "id": "INS_vBg8whrcUs4XdaGm8mtTFCbUHo899M",  "time_created": "2026-01-22T21:22:32.090Z",  "type": "INSTALLMENT_QUERY",  "status": "AVAILABLE",  "channel": "CNP",  "amount": "50000",  "currency": "CAD",  "country": "CA",  "merchant_id": "MER_20c2b3fcfedd484e9c3723347db56b71",  "merchant_name": "UCP_Test_Automation_Merchant",  "account_id": "TRA_1ba8c2df7e8f47439dd851b4a66e8e8f",  "account_name": "Portico_VISA_IPP_CNP_CERT",  "reference": "TRANS-20251009090941938Z60065ea",  "program": "VIS",  "terms": [    {      "name": "plan6CwithAPR",      "reference": "109bbbf5-c027-de5e-50c1-153dafa9ac01",      "mode": "ISSUER_DEFAULT",      "time_unit": "MONTH",      "terms_and_conditions": [        {          "url": "https://www.visa.ca/en_CA/partner-with-us/payment-technology/installments.html",          "version": "1",          "description": "Vous sélectionnez un plan de versement de 6 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 6 mois. Si vous manquez un paiement échelonné, le taux standard des achats s'appliquera au solde restant du versement.",          "language": "fr"        },        {          "url": "https://www.visa.ca/en_CA/partner-with-us/payment-technology/installments.html",          "version": "1",          "description": "You are selecting a 6-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 6 months. If you miss an installment payment, the standard rate of purchases will apply to the remaining installment balance.",          "language": "en"        }      ],      "count": 6,      "cost_percentage": "10.96",      "total_plan_cost": "53000",      "plan_amount": "8330",      "fees": {        "fee_info": [          {            "type": "CONSUMER",            "interest_rate": "3.00",            "flat_amount": "500"          },          {            "type": "MERCHANT_FUNDING",            "interest_rate": "0.00",            "flat_amount": "0"          },          {            "type": "CONSUMER_UPFRONT",            "interest_rate": "0.00",            "flat_amount": "0"          }        ],        "total_amount": "3000",        "total_subsequent_amount": "3000",        "subsequent_amount": "500",        "total_upfront_amount": "0",        "upfront_amount": "0"      },      "currency": "CAD"    },    {      "name": "plan12CPwithAPR",      "reference": "109bbbf5-c027-de5e-50c1-153dafa9ac03",      "mode": "ISSUER_PROMOTION",      "time_unit": "MONTH",      "terms_and_conditions": [        {          "url": "https://www.visa.ca/en_CA/partner-with-us/payment-technology/installments.html",          "version": "2",          "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.ca/en_CA/partner-with-us/payment-technology/installments.html",          "version": "2",          "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": "2.00",      "total_plan_cost": "51500",      "plan_amount": "4163",      "fees": {        "fee_info": [          {            "type": "CONSUMER",            "interest_rate": "3.00",            "flat_amount": "0"          },          {            "type": "MERCHANT_FUNDING",            "interest_rate": "0.00",            "flat_amount": "0"          },          {            "type": "CONSUMER_UPFRONT",            "interest_rate": "0.00",            "flat_amount": "0"          }        ],        "total_amount": "1500",        "total_subsequent_amount": "1500",        "subsequent_amount": "125",        "total_upfront_amount": "0",        "upfront_amount": "0"      },      "currency": "CAD"    }  ],  "payment_method": {    "result": "00",    "message": "APPROVAL",    "entry_mode": "ECOM",    "card": {      "brand": "VISA",      "masked_number_last4": "XXXXXXXXXXXX5262",      "authcode": "",      "brand_reference": ""    }  },  "action": {    "id": "ACT_vBg8whrcUs4XdaGm8mtTFCbUHo899M",    "type": "INSTALLMENT_QUERY",    "time_created": "2026-01-22T21:22:32.090Z",    "result_code": "SUCCESS",    "app_id": "PJoqXXSANSbA8292ASpE0ChpAPrmOwqO",    "app_name": "UCP_Test_Automation_Partner_App_01"  }}

List Funds GET

Get a list of Funds recently processed, using criteria passed in the query string. Page through the result set to access all records.

Get a list of Links GET

Get a list of links recently processed, using criteria passed in the query string. Page through the result set to access all records. Get a list of links recently processed, using criteria passedin the query string. Page through the result set to access all records. Availability of this feature in production depends on your allowed live configuration. Please contact Global Payments before coding this feature to confirm it will be available to you when you go live.