Payment Info Classes

Amount Validation
Card No Validation
Card Token Info
Card Type Validation
Common Validation
Configuration Info
Dynamic Currency Conversion
Exchange Rate
FX Rate
Installment Plan
Merchant Additional Info
Merchant Info
Multiple Currency Pricing
Payment Channel
Payment Channel Category
Payment Channel Group
Payment Code
Payment Configuration
Payment Context
Payment Data
Payment Info
Payment Input
Payment Notification
Payment Request
Payment Result Additional Info
Payment Validation
Payment Validation Additional
Recurring Info
System Initialization
System Locale
Transaction Additional Info
Transaction Info
Transaction Status Additional Info
User Preference
User Preference Info
User Preference Payment Channel
Alternative Payment Method Multiple Currency Conversion
Payment Custom Data
Payment Item Info
User Address
User Billing Address
User Info
Transaction Result Additional Info
Payment Provider

 

Amount Validation


Class AmountValidation

Parameter

Data Type

Mandatory

Description

min

Double

M

Minimum allowed amount.
if min > 0 then validate the min amount else no need to check min amount.

max

Double

M

Maximum allowed amount
if max > 0 then validate the max amount else no need to check max amount.

 

Card No Validation


Class CardNoValidation

Parameter

Data Type

Mandatory

Description

prefixes

Array

M

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

regex

String

M

Regex for allowed prefix credit card number.

luhn

Boolean

M

LUHN check for credit card number.

Default: true

 

Card Token Info


Class CardTokenInfo

Parameter

Data Type

Mandatory

Description

token

String

M

Card token id.

cardNo

String

M

Masked credit card number.

expiryDate

String

M

Credit card expiry date.

based on status

• EX: return card expiry date
• A: return masked card expiry date
• ED: return empty card expiry date

name

String

M

Customer’s name.

email

String

M

Customer’s email.

status

String

M

Credit card available status.

For prompt input to user if specific card was expired for expired/expiring month and year.

• ED: = Expired
• EX: = Expiring within 6 months
• A: = Available for use

iconUrl

String

M

Credit card brand icon url.

logoUrl

String

M

Credit card brand logo url.

 

Card Type Validation


Class CardTypeValidation

Parameter

Data Type

Mandatory

Description

sequenceNo

Integer

M

Sequence number of list.

name

String

M

Credit card brand name.

prefixes

Array

M

Array of prefix numbers to identify the credit card scheme.

regex

String

M

Regex for identify the card scheme.

iconUrl

String

M

Credit card scheme icon url.

 

Common Validation


Class CommonValidation

Parameter

Data Type

Mandatory

Description

cardNo

CardNoValidation

M

Credit Card number validation.

Refer: Card No Validation

cardTypes

Array

M

Credit card type validation list.

Refer: Card Type Validation

 

Configuration Info


Class ConfigurationInfo

Parameter

Data Type

Mandatory

Description

payment

PaymentConfiguration

M

Payment related configuration.

Refer: Payment Configuration

notification

PaymentNotification

M

Payment notification platform configuration.

Refer: Payment Notification

 

Dynamic Currency Conversion


Class DynamicCurrencyConversion

Parameter

Data Type

Mandatory

Description

active

Boolean

M

Dynamic currency conversion feature active status.

terms

String

M

Dynamic currency conversion term and condition.

 

Exchange Rate


Class ExchangeRate

Parameter

Data Type

Mandatory

Description

multipleCurrencyPricing

MultipleCurrencyPricing

M

Exchange rate multiple currency pricing.

Refer: Multiple Currency Pricing

dynamicCurrencyConversion

DynamicCurrencyConversion

M

Exchange rate dynamic currency conversion.

Refer: Dynamic Currency Conversion

alternativePaymentMethodMultipleCurrencyConversion

AlternativePaymentMethodMultipleCurrencyConversion

C

Exchange rate alternative payment method multiple currency conversion.

Refer: Alternative Payment Method Multiple Currency Conversion

 

FX Rate


Class FXRate

Parameter

Data Type

Mandatory

Description

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 code

 

Installment Plan


Class InstallmentPlan

Parameter

Data Type

Mandatory

Description

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

Instalment monthly amount.

monthlyInterest

Double

M

Installment monthly interest.

currencyCode

String

M

Installment currency code.

Based on ISO 4217 - A3 currency code

label

String

M

Installment plans label.

 

Merchant Additional Info


Class MerchantAdditionalInfo

Parameter

Data Type

Mandatory

Description

id

String

M

Merchant id.

name

String

M

Merchant name.

address

