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.1 |
timeStamp | AN 14 | M | Request time stamp
|
qpID | N 10 | M | QuickPay ID |
orderIdPrefix | AN 14 | M | Prefix of merchant order number for transaction done using this QuickPay URL
|
description | AN 150 | M | Description of QuickPay URL
|
currency | AN 3 | M | Standard ISO4217 currency codes Examples:
|
amount | AN 12 | M | Transaction amount Examples:
|
allowMultiplePayment | C 1 | M | Sets QuickPay link to allow multiple payments
Default value: N |
maxTransaction | N 4 | M | Maximum number of approved transactions
|
expiry | AN 8 | M | Expiry date of the QuickPay link
|
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:
By default, Option A is selected |
ippInterestType | C 1 | M | To indicate IPP (Installment Payment Plan)
By default, Option A is selected |
paymentExpiry | AN 19 | M | To specify payment expiry date and time for 123 service:
|
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:
By default, 3DS authentication is enabled |
enableStoreCard | C 1 | O | To enable card tokenization feature:
By default, tokenization is disabled |
recurring | C 1 | O | To enable RPP (Recurring Payment Plan):
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:
|
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.
|
recurringInterval | N 3 | C | Indicate the frequency of RPP charges, in days
|
recurringCount | N 5 | C | Indicate how many times to charge a customer with RPP
|
chargeNextDate | C 8 | C | Indicate the next RPP charge date
|
chargeOnDate | C 4 | C | Charge RPP on specific date every month
|
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:
|
Updated almost 2 years ago