Online Payment

Online payment allow business to accept online payments through our web applications. With Revenue Monster's Online Payment, customer can enter payment details or select e-wallet options to complete the payment process from their smartphones and website.

• Demo Web Payment (Version 4): Click Here

info

Online payment is an online payment method and it's subscription will based on online subscription rate.

Example of Web Payment

Example of Mobile Payment

Hosted Payment Checkout

Method : POST
URL : https://open.revenuemonster.my/v3/payment/online
Sandbox URL : https://sb-open.revenuemonster.my/v3/payment/online

note

• To create a unified payment checkout page for your website and mobile.
• Data object needs to be sorted, the Nested object also needs to be sorted.

Request Parameters

Parameter	Type	Validation	Required	Description
storeId	String		Yes	Store ID
redirectUrl	String	URL	Yes	Example of Redirect URL Response
notifyUrl	String	URL	Yes	Example of Notify URL Response
layoutVersion	String	ENUM("v1", "v2", "v3", "v4")	Yes
type	String	ENUM("WEB_PAYMENT", "MOBILE_PAYMENT")	Yes	Checkout session type
method	[]String		No	Payment methods
order.id	String	Length(24)	Yes	Order ID
order.title	String	Length(32)	Yes	Order Title
order.currencyType	String	ENUM("MYR")	Yes	Order Currency Type ( currently supported MYR only)
order.amount	Uint64		Yes	Order Amount
order.detail	String	Length(600)	No	Order Detail
order.additionalData	String	Length(128)	No	Order Additional Data
customer.userId	String		Conditional	Required when the tokenization is enabled
customer.email	String		No
customer.countryCode	String		No
customer.phoneNumber	String		No

Response Parameters

Parameter	Type	Validation	Description
item.checkoutId	String		Checkout session id
item.url	String		Checkout session url
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Advance: Individual Payment Checkout

After you have the checkout session url from the checkout api, you can append a query params "method" to proceed method checkout.

Example: https://sb-pg.revenuemonster.my/checkout?checkoutId=1548316308361173347&method=TNG_MY

Redirect Response

info

Redirect URL to redirect your customer back to your page after payment, it's can be any of the URL ( deeplink, browser url, server url ) as long as the browser itself can go and process.

Method : GET

Parameter	Type	Validation	Required	Description
status	String	Enum("SUCCESS", "FAILED", "CANCELLED", "EXPIRED")	Yes	Payment Status
orderId	String		Yes	Payment Order ID
reason	String		No	Payment fail reason

Notify Response

info

Notify URL or Callback URL to inform server on transaction status after payment made.

Notify will call only when the transaction is success, fail and refund will not fired a notify to your server. We suggest you to do a query transaction to get full transaction info if you need full info, for notify will only response the partial transaction info.

Reference: Query Transaction

Method : POST

Parameter	Type	Validation	Required	Description
eventType	ENUM("PAYMENT_WEB_ONLINE")		Yes	Notify event type
data.store	JSON	Transaction Object: Store	No	Store details
data.referenceId	String		No	Reference ID
data.transactionId	String		Yes	Transaction ID
data.terminalId	String		No	Terminal ID
data.currencyType	String	ENUM("MYR")	Yes	Currency Type ( currently supported MYR only)
data.balanceAmount	Uint64		Yes	Remaining balance amount for initiate refund
data.finalAmount	Uint64		Yes	Amount after all deductions ( voucher, membership)
data.platform	String	ENUM("TERMINAL", "MOBILE_APP", "OPEN_API", "WEB_LOYALTY")	Yes	Transaction platform
data.type	String	Appendix: Type	Yes	Transaction type
data.method	String	Appendix: Method	Yes	Transaction payment method
data.region	String	Appendix: Region	Yes	Transaction pament region
data.status	String	Appendix: Status	Yes	Transaction payment status
data.transactionAt	String	RFC3339	No	Transaction payment date time ( exists only when SUCCESS )
data.createdAt	String	RFC3339	Yes	Transaction created date time
data.updatedAt	String	RFC3339	Yes	Transaction last updated date time
data.payee.userId	String		No	Payment provider user id
data.payee.subUserId	String		No	Payment provider sub user id
data.order.id	String		Yes	Order ID
data.order.title	String	Length(32)	Yes	Order Title
data.order.currencyType	String	ENUM("MYR")	Yes	Order Currency Type ( currently supported MYR only)
data.order.amount	Uint64		Yes	Order Amount
data.order.detail	String	Length(600)	No	Order Detail
data.order.additionalData	String	Length(128)	No	Order Additional Data

Query Payment Checkout

caution

Please note that payment checkout isn't the payment transaction info, while payment checkout will only return the checkout information like status, amount, redirectUrl but for more information about the success payment checkout transaction you can query transcation using Query By Transaction ID with the response of this API transactionId.

