Skip to main content

Create Store

Register a new store under a merchant account. The new store becomes available for transactions tied to that merchant.

When to Use

Use this endpoint when:

  • A merchant opens a new physical or online location
  • You need to programmatically provision stores
  • Onboarding a new outlet to existing merchants

How to Use

Endpoint
POST/v3/store

Step 1: Prepare Store Details

Collect required fields: name, full address, country code, phone, and optional geo-location.

Step 2: Send the POST Request

POST the store payload to /v3/store with signed authentication headers.

Step 3: Store the ID

The response includes the new store id. Use it for transactions and subsequent updates.


Request Parameters

merchantSettlementIdSTRING

Linkage with payment settlement account

nameSTRINGrequired

Store Name

Example: "REVENUE MONSTER"

addressLine1STRINGrequired

Store Address 1

Example: "B-5-30, 5th Floor, Block Bougainvillea,"

addressLine2STRING

Store Address 2

Example: "PJU 6A, Lebuhraya SPRINT, 10 Boulevard,"

postCodeSTRINGrequired

Postcode of store

Example: "47400"

citySTRINGrequired

City of store

Example: "Petaling Jaya"

stateSTRINGrequired

State of store

Example: "Selangor"

countrySTRINGrequired

Country of store

Example: "Malaysia"

countryCodeSTRINGrequired

Country code of store contact number

Example: "60"

phoneNumberSTRINGrequired

Phone number of store

Example: "377334080"

geoLocationOBJECT

Geo Location (latitude and longitude) of store

Example: {"latitude": 3.1349857, "longitude": 101.6136659 }


Response Parameters

itemOBJECT

Created store details.

idSTRING

Store ID

Example: "6170506694335521334"

merchantSettlementIdSTRING

Merchant Settlement ID

Example: "6170506694335521334"

nameSTRING

Store Name

Example: "REVENUE MONSTER"

addressLine1STRING

Store Address 1

Example: "B-5-30, 5th Floor, Block Bougainvillea,"

addressLine2STRING

Store Address 2

Example: "PJU 6A, Lebuhraya SPRINT, 10 Boulevard,"

postCodeSTRING

Postcode of store

Example: "47400"

citySTRING

City of store

Example: "Petaling Jaya"

stateSTRING

State of store

Example: "Selangor"

countrySTRING

Country of store

Example: "Malaysia"

countryCodeSTRING

Country code of store contact number

Example: "60"

phoneNumberSTRING

Phone number of store

Example: "377334080"

geoLocationOBJECT

Geo Location (latitude and longitude) of store

Example: {"latitude": 3.1349857, "longitude": 101.6136659 }

statusSTRING

Current status of store

Example: "ACTIVE"

isDefaultBOOLEAN

Default store of merchant (first store created upon signup)

Example: true

createdAtDATETIME

Creation date time of store

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

updatedAtDATETIME

Last update date time of store

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

codeSTRING

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"