Get Transaction QR Code/URL By Code
Method : GET
URL : https://open.revenuemonster.my/v3/payment/transaction/qrcode/5413b4583a9440dd351b2dde0c0ea166
Sandbox URL : https://sb-open.revenuemonster.my/v3/payment/transaction/qrcode/5413b4583a9440dd351b2dde0c0ea166
note
- To get a specific QR Code previously generated in the system, by inputting code in your query.
- The URL is consists of
[base_URL]
/v3/payment/transaction/qrcode/[code]
Request Parameters
note
No request parameter is required for this endpoint.
Response Parameters
Parameter | Type | Description | Example |
---|---|---|---|
item | Object | Transaction object | (Refer to explanation below) |
code | String | Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes ) | "SUCCESS" |
Transaction object (item):
Parameter | Type | Description | Example |
---|---|---|---|
storeId | String | ID of store | 10946114768247530 |
type | String | "DYNAMIC" (days from now), "FIXED" (specific fixed date) or "PERMANENT" (never expire) | "PERMANENT" |
isPreFillAmount | Bool | To indicate QR code has pre-fill amount | true |
currencyType | String | Currency notation | "MYR" |
amount | Uint | Amount of order in cent. Only required when "isPrefillAmount" = true. | 100 |
platform | String | "OPEN_API" (generated through API calls) or "PORTAL" (generated through merchant portal) | "PORTAL" |
method | []String | RM currently supported method | ["WECHATPAY","WECHATPAY_MY", "WECHATPAY_CN","PRESTO_MY", "BOOST_MY", "ALIPAY_CN" ] |
expiry | Object | Object of expiry | (Refer to explanation above) |
code | String | Embedded code in QR | "c8ff3df0605a5f20cd6476661072eade" |
status | String | "VALID" (always valid for static QR) or "REDEEMED" (only applicable to dynamic QR) | "VALID" |
qrCodeUrl | String | Embedded URL in QR | "https://dev-rm-api.ap.ngrok.io/payment/unified?code=c8ff3df0605a5f20cd6476661072eade" |
redirectUrl | String | Redirect URL after QR payment is made | "https://www.apple.com/my/iphone/" |
createdAt | DateTime | Creation date time of transaction | "2018-03-21T06:41:22Z" |
updatedAt | DateTime | Last update date time of transaction | "2018-03-21T06:41:22Z" |
Expiry object (expiry):
Parameter | Type | Description | Example |
---|---|---|---|
type | String | "DYNAMIC" (days from now), "FIX" (specific fixed date) or "PERMANENT" (never expire) | "PERMANENT" |
day | Uint | Only required by "DYNAMIC" expiry type. To indicate number of days from now until expiry. | 3 |
expiredAt | DateTime | Only required by "FIXED". To indicate specific expiry date. | "2020-10-07T17:44:26.679908+08:00" |
Example Response
{
"item": {
"storeId": "10946114768247530",
"type": "STATIC",
"isPreFillAmount": true,
"currencyType": "MYR",
"amount": 100,
"platform": "PORTAL",
"method": ["WECHATPAY"],
"expiry": {
"type": "PERMANENT",
"day": 0,
"expiredAt": "2050-12-31T23:59:59Z"
},
"code": "a669adc3b06fe5cef977cc762f40ce8c",
"status": "VALID",
"qrCodeUrl": "https://dev-rm-api.ap.ngrok.io/payment/unified?code=a669adc3b06fe5cef977cc762f40ce8c",
"createdAt": "2018-06-25T02:29:28Z",
"updatedAt": "2018-06-25T02:29:28Z"
},
"code": "SUCCESS"
}