| Official Account ID |
sp_appid |
string[1,32] |
Yes |
Body Official Account ID assigned
by WeChat
Note:The value of this field cannot be modified
Example: wxd678efh567hg6787 |
| Vendor ID |
sp_mchid |
string[1,32] |
Yes |
Body Specifies vendor ID assigned by
WeChat Payment
Note:The value of this field cannot be modified
Example: 1230000109 |
| Merchant name |
name |
string[1,128] |
Yes |
Body Specifies the complete merchant entity name
Example: Fruit Store |
| Sub-merchant ID |
sub_mchid |
string[1,32] |
Yes |
path Sub-merchant ID
Note:The value of this field cannot be modified
Example: 20000100 |
| Merchant shortname |
shortname |
string[1,64] |
Yes |
Body Specifies the brief merchant name, which will be shown to the consumers
Example: FS |
| Customer Service Phone Number. |
office_phone |
string[1,32] |
Yes |
Body Specifies the customer service phone number, which will be shown in the payment details page for the consumers.
Please prefix the phone number. See the appendix for prefixes.
Example: +86075586010000 |
| Contact information |
contact |
object |
Yes |
Body Contact information object details is listed below |
| Name |
Variable Name |
Type |
Required |
Description |
| Full Name |
name |
string[1,64] |
Yes |
Specifies the contact person’s name.
Show: Encryption is required for this field, please refer to the field encryption guide
Example: Bob Zhang |
| Mobile Phone No. |
phone |
string[1,32] |
Yes |
Specifies the mobile phone number of the merchant for any urgent issues. Please prefix the phone number. See the appendix for prefixes.
Show: Encryption is required for this field, please refer to the field encryption guide
Example: +8613633334444 |
| Email |
email |
string[1,256] |
Yes |
Specifies the contact email of the merchant.
Show: Encryption is required for this field, please refer to the field encryption guide
Example: test@test.com |
|
| Business category |
business_category |
int |
Yes |
Body Specifies the business category, please refer to the business ID list of WeChat payment. see to Business Category
Example: 101 |
| Channel number |
channel_id |
string[1,20] |
No |
Body The channel number created by the institution in the WeChat merchant management backend. Fill in the channel number (if any).
Example: 3200000001 |
| Registered Country or Region |
merchant_country_code |
string[1,3] |
Yes |
Body The country where the submerchant was registered ,see to CountryCode
Example: 344 |
| Merchant Type |
merchant_type |
string[1,10] |
Yes |
Body ENTERPRISE or INDIVIDUAL
Example: ENTERPRISE |
| Registration Certificate Number |
registration_certificate_number |
string[1,50] |
Yes |
Body Company registration document No. Required when Merchant Type is ENTERPRISE.
Example: 5555-8888 |
| Expiration Date of Registration Certificate |
registration_certificate_date |
string[1,14] |
Yes |
Body The expiration date of the company registration document.
The value should be expire date or “PERMANENT” , “N/A”, the date format should YYYY-MM-DD , such as 2020-10-16. Required when Merchant Type is ENTERPRISE.
Example: 2020-10-16 |
| Copy of Registration Certificate |
registration_certificate_copy |
string[1,128] |
No |
Body The photocopy of the company registration document.
The value should be the media ID returned by Uploading Image API.
Example: DsWXok2NqRliv2SDL42QoEmHIPs |
| Settlement Bank No. |
settlement_bank_number |
string[1,128] |
No |
Body Settlement bank account number (settlement bank information)
Example: 555588889999 |
| Business information |
business |
object |
Yes |
Body Business information, the detail is listed below |
| Name |
Variable Name |
Type |
Required |
Description |
| Business type |
business_type |
string[1,7] |
Yes |
There are three business types:ONLINE,
OFFLINE or BOTH
Example: BOTH |
| Download link of APP |
app_download |
string[1,128] |
Yes/No |
The download link of merchant’s APP. app_download, bus_website，office_account, mini_program choose one field to submit if business type is ONLINE or BOTH
Example: https://download.qq.com |
| Business website |
website |
string[1,128] |
Yes/No |
The business website, app_download, bus_website，office_account, mini_program choose one field to submit if business type is ONLINE or BOTH
Example: https://www.qq.com |
| Official account |
office_account |
string[1,128] |
Yes/No |
Merchant’s official account. app_download, bus_website，office_account, mini_program choose one field to submit if business type is ONLINE or BOTH
Example: wx8888888888888888 |
| Mini Program |
mini_program |
string[1,128] |
Yes/No |
Merchant’s mini program. app_download, bus_website，office_account, mini_program choose one field to submit if business type is ONLINE or BOTH
Example: wx8888888888888888 |
| Store address |
store_address |
string[1,128] |
Yes/No |
Store address, required if business type is OFFLINE or BOTH
Example: 10F World Finance Centre (South Office), 11 Canton Road, Tsim Sha Tsui, Hong Kong |
| Store photos |
store_photos |
string[1,1024] |
No |
Store photos, the value should be at least 3 media IDs, which is returned by Uploading Image API. Multiple images are submitted in JSON format. Required if business type is OFFLINE or BOTH(Not mandatory)
Example: ["1beSM1UtWFrTTtCNYOrlllzaoIwc-RjARO-AP_QprCc", "1beSM1UtWFrTTtCNYOrlliXeq8spgRNG46iLYGMaeqc", "1beSM1UtWFrTTtCNYOrllooH4tOjn3F-NKYa_K6dAV8"] |
| MCC |
mcc |
string[1,4] |
Yes |
Mcc code, see to Merchant category codes
Example: 4214 |
|
| Director?information |
director |
object |
No |
Body Director?information,
Specify this field only when the Merchant Type is ENTERPRISE （Not mandatory）
The detail is listed below |
| Name |
Variable Name |
Type |
Required |
Description |
| Director Name |
name |
string[1,128] |
No |
Director name. Specify this field only when the Merchant Type is ENTERPRISE （Not mandatory）.
Example: Bob |
| Director ID Number |
number |
string[1,128] |
No |
Director's ID number. Specify this field only when the Merchant Type is ENTERPRISE （Not mandatory）
Example: 5555-8888 |
|
| Principal?information |
principal |
object |
No |
Body Principal?information,
Specify this field only when the Merchant Type is INDIVIDUAL （Not mandatory）
The detail is listed below |
| Name |
Variable Name |
Type |
Required |
Description |
| Principal Name |
name |
string[1,128] |
No |
Principal's ID number. Specify this field only when the Merchant Type is INDIVIDUAL （Not mandatory）
Example: Bob |
| Principal ID Number |
number |
string[1,128] |
No |
Principal's ID number. Specify this field only when the Merchant Type is INDIVIDUAL （Not mandatory）
Example: 5555-8888 |
|
| Apply for H5 payment authorization |
apply_h5_payment |
boolean |
No |
Apply for H5 payment authorization? The values are true or false.
If you already have H5 payment authorization but need to modify the H5 payment domain names, please fill in as true.
Example: true |
| H5 payment application info |
h5_payment_apply_info |
object |
Yes/No |
Body H5 payment application info.
Required when apply_h5_payment is true. |
| Name |
Variable Name |
Type |
Required |
Description |
| H5 business website URL |
website_url |
string[1,128] |
Yes/No |
Required when apply_h5_payment is true. Includes the sub-merchant's main business, goods/services and their prices, and website for offline orders from users.
Example: https://qq.com |
| H5 payment domain names |
domains |
array |
No |
Required when apply_h5_payment is true. Domain name from which H5 payment will be launched; up to 5; submit in json array format.
Note: The new list of domain names submitted will overwrite the existing list of payment domain names.
Example: ["www.qq.com","www.weixin.com"] |
|
Tips： 