String

M

Merchant address.

email

String

M

Merchant email.

logoUrl

String

M

Merchant logo url.

bannerUrl

String

M

Merchant banner url.

 

Merchant Info


Class MerchantInfo

Parameter

Data Type

Mandatory

Description

id

String

M

Merchant id.

name

String

M

Merchant name.

address

String

M

Merchant address.

email

String

M

Merchant email.

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.

 

Multiple Currency Pricing


Class MultipleCurrencyPricing

Parameter

Data Type

Mandatory

Description

active

Boolean

M

Multiple currency pricing feature active status.

terms

String

M

Multiple currency pricing term and condition.

 

Payment Channel


Class PaymentChannel

Parameter

Data Type

Mandatory

Description

sequenceNo

Integer

M

Sequence number of list.

name

String

M

Payment channel name.

currencyCodes

Array

M

Payment channel enabled currency code.

iconUrl

String

M

Payment channel icon url.

logoUrl

String

M

Payment channel logo url.

down

Boolean

M

Payment channel online/offline status.

Down is true mean this payment channel is Down/Offline

context

PaymentContext

M

Payment channel payment context information.

Refer: Payment Context

 

Payment Channel Category


Class PaymentChannelCategory

Parameter

Data Type

Mandatory

Description

sequenceNo

Integer

M

Sequence number of list.

name

String

M

Payment channel category name.

code

String

M

Payment channel category code.

iconUrl

String

M

Payment channel category icon url.

logoUrl

String

M

Payment channel category logo url.

default

Boolean

M

Default selected payment channel category.

groups

Array

M

Payment channel group list.

Refer: Payment Channel Group

 

Payment Channel Group


Class PaymentChannelGroup

Parameter

Data Type

Mandatory

Description

sequenceNo

Integer

M

Sequence number of list.

name

String

M

Payment channel group name.

code

String

M

Payment channel group code.

iconUrl

String

M

Payment channel group icon url.

logoUrl

String

M

Payment channel group logo url.

default

Boolean

M

Default selected payment channel group.

 

Payment Code


Class PaymentCode

Parameter

Data Type

Mandatory

Description

Constructors (channelCode)

String

C

Init class constructor with channel code.

Constructors (channelCode, agentCode, agentChannelCode)

String, String, String

C

Init class constructor with payment channel code, agent code and agent channel code.

channelCode

String

M

Payment channel code.

agentCode

String

M

Payment agent code.

agentChannelCode

String

M

Payment agent channel code.

 

Payment Configuration


Class PaymentConfiguration

Parameter

Data Type

Mandatory

Description

immediatePayment

Boolean

M

Payment with immediate without user input.

if single payment option and not contains mandatory user input will be redirect to 3rd party payment page.

Default : false

tokenize

Boolean

M

Tokenization enabled for credit card payment.

Default : false

tokenizeOnly

Boolean

M

Tokenization enabled for Credit Card as card token without perform transaction.

Config at Payment Token API

• true – Change to TWA layout.
• false – use as normal credit card layout.

cardTokenOnly

Boolean

M

Enforce use card token payment only.

exchangeRate

ExchangeRate

M

Exchange rate information.

Refer: Exchange Rate

 

Payment Context


Class PaymentContext

Parameter

Data Type

Mandatory

Description

code

PaymentCode

M

Payment code information.

Refer: Payment Code

input

PaymentInput

M

Payment input information.

Refer: Payment Input

validation

PaymentValidation

M

Payment validation information.

Refer: Payment Validation

info

PaymentInfo

M

Payment info information.

Refer: Payment Info

 

Payment Data


Class PaymentData

Parameter

Data Type

Mandatory

Description

name

String

O

Customer’s name.

email

String

O

Customer’s email.

mobileNo

String

O

Customer’s mobile number.

accountNo

String

O

Customer’s account number.

cardNo

String

O

Credit card number.

expiryMonth

Integer

O

Credit card expiry month.

expiryYear

Integer

O

Credit card expiry year.

securityCode

String

O

Credit card security code.

pin

String

O

Credit card pin.

bank

String

O

Credit card issuer bank name.

country

String

O

Credit card issuer country code.

tokenize

Boolean

O

Allowing customer to tokenize card info.

installmentInterestType

String

O

Installment interest type.

installmentPeriod

Integer

O

Installment period in month.

token

String

O

Token from card token id or digital payment.

qrType

String

O

QR data type.

fxRateId

String

O

Exchange rate id.

billingAddress1

String

O

Customer's billing address 1.

billingAddress2

String

O

Customer's billing address 2.

