1. Obtain Invoicing Platform ID

2. Creating Invoice Card Templates

3. Uploading PDF Files

4. Querying Uploaded PDF Files

5. Adding E-Invoice Cards to the User's Cards & Offers

6. Updating Invoice Card Status

7. Invoice Status Update Event Push

8. Decrypting Code

9. Error Codes

10. List of Invoice Reimbursement Status

---

# 1. Obtain Invoicing Platform ID

API description

The invoicing platform can use this API to obtain its own pre-invoicing URL and then the s_pappid. The invoicing platform provides this s_pappid to merchants, who then use it to identify the invoicing platform in the Weixin e-Invoice solution.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/seturl?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and the provided data is empty, i.e. {}.

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request
{}
Response
{
	"errcode": 0,
	"errmsg": "ok",
	"invoice_url": "https://mp.weixin.qq.com/bizmall/authinvoice?action=list&s_pappid=d3xxxxxxxxxxxxxGLSS0wrL14No8c1"
}

# 2. Creating Invoice Card Templates

API description

Invoicing platforms can use this API to create a merchant invoice card template and configure the custom fields in the template. The creation of an invoice card template generates a card_id, which is used to reference the template. Invoice card templates are used as the basis of invoice card creation.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/platform/createcard?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and contain the following fields:

invoice_info is an Object and includes the following fields:

base_info is an Object and includes the following fields:

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request:
{
	"invoice_info": {
		"base_info": {
			"logo_url": "http://mmbiz.qpic.cn/mmbiz/iaL1LJM1mF9aRKPZJkmG8xXhiaHqkKSVMMWeN3hLut7X7hicFNjakmxibMLGWpXrEXB33367o7zHN0CwngnQY7zb7g/0",
			"title": "xx company",
			"custom_url_name": "xyz",
			"custom_url": "xyz",
			"custom_url_sub_title": "xyz",
			"promotion_url_name": "puname",
			"promotion_url": "purl",
			"promotion_url_sub_title": "ptitle",
		},
		"type": " Guangdong VAT invoice ",
		"payee": " Test - Payee",
	}
}
Response:
{
	"errcode": 0,
	"errmsg": "ok",
	"card_id": "pjZ8Yt9WoOePThU0NfUKz5-tBEWU"
}

# 3. Uploading PDF Files

API description

The merchant or invoicing platform can call this API to upload PDF files. After the PDF file is successfully uploaded, the invoice file ID is obtained. This can subsequently be used with the "Add Card" API to link the PDF file with a user's invoice card and then add them to the user's Cards & Offers.

Note: If an uploaded PDF file is not linked with any invoice card and sent to the user's Cards & Offers within three days, it is erased. If the merchant or invoicing platform needs to link a PDF file with an invoice card after three days, they must upload it again.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/platform/setpdf?access_token={access_token}

Request method: POST

Request parameters

The data format is multipart/form-data and uses the following parameters:

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request:
 ------WebKitFormBoundary2exwM16BY25kVBgf Content-Disposition: form-data; name="pdf"; filename="1133090578170938.pdf" Content-Type: application/pdf Pdf content ------WebKitFormBoundary2exwM16BY25kVBgf—
Response:
{
	"errcode":0,
    "errmsg":"ok",
    "s_media_id":"3015806758683707"
}

# 4. Querying Uploaded PDF Files

API description

This API is used by merchants and invoicing platforms to query the invoices or proofs of purchase (in PDF) they have uploaded.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/platform/getpdf?action=get_url&access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and contain the following fields:

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request:
{
	"action": "get_url",
	"s_media_id": "75195574948725301"
}
Response:
{
	"errcode": 0,
	"errmsg": "ok",
	"pdf_url": "https://mp.weixin.qq.com/intp/invoice/getpdf?action=media_pdf&media_key=dFRnTkV6WCswNjB1V1czZ0tVU3MhaX4yb2pxeEVSY0teSCtuflY6UXAifD5rL09kTjFpOFVWKyJGNCgxTCtkJER6VjFlRCtVU2JKcS5FZw",
	"pdf_url_expire_time": 7200
}

# 5. Adding E-Invoice Cards to the User's Cards & Offers

API description

This API is called by invoicing platforms and self-deployed platform merchants. For users who have authorized invoicing requests, the invoicing platform can use this API to create invoice cards based on invoices and add them to the users' Weixin Cards & Offers.

Please note that, if the authorization page is triggered by a merchant and the card addition action is made by an invoicing platform, the merchant must send the ID of the invoice to be saved in Weixin Cards & Offers and the order_id to the invoicing platform in the invoice request.

Note: You must call this API using the invoicing platform Official Account appid that was used to call the "Obtain s_pappid" API. Otherwise, an error will occur and card addition will fail.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/insert?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and contain the following fields:

card_ext is an Object and includes the following content:

