Alipay CN

Accept online payments from Alipay users through your website using the AlipayCN payment method.

This payment method allows you to gain access to one of China's most popular online payment methods without needing an Alipay account or registering for a Chinese bank account. This guide walks you through the payment flow and details on how to implement.

For the legacy integration with Alipay Online payment, please refer to the Alipay (Online).

How to enable

• Supported Countries: Thailand, Singapore
• Minimum API version: 2017-11-02

To enable Alipay (Online), send an email requesting this feature to support@opn.ooo.

Payment flow

Alipay (Online) supports payment on mobile application and website. Customers paying via Alipay (Online) go through an app_redirect payment flow. This means they are redirected from your website or mobile application to Alipay’s secure checkout page where they authorize and confirm the payment. For mobile a customer can use Alipay’s app to complete the payment. For website payment a customer can either scan the QR code using the Alipay's app on their phone, or login into their Alipay account to complete the payment. The following screenshots demonstrate two flows: one by checking out the payment on desktop and another one on mobile.

Using a mobile

The customer chooses the wallet they want to pay with ❶ they are redirected to their wallet app to confirm the payment ❷. The payment details are shown ❸. The customer can choose to be redirected to the merchant's confirmation details page by pressing on Back to merchant ❹.

Using a desktop browser

The customer chooses the wallet they want to pay with ❶ ,after that a QR code will be shown ❷. The customer opens corresponding wallet app then uses the qr scanner ❸. The customer scans the QR code ❹. The customer is shown the summary page before confirming their payment ❺. The payment confirmation slip is shown. The customer can choose to be redirected to the merchant's payment confirmation page ❻. Once you receive a webhook completion event, confirm the payment with the customer ❺.

Implementation

Note: alipay will be deprecated in favor of alipay_cn

To create a charge using Alipay CN, make the following API requests. 1. Create a new payment source (type: alipay_cn) using Omise.js or one of the mobile SDKs (iOS and Android) 1. Create a new charge using the identifier of the source created in Step 1. 1. After receiving the charge completion webhook event, retrieve the charge to verify its status (optional, but recommended).

