API List

Update Time:2025.03.21

Module Name

Feature List

Description

PUBLIC API

Mini Program Signing

The merchant backend obtains a signing session ID by requesting this interface, and then calls the signing page of the mini program for Auto-debit through the mini program signing interface.

H5 Signing

The merchant backend obtains a signing url by requesting this interface, and then requests the signing url on the h5 page to redirect to WeChat to complete signing.

JSAPI Signing

The merchant backend obtains a signing url by requesting this interface, and then requests the signing url on the h5 page open inside of WeChat.

PC WEB Signing

The merchant backend obtains a signing url by requesting this interface, then generate a QR code based on the signing url and display it on PC Websites for consumers to scan. Consumers could scan the QR code either through WeChat or third party APPs or browsers.

APP Signing

The merchant backend obtains a signing session ID by requesting this interface, and then calls the signing SDK to redirect to WeChat signing page.

Querying Signing Status (By contract_id)

The signing relationship query interface provides the single transaction signing relationship query.

Querying Signing Status (By out_contract_code)

The signing relationship query interface provides the single transaction signing relationship query.

Applying for Termination

When the signing relationship between the merchant and the user is wrong or the merchant actively requests terminating the contract previously signed with the user, this interface can be called to terminate the contract. At present, the Auto-debit contract ID can be used to complete the termination at the merchant side. Moreover, the user can initiate termination through a WeChat client. The termination result will be sent to the merchant side based on Termination Callback Address.

Signing and Termination Result Callback

After successful signing and termination (no notice if unsuccessful), wechat will asynchronously notify merchants of relevant signing and termination information.

Deduction

The deduction request implements deduction according to the priority payment method recorded in the signed contract. If the deduction fails, the other payment methods of the user will be polled in turn.

Deduction Result Notification

After the deduction is completed, wechat will send the relevant payment results and user information to the merchant in the form of data flow.

Order Query

The interface provides the query function of all WeChat Pay orders. Merchants can actively query the order status through the order query interface to complete the business logic of next step.

Order Reversing

The order reversing interface needs to be called in the following circumstances: If payment for the merchant’s order fails and a new order ID needs to be generated to initiate payment again, the order closing interface needs to be called for the original order No. to avoid repeated payment; after an order is placed in the system, the user's payment times out and the system will exit without accepting the order, the order closing interface needs to be called to prevent the user from continuing operation.

Submit Refund

When a refund is needed due to the buyer or seller within a period after the transaction, the seller can return the payment to the buyer through the Refund API. WeChat Pay will return the payment to the buyer's account in accordance with the refund rules after receiving the refund request and completing the verification.

Query Single Refund

After submitting a refund request, check the refund status by calling this API. There may be a delay in refund. The refund paid by balance will be received within 20 minutes. For refunds paid by bank cards, check the refund status after 3 business days.

Query All Refunds

After submitting a refund request, check the refund status by calling this API. There may be a delay in refund. The refund paid by balance will be received within 20 minutes. For refunds paid by bank cards, check the refund status after 3 business days.

 

Refund Notification

After completing refund, the WeChat payment system will send the refund result to the Merchant.

 

Lang
TOP

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2025 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global

Contact Us

Customer Service Tel

+86 571 95017

9:00-18:00 Monday-Friday GMT+8

Business Development

wxpayglobal@tencent.com

Developer Support

wepayTS@tencent.com

Wechat Pay Global

About Tenpay
Powered By Tencent & Tenpay Copyright© 2005-2025 Tenpay All Rights Reserved.