Get Merchant Profile

Retrieve the authenticated merchant's full profile — company details, address, status, and partner flags.

When to Use

▾

Use this endpoint when you:

• Display merchant info in a dashboard
• Need to verify the merchant's verification or active status
• Check isPartner / isMasterMerchant flags

How to Use

▾

Endpoint

GET/v3/merchant

Step 1: Authenticate

▾

Obtain a valid accessToken for the merchant.

Step 2: Send the GET Request

▾

No request body or query parameters required.

Step 3: Read the Response

▾

The item object contains the merchant profile.

---

Request Parameters

▾

No request body. Authenticated headers only.

---

Response Parameters

▾

itemOBJECT

Object of item details.

idSTRING

Merchant ID

Example: "6170506694335521334"

companyNameSTRING

Company name of merchant

Example: "REVENUE MONSTER"

companyTypeSTRING

Type of company incorporation

Example: "SOLE PROPRIETOR"

companyLogoUrlSTRING

Public URL to show merchant's logo

Example: "https://storage.googleapis.com/rm-dev-asset/img/merchant.png"

registrationNumberSTRING

Registration number of merchant

Example: “12344”

businessCategorySTRING

Business category of merchant

Example: "SOFTWARE AND IT"

establishedAtDATETIME

Established date time of merchant

Example: "2018-03-26T04:50:57Z"

countryCodeSTRING

Country code of merchant contact number

Example: "60"

phoneNumberSTRING

Phone number of merchant

Example: "377334080"

addressLine1STRING

Address 1 of merchant

Example: "20, JALAN JASA 38, TAMAN MUTIARA RINI"

addressLine2STRING

Address 2 of merchant

Example: ""

postcodeSTRING

Postcode of merchant

Example: “81300”

citySTRING

City of merchant

Example: "Selangor"

stateSTRING

State of merchant

Example: "Selangor"

countrySTRING

Country of merchant

Example: "Malaysia"

invoiceAddressOBJECT

Object of Invoice Address

addressLine1STRING

Address 1 of merchant

Example: "20, JALAN JASA 38, TAMAN MUTIARA RINI"

addressLine2STRING

Address 2 of merchant

Example: ""

postcodeSTRING

Postcode of merchant

Example: “81300”

citySTRING

City of merchant

Example: "Selangor"

stateSTRING

State of merchant

Example: "Selangor"

countrySTRING

Country of merchant

Example: "Malaysia"

isActiveBOOLEAN

Merchant active or deactivated status

Example: true

statusSTRING

Current status of merchant

Example: “REVIEWING”

isMasterMerchantBOOLEAN

Master Merchant flag

Example: true

masterMerchantIdSTRING

Master Merchant ID, if any

Example: "2301663653361832803"

isPartnerBOOLEAN

Partner Merchant flag

Example: true

partnerIdSTRING

Partner Merchant ID, if any

Example: "2301663653361832803"

gstNoSTRING

GST No, if any

Example: ""

createdAtDATETIME

Creation date time of merchant

Example: "2018-02-12T08:53:13Z"

updatedAtDATETIME

Last update date time of merchant

Example: "2018-02-12T08:53:13Z"

codeSTRING

`"SUCCESS"` if the call succeeded. Otherwise returns an error code. See [Error Codes](../../error-codes).

Example: "SUCCESS"