Get Merchant Profile

Method : GET
URL :https://open.revenuemonster.my/v3/merchant
Sandbox URL :https://sb-open.revenuemonster.my/v3/merchant

note

To query for merchant details.

Request Parameters:#

note

No request parameter is required for this endpoint.

Response Parameters#

ParameterTypeDescriptionExample
itemObjectObject of item details.(Refer explanantion below)
codeStringStatus returned from Revenue Monster server, whether successfully called our endpoint or not."SUCCESS"

Item Object (item):
ParameterTypeDescriptionExample
idStringStore ID"6170506694335521334"
companyNameStringCompany name of merchant"REVENUE MONSTER"
companyTypeStringType of company incorporation"SOLE PROPRIETOR"
companyLogoUrlStringPublic URL to show merchant's logo"https://storage.googleapis.com/rm-dev-asset/img/merchant.png"
registrationNumberStringRegistration number of merchant“12344”
businessCategoryStringBusiness category of merchant"SOFTWARE AND IT"
establishedAtStringEstablished date time of merchant"2018-03-26T04:50:57Z"
countryCodeStringCountry code of merchant contact number"60"
phoneNumberStringPhone number of merchant"377334080"
addressLine1StringAddress 1 of merchant"20, JALAN JASA 38, TAMAN MUTIARA RINI"
addressLine2StringAddress 2 of merchant""
postcodeStringPostcode of merchant“81300”
cityStringCity of merchant"Selangor"
stateStringState of merchant"Selangor"
countryStringCountry of merchant"Malaysia"
invoiceAddresObjectObject of Invoice Address(Refer below)
isActiveBooleanMerchant active or deactivated statustrue
statusStringCurrent status of merchant“REVIEWING”
isMasterMerchantBoolMaster Merchant flagtrue
masterMerchantIdStringMaster Merchant ID, if any"2301663653361832803"
isPartnerBoolPartner Merchant flagtrue
partnerIdStringPartner Merchant ID, if any"2301663653361832803"
gstNoStringGST No, if any""
createdAtDateTimeCreation date time of merchant"2018-02-12T08:53:13Z"
updatedAtDateTimeLast update date time of merchant"2018-02-12T08:53:13Z"

Invoice Address Object:
ParameterTypeDescriptionExample
addressLine1StringAddress 1 of merchant"20, JALAN JASA 38, TAMAN MUTIARA RINI"
addressLine2StringAddress 2 of merchant""
postcodeStringPostcode of merchant“81300”
cityStringCity of merchant"Selangor"
stateStringState of merchant"Selangor"
countryStringCountry of merchant"Malaysia"

Example Response

{
"item": {
"id": "5611759774758429587",
"companyName": "YUSSUF TEST",
"companyType": "SOLE PROPRIETORSHIP",
"companyLogoUrl": "https://storage.googleapis.com/rm-dev-merchant/5611759774758429587/logo/merchant.jpeg",
"registrationNumber": "12343",
"businessCategory": "INSURANCE SERVICES",
"establishedAt": "2018-05-12T16:00:00Z",
"countryCode": "60",
"phoneNumber": "167367171",
"addressLine1": "20, JALAN JASA 38, TAMAN MUTIARA RINI",
"addressLine2": "",
"postcode": "81300",
"city": "AYER HITAM",
"state": "JOHOR",
"country": "MALAYSIA",
"invoiceAddress": {
"addressLine1": "20, JALAN JASA 38, TAMAN MUTIARA RINI",
"addressLine2": "",
"postcode": "81300",
"city": "AYER HITAM",
"state": "JOHOR",
"country": "MALAYSIA"
},
"isActive": true,
"status": "VERIFIED",
"isMasterMerchant": false,
"masterMerchantId": "2301663653361832803",
"isPartner": false,
"partnerId": "2301663653361832803",
"gstNo": "",
"createdAt": "2018-05-14T09:26:22Z",
"updatedAt": "2018-05-22T05:23:02Z"
},
"code": "SUCCESS"
}