Payment Token Request Parameters

merchantID

AN 25

M

Unique merchant ID that is registered with 2C2P

invoiceNo

AN 50

M

Unique merchant order number.
Example: 00000000010000091203

Pass through invoice no restriction :

*Limited to length of 12 numerals when requesting for APM payment for Myanmar.

*Limited to length of 20 alphanumeric when requesting for QR Payment.

idempotencyID

C 100

O

Unique value generated by the merchant that is used to recognize subsequent retries of the same request.

description

C 250

M

Product description. HTML Encode is required if it contains special characters.

amount

D (12,5)

M

Example: 000000002500.90000

currencyCode

A 3

M

Transaction currency code in 3 alphabetical values as specified in ISO 4217.

If the value is empty, the system
will use the merchant's base currency

paymentChannel

Array AN 1-6

O

Payment channel required to enable. If this value is empty, "ALL" payment channels will be used.

Value must be in string array if multiple payment channels are requested.

Example : ["CC", "IPP", "APM", "QR"]

Refer to Payment Channel List.

agentChannel

Array AN 1-6

O

Agent channel is required to enable if paymentChannel = '123'

Value must be in string array.

Example : ["WEBPAY", "ATM", "OVERTHECOUNTER"]

Refer to Agent Channel Code

request3DS

A1

O

Specify enable/disable 3ds authentication

• Y – Enable 3ds (default)
• F – Force 3ds
• N – Disable 3ds

tokenize

B

O

Specify whether display store card checkbox is in payment page. Used to enable tokenization and card token will be returned when payment is approved.

Used by SDK UI

cardToken

Array
C 255

O

To register card tokens for payment. When a merchant requests to do Payment API later, only the registered card tokens are retrieved

Value must be in string array if multiple card tokens are requested.

Example : ["00001", "00002"]

Specify whether to allow card token only. This is only applicable for card payment page.

If merchant set to card token only, new card options are not allowed in the payment page.

customerToken

Array
C 255

O

To register wallet tokens for payment. When a merchant requests to do Payment API later, only the registered wallet tokens are retrieved

Value must be in string array if multiple wallet tokens are requested.

Example : ["00001", "00002"]

Specify whether to allow customer token only. This is only applicable for customer payment page.

If merchant set to customer token only, new wallet options are not allowed in the payment page.

tokenizeOnly

B

O

Specify whether to require tokenization with authorization

true - Tokenization without authorization
false - Tokenization with authorization (Default)

Used by SDK UI

storeCredentials

A 1

O

Store Credential (depend on acquiring bank whether support COF)

F – First time payment
S – Subsequent payment
N – Not using

interestType

A 1

O

Installment interest type

A – All available options (Default)
C – Customer Pay Interest Option ONLY
M – Merchant Pay Interest Option ONLY

installmentPeriodFilter

Array

N 2

O

Select Installment Payment Plan Period that the merchant wants to offer.

Example:
Available periods are 3,6,12,24 months, but if the merchant wants to restrict to 3 & 6 months only, enter the value as [3,6]

Value must be in Integer

installmentBankFilter

Array

N 2

O

Select Installment Banks that the merchant wants to offer.

Example:
Available banks are HSBC, Citibank, but if the merchant wants to restrict to Citibank only, enter the value as ["Citibank"]

Value must be in String

productCode

AN 50

O

Installment product code

recurring

B

O

true - enable recurring
false - disable recurring (Default)

invoicePrefix

AN 15

C

Recurring transaction will add 5 additional digit behind invoicePrefix as invoice number.

mandatory if recurring is set to true

recurringAmount

D (12,5)

O

Recurring charge amount. If this value is not set, system will use transaction amount

allowAccumulate

B

C

Allow accumulation of failed Recurring transaction amounts

true - Allow
false - Do not allow

mandatory if recurring is set to true

maxAccumulateAmount

D (12,5)

C

Maximum recurring accumulated amount.

If the maximum accumulated amount is exceeded, recurring feature will be terminated.

mandatory if recurring is set to true

recurringInterval

N 3

C

Recurring interval in days, system will charge every x days

Example:
set to 30 days, payment was made on 1 May 2020,
System will charge next cycle on 1 June 2020 and so on.

mandatory if recurring is set to true

recurringCount

N 5

C

Specify the number of cycles of recurring payment that the system will charge.

mandatory if recurring is set to true

Set this to '0' to charge indefinitely until terminated manually.

chargeNextDate

N 8

O

The next date of recurring payment

format: ddMMyyyy

Only required if RPP with recurringInterval is set.

If RPP is using chargeOnDate then chargeNextDate is optional. If chargeNextDate is not set, chargeOnDate Date and Month will be used.

chargeOnDate

N 4

C

Indicate Recurring payment charge on specific day of every month.

Date format is ddMM.

dd represents which day of every month that the recurring payment is charged.

MM is only used if field chargeNextDate is not set.

If this value is set, recurringInterval will not be valid.

mandatory if recurring is set to true

paymentExpiry

C 19

O

Duration of time which the customer is allowed to complete payment. Payment completed after the expiry date/time will be rejected.

Date Format : yyyy-MM-dd HH:mm:ss

Default value is 30 minutes

promotionCode

AN 20

O

Promotion code for the payment.

paymentRouteID

C 255

O

Payment routing rules based on custom configuration

fxProviderCode

AN 20

O

Forex provided code used to enable multiple currency payments

fxRateId

C 50

O

Forex rate id

Refer to Exchange Rate API.

originalAmount

D 12,5

O

original currency amount

immediatePayment

B

O

To trigger payment immediately

iframeMode

B

O

To determine this payment is in iframe mode

userDefined1

C 150

O

For merchant to submit merchant's specific data.

userDefined2

C 150

O

