1. Obtaining Authorization Page Ticket

2 Obtaining Authorization Page URL

3. Mini Program Opens Authorization Page

4. iOS App Opens Authorization Page

5. Andoird App Opens Authorization Page

6. Receiving Authorization Completion Event Push

7. Querying Authorization Completion Status

8. Rejecting Invoicing

9. Setting Authorization Page Field Information

10. Querying Authorization Page Field Information

11. Linking Merchant ID and the Invoicing Platform

12. Querying the Linking Status of Merchant ID and the Invoicing Platform

13. Enabling Post-Payment Invoicing for a Specific Transaction

14. Unified Invoicing API - Issue Blue Invoice

15. Unified Invoicing API - Invoice Offset

16. Unified Invoicing API - Query Issued Invoices

17. Setting Merchant's Contact Information

18. Querying Merchant's Contact Information

19. Unified Invoicing API - Async Notifications of Invoicing Result

99. Error Codes

#1. Obtaining Authorization Page Ticket

API description

Before calling the authorization page, the merchant must obtain an authorization page ticket, which is valid for 7200s. This ticket is used as a parameter when calling the "obtaining authorization page" API to enhance security.

Request method

Request URL: https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=wx_card

Request method: GET

Response

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

Sample code

Response:
{
    "errcode": 0,
    "errmsg":"ok",
    "ticket":"m7RQzjA_ljjEkt-JCoklRM5zrzYr-6PI09QydZmNXXz-opTqMv53aFj1ykRt_AOtvqidqZZsLhCDgwGC6nBDiA",
    "expires_in": 7200
}

# 2. Obtaining Authorization Page URL

API description

This API is called by merchants. A merchant obtains the authorization page URL by providing the order number, invoicing platform ID, and other parameters via this API. On the authorization page displayed to users in Weixin, after a user taps the "Get Invoice" or "Apply for Invoice" button, the order number is linked to this user's authorization. The invoicing platform can initiate a request to add the invoice card into the user's Cards & Offers based on this order no. At this time, Weixin will verify the authorization to determine whether or not to add the card.

There are three authorization page styles. Merchants can provide different type values when calling the API to set the style. The different styles are shown below:

The different styles provide the following functions:

type=0 (Apply for invoice): This type is used when the merchant has already obtained the user's title from another channel. It pulls up the authorization page to initiate an invoicing request. After the invoice is issued, it is saved in the user's Cards & Offers.

type=1 (Enter invoice title and apply for invoice): When this type is called, the page will display the user's commonly used titles stored in Weixin. This makes it easy for users to specify their title information when the merchant does not already have it. Please note that only type=1 can be called for post-payment invoicing.

type=2 (Get invoice): After the merchant has issued an invoice, this type is used to pull up the authorization page so that the user can save the invoice in Cards & Offers.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/getauthurl?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:

If the error code is 0, the following information is returned:

Sample code

Request:
{
    "s_pappid": "wxabcd",
    "order_id": "1234",
    "money": 11,
    "timestamp": 1474875876,
    "source": "web",
    "redirect_url": "https://mp.weixin.qq.com",
    "ticket": "tttt",
    "type": 1
}
Response:
{
    "errcode": 0,
    "errmsg": "ok",
    "auth_url": "http://auth_url"
}
For Mini Programs, the response is:
{
    "errcode": 0,
    "errmsg": "ok",
    "auth_url": "auth_url"
    "appid": "appid"
}

# 3. Mini Program Opens Authorization Page

API description

To open the authorization page, a Mini Program must first get the authorization page URL by calling the Obtaining Authorization Page URL API using the Mini Program account.

Request method

Call the wx.navigateToMiniProgram method in the Mini Program.

Request parameters

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

Response

The user's authorization result is notified to the merchant via the Mini Program callback.

Sample code

wx.navigateToMiniProgram({
    appId: '{appid}',
    path: '{auth_url}',
    success(res) {
        console.log('navigateToMiniProgram success:', res)
    },
    fail(error){
        console.log('navigateToMiniProgram fail:', error)
    },
    complete(res){
        console.log('navigateToMiniProgram complete:', res)
    }
})

