IPP (Installment Payment Plan) Options Inquiry API

IPP Options Inquiry Request Parameter
IPP Options Inquiry Response Parameter

 

📘

Data Attribute Reference

Data Type
A - Alphabet, N - Numeric, AN - AlphaNumeric, C - Characters, D - Decimal, B - Boolean

Mandatory
M - Mandatory, C - Conditional, O - Optional

 

IPP Options Inquiry Request Parameter


Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

Version of the
Payment Request

Current version : 2.2

timeStamp

C 22

O

Date and time of the
maintenance request.

format of
"ddMMyyHHmmss"

merchantID

C 15

M

Merchant ID

 

IPP Options Inquiry Response Parameter


Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

Version of the Payment Action Response

Current version : 2.1

timeStamp

C 22

M

Date and time of request Message.

Format of "ddMMyyHHm
mss"

respCode

C 3

M

Response Code.

00 = success.

Response code
not 00 is
failed.

respReason

C 100

M

Reason of Failure.

ippBanks

Array

O

Array of ippBank.

ippBanks.bankName

C 250

M

IPP Bank Name

ippBanks.bankShortName

C 250

M

Bank Short Name / Bank Code.

ippBanks.bankTerms

C 250

M

Terms and condition of Bank

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

Allow BIN

ippBanks.installmentOptions

O

ippBanks.installmentOptions.option.id

N 2

M

Serial No for Option.

ippBanks.installmentOptions.option.installmentPeriod

N 2

M

No of Months IPP Period

ippBanks.installmentOptions.option.merInterestRate

D 2,2

M

Merchant Pay Interest Rate.

Negative value means there is no option for
merchant pay interest.

ippBanks.installmentOptions.option.cusInterestRate

D 2,2

M

Customer Pay Interest Rate.

Negative value means there is no option for
customer pay interest.

ippBanks.installmentOptions.option.minAmount

D 10,2

M

Minimum amount to be eligible for IPP

ippBanks.installmentOptions.option.currencyCode

C 3

M

Payment Currency to be eligible for IPP.

Refer to Currency Code List.

ippBanks.installmentOptions.option.validFrom

C 10

M

Option valid from Date.

Format of "yyyy-MM-dd"

ippBanks.installmentOptions.option.validUntil

C 10

M

Option valid Until Date.

Format of "yyyy-MM-dd"