alipay.commerce.qrcode.create
Call this interface to generate a merchant QR code. For one store ID, up to two merchant QR codes can be created, one with the commission charge and the other not. If you call this interface again after two merchant QR codes being created, the data of an existing merchant QR code is returned.
Request
Service address
Environment | HTTPS request URL |
Production environment | |
Test environment |
Request parameters
Parameter | Description |
Basic parameter | |
service String | Interface name
|
partner String(16) | The partner ID that is assigned by Alipay to identify an Alipay account. The partner ID is composed of 16 digits and begins with 2088.
|
_input_charset String | The charset with which the request data is encoded. UTF-8, GBK, and GB2312 are supported.
|
sign_type String | Sign type. RSA, RSA2, and MD5 are supported. Use uppercase.
|
sign String | Sign value.
|
timestamp String | The time when the merchant server sends request. The time is in GMT+8, and in a format of yyyy-MM-dd HH:mm:ss.By default, the request expires in 30 minutes.
|
notify_url URL(200) | The URL for receiving asynchronous notifications after the payment is completed.
|
Business parameter | |
biz_type String | Business type that is defined by Alipay, with a value of OVERSEASHOPQRCODE
|
biz_data String(2000) | Business data, which is in the JSON format. For more information, see biz_data.
|
biz_data
Parameter | Description |
secondary_merchant_industry String(4) | Business category code of the secondary merchant. For more information about the business category code, see MCC list. Example:0001 |
secondary_merchant_id String(32) | The unique ID assigned by the partner to identify a secondary merchant. The ID can contain letters, numbers, and underscores.
|
secondary_merchant_name String(32) | Registration legal name of the secondary merchant, shown in the Alipay Wallet and the reconciliation file to identify a secondary merchant.
|
store_id String | The unique ID that is assigned by the partner to identify a store of a merchant, which can contain letters, numbers, and underscores. Note: This field is optional for the taxi business (MCC=4121).
|
store_name String | Store name. Note: This field is optional for the taxi business (MCC=4121).
|
taxi_operation_id String | Taxi operation ID, which is compulsory for the taxi business (MCC=4121).
|
taxi_number String | Taxi number, which is compulsory for the taxi business (MCC=4121).
|
taxi_driver_name String | Taxi driver name, which is compulsory for the taxi business (MCC=4121) and is to be used in the transaction history of Alipay wallet.
|
taxi_driver_mobile String | Mobile number of the taxi driver, which is compulsory for the taxi business. (MCC=4121)
|
trans_currency String | The pricing currency. Use the same value for this parameter and the currency parameter. Contact Alipay technical support if you have to use different values. Use upper case.
|
currency String | The settlement currency that the merchant specifies in the contract. Only HKD is supported.
|
sys_service_provider_id String | System service provider ID, which is used to identify the payment system provider. Can’t be modified.
|
channel_fee String | Channel fee. For more information, see channel_fee. Note: If this field exists when the QR code is created, this field cannot be deleted when the QR code is modified. This field is in a format of JSON.
|
country_code String | The country code that consists of two letters (alpha-2 code). Refer to ISO 3166-1 for details.
|
address String | The address of the store where the code is created. Use postal address format.
|
passback_parameters String | The response parameters returned to the merchant in a JSON format after the payment succeeds. Merchants can define the parameters. Note: Nested JSON is not supported.
|
notify_mobile String | Phone number of the merchant legal representative. Must be numbers only.
|
notify_wangwang String | Wangwang name of the merchant legal representative
|
notify_alipay_account String | Alipay account of the merchant legal representative
|
channel_fee
Parameter | Description |
type String | Channel fee type. The value can be FIXED to indicate the fee is a fixed amount or RATE to indicate the fee is calculated based on a certain percentage.
|
value String | 1. A FIXED channel fee is charged based on the value. For example, {"type":"FIXED", "value":"X"}. If transaction amount*5% is less than X, the channel fee is transaction amount*5%. If transaction amount*5% is equal to or greater than X, the channel fee is fixed at X. 2. If the channel fee type is RATE, the value range is [0, 0.05]. (In promotion season, the channel fee can be 0.)
|
Note:
Do not use the halfwidth quotation mark (") in parameter values.
Response
Synchronous response
Parameter | Description |
is_success String | Indicates whether the request succeeds or not, with a value of T for success and F for failure. Note: a successful request does not mean the business is accepted and processed successfully.
|
sign_type String | Sign type. Only MD5 is supported. Use uppercase.
|
sign String | Sign value
|
error String | Error code that is returned when the request is not successful to describe the request failure reason. If the request is successful, this field is not returned. For more information, see the Error Code section in this document.
|
Business parameter | |
qrcode String | QR code
|
qrcode_img_urlString | The URL of the QR code image
|
Asynchronous response
Error codes
Business errors
Error Code | Specification |
AE_BARCODE_GENERAL_CODE_FAIL | Failed to generate the barcode |
ILLEGAL_ARGUMENT | Invalid agument |
ILLEGAL_SIGN | Invalid signature |
System errors
Error Code | Specification |
ILLEGAL_SIGN | Invalid signature |
ILLEGAL_DYN_MD5_KEY | Invalid dynamic key |
ILLEGAL_ENCRYPT | Invalid encryption |
ILLEGAL_ARGUMENT | Invalid argument |
ILLEGAL_SERVICE | Invalid service name |
ILLEGAL_USER | Invalid user ID |
ILLEGAL_PARTNER | Invalid partner ID |
ILLEGAL_EXTERFACE | Interface configure error. |
ILLEGAL_PARTNER_EXTERFACE | The partner ID does not have access privilege. |
ILLEGAL_SECURITY_PROFILE | The key is not available |
ILLEGAL_AGENT | Invalid agent ID |
ILLEGAL_SIGN_TYPE | Invalid sign type |
ILLEGAL_CHARSET | Illegal character set |
HAS_NO_PRIVILEGE | No priviledge |
INVALID_CHARACTER_SET | Invalid character set |
Samples
Request
https://intlmapi.alipay.com/gateway.do?service=alipay.commerce.qrcode.create&partner=2088021966645500&_input_charset=UTF-8&sign_type=MD5¬ify_url=http%3A%2F%2Fwww.mikascoffee.com%2Fnotify×tamp=2019-09-10%2014%3A43%3A12&biz_type=OVERSEASHOPQRCODE&biz_data=%7B%22secondary_merchant_industry%22%3A%225499%22%2C%22secondary_merchant_id%22%3A%221314520%22%2C%22secondary_merchant_name%22%3A%22Mika's%20coffee%20shop%22%2C%22store_id%22%3A%221993%22%2C%22store_name%22%3A%22Mika's%20coffee%20shop%22%2C%22trans_currency%22%3A%22HKD%22%2C%22currency%22%3A%22HKD%22%2C%22country_code%22%3A%22US%22%2C%22address%22%3A%223%20Old%20Concord%20Rd%2C%20Burlington%2C%20MA%2001803%E7%BE%8E%E5%9B%BD%22%2C%22notify_sign_type%22%3A%22RSA%22%2C%22notify_charset%22%3A%22UTF-8%22%7D&sign=a494fbdca0d437d2b48860e485329bab
Response
Synchronous response
The response of a successful request:
<alipay>
<is_success>T</is_success>
<request>
<param name="partner">208xxxxxxxxx5500</param>
<param name="service">alipay.commerce.qrcode.create</param>
<param name="_input_charset">UTF-8</param>
<param name="biz_type">OVERSEASHOPQRCODE</param>
<param name="sign">a494fbdca0d437d2b48860e485329bab</param>
<param name="notify_url">http://www.mikascoffee.com/notify</param>
<param name="biz_data">
{"secondary_merchant_industry":"5499","secondary_merchant_id":"1314520","secondary_merchant_name":"Mika's coffee shop","store_id":"1993","store_name":"Mika's coffee shop","trans_currency":"HKD","currency":"HKD","country_code":"US","address":"3 Old Concord Rd, Burlington, MA 01803美国","notify_sign_type":"RSA","notify_charset":"UTF-8"}
</param>
<param name="sign_type">MD5</param>
<param name="timestamp">2019-09-10 14:43:12</param>
</request>
<response>
<qrcodeinfo>
<qrcode>https://qr.alipay.com/ocx09863drhqewuprmuzm68</qrcode>
<qrcode_img_url>
https://mobilecodec.alipay.com/show.htm?code=ocx09863drhqewuprmuzm68
</qrcode_img_url>
</qrcodeinfo>
</response>
<sign>92d50b1269827bff460f8959a5218224</sign>
<sign_type>MD5</sign_type>
</alipay>
The response for a failed request:
<alipay>
<is_success>F</is_success>
<error>ILLEGAL_SIGN</error>
</alipay>
Asynchronous response
http://www.mikascoffee.com/notify
extra_common_param={"qrcode":"https://qr.alipay.com/ocx00197t1iruoiqhwwjr19"}
currency=HKD
payment_inst=ALIPAYHK
trans_currency=HKD
trade_no=201xxxxxxxxxxxxxxxxxxxxx0583
subject=Mika's coffee shop
buyer_email=852-****4034
paytools_pay_amount=[{"BANKCARD":"0.01"}]
gmt_create=2019-09-11 19:02:02
notify_type=trade_status_sync
quantity=1
forex_rate=1
out_trade_no=882xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx2346
trans_amount=0.01
notify_time=2019-09-11 19:02:41
seller_id=208xxxxxxxxx5500
trade_status=TRADE_SUCCESS
gmt_payment=2019-09-11 19:02:40
total_fee=0.01
seller_email=che***@antfin.com
notify_action_type=payByAccountAction
price=0.01
buyer_id=208xxxxxxxxx4270
notify_id=201xxxxxxxxxxxxxxxxxxxxxxxxxxx7574
sign_type=RSA
sign=$$$
The payment breakdown
The payment breakdown is represented in JSON format, and it includes the following parameters:
Parameter | Description |
ALIPAYACCOUNT String | The amount paid by Alipay account’s balance in CNY.
|
MCARD String | The money amount paid by the merchant's prepaid card. The unit is Yuan.
|
MDISCOUNT String | The amount paid by the merchant’s voucher in CNY.
|
TMPOINT String | The amount paid by the buyer’s point at the merchant in CNY.
|
COUPON String | The amount paid by red package in CNY.
|
POINT String | The amount paid by Ji Fen Bao in CNY.
|
DISCOUNT String | The amount paid by the discount of the account in CNY.
|
BANKCARD String | The amount paid by bank card.
|
MONEYFUND String | The amount paid by Yu’e Bao.
|
BAITIAO String | The money amount paid by BAITIAO. The unit is Yuan.
|
MCOUPON String | The money amount paid by the merchants issued coupons.
|
The JSON format:
[
{the payment balance type1: amount1},
{ the payment balance type2: amount2},
…
]
An JSON Format Example:
paytools_pay_amount=
[{"MCARD":"7.94"},
{"TMPOINT":"1.69"},
{"BANKCARD":"5.55"}
]
Payment amount information
The payment amount information is displayed in json, which includes the following parameters:
Parameter | Description |
ALIPAYACCOUNT String | The amount paid in Yuan by the balance in Alipay account.
|
MCARD String | The money amount paid by the merchant's prepaid card. The unit is Yuan.
|
MDISCOUNT String | The amount paid in Yuan by the merchant voucher.
|
TMPOINT String | The amount paid in Yuan by the Tmall points.
|
COUPON String | The amount paid in Yuan by the coupon.
|
POINT String | The amount paid in Yuan by the bonus points.
|
DISCOUNT String | The amount paid in Yuan by the account discounts.
|
BANKCARD String | The amount paid in Yuan by the bank card.
|
MONEYFUND String | The amount paid in Yuan by Yu'e Bao.
|
BAITIAO String | The money amount paid by BAITIAO. The unit is Yuan.
|
MCOUPON String | The money amount paid by the merchants issued coupons. The unit is Yuan.
|
Format structure:
[
{Type of payment amount 1:payment amount 1}
,
{Type of payment amount 2:payment amount 2}
,
…
]
Example:
paytools_pay_amount=[{"MCARD":"7.94"},{"TMPOINT":"1.69"},{"BANKCARD":"5.55"}]
Example
http://merchant customized address/alipay/notify_url.php?notify_id=ac05099524730693a8b330c5ecf72da978&seller_email=zhuzhanghu%40alitest.com¬ify_type=trade_status_sync&buyer_email=138*****011&sign=601510b7970e52cc63db0f44997cf70e&trade_no=2013112711001004940000394507&buyer_id=2088102105236945&quantity=10&total_fee=10.00&price=1.00&gmt_create=2013-11-27+15%3A45%3A57&out_trade_no=5431395578198135&seller_id=2088101106499364¬ify_time=2013-11-27+15%3A45%3A58&subject=%E5%A3%B0%E6%B3%A2%E6%94%AF%E4%BB%98-%E5%88%86%E8%B4%A6-sky&trade_status=WAIT_BUYER_PAY&payment_inst=ALIPAYCN&sign_type=MD5
Note:
This example is only for reference. The actual gateway is the domain name of a merchant.