QuickPay Send Link 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

🚧

Sending Method

Merchants must indicate whether to send the link via email OR sms (only one can be used per call)

Set the Sending parameter to either toEmails or toMobiles

Parameter

Data Type / Length

Mandatory

Description

version

AN 3

M

Request 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

qpID

AN 10

M

QuickPay ID

toEmails

AN 255

O

Email address to receive QuickPay link

  • Separate multiple email addresses with a semicolon (β€œ;”)

ccEmails

AN 255

O

Email address to receive CC of QuickPay link

  • Separate multiple email addresses with a semicolon (β€œ;”)

bccEmails

AN 255

O

Email address to receive BCC of QuickPay link

  • Separate multiple email addresses with a semicolon (β€œ;”)

emailSubject

AN 255

C

Subject of email

*Accepts all characters except special characters of > and <

  • Mandatory when toEmails is supplied

emailMessage

AN 255

C

Body of email

*Accepts all characters except special characters of > and <

  • Mandatory when toEmails is supplied

toMobiles

AN 255

O

Mobile number to receive QuickPay link

  • Separate multiple mobile numbers with a semicolon (β€œ;”)
  • In international format: CountryCodeAreaCode-TelephoneNumber
  • Example: +66889999999

smsMessage

AN 60

C

Body of SMS

*Accepts all characters except special characters of > and <

  • Mandatory when toMobiles is supplied

hashValue

AN 150

M

HMACSHA1 cryptographic hash value of:
version + timeStamp + merchantID +
qpID + toEmails + ccEmails +
bccEmails + emailSubject + emailMessage + toMobiles +
smsMessage

  • Uses secret key provided by 2C2P to merchant