| Module Name | Feature List | Description |
|---|---|---|
| Transaction | Quick Pay | The Merchant’s backend calls the Submit Quick Pay API to initiate a payment. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
| Revoke Order | When a payment transaction isn't successfully returned or the payment system times out, this API is called to cancel the transaction. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| Native Payment Order Placement | The Merchant’s backend calls this API to create an advance transaction in the WeChat payment service backend. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| JSAPI Payment Order Placement | This API can be used to query all WeChat Pay orders. Merchants can use the Query Order API to query the order status and then complete subsequent business logic. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| Call Payment in H5 within WeChat | The JSAPI is called when the Payer opens an HTML5 website with a WeChat-supported browser. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| Mini Program Payment Order Placement | The Merchant’s backend calls this API to create an advance transaction in the WeChat payment service backend. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| Mini Program Calls Payment | API for calling payment from mini program frontend. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| In-App Payment Order Placement | Call Payment API from APP. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| Call Payment | the merchant server first calls the [Order Placement API] to generate a prepayment order, and signs the obtained parameter prepay_id again before transferring it to the app to initiate payment. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| H5 Payment Order Placement | The Merchant’s backend calls this API to create an advance transaction in the WeChat payment service backend. Applicable to payment by submitting the payment code. If this payment capability has been integrated, no further development is required. Be sure to access the Funds-distribution Mark API to accurately mark funds-distribution business orders. |
|
| Query Order | This API allows inquiry of all payment orders made from WeChat. | |
| Close Order | This API needs to be called before a merchant wants to create a new order due to the Payer failing to pay for an order. The original order will be closed in order to avoid repeat payment. | |
| Payment Result Notification | After completing a payment, the WeChat payment system will send the relevant payment result and user information to the Merchant. | |
| Funds Distribution | Funds-distribution Mark | Before a merchant transaction, call the API to mark it with "funds-distribution", indicating that the transaction will subsequently be subject to the funds-distribution function. |
| Request funds-distribution | After the Weixin transaction is successfully completed, the merchant initiates a funds-distribution request and distributes the settled funds to the receiver. | |
| Unfreezing Remaining Funds | For transactions that do not require funds-distribution, call the API directly to unfreeze all the transaction amount to the sponsor account (original transaction funds settlement account). | |
| Query funds-distribution result | After requesting funds-distribution, call the API to query the funds-distribution result. | |
| Remaining Funds Amount to be Distributed Query | Call API to query the transaction's remaining funds amount to be distributed. | |
| Adding Receiver | The merchant initiates a request to add receiver and create a receiver list. | |
| Adding Receiver Result Query | After a merchant initiates a request to add a receiver, call the API to query the adding receiver result. | |
| Deleting Receiver | Merchant initiates a request to delete receiver. | |
| Upload File | Some designated merchants of Weixin Pay overseas business need to upload documents. They can use this API to submit these documents and obtain the FileID values required by other business APIs. | |
| Refund | Submit Refund | The Merchant can refund the Payer via this API. If refund sources are required, merchants using API v2 need to upgrade the refund API to API v3, and merchants using API v3 need to add the amount.from field in the request and response parameters. |
| Remaining Refundable Amount Query | If a merchant initiates funds-distribution several times for a funds-distribution payment order, this API can be used to query the remaining refundable amount of this order. | |
| Querying the Real-time Balance Available for Advance Refund | If a merchant would like to initiate a refund of the outbound portion of a funds-distribution payment order that is unfrozen, the overseas institutional merchant can use this API to get the current Advance Refund quota. | |
| Query Single Refund | After submitting a refund request, check the refund status by calling this API. If refund sources are required, merchants using API v2 need to upgrade the refund API to API v3, and merchants using API v3 need to add the amount.from field in the request and response parameters. |
|
| Query All Refunds | After submitting a refund request, check the refund status by calling this API. If refund sources are required, merchants using API v2 need to upgrade the refund API to API v3, and merchants using API v3 need to add the amount.from field in the request and response parameters. |
|
| Refund Notification | After completing refund, the WeChat payment system will send the refund result to the Merchant. | |
| Bill | Downloading Reconciliation | Merchants can download the transaction history via this API. Fields in the bill will also change after connection with the funds-distribution business. The following two new bill fields are added: 1) fund type, including SplittingOrder and NonSplittingOrder 2) fee CNY, no need to change it if the settlement currency is CNY. After completing the compatible development of the transaction bill API, log in to the merchant platform (https://pay.weixin.qq.com) or contact our business agent to perform bill switching before launching the funds-distribution business to ensure smooth reconciliation. |
| API Download Address for Bill | Merchant initiates a request to delete receiver. The settled funds of the merchant cannot be distributed to the deleted receiver. | |
| Obtaining the Refund Bill Download URL | WeChat Pay provides funds-distribution refund files by day. Merchants can call this API to get the download URL for billing files. | |
| Query Fund Settlement Details | The merchant can query the details of both settled funds (sette_state is SETTLED) and unsettled funds (sette_state is UNSETTLE) by settlement date. Fields concerning this API will also change after connection with the funds-distribution business. If the merchant connects to APIV3: Pay extra attention to the newly added "split_amount" field in the response parameter. If the merchant connects to APIV2: the following changes are required: - Add the request parameter "query_split" - Parse response parameters "split_settlement_fee" and "split_unsettlement_fee" |
