Installment Management Service API Reference

Installment Management Service


Start a Project](https://developer.visa.com/portal/#users/new)
API Overview](https://developer.visa.com/capabilities/installment-management-service)

Search API Reference

Installment Management Service API - Deprecated

Financial Institution (FI) requests Visa Installments Service (VIS) for the list of confirmed or cancelled installment transactions for a given time-period, so they can process installment conversion together with the clearing file received from payment network. Financial Institution performs cancel and refund accordingly.

Unenrollment API v1 - Latest

Cardholder Unenrollment API

Request

Header Parameters
X-SERVICE-CONTEXT
required		 string
X-SERVICE-CONTEXT
Request Body schema: application/json

List of consumer information
consumers
required		 Array of objects
consumerInfo object
--- ---
encAccountNumber
required		 string
Encrypted Personal Account Number
encEmailAddress string
Encrypted Email
encMobileNumber string
hashedURN string
Hashed URN
postTransactionInstallmentAcceptanceEnabled boolean
Consumer choice to opt for Post-transaction installments payment program
preTransactionInstallmentAcceptanceEnabled boolean
Consumer choice to opt for Pre-transaction installments payment program
settings object
--- ---
availableCredit object
--- ---
amount
required		 string
Installment Credit limit amount
currencyCode
required		 string
Installment Credit limit amount currency. ISO4217 3-letter currency code
availablePlans Array of objects
Pre-defined list of Installment plans available for the consumer
installmentFrequency string
Preferred Installment payments frequency
numberOfInstallments string
Preferred Installment payments tenure

Responses

202 Accepted

Response Schema: application/json
201 object
Created
UpdateConsumersResponse object
OK
--- ---
accepted
required		 object
--- ---
count
required		 integer
number of consumers successfully processed
rejected
required		 object
--- ---
count
required		 integer
number of consumers not processed due to errors
Example: 1
consumers Array of objects
Array
consumerInfo object
--- ---
encAccountNumber
required		 string
Encrypted Personal Account Number
encEmailAddress string
Encrypted Email
encMobileNumber string
hashedURN string
Hashed URN
errors Array of objects
The validation errors related to this entry
Array
errorMessage string
field string
requestIndex integer
An index into the request of which entry had an error (only used if the consumerID had validation errors)

401 Unauthorized

403 Forbidden

404 Not Found

Request samples

application/json

`{"consumers": [{"settings": {"availableCredit": {"amount": 40000.96,

"currencyCode": "INR"

},

"installmentFrequency": "Monthly",

"numberOfInstallments": 9

},

"consumerInfo": {"hashedURN": "PFnbUy8lOp1F6DgRgtarTcqM8uTvSjrNJdx07K9Gntw=",

"encMobileNumber": "eyJraWQiOiI2R08xT1NGRElGNUxWT1JSR1EwMjExTFdRNll4WVA1bzB0azE0LW5DdG1wMktWa0IwIiwidHlwIjoiSk9TRSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.ihbfLlw7kyeFS85BOfvJcxPyzMbB0oEkw87XsYnpse6QIUG1MWtJDsB62hOs3jaOf9KytBsZ3otG9KS5zcBCNlBv1GlqdgtXGeCeCYOHZbRI3OjlTpnYVXL5DEackKI2bAj-Fb8nUi0sJzz0GbD5--Y-s30di6_k4PYz6lWzrRHunMix_4WButR59MdN_rujxQkjgDxiWU-og1YCNRWY6Us9ctUUpIkfuqK3KQ7jkIBOel4N51dyBCXO7mBuEL7U-69EFSTKpFxLe8A9J-fN7wi9z-TsCfLU_oEL7D_YBIM8Qz2bR0zdRvmprNLBGn9fZnv4b3x3QPUSitvRX1d2pw.quHDupWQsWfhZXDA.lHw99XeDo8jODes.9VjdNVqIGGxobiRJl8Qlbw",

"encEmailAddress": "eyJraWQiOiI2R08xT1NGRElGNUxWT1JSR1EwMjExTFdRNll4WVA1bzB0azE0LW5DdG1wMktWa0IwIiwidHlwIjoiSk9TRSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.JJXcCvN_lNvavkisUAIxtjr8mO7v4nuZ5WlFWZMtwm4kbKuCT5Z8F8MlxkrfBZIaW-gxrjI2p_GvqN_7RaMlXKt-KYeZUbotCfiNXITsq_XNVoS_hox2m-r-26UxtG7czmpYW5-815-cn8AwNxmCyLlyJR8ZknJT7-KgHIbVRquexwbpbwPVBfKFyTXRpFkjiwAOWZrW5orKrnmNGohNAt7uMjSYYdSQclbgr7M2Jjo-SsAMuERPU-vrPOQpYDihY7onAm64PadTVHb4eldUanB8JNhe0ceDudaGp6WKO0G9_IuZRilTE9gM1H2FQ4IgiGBMauML1mNFYrwUvCd5vw.8yqzEHv97mTqVoOS.Acx5PISEe43cPzs.3HJ6CXbzrFi-dwuKoUfSlw",

"encAccountNumber": "eyJraWQiOiI2R08xT1NGRElGNUxWT1JSR1EwMjExTFdRNll4WVA1bzB0azE0LW5DdG1wMktWa0IwIiwidHlwIjoiSk9TRSIsImVuYyI6IkEyNTZHQ00iLCJhbGciOiJSU0EtT0FFUC0yNTYifQ.JKwZGrB95C683P3tdqIQbZPBjkIWpSj66Xx-HEw8weIarAtLhmep2OP6nxAulSiVmamlX56UsBmHJwWTa_1xILS4x3bNxgx3WCo5VQn98GXGfMRlGZi5HZzxt0h5pbMO1MJa953B4331jJnapTooeq3dvsFjcunZnhpDYB-oIc4Mw-TKiniWpcq5xyI49HfZECiCdNfuv_0DRDvUjrvFrFJlbRVBYhE5-BuVct2npGWB7m0ee1PYlcMaog6jIBmfgbOnzOIaWmpEyovOcfubMSFS3n6kgCjN8K3ctiKQyxMalMicYyK5236ccm_DVxD8jMHDP--Tb_D9rfjdNytzOQ.JpbmlUOstEwYskYc.oGM6-3q716zDZ0BNeYwjFA.1VHaMCqw9nMT6gTgOsMn7A"

},

"preTransactionInstallmentAcceptanceEnabled": false,

"postTransactionInstallmentAcceptanceEnabled": false

}]}

Response samples

application/json

`{"rejected": {"count": 0,

"consumers": [ ]

},

"accepted": {"count": 1

}

}`