QuickPay Query Response 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 / Length | Mandatory | Description |
|---|---|---|---|
| version | AN 3 | M | Request version number Current version: 2.4 |
| timeStamp | AN 14 | M | Request time stamp * In yyyyMMddHHmmss format |
| qpID | N 10 | M | QuickPay ID |
| orderIdPrefix | AN 14 | M | Prefix of merchant order number for transaction done using this QuickPay URL * Accepts only alphanumeric characters and the special characters _- |
| description | AN 150 | M | Description of QuickPay URL * Accepts only alphanumeric characters and the special characters ._#- |
| currency | AN 3 | M | Standard ISO4217 currency codes Examples: Thai baht = THB Singapore dollar = SGD * US dollar = USD |
| amount | AN 12 | M | Transaction amount Examples: SGD = 100.00 JPY = 100 |
| allowMultiplePayment | C 1 | M | Sets QuickPay link to allow multiple payments Y = Yes N = No Default value: N |
| maxTransaction | N 4 | M | Maximum number of approved transactions Based on number of items to sell (e.g., merchants with 10 items to sell must put a value of 10) Accepts values from 1 to 1000 |
| expiry | AN 1 | M | Expiry date of the QuickPay link * In yyyy-MM-dd HH:mm:ss format |
| userData1 | AN 255 | M | User data |
| userData2 | AN 255 | M | User data |
| userData3 | AN 255 | M | User data |
| userData4 | AN 255 | M | User data |
| userData5 | AN 255 | M | User data |
| promotion | AN 20 | M | Promotion code to filter promotion transactions |
| categoryId | AN 20 | M | Predefined payment category code for reporting purposes |
| resultUrl1 | AN 255 | M | Frontend return URL |
| resultUrl2 | AN 255 | M | Backend return URL |
| paymentOption | C 1 | M | To restrict customer payment methods / channels: F: Full amount payment only I: Installment payment plan only C: Credit card payment only A: All available options By default, Option A is selected |
| ippInterestType | C 1 | M | To indicate IPP (Installment Payment Plan) interest type: M: Merchant Pay interest option only C: Customer Pay interest option only * A: all available options By default, Option A is selected |
| paymentExpiry | AN 19 | M | To specify payment expiry date and time for 123 service: Expiry value is taken from the merchant configuration in the 2C2P portal By default, uses the format yyyy-MM-dd HH:mm:ss |
| url | AN 255 | M | QuickPay URL |
| currentApproved | N 5 | M | Current total approved transactions |
| clickCount | N 5 | M | Number of clicks of the QuickPay URL |
| request3DS | C 1 | O | To enable / disable / force 3DS authentication: Y: Enable 3DS authentication N: Disable 3DS authentication * F: Force 3DS authentication (only accepts ECI 02/05) By default, 3DS authentication is enabled |
| enableStoreCard | C 1 | O | To enable card tokenization feature: N: Disable tokenization Y: Enable tokenization By default, tokenization is disabled |
| recurring | C 1 | O | To enable RPP (Recurring Payment Plan): N: Disable RPP Y: Enable RPP feature By default, RPP is disabled. If RPP is enabled, the payment response will return the RPP unique ID |
| recurringAmount | D 12 | C | Recurring amount Examples: SGD = 100.00 JPY = 100 |
| allowAccumulate | C 1 | C | Allows a certain amount of failed RPP transactions before the RPP is terminated |
| maxAccumulateAmount | D 12 | C | Set the maximum accumulated failed transaction amount. If this amount is exceeded, the RPP will be terminated. * Only required if allowAccumulate is enabled |
| recurringInterval | N 3 | C | Indicate the frequency of RPP charges, in days Minimum: Every 1 day Maximum: Every 365 days (1 year) * Only required if RPP is enabled and chargeOnDate is disabled |
| recurringCount | N 5 | C | Indicate how many times to charge a customer with RPP Set to '0' to charge indefinitely until terminated manually Only required if RPP is enabled |
| chargeNextDate | C 8 | C | Indicate the next RPP charge date Format: ddMMyyyy Only required if RPP with recurringInterval is set For RPP configured with chargeOnDate, chargeNextDate is optional If chargeNextDate is not set, the month value from chargeOnDate will be used |
| chargeOnDate | C 4 | C | Charge RPP on specific date every month Format: ddMM MM is only used if chargeNextDate is not set Otherwise the day value will be used for every month Only required if RPP is enabled and recurringInterval is disabled |
| useStoreCardOnly | C 1 | O | To allow merchant provide Store Card ID |
| storeCardUniqueID | C 20 | C | Store Card ID |
| ippPeriodFilter | C 200 | C | Allow IPP Tenure selection |
| resCode | N 3 | M | Response status code Refer to: Respone Code List |
| resDesc | AN 50 | M | Response status short description |
| hashValue | AN 150 | M | HMACSHA1 cryptographic hash value of: version + timeStamp + qpID + orderIdPrefix + description + currency + amount + allowMultiplePayment + maxTransaction + expiry + userData1 + userData2 + userData3 + userData4 + userData5 + promotion + categoryId + resultUrl1 + resultUrl2 + paymentOption + ippInterestType + paymentExpiry + url + currentApproved + clickCount+ request3DS + enableStoreCard + recurring + recurringAmount + allowAccumulate + maxAccumulateAmount + recurringInterval + recurringCount + chargeNextDate + chargeOnDate + useStoreCardOnly + storeCardUniqueID + IPPPeriodFilter + resCode + resDesc * Uses secret key provided by 2C2P to merchant |
Updated over 1 year ago