Method : GET
URL : https://open.revenuemonster.my/v3/payment/online?checkoutId={checkoutId}
Sandbox URL : https://sb-open.revenuemonster.my/v3/payment/online?checkoutId={checkoutId}

Request Parameters

Parameter	Type	Validation	Description
checkoutId	QueryParam	Yes	Payment checkout id

Response Paramters

Parameter	Type	Validation	Description
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )
item.id	String		Payment checkout id
item.type	String	ENUM("WEB_PAYMENT", "WEB_MOBILE_PAYMENT", "MOBILE_PAYMENT")	Payment checkout type
item.transactionId	String		Payment transaction id, you can query transaction using Query Transaction
item.order.id	String	Length(24)	Order ID
item.order.title	String	Length(32)	Order Title
item.order.currencyType	String	ENUM("MYR")	Order Currency Type ( currently supported MYR only)
item.order.amount	Uint64		Order Amount
item.order.detail	String	Length(600)	Order Detail
item.order.additionalData	String	Length(128)	Order Additional Data
item.platform	String	ENUM("OPEN_API")	Payment checkout platform
item.method	String	Appendix: Method	Payment checkout available methods
item.redirectUrl	String	URL	Payment redirect url including cancel and fail
item.notifyUrl	String	URL	Payment notify url
item.startAt	String	RFC3339	Payment checkout start date time
item.status	String	ENUM("SUCCESS", "FAILED", "CANCELLED", "EXPIRED")	Payment checkout status
item.createdAt	String	RFC3339	Payment checkout created date time
item.updatedAt	String	RFC3339	Payment checkout last updated date time

Direct Payment Checkout

Method : POST
URL : https://open.revenuemonster.my/v3/payment/online/checkout
Sandbox URL : https://sb-open.revenuemonster.my/v3/payment/online/checkout

note

• With it you can create an unified payment checkout and build your own checkout page
• There's two mode qrcode & url, most of the times URL is preferred over QRCode

Mode: URL

Request Parameters

Parameter	Type	Validation	Required	Description
checkoutId	String		Yes	Checkout ID
type	String	ENUM("URL")	Yes	Checkout type url
method	String	Appendix: Method	Yes	Checkout method

Example Request

{
  "checkoutId": "1582438693268947023",
  "type": "URL",
  "method": "ALIPAYPLUS_MY"
}

Response Paramters

Parameter	Type	Validation	Description
item.type	String	ENUM("URL")	Checkout session type
item.url	String		Checkout session url
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Mode: QRCode

Decode your Image using Base64

Using qrCodeImageBase64 URL to generate a QR Code

What user will receive

Once user scan the QR Code it will display

Request Parameters

Parameter	Type	Validation	Required	Description
checkoutId	String		Yes	Checkout ID
type	String	ENUM("QRCODE")	Yes	Checkout type qrcode
method	String	Appendix: Method	Yes	Checkout method

Example Request

{
  "checkoutId": "1582438693268947023",
  "type": "QRCODE",
  "method": "MAYBANK_MY"
}

Response Paramters

Parameter	Type	Validation	Description
item.type	String	ENUM("QRCODE")	Checkout session type
item.qrcode.base64Image	String
item.qrcode.data	String
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Mode: Mini Program

Request Parameters

Parameter	Type	Validation	Required	Description
checkoutId	String		Yes	Checkout ID
type	String	ENUM("MINI_PROGRAM")	Yes	Checkout type qrcode
method	String	Appendix: Method	Yes	Checkout method

Example Request

{
  "checkoutId": "1582438693268947023",
  "type": "MINI_PROGRAM",
  "method": "ALIPAY_CN"
}

Response Paramters

Parameter	Type	Validation	Description
item.type	String	ENUM("MINI_PROGRAM")	Checkout session type
item.data	String		Base64 encoded data for pass to mini program
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Alipay Mini Program

note

Use base64 decode data paramter, and pass into mini program api.

my.tradePay({
  orderStr: << decoded base64 from url parameter >>,
  success: (res) => {
    console.log("success", res)
  },
  fail:(res) =>{
    console.log("error", res)
  },
});

Mode: FPX

FPX Bank Codes via API

Method : GET
URL : https://open.revenuemonster.my/v3/payment/fpx-bank
Sandbox URL : https://sb-open.revenuemonster.my/v3/payment/fpx-bank