billingAddress3

String

O

Customer's billing address 3.

billingCity

String

O

Customer's billing city.

billingState

String

O

Customer's billing state.

billingPostalCode

String

O

Customer's billing postal code

billingCountryCode

String

O

Customer's billing country code.

paymentExpiry

String

O

Payment expiry datetime.

 

Payment Info


Class PaymentInfo

Parameter

Data Type

Mandatory

Description

terms

String

M

Term and condition information.

promoUrl

String

M

Promo image URL.

installmentPlans

Array

M

Installment plan information list.

Refer: Installment Plan

paymentCustomDatas

Array

M

Additional custom data list from acquirer or specific info for payment channel.

Refer: Payment Custom Data

paymentProvider

PaymentProvider

M

Payment provider info.

Refer: Payment Provider

 

Payment Input


Class PaymentInput

Parameter

Data Type

Mandatory

Description

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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: Payment Input Code

email

String

M

Email input view visibility and validation for UI.

Based on admin portal configuration.

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

Default : M

Note: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: 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: For “I” (Ignore) means for bypass validation and hide the user input field view.

Refer: Payment Input Code

 

Payment Notification


Class PaymentNotification

Parameter

Data Type

Mandatory

Description

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.

Based on admin portal configuration.

Default : false

line

Boolean

M

LINE subscription view visibility based on admin portal configuration.

Based on admin portal configuration.

Default : false

 

Payment Request


Class PaymentRequest

Parameter

Data Type

Mandatory

Description

code

PaymentCode

M

Payment code for payment channel information.

Refer: Payment Code

data

PaymentData

M

Payment data for payment request.

Refer: Payment Data

 

Payment Result Additional Info


Class PaymentResultAdditionalInfo

Parameter

Data Type

Mandatory

Description

redirectImmediately

Boolean

M

Redirect immediately to frontend return url.

• true, redirect payment response to frontend return url.

• false, do action based on auto redirection flag.

autoRedirect

Boolean

M

Auto redirect to frontend return url after x second.

• true, auto redirect x second based on auto redirect timer to payment response.

• false, user need manually do action (click on button)

autoRedirectTimer

Integer

M

Auto redirect second.

Based on admin portal configuration.

In milliseconds (ms)

1000 = 1 second

frontendReturnUrl

String

M

Merchant frontend page return url.

If url is empty, UI should not show back to merchant button.

frontendReturnData

String

M

Data to be posted to merchant frontend return url

Based on base64 encoded.

If data is empty, UI should not show 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 : Show paymentResult message based on color above by code for UI.

Refer: API Response Code

responseDescription

String

M

Payment result response description.

 

Payment Validation


Class PaymentValidation

Parameter

Data Type

Mandatory

Description

name

String

M

Regex for name input.

email

String

M

Regex for email input.

mobileNo

String

M

Regex for mobile number input.

cardNo

String

M

Regex for credit card number input.

expiryDate

String

M

Regex for credit card expiry date input.

securityCode

String

M

Regex for credit card security coded input.

pin

String

M

Regex for credit card pin input.

token

String

M

Regex for card token id or digital payment input.

accountNo

String

M

Regex for account number input.

billingAddress1

String

M

Regex for billing address 1.

billingAddress2

String

M

Regex for billing address 2.

billingAddress3

String

M

Regex for billing address 3.

billingCity

String

M

Regex for billing city.

billingState

String

M

Regex for billing state.

billingPostalCode

String

M

Regex for billing postal code.

billingCountryCode

String

M

Regex for billing country code.

additional

PaymentValidationAdditional

M

Additional validation input of parameter for specific channel.

Refer: Payment Validation Additional

 

Payment Validation Additional


Class PaymentValidationAdditional

Parameter

Data Type

Mandatory

Description

cardNo

CardNoValidation

M

Credit card number validation.

Refer: Card No Validation

amount

AmountValidation

M

Amount validation.

Refer: Amount Validation

 

Recurring Info


Class RecurringInfo

Parameter

Data Type

Mandatory

Description

amount

String

M

Recurring amount.

interval

Integer

M

Recurring interval in days.

count

Integer

M

Recurring total count allowed.

chargeNextDate

String

M

The next date of recurring payment for transaction.

chargeOnDate

String

M

Recurring charge on specific date every month.

 

System Initialization


Class SystemInitialization

Parameter

Data Type

Mandatory

Description

locales

Array

M

Locale information.

Refer: System Locale

 

System Locale


Class SystemLocale

Parameter

Data Type

Mandatory

Description

code

String

M

Locale code.

