DocumentationRecipesAPI ReferenceChangelog
Documentation
These docs are for v3.2.6. Click to read the latest docs for v4.3.0.

QuickPay Generate and Send Link Request Parameter

📘

Data Attribute Reference

Data Type
A - Alphabet, N - Numeric, AN - AlphaNumeric, C - Characters, D - Decimal, B - Boolean

Mandatory
M - Mandatory, C - Conditional, O - Optional

🚧

Sending Method

Merchant are required to indicate whether to send via email OR sms (only one can be used per call)

Sending parameter either toEmails or toMobiles

Parameter

Data Type / Length

Mandatory

Description

version

AN 3

M

Request Message version number
Current Version 2.1

timeStamp

AN 14

M

Request time stamp in
yyyyMMddHHmmss format

merchantID

AN 15

M

Merchant ID provided by 2C2P

orderIdPrefix

AN 14

M

Prefix of merchant order number
for transaction done using this
QuickPay URL. Only alphanumeric
and special character of _- allowed.

description

AN 150

M

Description of QuickPay URL. Only
alphanumeric and special character
of ._#- allowed.

currency

AN 3

M

Standard ISO4217 currency codes.
Eg. Thai baht = THB, Singapore
dollar = SGD, US dollar = USD.

amount

AN 12

M

Transaction amount. E.g. SGD =
100.00, JPY = 100

allowMultiplePayment

C 1

O

Y = Yes, N = No. allow multiple
payment to be made with this QP
URL. Default value = N

maxTransaction

N 4

O

Maximum no of approved
transaction allowed. Value 1 to
1000.
If you have 10 items to sell, put 10
as value.

expiry

AN 8

M

Expiry date of the QP URL with
format of DDMMYYYY

userData1

AN 255

O

User data

userData2

AN 255

O

User data

userData3

AN 255

O

User data

userData4

AN 255

O

User data

userData5

AN 255

O

User data

promotion

AN 20

O

Promotion code to filter promotion
transactions

categoryId

AN 20

O

Predefined payment category code
for reporting purpose.

resultUrl1

AN 255

O

Frontend return ur

resultUrl2

AN 255

O

Backend return url

paymentOption

C 1

O

To restrict customer payment
methods / channel:

  • F – Full amount payment only
  • I – Installment payment plan only
  • C – Credit card payment only
  • A – All available options
    By default A option is selected.

ippInterestType

C 1

O

To allow merchant to specify IPP
Interest type.

  • M – Merchant Pay interest option
    only
  • C – Customer Pay interest option
    only
  • A – all available options
    By default A is selected.

paymentExpiry

AN 19

O

Allow merchant to specify payment
expiry date/time for 1-2-3 service.
Format:
yyyy-MM-dd HH:mm:ss
by default, expiry value is taken
from merchant configuration.

toEmails

AN 255

O

Email address to be sent to, separated by semi-colon, “;”.

ccEmails

AN 255

O

Email address to receive CC,
separated by semi-colon, “;”.

bccEmails

AN 255

O

Email address to receive BCC,
separated by semi-colon, “;”.

emailSubject

AN 255

C

Characters except special character of > and <

mandatory when toEmails is supplied

emailMessage

AN 255

C

Characters except special character of > and <

mandatory when toEmails is supplied

toMobiles

AN 255

O

Mobile Nos to be sent to,
separated by semi-colon, “;”. In
International format: CountryCodeAreaCode-TelephoneNo. E.g
+66889999999

smsMessage

AN 60

C

Characters except special character of > and <

mandatory when toMobiles is supplied

request3DS

C 1

O

To enable / disable / Force 3DS
authentication
Y - Do 3DS authentication (default)
N - No 3DS authentication
F - Force 3DS authentication (only
ECI 02/05 are accepted)

enableStoreCard

C 1

O

To enable tokenization feature
N - Disable tokenization option
(default)
Y - Enable tokenization option

recurring

C 1

O

To enable RPP (Recurring Payment
Plan) transaction feature.
N - Disable RPP feature (default)
Y - Enable RPP feature
(Recurring unique ID will be
returned on payment response
message if this option is enabled)

recurringAmount

D 12

C

Recurring amount. E.g. SGD =
100.00, JPY = 100

allowAccumulate

C 1

C

RPP will be terminated if
accumulated failed RPP transaction
amount is over
maxAccumulateAmount.

Only required if allowAccumulate is
allowed

maxAccumulateAmount

D 12

C

RPP will be terminated if
accumulated failed RPP transaction
amount is over
maxAccumulateAmount.

Only required if allowAccumulate is
allowed

recurringInterval

N 3

C

To indicate the frequency of RPP by
days.
minimum is every 1 day.
maximum is every 365 days (1
year).

Only required if RPP is enabled and
chargeOnDate is not used.

recurringCount

N 5

C

To indicate how many times to
charge the customer with RPP.

set to '0' to charge indefinitely until
terminated manually.

Only required if RPP is enabled.

chargeNextDate

C 8

C

To indicate the next RPP charge
date.
format: ddMMyyyy.

Only required if RPP with
recurringInterval is set.

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

chargeOnDate

C 4

C

To charge RPP on specific date
every month.
format: ddMM
the MM is only used if
charge_next_date is not set. otherwise the dd will be used for every month.

Only required if RPP is enabled and
recurringInterval is not used.

hashValue

AN 150

M

HMACSHA1 cryptographic hash
value of:
version + timeStamp + merchantID + orderIdPrefix + description +
currency + amount +
allowMultiplePayment +
maxTransaction + expiry +
userData1 + userData2 + userData3 + userData4 + userData5 +
promotion + categoryId +
resultUrl1 + resultUrl2 +
paymentOption + ippInterestType + paymentExpiry + toEmails + ccEmails + bccEmails +
emailSubject + emailMessage +
toMobiles + smsMessage + request3DS + enableStoreCard + recurring + recurringAmount +
allowAccumulate +
maxAccumulateAmount +
recurringInterval + recurringCount + chargeNextDate + chargeOnDate

using secret_key provided by 2C2P
to merchant