How to use Visa Installment Transaction Service

Available for use by:

Acquirer banks Merchants

Installments Eligibility feature

The Installments Eligibility feature offers multiple APIs that allow merchants to retrieve the list of eligible installment candidates in batch, check if a cardholder is eligible for installment offers, and display the installment plans that a cardholder is eligible for.

Check cardholder's eligibility for installment offers

Using the Matched Candidates API, you can check if a cardholder is eligible for installments based on issuer's pre-approved list. It will return a binary answer (yes/no). To use this API, you can provide the following optional information in the request:

Encrypted PAN
[Optional] Additional cardholder identification data (e.g. encrypted email address, mobile number, hashed URN)

The data response that you will receive will include:

Encrypted PAN
[Optional] Additional cardholder identification data (e.g. encrypted email address, mobile number, hashed URN)
Issuer brand name

Pre-qualify cardholders for installment offers in batch

Using the Matched Candidates Batch Request API, you can check the eligibility of cardholders for installments to pre-qualify cardholders in batch. To use this API, you can provide the following optional information in the request:

Encrypted PAN
[Optional] Additional cardholder identification data (e.g. encrypted email address, mobile number, hashed URN)

The data response that you will receive will include:

Batch expiration date
Failure count
Success count
Eligibility Batch ID

Receive a batch file of eligible cardholders for installment offers

Using the Matched Candidates Batch Response API, you can retrieve the list of eligible installment candidates from an issuer's pre-approved list of qualified cardholders in a batch request. To use this API, you must provide the following information in the request:

Candidate Batch IDs
[Optional] Client ID

The data response that you will receive will include:

Batch expiration date
Batch status
Eligibility Batch ID
[Optional] Cardholder identification data (e.g. encrypted card number, email address, mobile number, hashed URN, eligibility status)
[Optional] Issuer name
[Optional] Batch list of eligible Consumers based on Issuers' pre-approved list
[Optional] Batch Error

Display installment plans a cardholder is eligible for

Using the Eligible Installment Plans API, you can retrieve the installments plans that a cardholder is eligible for. To use this API, you must provide the following optional information in the request:

Encrypted PAN
[Optional] Additional cardholder identification data (e.g. encrypted email address, mobile number, hashed URN)
[Optional] Client ID
[Optional] Merchant Category Code
Transaction data (e.g. amount and currency)

The data response that you will receive can include the following optional information:

[Optional] Plan information (start and end date of plan, installment amount and frequency, last installment amount, number of installments, total plan cost, number of installments)
[Optional] Plan rates (effective APR, fees, total fixed fee amount, variable fee amount)
[Optional] Transaction amount and currency
[Optional] Terms & Conditions
[Optional] Installment Plan ID
[Optional] Partner ID
[Optional] Promotion ID, Promotion Code
[Optional] Type (string, query, body, etc.), Name

Installments Acceptance feature

The Installments Acceptance feature offers APIs that allow merchants to send the plan selected by the consumer back to Visa and cancel installment plans when consumers return an item or ask for a refund.

Send the plan selected by the cardholder to Visa

Using the Plan Selection API, you can send the plan selected by the cardholder back to Visa. To use this API, you must provide the following information in the request:

Encrypted PAN
[Optional] Additional cardholder identification data (e.g. encrypted email address, mobile number, hashed URN)
Installment Plan ID
Client ID
Transaction data (external transaction ID, transaction amount and date/time, descriptor)
Terms & Conditions
Transaction ID from Auth
[Optional] Merchant Category Code
[Optional] Acquirer Reference ID

The data response that you will receive can include the following optional information:

Plan Acceptance Status
Promotion code
Plan Acceptance ID
Installment Plan ID
Transaction ID

Cancel an installment plan

When consumers return an item, merchants may use the Plan Cancellation API to cancel previously active installment plans. Currently, partial refunds are not supported – only the full amount can be refunded to the cardholder. To use this API, you must provide the following information in the request:

Encrypted PAN
[Optional] Additional cardholder identification data (e.g. encrypted email address, mobile number, hashed URN)
[Optional] Client ID
[Optional] Refund Amount
[Optional] Refund Transaction ID
[Optional] Plan Acceptance ID
[Optional] Transaction ID from Auth

The data response that you will receive will include the following optional information:

The cancellation date, time, and status
Cancellation status
Transaction ID