IPP (Installment Payment Plan) Options Inquiry API

📘
Data Attribute Reference
Data Type

A: Alphabet

AN: Alphanumeric

C: Characters

B: Boolean

D: Decimal

N: Numeric

Mandatory attributes

M: Mandatory

C: Conditional

O: Optional

IPP Options Inquiry Request Parameters

<IppOptionRequest>
	<version>2.2</version>
	<timeStamp></timeStamp>
	<merchantID></merchantID>
</IppOptionRequest>

Parameter	Data Type / Length	Mandatory	Description
version	C 5	M	Request version number Current version : 2.2
timeStamp	C 22	O	Request time stamp * In ddMMyyHHmmss format
merchantID	C 15	M	Merchant ID

IPP Options Inquiry Response Parameters

<IppOptionResponse>
	<version>2.2</version>
	<timeStamp></timeStamp>
	<respCode></respCode>
	<respReason></respReason>
	<ippBanks>
		<ippBank>
			<bankName></bankName>
			<bankShortName></bankShortName>
			<bankLogoUrl></bankLogoUrl>
				<bankPromoUrl></bankPromoUrl>
				<bankTerms></bankTerms>
				<bins>
					<bin></bin>
					<bin></bin>
				</bins>
				<installmentOptions>
				</installmentOptions>
			</ippBank>
		</ippBanks>
	</IppOptionResponse>

Parameter	Data Type / Length	Mandatory	Description
version	C 5	M	Response version number Current version : 2.1
timeStamp	C 22	M	Response time stamp * In ddMMyyHHmmss format
respCode	C 3	M	Response Code 00 = success Any response code that is not 00 indicates failure
respReason	C 100	M	Reason of failure
ippBanks	Array	O	Array of IPP banks
ippBanks.bankName	C 250	M	IPP bank name
ippBanks.bankShortName	C 250	M	Bank Short Name / Bank Code
ippBanks.bankTerms	C 250	M	Bank terms and conditions
ippBanks.bankLogoUrl	C 250	M	Bank logo URL
ippBanks.bankPromoUrl	C 250	M	Bank promo URL
ippBanks.bins	Array	M	Array of BIN
ippBanks.bins.bin	C 6	M	Set to allow BIN
ippBanks.installmentOptions		O
ippBanks.installmentOptions.option.id	N 2	M	Serial number for IPP options
ippBanks.installmentOptions.option.installmentPeriod	N 2	M	IPP period, in months
ippBanks.installmentOptions.option.merInterestRate	D 2,2	M	Merchant interest rate * Negative value = no option for merchant interest
ippBanks.installmentOptions.option.cusInterestRate	D 2,2	M	Customer interest rate * Negative value = no option for customer interest
ippBanks.installmentOptions.option.minAmount	D 10,2	M	Minimum amount to be eligible for IPP
ippBanks.installmentOptions.option.currencyCode	C 3	M	Currencies eligible for IPP Refer to: Currency Code List
ippBanks.installmentOptions.option.validFrom	C 10	M	Option valid from date * In yyyy-MM-dd format
ippBanks.installmentOptions.option.validUntil	C 10	M	Option valid until date * In yyyy-MM-dd format