WeChat Pay via Checkout.com

Accept WeChat Pay payments with Checkout.com as the payment service provider (PSP). The customer selects WeChat Pay, scans a QR code with the WeChat app and confirms the payment.

Supported workflows

Before you begin

Complete these steps before you send your first WeChat Pay payment through Checkout.com:

Set up a Checkout.com integration in your workspace. Follow the Checkout.com integration setup guide if you don’t have one yet.
Ask Checkout.com support to enable WeChat Pay on the processing channel of your Checkout.com account.
In the Payrails Portal, go to Settings → Integrations, open your Checkout.com integration, select WeChat Pay under Payment methods, and save.
Add WeChat Pay as a payment option in your workflow.

Request fields for Checkout.com

Send these fields in the authorize request, in addition to the standard authorize fields. Payrails checks Required fields and returns an error when one is missing. Fields required by the PSP pass the Payrails checks but the PSP can decline the payment without them.

Field	Status	Description
`meta.order.lines`	Required	At least one line item. Payrails sends the line items to Checkout.com as the order items.
`meta.order.lines[].name`	Required	The item name.
`meta.order.lines[].id`	Required	Sent as the item reference. Payrails shortens it to 32 characters.
`meta.order.lines[].unitPrice`	Required	The price of one unit.
`meta.order.lines[].quantity`	Required	Must be one or more.
`meta.order.description`	Recommended	Sent to Checkout.com as the payment description.
`meta.clientContext.clientType`	Optional	`web`, `app` or `wap`. Sent to Checkout.com as the terminal type. Payrails sends `web` when it’s missing.
`meta.clientContext.osType`	Optional	`ios` or `android`. Sent to Checkout.com as the operating system.
`meta.customer.email`	Optional	Sent to Checkout.com as the customer email.
`meta.customer.name`, `meta.customer.lastName`	Optional	Sent to Checkout.com as the customer name.
`meta.customer.country.code`	Optional	Sent to Checkout.com as the customer country.

Authorize a WeChat Pay payment

Call authorize a payment with weChatPay as the paymentMethodCode. The response includes a redirect to a Payrails page that shows the WeChat Pay QR code.

Authorize request

{
  "amount": {
    "value": "50.00",
    "currency": "HKD"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "weChatPay",
      "amount": {
        "value": "50.00",
        "currency": "HKD"
      }
    }
  ],
  "meta": {
    "clientContext": {
      "clientType": "web"
    },
    "order": {
      "description": "Order 1234",
      "lines": [
        {
          "id": "item-1",
          "name": "Tea set",
          "quantity": 1,
          "unitPrice": {
            "value": "50.00",
            "currency": "HKD"
          }
        }
      ]
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

After the customer confirms the payment in WeChat, they return to your success or error URL. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How Checkout.com handles WeChat Pay

Checkout.com returns a WeChat link, not a page a browser can open. Payrails turns it into a Payrails-hosted page that shows the link as a QR code, and returns that page as the redirect.
Payrails sends only line items to Checkout.com. Tax, discount and shipping lines in meta.order.lines are left out.
Refunds use the standard Checkout.com refund flow.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

WeChat Pay via Checkout.com

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize a WeChat Pay payment

How Checkout.com handles WeChat Pay

​Supported workflows

​Before you begin

​Request fields for Checkout.com

​Authorize a WeChat Pay payment

​How Checkout.com handles WeChat Pay

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize a WeChat Pay payment

How Checkout.com handles WeChat Pay