# 4. iOS App Opens Authorization Page

API description

To open the authorization page, an app on iOS devices must first get the authorization page URL by calling the Obtaining Authorization Page URL API using the open account.

Request method

Call the sendReq API.

Request parameters

Response

The merchant's app receives the response of the Weixin invoice authorization API and must implement the onResp method. The fields in the returned result are described below:

Sample code

Send request
WXInvoiceAuthInsertReq *req = [[WXInvoiceAuthInsertReq alloc] init];
req.urlString = self.authUrl;
[WXApi sendReq:req];

Receive response
- (void) onResp:(BaseResp *)resp
{
    if ([resp isKindOfClass:[WXInvoiceAuthInsertResp class]]) {
        WXInvoiceAuthInsertResp *wxResp = (WXInvoiceAuthInsertResp *) resp;
        NSString *strTitle = @"Weixin redirection";
        NSString *strMsg = [NSString stringWithFormat:@"errcode: %d orderid:%@", wxResp.errCode, wxResp.wxOrderId];
        UIAlertView *alert = [[UIAlertView alloc] initWithTitle:strTitle message:strMsg delegate:self cancelButtonTitle:@"Cancel " otherButtonTitles:@"OK", nil];
        [alert show];
    }
}

Note

After the user is redirected from the merchant's app to the Weixin app and authorizes invoicing, the user may not be able to return to the merchant's app (for example, if the user ends the Weixin process). Therefore, the merchant cannot rely on a response from the Weixin app to determine if the user has granted authorization. The Weixin e-invoicing platform provides an Official Account callback mechanism. When the user authorizes invoicing, the Weixin e-invoicing platform notifies merchants using the callback. In addition, the Weixin e-invoicing platform provides an authorization status query API.

How to use:

1. The merchant obtains the authorization URL by calling the API using the open account.

2. The user goes to the invoicing page from the merchant app and then is redirected to the Weixin app through the Weixin SDK to grant the authorization for adding the invoice card.

3. The merchant's Official Account receives a callback indicating the user's authorization status.

4. When the merchant's app receives the redirection of invoice card adding authorization from the Weixin app, the merchant queries the user's authorization status by calling the API using the open account.

5. When the user enters the invoicing page on the merchant's app again, the merchant queries the user's authorization status by calling the API using the open account.

6. If the user has granted authorization, the invoicing platform is notified to issue an invoice.

# 5. Andoird App Opens Authorization Page

API description

To open the authorization page, an app on android devices must first get the authorization page URL by calling the Obtaining Authorization Page URL API.

Request method

Call the sendReq API.

Request parameters

Response

The merchant's app receives the response of the Weixin invoice authorization API and must implement the onResp method. The fields in the returned result are described below:

Sample code

Send request
WXInvoiceAuthInsert.Req oReq = new WXInvoiceAuthInsert.Req();
oReq.url = sJumpUrl;
api.sendReq(oReq);

Receive response
public class WXEntryActivity extends Activity implements IWXAPIEventHandler {
    private static final String APP_ID = "wxxxxxxxxxxx";
    private IWXAPI api;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        api = WXAPIFactory.createWXAPI(this, APP_ID, true);
        api.handleIntent(getIntent(), this);
    }

    @Override
    public void onReq(BaseReq baseReq) {
    }

    @Override
    public void onResp(BaseResp baseResp) {
        Toast.makeText(getApplicationContext(), "onResp", Toast.LENGTH_LONG).show();
        if (baseResp.getClass().equals(WXInvoiceAuthInsert.Resp.class)) {
            WXInvoiceAuthInsert.Resp oResp = (WXInvoiceAuthInsert.Resp) baseResp;
            String sLog = "errcode:" + oResp.errCode + " wxorderid:" + oResp.wxOrderId;
            System.out.print(sLog);
        }
    }
}

Note

