Payment Token Request 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 |
||||
---|---|---|---|---|---|---|---|
merchantID |
AN 25 |
M |
Unique merchant ID that is registered with 2C2P |
||||
invoiceNo |
AN 50 |
M |
Unique merchant order number. 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 |
||||
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
|
||||
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 |
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"] |
||||
cardTokenOnly | B | O |
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 |
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"] |
customerTokenOnly | B | O |
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 Used by SDK UI |
||||
storeCredentials |
A 1 |
O |
Store Credential (depend on acquiring bank whether support COF)
F – First time payment |
||||
interestType |
A 1 |
O |
Installment interest type
A – All available options (Default) |
||||
installmentPeriodFilter |
Array N 2 |
O |
Select Installment Payment Plan Period that the merchant wants to offer.
Example: Value must be in Integer |
||||
installmentBankFilter |
Array N 2 |
O |
Select Installment Banks that the merchant wants to offer.
Example: Value must be in String |
||||
productCode |
AN 50 |
O |
Installment product code |
||||
recurring |
B |
O |
true - enable recurring |
||||
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 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: 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
* 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. *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. |
|||
loyaltyPoints | - | O | List of loyalty points | ||||
providerID | AN 20 | O | Loyalty point provider id | ||||
externalMerchantId | AN 50 | C | External mercahnt id | ||||
redeemAmount | D 12,5 | O | Amount | ||||
rewards | - | O | List of rewards | ||||
quantity | N | O | Rewards quantity | ||||
|
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 |
|||
|
|
name |
C 50 |
O |
User name |
||
|
|
C 150 |
O |
User email |
|||
|
|
mobileNo |
N 15 |
O |
User mobile no |
||
|
|
countryCode |
A 2 |
O |
Address country in A2 of ISO3166 format |
||
|
|
mobileNoPrefix |
N 2 |
O |
User mobile no prefix |
||
|
|
currencyCode |
A 3 |
O |
User currency code |
||
customerAddress |
- | O | Address information array | ||||
billing |
- | O | Billing address object | ||||
|
|
address1 | C 255 |
M |
Address line 1 | ||
|
|
address2 | C 255 |
O |
Address line 2 | ||
|
|
address3 | C 255 |
O |
Address line 3 | ||
|
|
city | C 255 |
M |
Address city | ||
|
|
state | C 255 |
O |
Address state | ||
|
|
postalCode | AN 10 |
M |
Address postal code | ||
|
|
countryCode | A 2 |
M |
Address country in A2 of ISO3166 format | ||
shipping |
- | O | Shipping address object | ||||
|
|
address1 | C 255 |
M |
Address line 1 | ||
|
|
address2 | C 255 |
O |
Address line 2 | ||
|
|
address3 | C 255 |
O |
Address line 3 | ||
|
|
city | C 255 |
M |
Address city | ||
|
|
state | C 255 |
O |
Address state | ||
|
|
postalCode | AN 10 |
M |
Address postal code | ||
|
|
countryCode | A 2 |
M |
Address country in A2 of ISO3166 format | ||
airlinePassengers |
- | O | Airline Passengers array | ||||
passenger |
- | O | Passenger object | ||||
|
|
purchaser | B |
M |
Indicate whether is passenger or purchaser of ticket | ||
|
|
identificationNo | C 50 |
M |
Passenger's identification document no | ||
|
|
documentType | C 3 |
O |
Passenger's document type | ||
|
|
title | C 50 |
O |
Passenger's title | ||
|
|
firstName | C 50 |
M |
Passenger's first name | ||
|
|
middleName | C 50 |
O |
Passenger's middle name | ||
|
|
lastName | C 50 |
M |
Passenger's last name | ||
|
|
C 150 |
O |
Passenger's email | |||
|
|
mobileNo | C 15 |
O |
Passenger's mobile no | ||
|
|
type | C 32 |
O |
Passenger's type
|
||
agency |
- | O | Agency information | ||||
|
|
name | C 25 |
O |
Travel agency name If the ticket is sold through agency |
||
|
|
code | C 8 |
O |
Travel agency code If the ticket is sold through agency |
||
|
|
invoiceNo | C 50 |
O |
Travel agency invoice no If the ticket is sold through agency |
||
|
|
planName | C 50 |
O |
Travel agency plan If the ticket is sold through agency |
||
issuer |
- | M | Ticket issuer information | ||||
|
|
ticketNo | C 13 |
M |
Ticket issuing no. | ||
|
|
ticketIssueDate | C 8 |
M |
Ticket issuing date Ticket issue date in local time format : yyyyMMdd |
||
|
|
ticketReservationSystem | C 4 |
O |
Ticket issuing reservation system | ||
|
|
carrierName | C 50 |
M |
Ticket issuing airline carrier name | ||
|
|
carrierCode | C 2 |
M |
Ticket issuing airline carrier code | ||
|
|
address1 | C 255 |
M |
Ticket issuer address 1 | ||
|
|
address2 | C 255 |
O |
Ticket issuer address 2 | ||
|
|
address3 | C 255 |
O |
Ticket issuer address 3 | ||
|
|
postalCode | AN 10 |
M |
Ticket issuer postal code | ||
|
|
city | C 255 |
M |
Ticket issuer city | ||
|
|
state | C 255 |
M |
Ticket issuer state | ||
|
|
countryCode | A 2 |
M |
Ticket issuer country code Country code in 2 alphabet value as specified in ISO 3166. |
||
legs |
- | M | Airline legs array | ||||
|
|
sequenceNo | N 5 |
M |
Airline leg sequence no. | ||
|
|
carrierCode | C 2 |
M |
Airline carrier code | ||
|
|
flightNo | C 5 |
M |
Airline flight no. | ||
|
|
flightType | C 32 |
O |
Airline flight type | ||
|
|
originCountryCode | A 2 |
M |
Airline origin city's airport code Country code in 2 alphabet value as specified in ISO 3166. |
||
|
|
destinationCountryCode | A 2 |
M |
Airline destination city's airport code Country code in 2 alphabet value as specified in ISO 3166. |
||
|
|
departureDateTime | C 19 |
M |
Airline departure date time Departure time in local time yyyy-MM-dd HH:mm:ss |
||
|
|
arrivalDateTime | C 19 |
M |
Airline arrival date time Arrival time in local time yyyy-MM-dd HH:mm:ss |
||
|
|
serviceClass | C 1 |
M |
Airline service class | ||
|
|
stopOver | B |
M |
Airline indicate if stop allow or not
|
||
|
|
fareBasisCode | C 6 |
M |
Airline fare basis code | ||
|
|
endorcementOrRestriction | C 12 |
M |
Airline restriction applied on ticket.
|
||
|
|
fare | D (12,5) |
O |
Airline fare for the leg in payment currency | ||
|
|
fee | D (12,5) |
O |
Airline fee for the leg in payment currency | ||
|
|
tax | D (12,5) |
O |
Airline tax for the leg in payment currency | ||
|
|
departureTaxCurrencyCode | A 3 |
O |
Airline departure tax currency for leg Currency code in 3 alphabet value as specified in ISO 4217. |
||
|
|
departureTaxAmount | D (12,5) |
O |
Airline departure tax amount for leg | ||
3DSecure2Params |
- | O | 3DS 2 Parameters Objects | ||||
payer |
- | O | Payer information | ||||
accountCreateDate |
C 8 |
O |
Format: YYYYMMDD | ||||
accountAgeIndicator | C 2 |
O |
Account Age Indicator
• 01 = No account (guest check-out) |
||||
accountChangeDate | C 8 |
O |
Format: YYYYMMDD | ||||
accountChangeIndicator | C 2 |
O |
Account Change Indicator
• 01 = Changed during this transaction |
||||
accountPasswordChangeDate | C 8 |
O |
Format: YYYYMMDD | ||||
accountPasswordChangeIndicator | C 2 |
O |
Account Password Change Indicator
• 01 = No change |
||||
paymentAccountCreateDate | C 8 |
O |
Format: YYYYMMDD | ||||
paymentAccountAgeIndicator | C 2 |
O |
Payment Account Age Indicator
• 01 = No account (guest check-out) |
||||
suspiciousAccountActivity | C 2 |
O |
Suspicious Account Activity
• 01 = No suspicious activity has been observed |
||||
purchaseCountLast6Months | C 4 |
O |
Number of purchases with this cardholder account during the
previous six months.
maximum is 9999. |
||||
transactionCountLast24Hours | C 3 |
O |
Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. | ||||
transactionCountLastYear | C 3 |
O |
Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. | ||||
provisionAttemptCountLast24Hours | C 3 |
O |
Number of Add Card attempts in the last 24 hours. | ||||
shippingAddressCreateDate | C 8 |
O |
Date when the shipping address used for this transaction was first used
with the 3DS Requestor.
Format: YYYYMMDD |
||||
shippingAddressAgeIndicator | C 2 |
O |
Indicates when the shipping address used for this transaction was first
used with the 3DS Requestor.
Values accepted: |
||||
shippingNameIndicator | C 2 |
O |
Ship Name Indicator
• 01 = Account Name identical to shipping Name |
||||
contact | - |
O |
Contact Information | ||||
home | - | O | For Home Contact | ||||
countryCode | A 2 | O | Home phone country code. | ||||
subscriberNo | C 15 | O | Home phone subscriber number. | ||||
mobile | - | O | For Mobile Contact | ||||
countryCode | A 2 | O | Mobile phone country code. | ||||
subscriberNo | C 15 | O | Mobile phone subscriber number. | ||||
work | - | O | For Work Contact | ||||
countryCode | A 2 | O | Workphone country code. | ||||
subscriberNo | C 15 | O | Work phone subscriber number. | ||||
order | - | O | Merchant Risk Info | ||||
deliveryEmailAddress | C 254 | O | Email address | ||||
deliveryTimeframe | C 2 | O |
deliveryTimeFrame
• 01 = Electronic Delivery |
||||
giftCardAmount | C 15 | O | For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units (for example, USD 123.45 is 123). | ||||
giftCardCount | C 2 | O |
giftCardCount
valid values 00-99 |
||||
giftCardCurrencyCode | A 3 | O |
giftCardCurrency
Currency code in 3 alphabetical values as specified in ISO 4217. |
||||
preOrderDate | C 8 | O | Format: YYYYMMDD | ||||
preOrderPurchaseIndicator | C 2 | O |
Preorder Purchase Indicator
• 01 = Merchandise available |
||||
reorderItemsIndicator | C 2 | O |
Reorder Items Indicator
• 01 = First time ordered |
||||
shippingIndicator | C 2 | O |
Shipping Indicator
• 01 = Ship to cardholder’s billing address |
||||
deviceChannel | - | O | fixed - BRW | ||||
browserInfo | - | O | Browser Info, if not available submit null object | ||||
browserAcceptHeader | C 2048 | M | Exact content of the HTTP accept headers from the Cardholder’s browser | ||||
browserIP | C 45 | M | IP address of the browser as returned by the HTTP headers | ||||
browserJavaEnabled | B | M | Boolean that represents the ability of the cardholder browser to execute Java. | ||||
browserLanguage | C 8 | M | Value representing the browser language as defined in IETF BCP47 | ||||
browserColorDepth | C 2 | M |
Value representing the bit depth of the colour palette for
displaying images, in bits per pixel. Values accepted: • 1 = 1 bit • 4 = 4 bits • 8 = 8 bits • 15 = 15 bits • 16 = 16 bits • 24 = 24 bits • 32 = 32 bits • 48 = 48 bits |
||||
browserScreenHeight | C 6 | M | Total height of the Cardholder’s screen in pixels. | ||||
browserScreenWidth | C 6 | M | Total width of the Cardholder’s screen in pixels. | ||||
browserTZ | C 5 | M | Time difference between UTC time and the Cardholder browser local time, in minutes. | ||||
browserUserAgent | C 2048 | M | Exact content of the HTTP user-agent header from Cardholder's browser | ||||
browserJavaScriptEnabled | B | M | Boolean that represents the ability of the cardholder browser to execute JavaScript. | ||||
loyaltyPoints | - | O | List of loyalty points | ||||
providerID | AN 20 | O | Loyalty points provider id | ||||
accountNo | AN 255 | O | Account no | ||||
externalMerchantID | AN 50 | C | External Loyalty Merchant ID | ||||
redeemAmount | D 12,5 | O | Amount | ||||
rewards | Array | O | List of rewards | ||||
quantity | N | O | Rewards quantity | ||||
allowCustomerNote | B | O | To allow customer to display their own notes | ||||
userAgent | C 2048 | O | Exact content of the HTTP user-agent header of Payer's browser | ||||
transactionMode | AN 20 | O | Allow manual settle merchant to be able to select transaction mode | ||||
childMerchantID | AN 25 | C | Unique merchant ID that is registered with 2C2P, must be SUB Account of merchantID | ||||
transactionInitiator | C 1 | O |
• C = Customer (Default) • M = Merchant |
||||
browserDetails | - | O | Browser Details | ||||
Device Type | AN 255 | O | Device Type | ||||
Name | AN 255 | O | Name of Browser | ||||
OS | AN 255 | O | Operating System of Browser | ||||
Version | AN 255 | O | Version of Browser | ||||
scaExemptionIndicator | C 255 | O |
•authentication_outage - when payer authentication is not available • delegated_authentication - when the authentication is performed another party • low_value - for low value transaction • low_risk - for low risk transaction • secure_corporate_payment - when payment is B2B transaction • trusted_merchant - when the merchant is trusted by the payer • recurring_payment - for recurring payment • out_of_sca_scope - for MIT transaction (transactionInitiator = 'M'), it is out of scope • transaction_risk_assessment - for transactional risk analysis is already performed • other - other reasons (if applicable) • none - (default) sca exemption is not applied |
||||
previousPaymentID | C 255 | O | Required if transactionInitiator = 'M' | ||||
allow3DSUpgrade | A 1 | O |
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 |
||||
requestReauthentication | B | O | Allow merchant to request re-authentication | ||||
defaultSettlementCurrencyMerchantID | AN 50 | O | set default settlement curreny merchant ID | ||||
settlementCurrencyMerchantID | AN 50 | O | set settlement curreny merchant ID | ||||
newRedisCacheOptimizationSwitchTag | B | O | use redis cache |
Updated 6 days ago