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.
merchantType	int	Y	1=Personal(Individual)、2=solo proprietor、 3=Partnership、4=Private company、5=Others company	-
merchantMcc	string	Y	Specified code	four-digit number that classifies the business. Get from here
payIndustryDescription	string	N	maximum length 500	Mandatory if merchantMcc is 9999. Please specify the industry of this sub merchant here.
brandLogo	string	N	maximum length 256	sub merchant logo url
country	string	Y	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"
address	string	N	maximum length 1024	store address
companyName	string	N	maximum length 64	The legal name that is used in the registration, Required if merchantType is not Individual
registrationNumber	string	N	maximum length 64	Registration number/Company tax ID, Required if merchantType is not Individual
registrationCountry	string	N	iso alpha 2 country code(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)	Country of Registration, Required if merchantType is not Individual
registrationAddress	string	N	maximum length 1024	Country of Registration, Required if merchantType is not Individual
incorporationDate	long	N	UnixTimestamp in milliseconds	The date when the business registration is in effective, Required if merchantType is not Individual
storeType	int	N	0 or 1	0=Online 1=Physical
siteType	int	N	1,2,3,4	1=Web 2=App 3=Binance applets 4=Others , Required if merchantType is not Individual
siteUrl	string	N	maximum length 256	The URL of the website, Required if siteType is Web
siteName	string	N	maximum length 32	The name of the website, Required if siteType is Web or App or Binance applets
certificateType	int	N	1 or 2	1=ID 2=Passport, Required if merchantType is Individual
certificateCountry	string	N	iso alpha 2 country code(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)	Required if merchantType is Individual
certificateNumber	string	N	maximum length 64	Required if merchantType is Individual
certificateValidDate	long	N	UnixTimestamp in milliseconds	Certificate Valid Date, Required if merchantType is Individual
contractTimeIsv	long	N	UnixTimestamp in milliseconds	Contract date with ISV

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,  "siteType":null,  "siteUrl":null,  "siteName":null,  "certificateType":1,  "certificateCountry":"US",  "certificateNumber":"123456X",  "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,  "siteType":2,  "siteUrl":"site url demo",  "siteName":"site name demo",  "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