Airwallex logo
Airwallex logoAirwallex logo

Accept Recurring Payments - WeChat Pay

Copy for LLMView as Markdown

Recurring payments requires additional onboarding. Please reach out to your Airwallex account manager or [email protected] to enable this feature.

Linking with the shopper's WeChat Pay account for the first time

Step 1: Create a Customer (Optional)

Create a customer with the Create a Customer API API if the customer is new. Otherwise, this step is optional.

Shell
1curl -X POST https://api-demo.airwallex.com/api/v1/pa/customers/create \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "request_id": "2ed2d823-f8b3-416e-86db-ced8770ce217",
6    "merchant_customer_id": "9fafc2fb-4262-4ff8-a205-d60fb4781cb0",
7    "first_name": "John",
8    "last_name": "Doe",
9    "email": "[email protected]",
10    "phone_number": "+8613800138000"
11  }'

Example response:

JSON
1{
2  // ... other fields omitted.
3  "id": "cus_uspd6m9zph9g2fjvn1r",
4  "request_id": "2ed2d823-f8b3-416e-86db-ced8770ce217",
5  "merchant_customer_id": "c9fafc2fb-4262-4ff8-a205-d60fb4781cb0",
6  "first_name": "John",
7  "last_name": "Doe",
8  "email": "[email protected]",
9  "phone_number": "+8613800138000",
10  "created_at": "2024-01-15T10:30:00Z"
11}

Create a Payment Consent with the Create a Payment Consent API API.

Shell
1curl -X POST https://api-demo.airwallex.com/api/v1/pa/payment_consents/create \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "request_id": "ed11e38a-7234-11ea-aa94-7fd44ffd1b89",
6    "customer_id": "cus_uspd6m9zph9g2fjvn1r",
7    "next_triggered_by": "merchant",
8    "merchant_trigger_reason": "unscheduled"
9  }'

Example response:

JSON
1{
2  // ... other fields omitted.
3  "id": "cst_sgstjgzhsh7hhmj8hr0",
4  "request_id": "ed11e38a-7234-11ea-aa94-7fd44ffd1b89",
5  "customer_id": "cus_uspd6m9zph9g2fjvn1r",
6  "next_triggered_by": "merchant",
7  "status": "REQUIRES_PAYMENT_METHOD",
8  "merchant_trigger_reason": "unscheduled",
9  "created_at": "2024-01-15T10:35:00Z"
10}

Verify the Payment Consent with the Verify a Payment Consent API API to authorize the shopper's WeChat Pay account for future payments.

Shell
1curl -X POST https://api-demo.airwallex.com/api/v1/pa/payment_consents/{{PAYMENT_CONSENT_ID}}/verify \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "request_id": "139b8ee8-e306-47d6-8d6a-fa586967e5a9",
6    "payment_method": {
7      "type": "wechatpay",
8      "wechatpay": {
9        "flow": "qrcode"
10      }
11    },
12    "verification_options": {
13      "wechatpay": {
14        "currency": "CNY"
15      }
16    },
17    "return_url": "https://www.airwallex.com"
18  }'
  • The flow parameter can be "qrcode", "mobile_web", or "mobile_app". When flow is "mobile_web" or "mobile_app", os_type should be "ios" or "android".

Each WeChat Pay consent can only be used for subsequent payments with the same currency specified in verification_options.wechatpay.currency.

Example response:

JSON
1{
2  // ... other fields omitted.
3  "id": "cst_sgstjgzhsh7hhmj8hr0",
4  "request_id": "139b8ee8-e306-47d6-8d6a-fa586967e5a9",
5  "status": "REQUIRES_CUSTOMER_ACTION",
6  "next_action": {
7    "type": "redirect",
8    "method": "GET",
9    "url": "https://api.airwallex.com/pa/redirect/..."
10  }
11}

Redirect the shopper to the URL found in the next_action field so they can complete authorization on the WeChat Pay page.

To get the consent verification result, poll the status of the Payment Consent via the Retrieve a Payment Consent API API.

In addition, Airwallex will notify you asynchronously of the Payment Consent status via webhook. Please refer to the webhook documentation to set up your webhook properly. It is recommended to subscribe to the payment_consent.verified webhook which indicates that the shopper has authorized your business to make recurring payments with their WeChat Pay wallet. Be sure to save the id returned in the response, as you will use this verified Payment Consent for future payments.

Initiating future payments

Step 1: Create a Payment Intent

Once the Payment Consent is verified by the shopper, you can use that consent for recurring payments. When you are ready to process a recurring payment, create a Payment Intent with the Create a Payment Intent API API.

Shell
1curl -X POST https://api-demo.airwallex.com/api/v1/pa/payment_intents/create \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "request_id": "2c343609-5561-4c39-b055-bdaf89176555",
6    "amount": 10,
7    "currency": "CNY",
8    "merchant_order_id": "order_67890",
9    "return_url": "https://www.airwallex.com"
10  }'

Example response:

JSON
1{
2  // ... other fields omitted.
3  "id": "int_hkdmr7v9rg1j58ky8re",
4  "request_id": "2c343609-5561-4c39-b055-bdaf89176555",
5  "amount": 10,
6  "currency": "CNY",
7  "merchant_order_id": "order_67890",
8  "status": "REQUIRES_PAYMENT_METHOD",
9  "created_at": "2024-01-15T11:00:00Z"
10}

Confirm the payment with the verified Payment Consent by calling the Confirm a Payment Intent API API. This allows you to charge the shopper using their previously authorized WeChat Pay account without requiring them to re-authenticate.

Shell
1curl -X POST https://api-demo.airwallex.com/api/v1/pa/payment_intents/{{PAYMENT_INTENT_ID}}/confirm \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "payment_consent_id": "cst_sgstjgzhsh7hhmj8hr0",
6    "request_id": "a7f3e2d1-9c4b-4e8a-b5f6-3d2c1a0e9f8b"
7  }'

Step 3: Query the payment result status

To get the payment result, poll the status of the Payment Intent via the Retrieve a Payment Intent API API.

In addition, Airwallex will notify you of the payment result asynchronously via webhooks. Please refer to the webhook documentation to set up your webhook accordingly. It is recommended to subscribe to the payment_intent.succeeded webhook which indicates that the shopper has paid the order.

Was this page helpful?