Create SubMerchant

Create Sub-merchant API to create submerchant ID for order management purpose. This is available for Partner only.

EndPoint

POST /binancepay/openapi/submerchant/add

Request Parameters

Attributes	Type	Required	Limitation	Description
merchantName	string	Y	maximum length 128	The sub merchant name maximum length 128, unique under one mainMerchantId.
storeType	int	Y	0 or 1	0=Online , 1=Physical, -1=Online&Physical
merchantMcc	string	Y	Specified code	four-digit number that classifies the business. Get from here
merchantType	int	N	1=Personal(Individual)、2=solo proprietor、 3=Partnership、4=Private company、5=Others company	-
country	string	N	iso alpha 2 country code(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), use "GO" if global	Country/Region of Business Operation,Can be multiple, split by "," eg:"SG,US"
siteUrl	string	N	maximum length 256	For Online stores, the URL field is required. (If your online store is an APP, please pass its link in the app store )
address	string	N	maximum length 1024	For Physical stores, the address field is required.
payIndustryDescription	string	N	maximum length 500	Mandatory if merchantMcc is 9999. Please specify the industry of this sub merchant here.
subPayMccCode	string	N	Specified code	four-digit number that classifies the business. Get from here
subPayIndustryDescription	string	N	Specified code	Mandatory if subPayMccCode is 9999. Please specify the industry of this sub merchant here.
brandLogo	string	N	maximum length 256	sub merchant logo url
companyName	string	N	maximum length 64	The legal name that is used in the registration.
registrationNumber	string	N	maximum length 64	Registration number/Company tax ID
registrationCountry	string	Y	iso alpha 2 country code(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)	Country of Registration
registrationAddress	string	N	maximum length 1024	Address of Registration
incorporationDate	long	N	UnixTimestamp in milliseconds	The date when the business registration is in effective.
certificateType	int	N	1 or 2	1=ID 2=Passport
certificateCountry	string	N	iso alpha 2 country code(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)	Certificate country
certificateNumber	string	N	maximum length 64	Certificate number
certificateValidDate	long	N	UnixTimestamp in milliseconds	Certificate Valid Date
contractTimeIsv	long	N	UnixTimestamp in milliseconds	Contract date with ISV
blockPayerKycCountries	List	N	iso alpha 2 country code(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)	Blocks payers from specified countries based on their KYC country. The list contains the countries to be blocked.

Sample Request Body

when merchant type is individual

{
  "merchantName":"Individual",
  "merchantType":1,
  "merchantMcc":"5511",
  "brandLogo":null,
  "country":"CN,US",
  "address":null,
  "companyName":null,
  "registrationNumber":null,
  "registrationCountry":null,
  "registrationAddress":null,
  "incorporationDate":null,
  "storeType":null,
  "siteUrl":null,
  "certificateType":1,
  "certificateCountry":"US",
  "certificateNumber":"123456X",
  "blockPayerKycCountries": ["AE","US"],
  "certificateValidDate":1752422400000,
  "contractTimeIsv":1594656000000
}

when merchant type is not individual

{
  "merchantName":"Sole Proprietor",
  "merchantType":2,
  "merchantMcc":"5511",
  "brandLogo":"logoUrlDemo",
  "country":"CN,US",
  "address":"store address demo",
  "companyName":"Sole Proprietor",
  "registrationNumber":"registration number demo",
  "registrationCountry":"US",
  "registrationAddress":"registration address demo",
  "incorporationDate":1588262400000,
  "storeType":1,
  "siteUrl":"https://siteurl.com",
  "certificateType":null,
  "certificateCountry":null,
  "certificateNumber":null,
  "certificateValidDate":null,
  "contractTimeIsv":1594656000000
}

Response Parameters

Attributes	Type	Required	Limitation	Description
status	string	Y	"SUCCESS" or "FAIL"	status of the API request
code	string	Y	-	result code
data	AddSubMerchantResponse	N	-	response body, refer to
errorMessage	string	N	maximum length 256	-

Child Attribute

AddSubMerchantResponse

Attributes	Type	Required	Limitation	Description
subMerchantId	long	Y	-	unique sub-merchant id generated by payment

Sample Response

{
  "status": "SUCCESS",
  "code": "000000",
  "data": {
    "subMerchantId": 2107268400000001
  }
}

{
"status": "FAIL",
"code": "400101",
"errorMessage": "Parameter 'merchantMcc' not valid, was empty/null, or too long/short, or wrong format."
}

Result Code

Name	Code	Reason	Solution
UNKNOWN_ERROR	400000	An unknown error occurred while processing the request.	Try again later
INVALID_REQUEST	400001	Parameter format is wrong or parameter transferring doesn't follow the rules.	Please check whether the parameters are correct.
INVALID_SIGNATURE	400002	Incorrect signature result	Check whether the signature parameter and method comply with signature algorithm requirements.
INVALID_TIMESTAMP	400003	Timestamp for this request is outside of the time window.	Sync server clock
INVALID_API_KEY_OR_IP	400004	API identity key not found or invalid.	Check API identity key
BAD_API_KEY_FMT	400005	API identity key format invalid.	Check API identity key.
BAD_HTTP_METHOD	400006	Request method not supported.	Check Request method.
MEDIA_TYPE_NOT_SUPPORTED	400007	Media type not supported.	Check Request Media type.
INVALID_REQUEST_BODY	400008	Request body is not a valid json object.	Check Request body
MANDATORY_PARAM_EMPTY_OR_MALFORMED	400100	A parameter was missing/empty/null, or malformed.
INVALID_PARAM_WRONG_LENGTH	400101	A parameter was not valid, was empty/null, or too long/short, or wrong format.
INVALID_PARAM_ILLEGAL_CHAR	400103	A parameter was not valid, contains illegal characters
INVALID_REQUEST_TOO_LARGE	400104	Invalid request, content length too large
INVALID_ACCOUNT_STATUS	400203	Not support for this account, please check account status.
SUB_MERCHANT_EXISTS	400205	Sub-merchant already exists.	Please check merchant name
PAYMENT_MERCHANT_NOT_FOUND	400208	Merchant not found.	Please check your merchantId
PAYMENT_ACTION_TOO_FREQUENT	400501	action Too Frequent, get the lock fail	Try again later