Use your public key to create the Alipay CN source on the client (a customer's browser or mobile phone). Use your secret key to create the Alipay CN charge on the server.

If both the creation and charge of a source must happen server-side, you can create and charge the source in a single API request using your secret key.

Creating a source

When the customer confirms that they wish to pay with this payment method, create a new source specifying the amount, currency, platform_type, and type.

The following examples demonstrate the creation of a new Alipay CN source for S$1500. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with the test public key found on your dashboard.

Using Omise.js, the type parameter is supplied as the first argument to the createSource method.

Omise.setPublicKey(omise_public_key);

Omise.createSource('alipay_cn', {
  "amount": 150000,
  "currency": "SGD",
  "platform_type": "WEB"
}, function(statusCode, response) {
  console.log(response)
});

For testing, you can create the same request using curl.

curl https://api.omise.co/sources \
  -u $OMISE_PUBLIC_KEY: \
  -d "amount=150000" \
  -d "currency=SGD" \
  -d "type=alipay_cn" \
  -d "platform_type=WEB"

{
  "object": "source",
  "id": "src_test_61l8jkfr67rqij77ktx",
  "livemode": false,
  "location": "/sources/src_test_61l8jkfr67rqij77ktx",
  "amount": 150000,
  "barcode": null,
  "bank": null,
  "created_at": "2024-10-31T02:05:49Z",
  "currency": "SGD",
  "email": null,
  "flow": "app_redirect",
  "installment_term": null,
  "ip": "35.198.236.178",
  "absorption_type": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": "WEB",
  "scannable_code": null,
  "billing": null,
  "shipping": null,
  "items": [],
  "references": null,
  "provider_references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "alipay_cn",
  "zero_interest_installments": null,
  "charge_status": "unknown",
  "receipt_amount": null,
  "discounts": [],
  "promotion_code": null
}

The id attribute is the source identifier (begins with src).

Creating a charge

Create a charge specifying the parameters return_uri, source, amount, and currency.

• return_uri specifies the location on your website to which the customer should be redirected after completing the payment authorization step.

  URL must be in HTTPS format.

• source specifies the source identifier.

• amount and currency must match amount and currency of the source.

Can support both manual and automatic capture.

The following example demonstrates how to create a new charge using curl. Replace $OMISE_SECRET_KEY with your test secret key found on your dashboard. Replace $SOURCE_ID with the id of the source.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=150000" \
  -d "currency=SGD" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"

{
  "object": "charge",
  "id": "chrg_test_61l8jkj91e3r4sa7ok6",
  "location": "/charges/chrg_test_61l8jkj91e3r4sa7ok6",
  "amount": 150000,
  "acquirer_reference_number": null,
  "net": 145650,
  "fee": 4350,
  "fee_vat": 0,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 150000,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": "0.0",
    "fee_rate": "2.9",
    "vat_rate": "0.0"
  },
  "platform_fee": {
    "fixed": null,
    "amount": null,
    "percentage": null
  },
  "currency": "SGD",
  "funding_currency": "SGD",
  "ip": null,
  "refunds": {
    "object": "list",
    "data": [],
    "limit": 20,
    "offset": 0,
    "total": 0,
    "location": "/charges/chrg_test_61l8jkj91e3r4sa7ok6/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2024-10-31T02:05:50Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_61l8jk6nim2s2wg7u8n",
    "livemode": false,
    "location": "/sources/src_test_61l8jk6nim2s2wg7u8n",
    "amount": 150000,
    "barcode": null,
    "bank": null,
    "created_at": "2024-10-31T02:05:48Z",
    "currency": "SGD",
    "email": null,
    "flow": "app_redirect",
    "installment_term": null,
    "ip": "35.198.236.178",
    "absorption_type": null,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "platform_type": "WEB",
    "scannable_code": null,
    "billing": null,
    "shipping": null,
    "items": [],
    "references": null,
    "provider_references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "alipay_cn",
    "zero_interest_installments": null,
    "charge_status": "pending",
    "receipt_amount": null,
    "discounts": [],
    "promotion_code": null
  },
  "schedule": null,
  "linked_account": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "status": "pending",
  "authorize_uri": "https://pay.omise.co/payments/pay2_test_61l8jkjb8d0c4njcf63/authorize?acs=false",
  "return_uri": "https://example.com/orders/345678/complete",
  "created_at": "2024-10-31T02:05:50Z",
  "paid_at": null,
  "authorized_at": null,
  "expires_at": "2024-11-07T02:05:49Z",
  "expired_at": null,
  "reversed_at": null,
  "multi_capture": false,
  "zero_interest_installments": false,
  "branch": null,
  "terminal": null,
  "device": null,
  "authorized": false,
  "capturable": false,
  "capture": true,
  "disputable": false,
  "livemode": false,
  "refundable": false,
  "partially_refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": false,
  "can_perform_void": false,
  "approval_code": null
}

Creating a source and charge

Alternatively, you can create and charge a source in a single API request.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=150000" \
  -d "currency=SGD" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source[type]=alipay_cn" \
  -d "source[platform_type]=WEB"

Completing the charge

At this point, you have created a new charge with its status set to pending. Other possible values for charge status are successful, failed, and expired.

The following sections detail how to authorize a charge, receive its completion webhook event, and update its status.

Authorizing the charge

Redirect the customer to the location specified in authorize_uri so that they can authorize the charge.

The merchant can simulate this authorization phase in test mode by visiting authorize_uri to manually mark the charge as Successful or Failed.

After the customer has completed the authorization phase, they will be redirected to the location specified in return_uri.

Receiving the charge completion event

The best way to be notified about the completion of a charge is using webhook events.

Set up a location on the merchant server to receive webhook events, and add this location as a webhook endpoint on the dashboard.

Checking the charge status

After receiving this event, retrieve the charge using its id and confirm that its status matches the status of the charge contained in the event.

If the value of status is successful, you got paid.

If the value of status is failed, check the failure_code and failure_message in the charge object for an explanation.

Possible failure codes are as follows.

See the Refunds API documentation for information on how to refund a payment charge.

Alipay payment charges can be voided within the next 00:15(GMT+8) after the charge was created.

Limits

Singapore

• Minimum: 100 (SGD 1.00)
• Maximum: 2000000 (SGD 20,000.00)

Thailand

• Minimum: 2000 (THB 20.00)
• Maximum: 15000000 (THB 150,000.00)

Related API documentation

• Charge
• Source
• Webhook

How to check the public key and secret key

For information on how to obtain and check the public and secret keys, please refer to this document.