Transaction Object

Reference for the transaction object returned in item (or each entry in items[]) by all transaction query and payment endpoints. Use this page as the canonical field map when parsing responses.

When to Use

▾

Refer to this page when:

• Parsing the response of any payment or query endpoint
• You need to know which fields apply to a specific payment method (card, FPX, BNPL, loyalty)

Fields

▾

The transaction object is returned in the item (or items[]) field of query responses.

storeOBJECT

Store details

referenceIdSTRING

Reference ID from the payment provider

transactionIdSTRINGrequired

Revenue Monster's unique transaction ID

terminalIdSTRING

Terminal ID if applicable

currencyTypeSTRINGrequired

Currency type (currently supported MYR only)

balanceAmountINTEGERrequired

Remaining balance amount for initiating refund

finalAmountINTEGERrequired

Amount after all deductions (voucher, membership)

platformSTRINGrequired

Transaction platform

typeSTRINGrequired

Transaction type

methodSTRINGrequired

Transaction payment method

regionSTRINGrequired

Transaction payment region

statusSTRINGrequired

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

sourceSTRINGrequired

(Internal) Determines initiator source

transactionAtSTRING

Transaction date time (exists only when SUCCESS)

createdAtSTRINGrequired

Transaction created date time

updatedAtSTRINGrequired

Transaction last updated date time

orderOBJECTrequired

Order details

idSTRINGrequired

Order ID

titleSTRINGrequired

Order title

currencyTypeSTRINGrequired

Order currency type

amountINTEGERrequired

Order amount

detailSTRING

Order detail

additionalDataSTRING

Order additional data

Show Example Transaction▾

Example Transaction

JSON

1{
2"referenceId": "230522162302AC0570UM",
3"transactionId": "230522082259300426500551",
4"order": {
5  "id": "1684743768790895",
6  "title": "Demo",
7  "detail": "Demo",
8  "additionalData": "Demo",
9  "amount": 120
10},
11"currencyType": "MYR",
12"balanceAmount": 120,
13"finalAmount": 120,
14"platform": "OPEN_API",
15"method": "GOBIZ",
16"transactionAt": "2023-05-22T08:23:02Z",
17"type": "WEB_PAYMENT",
18"status": "SUCCESS",
19"region": "MALAYSIA",
20"createdAt": "2023-05-22T08:23:02Z",
21"updatedAt": "2023-05-22T08:23:11Z"
22}

---

Store Object

▾

idSTRINGrequired

Store ID

nameSTRING

Store name

imageUrlSTRING

Store image URL

addressLine1STRING

Store address line 1

addressLine2STRING

Store address line 2

postCodeSTRING

Store postal code

citySTRING

Store city

stateSTRING

Store state

countrySTRING

Store country

countryCodeSTRING

Store country code for phone number

phoneNumberSTRING

Store phone number

geoLocationOBJECT

Geographic coordinates

latitudeFLOAT

Store latitude

longitudeFLOAT

Store longitude

statusSTRING

Store status

createdAtSTRING

Store created time

updatedAtSTRING

Store last updated time

---

BuyNowPayLater (BNPL)

▾

isBuyNowPayLaterBOOLEAN

Whether this is a BNPL transaction

installmentMonthINTEGER

Number of months selected for BNPL

---

Online Banking (FPX)

▾

buyerNameSTRING

FPX buyer name

bankIdSTRING

FPX bank ID

---

Card Payment

▾

cardTypeOBJECT

Card type details

brandSTRING

Card brand

typeSTRING

Card type (CREDIT, DEBIT)

issuerSTRING

Card issuer

alpha2STRING

Card country in alpha2 code

alpha3STRING

Card country in alpha3 code

countrySTRING

Card country full name

providerSTRING

(Internal) Card provider

isTokenizationBOOLEAN

Whether payment uses a token instead of PAN

tokenSTRING

Token used for tokenized payment

maskNoSTRING

Masked PAN, last four digits

Example: "XXXX-XXXX-XXXX-2354"

inputTypeSTRING

Card input type

referenceIdSTRING

Card transaction reference number

secondaryReferenceIdSTRING

Card transaction invoice number

domainSTRING

Online card payment domain

---

Spending Loyalty

▾

tip

If you are using QR code mode for payment, you will receive the spending loyalty object in the transaction response. When printing the receipt, include the qrcode parameter as the QR code content — customers can scan it to retrieve their loyalty points.

codeSTRING

Spending loyalty code

qrcodeSTRING

Spending loyalty QR code content

idSTRING

Spending loyalty ID

---

Payment Provider Discount Info

▾

salesAmountINTEGER

Original sales amount before discount

discountAmountINTEGER

Payment provider discount amount

grossAmountINTEGER

Sales amount after discount

---

Membership Discount Info

▾

memberIdSTRING

Membership member ID

voucherIdSTRING

Membership voucher ID

discountAmountINTEGER

Membership discount amount