Skip to main content

Refund Transaction

Refund returns funds to the customer — based on the payment provider's policy and time limits.

info

Refund eligibility depends on the payment provider. Each payment method has its own refund period. If the refund period has passed, contact [email protected] with:

  • Transaction ID
  • Reference ID (if applicable)
  • Total Transaction Amount
  • Total Refund Amount
  • Reason for refund

How to Use

Endpoint
POST/v3/payment/refund

Step 1: Get the Transaction ID

Locate the transactionId from the original transaction.

Step 2: Prepare the Refund

Prepare the refund amount and reason.

Step 3: Make the Request

Send the refund request. Check the code field in the response — if "SUCCESS", the operation completed.


Request Parameters

transactionIdSTRINGrequired

Transaction ID to refund

Example: "180730103903010431152179"

refundOBJECTrequired

Refund details

typeSTRINGrequired

Refund type (e.g., "FULL")

Example: "FULL"

currencyTypeSTRINGrequired

Refund currency type

Example: "MYR"

amountINTEGERrequired

Refund amount in smallest currency unit

Example: 100

reasonSTRINGrequired

Reason for the refund

Response Parameters

itemOBJECT

Transaction response object

transactionIdSTRING

Revenue Monster's unique transaction ID

referenceIdSTRING

Reference ID from the payment provider

orderOBJECT

Order details

idSTRING

Order ID

titleSTRING

Order title

currencyTypeSTRING

Currency type

amountINTEGER

Order amount in cents

detailSTRING

Order detail

additionalDataSTRING

Additional data

terminalIdSTRING

RM Terminal ID, if processed via terminal

payeeOBJECT

Payee details

userIdSTRING

Payee user ID

subUserIdSTRING

Payee sub-user ID

storeOBJECT

Store details

idSTRING

Store ID

nameSTRING

Store name

imageUrlSTRING

Store image URL

addressLine1STRING

Store address line 1

addressLine2STRING

Store address line 2

postCodeSTRING

Store postcode

citySTRING

Store city

stateSTRING

Store state

countrySTRING

Store country

countryCodeSTRING

Store contact country code

phoneNumberSTRING

Store phone number

geoLocationOBJECT

Store geolocation

latitudeNUMBER

Latitude

longitudeNUMBER

Longitude

statusSTRING

Store status

createdAtSTRING

Store creation date time

updatedAtSTRING

Store last update date time

currencyTypeSTRING

Currency type (MYR)

balanceAmountINTEGER

Remaining balance amount for initiating refund

finalAmountINTEGER

Amount after all deductions

voucherOBJECT

Voucher applied to this transaction (null if none)

keySTRING

Voucher key (internal usage)

discountAmountINTEGER

Discount amount deducted, in cents

membershipOBJECT

Membership voucher details (null if not applicable)

voucherIdSTRING

Membership voucher ID

memberIdSTRING

Member ID that owns the voucher

discountAmountINTEGER

Discount amount deducted, in cents

walletOBJECT

Wallet voucher details (null if not applicable)

discountAmountINTEGER

Discount amount deducted, in cents

grossAmountINTEGER

Gross amount before discount, in cents

salesAmountINTEGER

Sales amount after discount, in cents

platformSTRING

Transaction platform

methodSTRING

Payment method

typeSTRING

Transaction type

regionSTRING

Payment region

statusSTRING

Transaction status (SUCCESS, FAILED, IN_PROCESS, etc.)

transactionAtSTRING

Transaction date time (only when SUCCESS)

extraInfoOBJECT

Payment method-specific details (populated depending on method used)

cardOBJECT

Card payment details (null if not a card payment)

cardTypeOBJECT

Card type details

brandSTRING

Card brand (e.g. VISA, MASTERCARD)

typeSTRING

Card type (e.g. CREDIT, DEBIT)

issuerSTRING

Card issuing bank

alpha2STRING

Card issuing country (ISO alpha-2)

alpha3STRING

Card issuing country (ISO alpha-3)

countrySTRING

Card issuing country name

providerSTRING

Card provider

isTokenizationBOOLEAN

Whether the card was tokenized

tokenSTRING

Card token

maskNoSTRING

Masked card number

inputTypeSTRING

Card input type

referenceIdSTRING

Card reference ID

domainSTRING

Tokenization domain

secondaryReferenceIdSTRING

Secondary reference ID

onlineBankingOBJECT

Online banking details (null if not applicable)

manualRefundOBJECT

Manual refund details (null if not applicable)

extendInfoOBJECT

Additional payment method-specific info

inHousePromoOBJECT

In-house promotion applied

amountINTEGER

Promotion discount amount

infoSTRING

Promotion info (null if none)

buyNowPayLaterOBJECT

Buy-now-pay-later details

isBuyNowPayLaterBOOLEAN

Whether this transaction used buy-now-pay-later

installmentMonthINTEGER

Number of installment months

cardInfoOBJECT

Card details (for card payments)

binSTRING

Card bank identification number

lastFourSTRING

Last four digits of the card

fundingMethodSTRING

Card funding method

alpha2STRING

Card issuing country (ISO alpha-2)

schemeSTRING

Card scheme (e.g. Visa, Mastercard)

approvalCodeSTRING

Card approval code

referenceNoSTRING

Card transaction reference number

issuerSTRING

Card issuing bank

paymentSourceSTRING

Source of the payment

terminalInfoOBJECT

Terminal-specific info

providerSTRING

Terminal provider

inputTypeSTRING

Terminal input type

referenceNoSTRING

Terminal reference number

invoiceNoSTRING

Terminal invoice number

sourceSTRING

Source of the transaction

createdAtSTRING

Created date time

updatedAtSTRING

Last updated date time

codeSTRING

"SUCCESS" if the refund succeeded, otherwise an error code.

errorOBJECT

Error details

codeSTRING

Error code if the request failed.

messageSTRING

Error message if the request failed.

debugSTRING

Debug message (sandbox only).