Based on ISO 639.

name

String

M

Locale name.

iconUrl

String

M

Locale icon url.

 

Transaction Additional Info


Class TransactionAdditionalInfo

Parameter

Data Type

Mandatory

Description

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 date time.

Date format “ yyyyMMddHHmmss”

agentCode

String

M

Agent code.

channelCode

String

M

Agent channel code.

data

String

M

Processed payment data from agent.

interestType

String

M

Installment Interest Type.

interestRate

Double

M

Installment interest rate.

monthlyAmount

Double

M

Instalment monthly amount.

installmentPeriod

Integer

M

Installment tenor period.

 

Transaction Info


Class TransactionInfo

Parameter

Data Type

Mandatory

Description

amount

String

M

Transaction amount.

currencyCode

String

M

Transaction currency code.

invoiceNo

String

M

Transaction invoice number.

productDescription

String

M

Transaction product description.

recurring

RecurringInfo

M

Recurring information.

Refer: Recurring Info

paymentItemInfos

Array

M

Payment items information.

Refer: Payment Item Info

 

Transaction Status Additional Info


Class TransactionStatusAdditionalInfo

Parameter

Data Type

Mandatory

Description

merchantInfo

MerchantAdditionalInfo

M

Additional merchant information.

Refer: Merchant Additional Info

transactionInfo

TransactionAdditionalInfo

M

Additional transaction information.

Refer: Transaction Additional Info

resultInfo

PaymentResultAdditionalInfo

M

Additional payment result information.

Refer: Payment Result Additional Info

 

User Preference


Class UserPreference

Parameter

Data Type

Mandatory

Description

name

String

M

Customer's name.

email

String

M

Customer's email.

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

For pre-selected country code.

 

User Preference Info


Class UserPreferenceInfo

Parameter

Data Type

Mandatory

Description

preference

UserPreference

M

User preference information.

Refer: User Preference

channels

Array

M

User preference payment channel list.

Refer: User Preference Payment Channel

 

User Preference Payment Channel


Class UserPreferencePaymentChannel

Parameter

Data Type

Mandatory

Description

sequenceNo

Integer

M

Sequence number of list.

name

String

M

Payment channel name.

categoryCode

String

M

Payment channel category code.

groupCode

String

M

Payment channel group code.

channelCode

String

M

Payment channel code.

iconUrl

String

M

Payment channel icon url.

logoUrl

String

M

Payment channel logo url.

 

Alternative Payment Method Multiple Currency Conversion


Class AlternativePaymentMethodMultipleCurrencyConversion

Parameter

Data Type

Mandatory

Description

active

Boolean

M

Alternative payment method multiple currency conversion feature active status.

terms

String

M

Alternative payment method multiple currency conversion term and condition.

 

Payment Custom Data


Class PaymentCustomData

Parameter

Data Type

Mandatory

Description

sequenceNo

Integer

M

Sequence number of list.

type

String

M

Data Type.

Refer Payment Custom Data Code

data

String

M

Data information.

 

Payment Item Info


Class PaymentItemInfo

Parameter

Data Type

Mandatory

Description

code

Integer

M

Payment item code.

name

String

M

Payment item name.

quantity

Integer

M

Payment item quantity.

price

Double

M

Payment item price.

 

User Address


Class UserAddress

Parameter

Data Type

Mandatory

Description

userBillingAddress

UserBillingAddress

M

Customer's billing address.

Refer: User Billing Address

 

User Billing Address


Class UserBillingAddress

Parameter

Data Type

Mandatory

Description

address1

String

M

Customer's billing address 1.

address2

String

M

Customer's billing address 2.

address3

String

M

Customer's billing address 3.

city

String

M

Customer's billing city.

state

String

M

Customer's billing state.

postalCode

String

M

Customer's billing postal code

countryCode

String

M

Customer's billing country code.

 

User Info


Class UserInfo

Parameter

Data Type

Mandatory

Description

userAddress

UserAddress

M

Customer's address.
Refer: User Address

 

Transaction Result Additional Info


Class TransactionResultAdditionalInfo

Parameter

Data Type

Mandatory

Description

qrData

String

O

QR data.

barcodeData

String

O

Barcode data.

referenceNo

String

O

Payment reference number.

 

Payment Provider


Class PaymentProvider

Parameter

Data Type

Mandatory

Description

id

String

C

Payment provider id.

channels

Array

C

Allowed payment channels.

merchantInfo

MerchantInfo

C

Merchant information.

Refer Merchant Info

transactionInfo

TransactionInfo

C

Transaction information

Refer Transaction Info