DOCSEARCHbyAlgolia
Submit Docs

WeChat Pay Brand API Documentation

website·Indexed 6 days ago

https://pay.weixin.qq.com/wiki/doc/api_external/index_en.shtml

Technical documentation for the WeChat Pay Brand API, designed for brand merchants to manage business operations and user engagement. It covers the Brand Management Platform, Merchant Business Cards (商家名片), and Membership Card features including template management, user enrollment via Mini Programs/H5, and point synchronization. Includes developer toolsets for Java (WXPayUtility) and Go (wxpay_utility), as well as guides for API integration, event notifications, and interactive marketing tools like 'Shake for Discounts' (摇一摇有优惠).

Tokens
1.4M
Snippets
2.9K
Records
7.3K
Agent score
94%

What's inside WeChat Pay Brand API

  1. Overview of WeChat Pay Cash Coupon Marketing API

    v3
    The WeChat Pay Marketing API provides a full-lifecycle solution for cash coupons, allowing merchants to create, distribute, query, and modify coupons within their own platforms. Key capabilities include distribution within WeChat scenarios, security mechanisms to prevent fraud, and brand exposure. The system supports various coupon types including full-store discounts, single-item discounts, and single-item exchange coupons.

  2. Overview of the WeChat Pay 'Dianjin Plan' (点金计划)

    v3

    The 'Dianjin Plan' is an upgrade program for post-payment callback capabilities provided by WeChat Pay. It replaces the standard JSAPI payment completion page with an official template that supports bill display, service-related content, and traffic monetization via the WeChat Advertising platform.

    Key characteristics include:

    • Applicable Entities: Ordinary Service Providers and Channel Providers.
    • User Experience: Once enabled for a special merchant, the JSAPI payment completion page will only show the official Dianjin Plan page; the original H5 or Mini Program page that initiated the payment will be closed.
    • Monetization: Service Providers receive commission rewards from WeChat Pay for providing technical services related to the plan.
    • Advertising: Ad links within the plan cannot be customized; the WeChat Advertising team manages advertisers and delivery strategies.

  3. Overview of WeChat Pay Score Parking

    v3

    WeChat Pay Score Parking is a 'leave first, pay later' service for car owners in parking scenarios. It leverages the binding relationship between a user's WeChat account and their license plate to automatically deduct parking fees upon exit. Once enabled, the service is available across all supported parking lots.

    Key requirements and impacts include:

    • Eligibility: Only users with a WeChat Pay Score of 500 or higher can enable the service.
    • Score Impact: Timely payment of orders helps increase the user's WeChat Pay Score, while failure to pay debts on time will be recorded as a late payment, negatively affecting the score.

  4. Overview of WeChat Pay Merchant Card Membership

    Merchant Card Membership is a tool provided by WeChat Pay to help brand merchants manage membership operations. It allows merchants to link membership asset changes with WeChat Pay orders, drive new member sign-ups, redirect users to membership pages in mini-programs, and issue membership coupons. To use this feature, merchants must first apply for and enable the 'Merchant Card' (商家名片) functionality.

  6. Overview of WeChat Pay Product Coupons

    v3
    WeChat Pay Product Coupons provide a full-lifecycle solution for brands to manage coupons. Merchants can use API interfaces to create, distribute, claim, notify, verify (redeem), and query product coupons. These coupons can be deployed across both WeChat platform traffic scenarios and merchant-owned traffic channels.

  7. Overview of WeChat Mini Program Combined Payment

    v3
    Mini Program Combined Payment allows a merchant to consolidate orders from multiple different merchants into a single payment transaction within a WeChat Mini Program. For standard merchants, this mode supports combining 2 to 10 orders. For single-order payments, the standard Mini Program Payment should be used instead.

  8. Overview of WeChat Pay Product Coupons

    WeChat Pay Product Coupons provide a full-lifecycle solution for brands to manage discount coupons. Merchants can use API interfaces to create, distribute, claim, notify, verify (redeem), and query product coupons. These coupons can be deployed across both WeChat platform traffic scenarios and the merchant's own traffic channels.

  9. Overview of post_payments parameter for WeChat Pay Later

    v3

    Merchants using WeChat Pay Later must provide detailed post-payment item breakdowns via the post_payments parameter when creating, completing, or modifying order amounts. This information is displayed on the order details page to reduce user confusion regarding the final amount.

    post_payments is an array that can contain between 1 and 100 items. Each item consists of four potential parameters: name, amount, description, and count.

  10. Overview of WeChat Mobile Medical Insurance Payment Integration

    v3

    Integrating WeChat Mobile Medical Insurance Payment for medical institutions involves three core steps:

    1. Apply for access to the provincial mobile medical insurance payment system.
    2. Apply for hospital project initiation (立项) with WeChat.
    3. Apply for payment permissions for the new medical insurance payment interface from WeChat.

  11. Overview of WeChat Pay Member Dynamic Information

    The Member Dynamic Information capability allows merchants to synchronize real-time membership updates (e.g., point changes, reward eligibility) to the WeChat Pay Merchant Business Card. This information is displayed to users on the payment voucher cell and the payment completion page to facilitate precise member operation and engagement. If a member's status changes via a non-WeChat Pay transaction, merchants can use the 'Create User Dynamic Information' API to sync the data.

  12. Overview of WeChat Pay Member Dynamic Information

    v3
    The Member Dynamic Information capability allows merchants to synchronize real-time member updates (e.g., point changes, reward eligibility) to the WeChat Pay Merchant Business Card. This information is displayed to users on the payment voucher page and the payment completion page, helping merchants perform fine-grained member operations. For updates triggered by non-WeChat Pay orders, merchants should use the 'Create User Dynamic Information' API.