For merchant to submit merchant's specific data.

userDefined3

C 150

O

For merchant to submit merchant's specific data.

userDefined4

C 150

O

For merchant to submit merchant's specific data.

userDefined5

C 150

O

For merchant to submit merchant's specific data.

statementDescriptor

AN 20

O

Dynamic statement description

• Contains between 5 and 22 characters, inclusive.
• Doesn’t contain any of the following special characters: < > \ ' " *

* Feature availibity subject to acquirer bank

protocolVersion

AN 10

O

3DsProtocol version

Default value is "2.1.0"

eci

N 2

C

Required if parameter protocolVersion or cavv or dsTransactionId is pass in.

cavv

AN 40

C

Required if parameter protocolVersion or cavv or dsTransactionIdis pass in.

dsTransactionId

C 36

O

Required if parameter protocolVersion or eci or cavv is pass in.

externalSubMerchantID

AN 50

O

External Sub Merchant ID

subMerchants

-

O

Sub merchant list

merchantID

AN 25

M

Unique sub merchant ID that is registered with 2C2P

invoiceNo

AN 20

M

Unique merchant order number.
Example: 00000000010000091203

*Limited to 12 numericals when requesting for APM payment for Myanmar.

amount

D (12,5)

M

Example: 000000002500.90000

description

C 255

M

Product description. HTML Encode is required if it contains special characters.

originalAmount

D (12,5)

O

Example: 000000002500.90000

paymentItems

-

O

Payment Items list

code

C 25

O

Example: MSK001

name

C 50

O

Example: "Green Mask"

quantity

N 4

O

Example: 1000

price

D (12,2)

O

Example: 7.00

locale

C 10

O

Specify payment page and API response localization

Refer to Initialization API for the language code list.

frontendReturnUrl

C 255

O

Specify the return url to be redirected to merchant after payment is completed via 2C2P.

backendReturnUrl

C 255

O

Specify backend url to be notified after payment is completed via 2C2P.

schemeReturnUrl

C 512

O

If client is mobile phone, merchant may submit the return schemeReturnUrl

appBundleID

C 255

C

Bundle identifier for the app. This parameter is required when "schemeReturnUrl" is used.

Example : com.sample.merchant.app

nonceStr

C 32

O

Nonce random string

uiParams

-

O

Extra information parameters

userInfo

-

O

Pre-fill User information by merchant

C 50

O

User name

C 150

O

User email

N 15

O

User mobile no

A 2

O

Address country in A2 of ISO3166 format

N 2

O

User mobile no prefix

A 3

O

User currency code

customerAddress

billing

M

O

O

M

O

M

M

shipping

M

O

O

M

O

M

M

airlinePassengers

passenger

M

M

O

O

M

O

M

O

O

O

• ADT : Adult
• CNN : Child
• INF: Infant
• YTH : Youth
• STU : Student
• SCR : Senior Citizen
• MIL : Military

agency

O

O

O

O

issuer

M

M

O

M

M

M

O

O

M

M

M

M

legs

M

M

M

O

M

M

M

M

M

M

• false : stopover is not restricted
• true : stopover is restricted

M

M

• RESTRICTED
• NORESTRICED
• ENDORSED
• NOT REFUNDABLE
• NOT ENDORSABLE
• NOT REROUTEABLE
• REFUNDABLE ONLY TO
• RESERVATION REQUESTS/WAITLISTED FLIGHTS
• FARE SUBJECT TO GOVERNMENT APPROVAL
• VALIDITY OR TRAVEL RESTRICTIONS
• CERTIFICATE NUMBERS (IF AIRLINE ADVISES)

O

O

O

O

O

3DSecure2Params

payer

accountCreateDate

O

O

• 01 = No account (guest check-out)
• 02 = Created during this transaction
• 03 = Less than 30 days
• 04 = 30-60 days
• 05 = More than 60 days

O

O

• 01 = Changed during this transaction
• 02 = Less than 30 days
• 03 = 30-60 days
• 04 = More than 60 days

O

O

• 01 = No change
• 02 = Changed during this transaction
• 03 = Less than 30 days
• 04 = 30-60 days
• 05 = More than 60 days

O

O

• 01 = No account (guest check-out)
• 02 = During this transaction
• 03 = Less than 30 days
• 04 = 30-60 days
• 05 = More than 60 days

O

• 01 = No suspicious activity has been observed
• 02 = Suspicious activity has been observed

O

maximum is 9999.

O

O

O

O

Format: YYYYMMDD

O

Values accepted:
• 01 = This transaction
• 02 = Less than 30 days
• 03 = 30-60 days
• 04 = More than 60 days

O

• 01 = Account Name identical to shipping Name
• 02 = Account Name different than shipping Name

O

• 01 = Electronic Delivery
• 02 = Same day shipping
• 03 = Overnight shipping
• 04 = Two-day or more shipping

valid values 00-99

Currency code in 3 alphabetical values as specified in ISO 4217.

• 01 = Merchandise available
• 02 = Future availability

• 01 = First time ordered
• 02 = Reordered

• 01 = Ship to cardholder’s billing address
• 02 = Ship to another verified address on file with merchant
• 03 = Ship to address that is different than the cardholder’s billing address
• 04 = “Ship to Store” / Pick-up at local store (Store address shall be populated in shipping address fields)
• 05 = Digital goods (includes online services, electronic gift cards and redemption codes)
• 06 = Travel and Event tickets, not shipped
• 07 = Other (for example, gaming, digital services not shipped, emedia subscriptions, etc.)

• C = Customer (Default)

• M = Merchant 

Only applicable for those using 2C2P's authentication and with the request of "request3DS = Y"

• Y – allow upgrade to use 3DS if sca exemption didnt go through and soft decline happened

• N - does not allow auto upgrade