Skip to main content

Card Payment Refund

Method : POST
URL : https://open.revenuemonster.my/v3/event/terminal
Sandbox URL : https://sb-open.revenuemonster.my/v3/event/terminal

Request Parameters

ParameterTypeRequiredDescriptionExample
terminalIdStringYesTerminal ID"1582107209454501456"
typeStringYesRequest type"REFUND"
dataStringYes(Refer data ){}
Data object (data):
ParameterTypeRequiredDescriptionExample
transactionIdStringYesTransaction ID generated from Revenue Monster."1582107209454501456"
receiptTypeUintYes1 : Print Merchant Copy and Customer copy
2 : Print Customer copy
3 : Do not print Merchant Copy & Customer Copy
1
reasonStringYesRefund reason"Wrong Item"
emailStringYesRefund email"oska.ng@revenuemonster.my"
pinStringYesRefund pin"321123"

Example Request

curl --location --request POST "https://sb-open.revenuemonster.my/v3/event/terminal" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjIwMTgtMDMtMTMiLCJ0eXAiOiJKV1QifQ.eyJhdWQiOlsiYXBpX2NsaWVudEBFaGNLQzA5QmRYUm9RMnhwWlc1MEVNV1Z4NF9UbE5MZEZRIl0sImV4cCI6MTU4NjMzNzc1OCwiaWF0IjoxNTgzNzQ1NzU4LCJpc3MiOiJodHRwczovL3NiLW9hdXRoLnJldmVudWVtb25zdGVyLm15IiwianRpIjoiRWh3S0VFOUJkWFJvUVdOalpYTnpWRzlyWlc0UXlKSG9qb2VNcHYwViIsIm5iZiI6MTU4Mzc0NTc1OCwic3ViIjoiRWhRS0NFMWxjbU5vWVc1MEVKWFZ6ZDN3cmFxVE9SSVFDZ1JWYzJWeUVJeUpxSXp2eU1QVmNRIn0.FfBkCb7fjCKJdcy_DS06dKgEtcAvukPio0HyDRtH2UovhZsLFSqD_8oo21u094XSor_mqFg4hqXmLaHjX-h92Wz3kHl7OwiKQb16x8Rnl5OdyPHtMqIZqP8ab8Ch0RHEZ33VchK1zBTnG6Xosrb1B44tWqJ0_kdTtbRZN4rG821C8i4sb6sx8GaxgluJ5q7CEifMTBFJam_Jub9LfAfukq8YyIl0Bykp7B3A_su2QoELL9L_ElJdV9FuwFPHcKr9bxLvVSrEdyrFg7IBm_tJHxSl8gTh3j4b6lWZrBCfMSLraXaYRNzz1ddbVnwYD4aRuSyRmQeMYTUj0cInktnKUA" \
--header "X-Signature: sha256 GohuT2QTUXJV3MZh2OoEE9qW9wcfakOU9iVLmkTjM12NQuV6IcWMRQDz9NdxAOVIrh5MssfYCLDlafb2illXxgQMpmZkZ38NT6NQsMeMfGbHBS1Kc+BUtU7o1TMLUzk55J1tA6f0Z95oEuBlCeLm6VsgCG30wFm5YmgssJ0weIwMcW355r2sFl7QcKOuRqynoGtmmr/aGfOk1HjiFLoFzSd38O7rRjwGrekYwuYUD1N/Wp5GFXRjtaaPkzAERPbXEmnh/taLME8VeAhky6dAVGZE6gHKnP5WvvVjUE+KLtj3D32YIHzxhzEW9x3JEObqgvm5Q2oRZNxoh6/MvqwkVA==" \
--header "X-Nonce-Str: bfdgdjgtjhmnbmmjmdfdghghffj" \
--header "X-Timestamp: 1546850694" \
--data-raw {
"terminalId": "1582107209454501456",
"type": "REFUND",
"data": {
"transactionId": "210215083727100327507906",
"receiptType": 3,
"reason": "Testing",
"email": "oska.ng@revenuemonster.my",
"pin": "321123"
}
}

Response Parameters

ParameterTypeDescriptionExample
balanceAmountUintAmount of order in cent10
createdAtDateTimeCreation date time of store"2020-02-13T07:08:56Z"
currencyTypeStringCurrency notation (currently only support MYR)"MYR"
extraInfoObject(Refer to extraInfo){}
methodStringRM currently supported method"CARD"
orderString(Refer to order){}
platformStringOnly "TERMINAL""TERMINAL"
referenceIdStringTransaction ID (from server)"00000000000791320002737201919250001"
regionStringRegion of wallet"MALAYSIA"
statusStringStatus returned from WeChat server"SUCCESS"
transactionAtDateTimeTransaction date time of store"2020-10-25T04:35:22Z"
transactionIdDateTimeTransaction ID generated from Revenue Monster."200213070856100322408442"
typeString"QUICKPAY" or "BANK_CARD""BANK_CARD"
updatedAtDateTimeLast update date time of store"2020-02-13T07:08:56Z"
codeStringSuccessfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)"SUCCESS"
errorObject(Refer Appendix: Error Codes){}

Extra Info object (extraInfo):
ParameterTypeRequiredDescriptionExample
cardObjectYesObject of card Info(Refer to explanation below)

Card object (card):
ParameterTypeRequiredDescriptionExample
inputTypeStringYesType of card payment"NFC"
maskNoStringYesMasked card no"XXXX-XXXX-XXXX-9081"
referenceIdStringYesCard payment ref on server"104974001774"
secondaryReferenceIdStringYesCard payment ref on terminal"001774"

Order object (order):
ParameterTypeRequiredDescriptionExample
amountUintYesAmount of order in cent (min RM 0.10 or amount: 10)10
idStringYesOrder ID (from Merchant), max: 24"201919250001"
titleStringYesOrder title, max: 32"SALE"
detailsStringYesOrder details, max: 600"XXXX-XXXX-XXXX-3121"
additionalDataStringYesFor merchant's remark, max 128"000008"

Example Response

{
"code": "SUCCESS",
"item": {
"balanceAmount": 0,
"createdAt": "2021-02-17T17:43:59Z",
"currencyType": "MYR",
"extraInfo": {
"card": {
"inputType": "NFC",
"maskNo": "XXXX-XXXX-XXXX-9081",
"referenceId": "104974001774",
"secondaryReferenceId": "001774"
}
},
"method": "CARD",
"order": {
"additionalData": "In store payment",
"amount": 10,
"detail": "[Terminal app] Pay to Mountain Food - Utropolis",
"id": "1613583839549PE24191B504",
"title": "In store payment"
},
"platform": "TERMINAL",
"referenceId": "00000000000550520003236104974001774",
"region": "MALAYSIA",
"status": "FULL_REFUNDED",
"transactionAt": "2021-02-17T17:44:02Z",
"transactionId": "210217174359100325085446",
"type": "BANK_CARD",
"updatedAt": "2021-02-17T17:44:30Z"
}
}