Create Merchant
Create a new merchant account under your Partner account. This endpoint submits merchant information for review. Once approved, the merchant can access RM services.
When to Use
▾
Use this endpoint when:
- A new merchant signs up through your platform
- You need to programmatically create merchant accounts
- You want to onboard merchants in bulk
This endpoint is for merchants with a Partner account. To activate a Partner account, contact us.
How to Use
▾
/v3/partner/merchantStep 1: Get Your Partner Credentials
▾
Obtain your clientId and clientSecret from the RM Merchant Portal > Developer > Application.
Step 2: Prepare Merchant Information
▾
Collect the required merchant details:
- Company name
- Country code and phone number
- Email address
- Contact person's first and last name
Step 3: Make the API Request
▾
Send the merchant information to this endpoint with your authenticated headers.
Step 4: Review the Response
▾
Check the code field in the response. If "SUCCESS", the merchant was created. The merchant and store objects will be returned.
Request Parameters
▾
Registered company name
Example: "Revenue Monster"
Country code for phone number (e.g., "60" for Malaysia)
Example: "60"
Contact email address
Example: "[email protected]"
Contact person's first name
Example: "Edwin"
Contact person's last name
Example: "Testing"
Contact phone number (without country code)
Example: "164699177"
Response Parameters
▾
Contains merchant, store, and user objects
Merchant details
Unique merchant ID
Example: "1629292083526787883"
Registered company name
Example: "Revenue Monster"
Brand name if different from company
Example: ""
Short name / alias for the merchant
Example: ""
Type of company incorporation
Example: ""
Public URL for company logo
Example: "https://storage.googleapis.com/rm-sandbox-asset/img/merchant.png"
Company registration number
Example: ""
Business category
Example: ""
Scope of business activities
Example: ""
Source of the merchant's funds
Example: ""
Origin/channel of the merchant's customers
Example: ""
Merchant's website URL
Example: ""
Established date time of the company
Example: "0001-01-01T00:00:00Z"
Country code for contact
Example: "60"
Contact phone number
Example: ""
Street address line 1
Example: ""
Street address line 2
Example: ""
City
Example: ""
State/Province
Example: ""
Postal/ZIP code
Example: ""
Country
Example: ""
Merchant's invoice/billing address
Invoice address line 1
Example: ""
Invoice address line 2
Example: ""
Invoice address postcode
Example: ""
Invoice address city
Example: ""
Invoice address state
Example: ""
Invoice address country
Example: ""
Whether the merchant account is active
Example: true
Merchant status (e.g., "UNVERIFIED", "REVIEWING", "ACTIVE")
Example: "UNVERIFIED"
Whether this merchant is a master merchant
Example: false
Master merchant ID, if any
Example: ""
Whether this is a partner merchant
Example: true
Partner ID if applicable
Example: ""
GST registration number, if any
Example: ""
Payment subscription plan
Example: ""
Subscription flags
Offline e-wallet terminal enabled
Example: false
Offline credit card terminal enabled
Example: false
Online credit card enabled
Example: false
Countries whitelisted for online credit card payment
Example: []
Partial refund enabled
Example: false
SMS Open API enabled
Example: false
Recurring payments enabled
Example: false
Tokenized payments enabled
Example: false
Merchant wallet enabled
Example: false
VOP API enabled
Example: false
Channel through which the merchant registered
Example: "OPEN_API"
Account creation timestamp
Example: "2021-08-18T13:08:03.530Z"
Last update timestamp
Example: "2021-08-18T13:08:03.530Z"
Store details
Unique store ID
Example: "1629292083696729288"
Merchant settlement ID
Example: ""
Store name
Example: "Revenue Monster"
Store image URL
Example: "https://storage.googleapis.com/rm-prod-asset/img/store.png"
Street address line 1
Example: ""
Street address line 2
Example: ""
Postal code
Example: ""
City
Example: ""
State
Example: ""
Country
Example: ""
Country code
Example: ""
Store phone number
Example: ""
Latitude and longitude
Latitude
Example: 0
Longitude
Example: 0
Store status ("ACTIVE", "INACTIVE")
Example: "ACTIVE"
Creation timestamp
Example: "2021-08-18T13:08:03.535Z"
Last update timestamp
Example: "2021-08-18T13:08:03.535Z"
User details
Unique user ID
Example: "1629292083650514742"
User's first name
Example: "EDWIN"
User's last name
Example: "TESTING"
Country code
Example: "60"
Phone number
Example: "164699177"
Email address
Example: "[email protected]"
Avatar image URL
Example: "https://storage.googleapis.com/rm-sandbox-asset/img/avatar.png"
User status ("ACTIVE", "INACTIVE")
Example: "ACTIVE"
Settlement account IDs linked to the user
Example: []
Store IDs the user has access to
Example: []
Whether user is active
Example: true
Current store ID
Example: ""
Merchant ID the user belongs to
Example: "1629292083526787883"
Creation timestamp
Example: "2021-08-18T13:08:03.537Z"
Last update timestamp
Example: "2021-08-18T13:08:03.537Z"
"SUCCESS" if the merchant was created. Otherwise returns an error code.
Example: "SUCCESS"