User Preference Response Parameters

πŸ“˜

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

Parameter

Data Type

Mandatory

Description

paymentToken

C 255

M

Payment token ID

user

-

M

User details

 

preference

-

M

User preference details

There are several ways to retrieve user information.

1) ClientID (System-generated): created after user successfully completes a payment (For use in subsequent payments)

2) uiParams (Payment Token API): when merchants pass user information via the payment token API. (First time payment)

 

3) User IP : used when the above options are not available

 

4) Default value : used when none of the above information is available
  - locale : en
  - mobilePrefix : 1
  - currencyCode : follow payment token currency code.

User information priority:
Client ID > UI Params > User IP > Default Value

 

 

name

C 255

O

User preference name

 

 

email

C 255

O

User preference email

 

 

mobileNo

N 15

O

User preference mobile no

 

 

countryCode

A 2

M

User preference country code

Based on ISO 3166-1 codes

For pre-selected country code.

 

 

mobileNoPrefix

N 2

M

User preference mobile no prefix

 

 

locale

C 10

M

User preference locale

Default : en

 

 

currencyCode

A 3

M

User current country’s currency code

Note:

Detect from requestor IP address.

 

paymentChannels

-

M

User preference payment channels

 

 

sequenceNo

N 5

M

Sequence number of list

 

 

name

C 50

M

Payment channel name

 

 

categoryCode

AN 6

M

Payment channel category code

Refer to: Payment Channel Matrix

 

 

groupCode

AN 6

M

Payment channel group code

Refer to: Payment Channel Matrix

 

 

channelCode

AN 6

M

Payment channel code

Refer to: Payment Channel Matrix

 

 

iconUrl

C 255

M

Payment option icon url

 

 

logoUrl

C 255

M

Payment option logo URL

respCode

N 4

M

Response Code

Refer to: API Response Code List

respDesc

C 255

M

Response Description