user_card includes an invoice_user_data object, which contains the following content:

info is an Object list, and each Object in the list includes the following information:

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request:
{
	"order_id": "111163",
	"card_ext": {
		"nonce_str": "j!Re1WxaHv",
		"user_card": {
			"invoice_user_data": {
				"info": [
					{
						"price": 10000,
						"num": 3,
						"name": "Toothpaste",
						"unit": "Tube"
					}
				],
				"billing_no": "4545145712",
				"billing_code": "4541212454512",
				"billing_time": "1468306058",
				"tax": 123,
				"s_pdf_media_id": "s_pdf_media_id_abc123",
				"fee": 123,
				"title": "Guan Ge's invoice",
				"fee_without_tax": 2345
				"buyer_number":"123456789012345678"
			}
		}
	},
	"card_id": "pjZ8Yt9WoOePThU0NfUKz5-tBEWU",
	"appid": "wxc0b84a53ed8e8d29"
}
Response:
{
	"errcode": 0,
	"errmsg": "ok",
	"code": "682xxxx661927",
	"openid": "ojZ8Ytz4lESxxxx_R1TvB2Kds"
}

# 6. Updating Invoice Card Status

API description

When the invoicing platform is aware of a change to invoice statuses (such as invoice offset or reimbursement), it must update the relevant invoice card statuses in users' Cards & Offers. This ensures the availability of the invoice card and avoids invalid reimbursement or repeated reimbursement.

This API is used by invoicing platforms to make updates in response to information from other channels or invoice reimbursement status changes. For information about the company reimbursement APIs, see the section on company e-invoice reimbursement.

In Weixin, invoice offset means to write off the invoice. To do this, call this API and set the invoice card status to "INVOICE_REIMBURSE_CANCEL".

For more information about the invoice status, see the list of invoice status.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/platform/updatestatus?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format and contain the following fields:

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request:
{
	"card_id": "pjZ8Yt7Um2jYxzneP8GomnxoVFWo",
	"code": "186921658591",
	"reimburse_status": "INVOICE_REIMBURSE_INIT"
}
Response:
{
	"errcode": 0,
	"errmsg": "ok"
}

# 7. Invoice Status Update Event Push

API description

After Weixin learns that users have submitted invoices for reimbursement, Weixin will push the invoice status change to the invoicing platform and merchant to ensure that all parties have the same invoice status. Invoicing platforms or self-deployed platform merchants can configure the time receiving URL to parse push event types and obtain status change messages.

The event will be sent to the URL entered by the developer in the Official Accounts Platform Developer Center, as shown below.

If the Weixin server does not receive the response within five seconds, the connection is broken and the request is initiated again. A maximum of three retries are made. We recommend that you use FromUserName + CreateTime to de-duplicate requests. If the merchant's server cannot ensure the request is processed within five seconds, it can return an empty string. When receiving the string, the Weixin server will not take any action or make a retry.

Response

The returned result is in XML format and contains the following fields:

Sample code

<xml>
	<ToUserName><![CDATA[gh_9e1765b5568e]]></ToUserName>
	<FromUserName><![CDATA[ojZ8Ytz4lESgdWZ34L_R1TvB2Kds]]></FromUserName>
	<CreateTime>1478068440</CreateTime> <MsgType><![CDATA[event]]></MsgType>
	<Event><![CDATA[update_invoice_status]]></Event>
	<Status><![CDATA[INVOICE_REIMBURSE_INIT]]></Status>
	<CardId><![CDATA[pjZ8Yt7Um2jYxzneP8GomnxoVFWo]]></CardId>
	<Code><![CDATA[186921658591]]></Code>
</xml>

# 8. Decrypting Code

API description

To allow merchants to extend the invoice services, we support adding external redirect URL in the invoice page (promotion_url and custom_url in invoice creation), with the fields encrypt_code and card_id.

For example, if the specified URL is: http://www.qq.com, when A user taps the URL, the redirect URL is: http://www.qq.com?encrypt_code=ENCRYPT_CODE&card_id=CARDID.

encrypt_code is an encrypted code, which needs to be decoded to a real code with the decoding API. The real code is the same as the code returned by calling the "Add Cards" API.

Request method

Request URL: https://api.weixin.qq.com/card/code/decrypt?access_token={access_token}

Request method: POST

Request parameters

The request parameters use JSON format. Included parameters are as below:

Response

The returned result is in JSON format and contains the following fields:

Sample code

Request:
{
	"encrypt_code":"XXIzTtMqCxwOaawoE91+VJdsFmv7b8g0VZIZkqf4GWA60Fzpc8ksZ/5ZZ0DVkXdE"
}
Response:
{
	"errcode":0,
	"errmsg":"ok",
	"code":"751234212312"
}

# 9. Error Codes

# 10. List of Invoice Reimbursement Status