After the user is redirected from the merchant's app to the Weixin app and authorizes invoicing, the user may not be able to return to the merchant's app (for example, if the user ends the Weixin process). Therefore, the merchant cannot rely on a response from the Weixin app to determine if the user has granted authorization. The Weixin e-invoicing platform provides an Official Account callback mechanism. When the user authorizes invoicing, the Weixin e-invoicing platform notifies merchants using the callback. In addition, the Weixin e-invoicing platform provides an authorization status query API.

How to use:

1. The merchant obtains the authorization URL by calling the API using the open account.

2. The user goes to the invoicing page from the merchant app and then is redirected to the Weixin app through the Weixin SDK to grant the authorization for adding the invoice card.

3. The merchant's Official Account receives a callback indicating the user's authorization status.

4. When the merchant's app receives the redirection of invoice card adding authorization from the Weixin app, the merchant queries the user's authorization status by calling the API using the open account.

5. When the user enters the invoicing page on the merchant's app again, the merchant queries the user's authorization status by calling the API using the open account.

6. If the user has granted authorization, the invoicing platform is notified to issue an invoice.

# 6. Receiving Authorization Completion Event Push

API description

When a user grants the authorization for saving invoices in their Weixin account, the merchant can receive the authorization completed status push. After receiving the push, the merchant can send the order_id and invoice information to the invoicing platform. Then the invoicing platform can add the e-invoice in the user's Cards & Offers after issuing the invoice.

