Payment Option Details 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

 

Parameter

Data Type

Mandatory

Description

name

C 50

M

Payment channel title

categoryCode

AN 6

M

Payment channel category code

groupCode

AN 6

M

Payment channel group code

iconUrl

C 255

M

Payment channel icon url

validation

-

M

Global validation

 

cardNo

-

C

Validation of card no

 

 

prefixes

Array
N 8

M

Array of allowed prefix card numbers to identify the card scheme

 

 

regex

C 255

M

Regex for allowed prefix card number

 

cardTypes

-

C

Card type list

 

 

sequenceNo

N 5

M

Sequence number of list

 

 

name

C 255

M

Card brand name

 

 

prefixes

Array
N 8

M

Array of prefix numbers to identify the card scheme

 

 

regex

C 255

M

Regex of identify the card scheme

 

 

iconURL

C 255

M

card scheme icon url

channels

-

M

Payment channels

 

sequenceNo

N 5

M

Sequence number of list

 

name

C 255

M

Channel name

 

currencyCodes

Array
A 3

C

Channel enabled currency code

 

iconUrl

C 255

M

Channel icon url

 

logoUrl

C 255

M

Channel logo url

  isDown B M For checking payment channel Online/Offline status
  immediatePayment B M To do immediatePayment

 

payment

-

M

Payment required information

 

 

code

-

M

Payment code information

 

 

 

channelCode

AN 10

M

Payment channel code

 

 

 

agentCode

C 10

M

Agent’s code

 

 

 

agentChannelCode

C 10

M

Agent’s channel code

 

 

input

-

M

Payment input parameters. This indicate what are the mandatory/optional parameter required when call Do Payment API

 

 

 

name

A 1

O

name input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

 

email

A 1

O

Email input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

 

mobileNo

A 1

O

Mobile no input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

 

cardNo

A 1

O

Card no input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

 

expiryDate

A 1

O

Expiry date input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

 

securityCode

A 1

O

Security code input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

 

pin

A 1

O

Pin input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

 

token

A 1

O

Token input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

 

accountNo

A1

O

Account no input view visibility and validation based on admin portal configuration.

M-Mandatory, O-Optional, I-Ignore/Hide

 

 

validation

-

M

Validation of customer input data of parameters

 

 

 

name

C 255

C

Regex name.

 

 

 

email

C 255

C

Regex for email.

 

 

 

mobileNo

C 255

O

Regex for mobile no

 

 

 

cardNo

C 255

O

Regex for card no

 

 

 

expiryDate

C 255

O

Regex for expiry date

 

 

 

securityCode

C 255

O

Regex for security code

 

 

 

pin

C 255

O

Regex for pin

 

 

 

token

C 255

O

Regex for token

 

 

 

accountNo

C 255

O

Regex for account no

 

 

 

additional

-

O

Additional validation input of parameter for specific channel

 

 

 

 

cardNo

-

C

Card no validation

 

 

 

 

 

luhn

B

M

Luhn check for card number

 

 

 

 

 

prefixes

Array
N 8

M

Array of allowed prefix card numbers to identify the card scheme

        amount   C Amount validation
          min D (12,2) M Payment channel specific additional information
          max D(12,2) M Payment channel specific additional information

 

 

info

-

C

Payment channel specific additional information

 

 

 

terms

C 255

O

Bank term and condition

 

 

 

promoUrl

C 255

O

Bank promo image URL

 

 

 

plans

-

M

Installment plan details

 

 

 

 

sequenceNo

N 5

M

Sequence number of list

 

 

 

 

period

N 2

M

Installment tenor

 

 

 

 

interestType

A 1

M

Installment Interest Type.

 

 

 

 

 

interestRate

D (3,5)

M

Installment interest rate

 

 

 

 

monthlyAmount

D (12,5)

M

Instalment montly amount

 

 

 

 

monthlyInterest

D (12,5)

M

Installment montly interest

 

 

 

 

currencyCode

A 3

M

Currency Code A 3

 

 

 

 

label

C 255

M

Installment plans label

configuration

-

M

Merchant admin portal configuration

 

payment

-

M

Payment related configuration

    immediatePayment B C Payment with immediate without user input

 

 

tokenize

B

C

Tokenization for credit card payment

 

 

tokenizeOnly

B

C

Tokenization for Credit Card as card token without perform transaction.

 

 

cardTokenOnly

B

O

Enforce use card token only

 

 

fx

-

O

Exchange rate

 

 

 

mcp

-

C

Exchange rate Multiple currency pricing

 

 

 

 

active

B

M

MCP’s feature active status

 

 

 

 

terms

C 255

M

MCP’s term and condition

 

 

 

dcc

-

C

Exchange rate Dynamic currency conversion

 

 

 

 

active

B

M

DCC’s feature active status

 

 

 

 

terms

C 255

M

DCC’s term and condition

 

notification

-

M

Payment notification platform configuration

 

 

facebook

B

C

Facebook subscription view visibility based on admin portal configuration.

 

 

whatsApp

B

C

WhatsApp subscription view visibility based on admin portal configuration.

 

 

line

B

C

Line subscription view visibility based on admin portal configuration.

respCode

C 4

M

Response Code

Refer to API Response Code List

respDesc

C 255

M

Response Code Description