MCC

Code	Industry	Industry Description
1001	Accommodation and Food Services	"Hotels, Caterers, Restaurants"
1002	Administrative and Support and Waste Management and Remediation Services	"Organization/Association, Office administrative services, Travel arrangements, Locksmiths, Janitorial/Landscaping services, Waste Collection/Treatment/Disposal"
1004	"Agriculture, Forestry, Fishing and Hunting"	"Crop production, Animal farming, Aquaculture, Fishing"
1005	"Arts, Entertainment, and Recreation"	"Games, Amusements and recreation industries, Theatre companies, Dance companies, Museums, Sports teams and clubs"
1006	Construction	"Building, Flooring, Highway, Bridge, Glass construction/contractors"
1007	Broker	"OTC Broker / Dealer"
1008	Crypto ATM
1009	Crypto Mining	"Crypto miner, mining pool, mining hardware"
1010	Proprietary Crypto Traders
1011	Algorithm Crypto Traders
1012	P2P Merchants
1013	Other Digital Asset Services Provider (VASP)	"NFT marketplace, E-wallet, Custody service providers, crypto trading bot developers"
1014	Bank	"Private Banking, Investment Banking, Corporate Banking, Wealth Management "
1015	Non-Bank Financial Institution	"Insurance, Credit intermediation, Asset Management, Clearing House"
1016	Money Services Business and Payment Service Providers
1017	Family Office
1018	Personal Investment Companies
1019	Superannuation Fund
1020	Sovereign Wealth Fund
1021	Investment Funds	"Collective Investment Schemes, Mutual Funds, Hedge Funds, Private Equity Funds"
1022	Educational Services	"Child Care, Schools, Universities, Educational support services"
1024	Betting	"Legalised Casino, Online Betting, Gambling platform"
1025	Health Care and Social Assistance	"Hospitals, Nursing care facilities, Vocational rehabilitation services, Offices of physicians/dentists/optometrists "
1026	Information	"Newspaper, Record/Music/Motion Picture Production and Distribution, Radio and TV broadcasting"
1027	General Wholesalers	Building Supplies/Equipment/motor vehicles/household appliances/apparels/F&B wholesalers
1028	Management of Companies and Enterprises	"Non-Operating Asset Holding Companies, Head offices"
1029	Precious Stones and Precious Metals Dealers	"Production or trading of precious metals, precious stones or jewelry"
1030	Crude Oil and Natural Gas Dealers	"Production, refining and trading of Oil and Gas"
1031	General Manufacturing	"F&B manufacturing, breweries/wineries/distilleries, poultry processing, books printing, valves/motor vehicle manufacturing"
1032	Marijuana
1033	Mining and Extraction	"Mining and quarrying, oil and gas extraction"
1034	Pawn Shops
1035	Professional Services	"Business Consultations, Offices of Lawyers, Notaries, other independent legal professionals and accountants, Trust and Company Service Providers"
1036	Scientific and Technical Services	"Internet, Testing laboratories, Interior/Graphic design services, Photographic services, Veterinary services, Administrative management and general management consulting services, Non-Web3 software programming services"
1037	Public Administration	Federal government/Provincial and territorial public administration
1038	Real Estate Rental and Leasing	"Real estate agents, Lessors of buildings and dwellings, Construction, transportation, mining, and forestry machinery and equipment rental and leasing"
1039	Retail Stores - Electronics	"Phones, Computers, Cameras, Softwares, Electronic Product Supplies/Parts"
1040	Retail Stores - F&B	"Restaurants, Bars, Bakeries"
1041	Retail Stores - Jewelry	"Jewelry, Watches"
1042	Retail Trade - Others	"Gasoline Stations, Clothing/Shoe stores, Florists, Bookstores, Newspaper Stand, Mini-marts, Convenience store, Supermarket, Household appliances/supplies, Hardware stores, Beauty shop"
1043	Sale of Drugs and Pharmaceutical products (except Marijuana)
1044	Tobacco	Sales of Tobacco / Farming of Tobacco / Manufacturing of Tobacco
1045	Transportation and Warehousing	"Air/Rail/Water/Truck transportation, scenic and sightseeing transportation, Postal Service, Warehousing and storage, Automotive business"
1046	Utilities	"Electric power generation, transmission and distribution, Sewage treatment facilities, Water supply and irrigation systems, Natural gas distribution"
1047	Other Crypto/Web3 services (non VASP)	"Non Custodial NFT Marketplace, Software or Blockchain as a Service (SaaS or BaaS), dApps"
9999	Other