This event is sent to the URL entered by the developer (log in to the Official Accounts Platform and go to Developer Center Settings; an Official Account account shall be used for an open account, as shown in the figure 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 version="1.0" encoding="utf-8"?>
<xml>
   <ToUserName><![CDATA[gh_fc0a06a20993]]></ToUserName>
   <FromUserName><![CDATA[oZI8Fj040-be6rlDohc6gkoPOQTQ]]></FromUserName>
   <CreateTime>1475134700</CreateTime>
   <MsgType><![CDATA[event]]></MsgType>
   <Event><![CDATA[user_authorize_invoice]]></Event>
   <SuccOrderId><![CDATA[1202933957956]]></SuccOrderId>
   <FailOrderId><![CDATA[]]></FailOrderId> < AuthorizeAppId ><![CDATA[]]></ AuthorizeAppId > <Source><![CDATA[]]></Source>
</xml>

# 7. Querying Authorization Completion Status

API description

This API is called in two scenarios:

1. If the merchant has displayed the authorization page to the user, but does not receive an authorization completion status push after a long period of time, the merchant can use this API to actively check if the user has completed authorization. This API can be used when the merchant fails to receive the authorization completion status event due to problems such as network issue.

2. If the merchant displays a type=1 authorization page to a user and, after receiving the authorization completion event push, the merchant can call this API to obtain user invoice information.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/getauthdata?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:
{
    "s_pappid": "{s_pappid}",
    "order_id": "{order_id}"
}
Response:
If the user enters an individual invoice title:
{
    "errcode": 0,
    "errmsg": "ok",
    "invoice_status": "auth success",
    "auth_time": 1480342498,
    "user_auth_info": {
        "user_field": {
            "title": "Dhxhhx ",
            "phone": "5554545",
            "email": "dhxhxhhx@qq.cind",
            "custom_field": [
                {
                    "key": "field1",
                    "value": "ABCD"
                }
            ]
        }
    }
}
If the user enters a company invoice title:
{
    "errcode": 0,
    "errmsg": "ok",
    "invoice_status": "auth success",
    "auth_time": 1480342897,
    "user_auth_info": {
        "biz_field": {
            "title": "xxCompany",
            "tax_no": "6464646766",
            "addr": "xxBuilding",
            "phone": "1557548768",
            "bank_type": "xxBank",
            "bank_no": "545454646",
            "custom_field": [
                {
                    "key": "field2",
                    "value": "EFGH"
                }
            ]
        }
    }
}

# 8. Reject Invoicing

API description

After the user completes authorization, if the merchant finds that the information provided by the user is incorrect or a refund occurs, the merchant can call this API to reject invoicing and notify the user. After invoicing is rejected, the user cannot invoice this order again. Orders for which invoicing is rejected cannot be reused. If a new invoice is needed, the merchant must use a new order_id and obtain the authorization URL to get the authorization from the user again. After the merchant calls the API, the user receives the following notification:

Request method

Request URL: https://api.weixin.qq.com/card/invoice/rejectinsert?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:
{
    "s_pappid": "d3JCEfhGLW+q0iGP+o9",
    "order_id": "111229",
    "reason": "1234",
    url": "http://xxx.com"
}
Response:
{
    "errcode": 0,
    "errmsg": "ok"
}

# 9. Setting Authorization Page Field Information

API description

When users use a type=1 authorization page, merchants can use this API to set the information users are required to enter on the authorization page. When using type=0 or type=2 authorization pages, merchants do not need to call this API. This API only needs to be called once to set the required fields and only needs to be called again when changing the required fields.

Please note that the fields of which the status are displayed are required fields. If a user does not enter this field, they cannot proceed to the next step.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/setbizattr?action=set_auth_field&access_token={access_token}

Request method: POST

Request parameters

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

auth_field is an Object and includes the following fields:

user_field is an Object and includes the following fields:

biz_field is an Object and includes the following fields:

custom_field is a List, with each object containing the following fields:

Response

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

Sample code

Request:
{
    "auth_field" : {
        "user_field" : {
            "require_phone" : 1,
            "custom_field" : [
                {
                    "is_require" : 1,
                    "key" : "field1"
                }
            ],
            "show_email" : 1,
            "show_title" : 1,
            "show_phone" : 1,
            "require_email" : 1
        },
        "biz_field" : {
            "require_phone" : 0,
            "custom_field" : [
                {
                    "is_require" : 0,
                    "key" : "field2"
                }
            ],
            "require_bank_type" : 0,
            "require_tax_no" : 0,
            "show_addr" : 1,
            "require_addr" : 0,
            "show_title" : 1,
            "show_tax_no" : 1,
            "show_phone" : 1,
            "show_bank_type" : 1,
            "show_bank_no" : 1,
            "require_bank_no" : 0
        }
    }
}
Response:
{
    "errcode": 0,
    "errmsg": "ok"
}

# 10. Querying Authorization Page Field Information

API description

The merchant can query authorization field settings via this API.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/setbizattr?action=get_auth_field&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:

auth_field is an Object and includes the following fields:

user_field is an Object and includes the following fields:

biz_field is an Object and includes the following fields:

custom_field is a list, with each object containing the following fields:

Sample code

Request:  {}
Response:
{
    "errcode": 0,
    "errmsg": "ok",
    "auth_field": {
        "user_field": {
            "show_title": 1,
            "show_phone": 1,
            "show_email": 1,
            "custom_field": [{"key": "field1"}]
        },
        "biz_field": {
            "show_title": 1,
            "show_tax_no": 1,
            "show_addr": 1,
            "show_phone": 1,
            "show_bank_type": 1,
            "show_bank_no": 1,
            "custom_field": [{"key": "field2"}]
        }
    }
}

# 11. Linking Merchant ID and the Invoicing Platform

API description

When using post-paid invoicing, the merchant must first link its merchant ID with the invoicing platform ID. The invoicing platform ID is generated by the invoicing platform according to the Weixin rules and then sent to the merchant. This API only needs to be used once. Afterward, it only needs to be used when relinking the invoicing platform if the invoicing platform's ID changes or if the merchant changes invoicing platforms.

If the merchant has already implemented the Weixin Cards & Offers solution for delivering e-invoices, we suggest the merchant confirm the Official Account linked to the merchant ID is the same account that is used to pull up the authorization page in the WeChat Pay Merchants Platform before calling this API. If the accounts are inconsistent, the merchant shall use the Official Account linked to the merchant ID to call the API to pull up the authorization page again.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/setbizattr?action=set_pay_mch&access_token={access_token}

Request method: POST

Request parameters

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

paymch_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:
{
	"paymch_info":
    {
		"mchid": "1234",
		"s_pappid": "wxabcd"
	}
}
Response:
{
 	"errcode": 0,
    "errmsg": "ok"
}

# 12. Querying the Linking Information of Merchant ID and the Invoicing Platform

API description

The merchant can query its linking information with the invoicing platform via this API.

Request method

Request URL: https://api.weixin.qq.com/card/invoice/setbizattr?action=get_pay_mch&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 response parameters use JSON format and contains the following fields:

When errcode is 0, the returned data also contains a paymch_info object, which includes the following fields:

Sample code

Request:  {}
Response:
{
	"errcode": 0,
	"errmsg": "ok",
	"paymch_info":
    {
		"mchid": "1234",
		"s_pappid": "wxabcd"
	}
}

# 13. Enabling Post-Payment Invoicing for a Specific Transaction

API description

After linking the Weixin merchant ID and the invoicing platform, Merchant with the ability to issue e-invoices can set whether payment success messages provide an invoicing entry for specific transactions. Users can use this entry to request an invoice.

Request method

The protocol and call method for this API are the same as described in the online Payment Documentation. This feature adds new field to the original payment API.

Request parameters

After the user confirms an order, the merchant can add the receipt field in the payment API (unified order placement/submit Quick Pay/payments-on-behalf) to indicate that an e-invoice needs to be issued. The parameters for this field are as follows:

Response

It is the same as the result returned by the original payment API.

Sample code

<xml>
    <appid>wx2421b1c4370ec43b </appid>
    <attach>Payment test</attach>
    <body>JSAPIPayment test</body>
    <mch_id>10000100</mch_id>
    <receipt>Y</receipt>
    <nonce_str>1add1a30ac87aa2db72f57a2375d8fec</nonce_str>
    <notify_url>http://wxpay.wxutil.com/pub_v2/pay/notify.v2.php</notify_url>
    <openid>oUpF8uMuAJO_M2pxb1Q9zNjWeS6o</openid>
    <out_trade_no>1415659990</out_trade_no>
    <spbill_create_ip>14.23.150.211</spbill_create_ip>
	<total_fee>1</total_fee>
	<trade_type>JSAPI</trade_type>
	<sign>0CB01533B8C1EF103065174F50BCA001</sign>
</xml>

# 14. Unified Invoicing API - Issue Blue Invoice

API description Merchants who use the Weixin E-invoice feature can issue invoices via this API, no matter which invoicing platform they have selected for invoicing packages on the Official Accounts backend.

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

Request method: POST

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

'Note 1': "ddh" (order no.) must be consistent with the order_id on the authorization page. Otherwise, the system will report an unauthorized order no. error. 'Note 2': "fpqqlsh" (invoice request serial no.) is the unique identifier of the invoice. The first six digits must be consistent with the merchant ID on the backend.

invoicedetail_list is a JSON list, with each object taking the following structure:

'Note': The tax classification code is a 19-digit code in the Tax Classification and Coding for Commodities and Services. The merchant shall enter this field based on the actual invoice item and the situation of the enterprise and verify it with the enterprise's financial department.

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

Sample code

Request
{
	"invoiceinfo" :
	{
	    "wxopenid": "os92LxEDbiOw7kWZanRN_Bb3Q45I",
	    "ddh" : "30000",
	    "fpqqlsh": "test20160511000461",
	    "nsrsbh": "110109500321654",
	    "nsrmc": "Baiwang electronic test1",
	    "nsrdz": "Shenzhen",
	    "nsrdh": "0755228899988",
	    "nsrbank": "Bank of China, Guangzhou branch",
		"nsrbankid": "12345678",
	    "ghfnsrsbh": "110109500321654",
	    "ghfmc": "Monday",
	    "ghfdz": "Guangzhou",
	    "ghfdh": "13717771888",
		"ghfbank": "ICBC",
		"ghfbankid": "12345678",
	    "kpr": "John",
	    "skr": "Mark",
	    "fhr": "Jane",
	    "jshj": "159",
	    "hjje": "135.9",
	    "hjse": "23.1",
	    "bz": "Remarks",
	    "hylx": "0",
	    "invoicedetail_list": [
	        {
	            "fphxz": "0",
	            "spbm": "1090418010000000000",
	            "xmmc": "Washing machine",
	            "dw": "Unit",
	            "ggxh": "60L",
	            "xmsl": "1",
	            "xmdj": "135.9",
	            "xmje": "135.9",
	            "sl": "0.17",
	            "se": "23.1"
	        }
	    ],
	}
}
Response
{
  "errcode": 0,
  "errmsg": "sucesss"
}

# 15. Unified Invoicing API - Invoice Offset

API description Merchants who use the Weixin E-invoice feature can offset invoices via this API, no matter which invoicing platform they have selected for invoicing packages on the Official Accounts backend.

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

Request method: POST

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
{
	"invoiceinfo" :
	{
	    "wxopenid": "os92LxEDbiOw7kWZanRN_Bb3Q45I",
	    "fpqqlsh": "test20160511000400",
	    "nsrsbh": "110109500321654",
	    "nsrmc": "Baiwang electronic test1", 
	    "yfpdm" : "050003521100",
	    "yfphm" : "30329969",
  
	}
}

Response
{
  "errcode": 0,
  "errmsg": "sucesss"
}

# 16. Unified Invoicing API - Query Issued Invoices

API description Merchants who use the Weixin E-invoice feature can query issued invoices via this API, no matter which invoicing platform they have selected for invoicing packages on the Official Accounts backend.

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

Request method: POST

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
{
	 "fpqqlsh": "test20160511000440",
	 "nsrsbh": "110109500321654"
}

Response:

{
    "errcode": 0,
    "errmsg": "Invoice data obtained successfully",
    "invoicedetail": {
        "fpqqlsh": "14574d75004451097845",
        "fpdm": "088978450417",
        "fphm": "21590001",
        "jym": "59004166725791147047",
        "kprq": "20171204172159",
        "pdfurl": "http://weixin.com"
    }
}

# 17. Setting Merchant's Contact Information

API description The merchant must set contact information before obtaining the authorization link.

Request method Request URL: https://api.weixin.qq.com/card/invoice/setbizattr?action=set_contact&access_token={access_token}

Request method: POST

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

contact is an Object and includes the following fields:

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

Sample code

Request: 
{
	"contact" :
    {
        "phone" : "88888888",
        "time_out" : 12345
    }
}
Response:
{
 	"errcode": 0,
    "errmsg": "ok"
}

# 18. Querying Merchant's Contact Information

API description The merchant must set contact information before obtaining the authorization link.

Request method Request URL: https://api.weixin.qq.com/card/invoice/setbizattr?action=get_contact&access_token={access_token}

Request method: POST

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:

contact is an Object and includes the following fields:

Sample code

Request:
{}
Response:
{
    "contact" : {
        "phone" : "88888888",
        "time_out" : 12345
    },
    "errcode" : 0,
    "errmsg" : "ok"
}

# 19. Unified Invoicing API - Async Notifications of Invoicing Result

API description

When a user grants the authorization for saving invoices in their Weixin account, the merchant can receive the authorization completed status push. After receiving the push, the merchant can send the order_id and invoice information to the invoicing platform. Then the invoicing platform can add the e-invoice in the user's Cards & Offers after issuing the invoice.

This event is sent to the URL entered by the developer (log in to the Official Accounts Platform and go to Developer Center Settings; an Official Account account shall be used for an open account, as shown in the figure 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 version="1.0" encoding="utf-8"?>
<xml>
  <ToUserName><![CDATA[toUser]]></ToUserName>
  <FromUserName><![CDATA[FromUser]]></FromUserName>
  <CreateTime>123456789</CreateTime>
  <MsgType><![CDATA[]></MsgType>
  <Event><![CDATA[cloud_invoice_invoiceresult_event]]></Event>
  <fpqqlsh><![CDATA[14574d75004451097886]]></fpqqlsh>
  <status>100</status>
  <nsrsbh><![CDATA[150001197205134629]]></nsrsbh>
</xml>

# 99. Error Codes