{
  "item": {
      "AFFIN_BANK": {
          "code": "AFFIN_BANK",
          "isOnline": true,
          "name": "Affin Bank"
      },
      "ALLIANCE_BANK": {
          "code": "ALLIANCE_BANK",
          "isOnline": true,
          "name": "Alliance Bank"
      },
      "AMBANK": {
          "code": "AMBANK",
          "isOnline": true,
          "name": "AmBank"
      },
      "BANK_ISLAM": {
          "code": "BANK_ISLAM",
          "isOnline": true,
          "name": "Bank Islam"
      },
      "BANK_MUAMALAT": {
          "code": "BANK_MUAMALAT",
          "isOnline": true,
          "name": "Bank Muamalat"
      },
      "BANK_RAKYAT": {
          "code": "BANK_RAKYAT",
          "isOnline": false,
          "name": "Bank Rakyat"
      },
      "BSN": {
          "code": "BSN",
          "isOnline": true,
          "name": "Bank Simpanan Nasional"
      },
      "CIMB_CLICKS": {
          "code": "CIMB_CLICKS",
          "isOnline": true,
          "name": "CIMB Bank"
      },
      "HLB_CONNECT": {
          "code": "HLB_CONNECT",
          "isOnline": true,
          "name": "Hong Leong Bank"
      },
      "HSBC": {
          "code": "HSBC",
          "isOnline": true,
          "name": "HSBC"
      },
      "KUWAIT_FINANCE_HOUSE": {
          "code": "KUWAIT_FINANCE_HOUSE",
          "isOnline": false,
          "name": "Kuwait Finance House"
      },
      "MAYBANK2U": {
          "code": "MAYBANK2U",
          "isOnline": true,
          "name": "Maybank"
      },
      "OCBC": {
          "code": "OCBC",
          "isOnline": true,
          "name": "OCBC"
      },
      "PUBLIC_BANK": {
          "code": "PUBLIC_BANK",
          "isOnline": true,
          "name": "Public Bank"
      },
      "RHB_NOW": {
          "code": "RHB_NOW",
          "isOnline": true,
          "name": "RHB Bank"
      },
      "STANDARD_CHARTERED_BANK": {
          "code": "STANDARD_CHARTERED_BANK",
          "isOnline": true,
          "name": "Standard Chartered Bank"
      },
      "UNITED_OVERSEA_BANK": {
          "code": "UNITED_OVERSEA_BANK",
          "isOnline": true,
          "name": "United Oversea Bank"
      }
  },
  "code": "SUCCESS"
}

FPX Bank Codes

RM BankCode	FPX / Third Party BankCode
AFFIN_BANK	FPX_ABB
ALLIANCE_BANK	FPX_ABMB
AMBANK	AMOnline
BANK_ISLAM	BIMB
BANK_MUAMALAT	bankmuamalat
BANK_RAKYAT	bankrakyat
BSN	FPX_BSN
CIMB_CLICKS	CIMBCLICKS
HSBC	FPX_HSBC
HLB_CONNECT	HLBConnect
KUWAIT_FINANCE_HOUSE	FPX_KFH
MAYBANK2U	MB2U
OCBC	FPX_OCBC
PUBLIC_BANK	PBB
RHB_NOW	RHBNow
STANDARD_CHARTERED_BANK	FPX_SCB
UNITED_OVERSEA_BANK	FPX_UOB

Request Parameters

Parameter	Type	Validation	Required	Description
checkoutId	String		Yes	Checkout ID
type	String	ENUM("URL")	Yes	Checkout type qrcode
method	String	ENUM("FPX_MY")	Yes	Checkout method
fpx.bankCode	String		Yes	FPX Bank code

Example Request

{
    "checkoutId": "1687166508263303064",
    "method": "FPX_MY",
    "type": "URL",
    "fpx": {
        "bankCode": "TEST0021"
    }
}

Response Paramters

Parameter	Type	Validation	Description
item.type	String	ENUM("QRCODE")	Checkout session type
item.url	String		FPX Payment URL
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Mode: GoBiz

Request Parameters

Parameter	Type	Validation	Required	Description
checkoutId	String		Yes	Checkout ID
type	String	ENUM("URL")	Yes	Checkout type qrcode
method	String	ENUM("GOBIZ_MY")	Yes	Checkout method
gobiz.type	String	ENUM("UNIVERSAL_PAYMENT")	Yes	GoBiz Payment Type

Example Request

{
    "checkoutId": "1687168234460362061",
    "method": "GOBIZ_MY",
    "type": "URL",
    "gobiz": {
        "type": "UNIVERSAL_PAYMENT"
    }
}

Response Paramters

Parameter	Type	Validation	Description
item.type	String	ENUM("URL")	Checkout session type
item.url	String		GoBiz Payment URL
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Mode: GoBiz w/ Card

Request Parameters

Parameter	Type	Validation	Required	Description
checkoutId	String		Yes	Checkout ID
type	String	ENUM("URL")	Yes	Checkout type qrcode
method	String	ENUM("GOBIZ_MY")	Yes	Checkout method
gobiz.type	String	ENUM("UNIVERSAL_PAYMENT")	Yes	GoBiz Payment Type
card.isToken	bool		Yes	Token mode
card.isSave	bool		Yes	Save the token after made transaction else will delete
card.no	String		Yes	Customer card number
card.cvc	String		Yes	Customer CVC
card.month	Uint64		Yes	Card expiry month
card.year	Uint64		Yes	Card expiry year
card.countryCode	String	ENUM("MY")	Yes	Card country code

