Payment Info Classes

min

Double

M

Set the minimum allowed amount

• If min > 0, this validates the minimum amount

max

Double

M

Set the maximum allowed amount

• If max > 0, this validates the maximum amount

prefixes

Array

M

Array of allowed prefix card numbers to identify the credit card scheme

regex

String

M

Regex for allowed prefix credit card numbers

luhn

Boolean

M

LUHN check for credit card number

• Default: true

sequenceNo

Integer

M

Sequence number of list

id

String

M

Exchange rate ID

name

String

M

Exchange rate title

iconUrl

String

M

Exchange rate currency icon URL

amount

String

M

Exchange rate offer amount

fx

Double

M

Exchange rate offer rate

currencycode

String

M

Exchange rate currency code

• Based on ISO 4217 - A3 currency codes

sequenceNo

Integer

M

Sequence number of list

period

Integer

M

Installment tenor period

interestType

String

M

Installment interest type

interestRate

Double

M

Installment interest rate.

monthlyAmount

Double

M

Installment monthly amount

monthlyInterest

Double

M

Installment monthly interest

currencyCode

String

M

Installment currency code

• Based on ISO 4217 - A3 currency code

id

String

M

Merchant ID

name

String

M

Merchant name

address

String

M

Merchant address

email

String

M

Merchant email address

logoUrl

String

M

Merchant logo URL

bannerUrl

String

M

Merchant banner URL

countryCode

String

M

Merchant county code

• Based on ISO 3166-1 alpha 2 codes

sequenceNo

Integer

M

Sequence number of list

name

String

M

Payment channel name

currencyCodes

Array

M

Payment channel enabled currency codes

iconUrl

String

M

Payment channel icon URL

logoUrl

String

M

Payment channel logo URL

down

Boolean

M

Payment channel online/offline status.

• If down = true, the payment channel is down (offline)

immediatePayment

Boolean

M

Immediate payment without user input

• If there is only one payment option available and user input is not required, this will redirect to the third-party payment page
  
• Default: false

tokenize

Boolean

M

Enables the tokenization feature for credit card payments

Default: false

tokenizeOnly

Boolean

M

Indicates that a credit card will be tokenized to generate a card token without performing a transaction

• Configured via Payment Token API • true – Change to TWA layout
  • false – use as normal credit card layout

name

String

M

Name input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

email

String

M

Email input view visibility and validation for UI

/8 Based on admin portal configuration

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

mobileNo

String

M

Mobile number input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

cardNo

String

M

Credit card number input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

expiryDate

String

M

Credit card expiry date input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

securityCode

String

M

Credit card security code input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

pin

String

M

Credit card pin input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

token

String

M

Token ID input validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

accountNo

String

M

Account number input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

billingAddress1

String

M

Billing address 1 input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

billingAddress2

String

M

Billing address 2 input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

billingAddress3

String

M

Billing address 3 input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

billingCity

String

M

Billing city input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

billingState

String

M

Billing state input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

billingPostalCode

String

M

Billing postal code input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

billingCountryCode

String

M

Billing country code input view visibility and validation for UI

• Based on admin portal configuration
  

• M = Mandatory
• O = optional
• I = Ignore

• Default: M
  
• Note: Setting this to “I” (Ignore) will bypass validation and hide the user input field.
  

Refer to: Payment Input Code

facebook

Boolean

M

Facebook subscription view visibility

• Based on admin portal configuration.
  
• Default: false

whatsApp

Boolean

M

WhatsApp subscription view visibility

• Based on admin portal configuration.
  
• Default: false

line

Boolean

M

LINE subscription view visibility

• Based on admin portal configuration.
  
• Default: false

redirectImmediately

Boolean

M

Redirect immediately to frontend return URL

• If set to true: Redirects payment response to frontend return URL

• If set to false: Proceeds based on auto redirection flag

autoRedirect

Boolean

M

Auto redirect to frontend return URL after indicated number of seconds

• If set to true: Auto redirect to payment response in x seconds, based on auto redirect timer

• If set to false: User must proceed manually (click on button)

autoRedirectTimer

Integer

M

Auto redirect countdown

• Based on admin portal configuration.

• In milliseconds (ms)

• 1000 = 1 second
  

frontendReturnUrl

String

M

Merchant frontend page return URL

• If the URL is empty, the UI should not display a "Back to merchant" button
  

frontendReturnData

String

M

Data to be posted to merchant frontend return URL

• Based on base64 encoding

• If the data is empty, UI should not display a "Back to merchant" button
  

responseCode

String

M

Payment result response code

• 0000 - transaction success (GREEN)

• 0001 - transaction failed (RED)

• 0003 - transaction cancelled (RED)

• 0999 - general error message (GREY)

• Note: The UI will display a paymentResult message in the colors indicated above
  

Refer to: API Response Code

code

String

M

Locale code

• Based on ISO 639 codes

amount

String

M

Transaction amount

currencyCode

String

M

Transaction currency code

invoiceNo

String

M

Transaction invoice number

productDescription

String

M

Transaction product description

dateTime

String

M

Process transaction datetime

• Date format: yyyyMMddHHmmss

name

String

M

Customer's name

email

String

M

Customer's email address

mobileNo

String

M

Customer's mobile number

mobileNoPrefix

String

M

Customer's mobile number prefix

locale

String

M

Customer's preferred locale

currencyCode

String

M

Customer's current currency code

countryCode

String

M

Customer's current country code

• Based on ISO 3166-1 codes
  
• For pre-selected country codes