Alipay via Checkout.com

Accept Alipay payments from customers in mainland China and Hong Kong with Checkout.com as the payment service provider (PSP). The customer selects Alipay, confirms the payment in Alipay, and returns to your site. Checkout.com processes two Alipay payment method codes:

alipayCn for Alipay customers in mainland China, in CNY.
alipayHk for AlipayHK customers in Hong Kong, in HKD.

Supported workflows

Before you begin

Complete these steps before you send your first Alipay 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 to enable Alipay+ on your Checkout.com processing channel.
In the Payrails Portal, go to Settings → Integrations, open your Checkout.com integration, select AlipayCN, AlipayHK, or both under Payment methods, and save.
Add each Alipay code 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 for `alipayHk`	At least one line item. Each line needs `id`, `name`, `unitPrice` and a `quantity` of one or more. Sent to Checkout.com as the order items.
`meta.order.lines`	Recommended for `alipayCn`	Sent to Checkout.com as the order items when present.
`meta.order.description`	Optional	Sent to Checkout.com as the payment description.
`meta.clientContext.clientType`	Optional	`app` or `wap` sets the Alipay terminal type. Any other value, or no value, sends `web`.
`meta.clientContext.osType`	Optional	`ios` or `android`. Sent to Checkout.com as the customer’s operating system.
`meta.customer.name`, `meta.customer.lastName`	Optional	Sent to Checkout.com as the customer name.
`meta.customer.email`	Optional	Sent to Checkout.com as the customer email.
`meta.customer.country.code`	Optional	Sent to Checkout.com as the customer country.

Authorize an Alipay payment

Call authorize a payment with alipayHk or alipayCn as the paymentMethodCode. The response includes the redirect to Alipay. This AlipayHK request sends the order lines that alipayHk requires:

Authorize request (AlipayHK)

{
  "amount": {
    "value": "250.00",
    "currency": "HKD"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "alipayHk",
      "amount": {
        "value": "250.00",
        "currency": "HKD"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Mei Ling",
      "lastName": "Chan",
      "email": "meiling.chan@example.com"
    },
    "order": {
      "description": "Order 1234",
      "lines": [
        {
          "id": "item-1",
          "name": "Travel adapter",
          "quantity": 1,
          "unitPrice": {
            "value": "250.00",
            "currency": "HKD"
          }
        }
      ]
    },
    "clientContext": {
      "clientType": "web"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

For customers in mainland China, send alipayCn with an amount in CNY:

Authorize request (Alipay China)

{
  "amount": {
    "value": "200.00",
    "currency": "CNY"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "alipayCn",
      "amount": {
        "value": "200.00",
        "currency": "CNY"
      }
    }
  ],
  "meta": {
    "order": {
      "description": "Order 1235"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

After the customer confirms the payment, Alipay returns them 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 Alipay

Payrails creates a payment setup at Checkout.com and confirms it for the Alipay method you selected. The confirmation returns the redirect to Alipay.
Payrails sends only order lines of type lineItem, or lines with no type. It skips tax, discount and shipping lines, and lines with no unit price or a zero quantity.
If Checkout.com reports that the Alipay method isn’t ready on your processing channel, the payment fails before Payrails redirects the customer.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize an Alipay payment

How Checkout.com handles Alipay

​Supported workflows

​Before you begin

​Request fields for Checkout.com

​Authorize an Alipay payment

​How Checkout.com handles Alipay

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize an Alipay payment

How Checkout.com handles Alipay