Example Request

{
    "checkoutId": "1687168114614662971",
    "method": "GOBIZ_MY",
    "type": "URL",
    "gobiz": {
        "type": "UNIVERSAL_PAYMENT"
    },
    "card": {
        "isToken": false,
        "isSave": true,
        "name": "Test Card",
        "no": "5453010000095323",
        "cvc": "123",
        "month": 12,
        "year": 2024,
        "countryCode": "MY"
    }
}

Response Paramters

Parameter	Type	Validation	Description
item.type	String	ENUM("URL")	Checkout session type
item.url	String		GoBiz Payment URL
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Mode: GoBiz w/ Token

Request Parameters

Parameter	Type	Validation	Required	Description
checkoutId	String		Yes	Checkout ID
type	String	ENUM("URL")	Yes	Checkout type qrcode
method	String	ENUM("GOBIZ_MY")	Yes	Checkout method
gobiz.type	String	ENUM("DIRECT_PAYMENT")	Yes	GoBiz Payment Type
card.isToken	bool		Yes	Token mode
card.isSave	bool		Yes	Save the token after made transaction else will delete
card.no	String		Yes	Customer token

Example Request

{
    "checkoutId": "1687168234460362061",
    "method": "GOBIZ_MY",
    "type": "URL",
    "gobiz": {
        "type": "DIRECT_PAYMENT"
    },
    "card": {
        "isToken": true,
        "isSave": true,
        "no": "tk10f26d83de548aee420872dae999992475",
    }
}

Response Paramters

Parameter	Type	Validation	Description
item.type	String	ENUM("URL")	Checkout session type
item.transaction	JSON	Transaction Object	Transaction response
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Extra: Card-on-File Tokenization ( CoFT )

Card-on-File Tokenization ( CoFT ) will be applied when your customer doing card payment, they will return the customer token to allow your customer can proceed payment without key in again full card information to provide better security so you will able to get customer token or remove the token via API and also payment with Direct Payment Checkout API.

note

We suggest you to calling the get customer token api after the transaction is success or after the webhook, else the token might not exists even you're completed the payments.

Get Customer Tokens

Method : GET
URL : https://open.revenuemonster.my/v3/payment/tokens/{customer_id}
Sandbox URL : https://sb-open.revenuemonster.my/v3/payment/tokens/{customer_id}

Request Parameters

Parameter	Type	Validation	Required	Description
customer_id	Param		Yes	Customer ID you have used when create online payment checkout

Response Paramters

Parameter	Type	Validation	Description
item.*.id	String		Token ID
item.*.label	String		Token label
item.*.provider	String	ENUM("GOBIZ")	Token provider
item.*.token	String		Use this token when proceed payment
item.*.country	String	ENUM("MY")	Token country
item.*.createdAt	String	RFC3339	Payment checkout created date time
item.*.updatedAt	String	RFC3339	Payment checkout last updated date time
item.*.card.name	String		Card name when input card information
item.*.card.method	String	ENUM("MASTERCARD", "VISA")	Card type
item.*.card.lastFourNo	String		Last four digit of the card
item.*.card.expMonth	Uint64		Card expiry month
item.*.card.expYear	Uint64		Card expriy year
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )

Delete Customer Token

Method : DELETE
URL : https://open.revenuemonster.my/v3/payment/tokens/{customer_id}
Sandbox URL : https://sb-open.revenuemonster.my/v3/payment/tokens/{customer_id}

Request Parameters

Parameter	Type	Validation	Required	Description
customer_id	Param		Yes	Customer ID you have used when create online payment checkout
token	String		Yes	Token

Example Request

{
  "token": "tk10f26d83de548aee420872dae999992475"
}

Response Paramters

Parameter	Type	Validation	Description
item.*.id	String		Token ID
item.*.label	String		Token label
item.*.provider	String	ENUM("GOBIZ")	Token provider
item.*.token	String		Use this token when proceed payment
item.*.country	String	ENUM("MY")	Token country
item.*.createdAt	String	RFC3339	Payment checkout created date time
item.*.updatedAt	String	RFC3339	Payment checkout last updated date time
item.*.card.name	String		Card name when input card information
item.*.card.method	String	ENUM("MASTERCARD", "VISA")	Card type
item.*.card.lastFourNo	String		Last four digit of the card
item.*.card.expMonth	Uint64		Card expiry month
item.*.card.expYear	Uint64		Card expriy year
code	String	ENUM("SUCCESS")	Determine request have success
error.code	String		Error code
error.message	String		Error message
error.debug	String		Debug message ( sandbox only )