Alipay (Online)

Accept online payments from Alipay users through your website using the Alipay Online 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.

This guide is for accepting online Alipay payments. See Alipay (In-Store) for accepting in-store Alipay payments using a barcode reader. See Get paid with Alipay for accepting in-store Alipay payments using the OmisePay application.

How to enable

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

To enable Alipay (Online), send an email requesting this feature to support@omise.co. You will need to review and accept new terms and conditions.

Payment flow

When your customer chooses Alipay as their preferred payment method at checkout, they go through a redirect payment flow. This means they are redirected from your website to Alipay’s secure checkout page where they authorize and confirm the payment.

Payment Flow1 Payment Flow2

The currency displayed to your customer will your account funding currency and the equivalent amount in CNY. Upon confirmation, the customer is redirected back to the your website.

Implementation

To create a charge using Alipay (Online), make the following API requests.

  1. Create a new payment source (type: alipay) using Omise.js or one of the mobile SDKs (iOS and Android)
  2. Create a new charge using the identifier of the source created in Step 1.
  3. 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 (Online) source on the client (a customer's browser or mobile phone). Use your secret key to create the Alipay (Online) 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, and type.

The following examples demonstrate the creation of a new Alipay (Online) source for ฿4,000. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with your 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', {
  "amount": 400000,
  "currency": "THB"
}, 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=400000" \
  -d "currency=THB" \
  -d "type=alipay"
{
  "object": "source",
  "id": "src_test_5jk1z3rj1o7u7klv8lf",
  "livemode": false,
  "location": "/sources/src_test_5jk1z3rj1o7u7klv8lf",
  "amount": 400000,
  "barcode": null,
  "created_at": "2020-04-15T08:02:29Z",
  "currency": "THB",
  "email": null,
  "flow": "redirect",
  "installment_term": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "scannable_code": null,
  "references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "alipay",
  "zero_interest_installments": 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.
  • source specifies the source identifier.
  • amount and currency must match amount and currency of the source.

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=400000" \
  -d "currency=THB" \
  -d "return_uri=https://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"
{
  "object": "charge",
  "id": "chrg_test_5jk1z3wuw3k5agp30se",
  "location": "/charges/chrg_test_5jk1z3wuw3k5agp30se",
  "amount": 400000,
  "net": 384378,
  "fee": 14600,
  "fee_vat": 1022,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 400000,
  "refunded_amount": 0,
  "authorized": false,
  "capturable": false,
  "capture": true,
  "disputable": false,
  "livemode": false,
  "refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": false,
  "platform_fee": {
    "fixed": null,
    "amount": null,
    "percentage": null
  },
  "currency": "THB",
  "funding_currency": "THB",
  "ip": null,
  "refunds": {
    "object": "list",
    "data": [],
    "limit": 20,
    "offset": 0,
    "total": 0,
    "location": "/charges/chrg_test_5jk1z3wuw3k5agp30se/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2020-04-15T08:02:30Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_5jk1z3gyuvhd3j0ackh",
    "livemode": false,
    "location": "/sources/src_test_5jk1z3gyuvhd3j0ackh",
    "amount": 400000,
    "barcode": null,
    "created_at": "2020-04-15T08:02:28Z",
    "currency": "THB",
    "email": null,
    "flow": "redirect",
    "installment_term": null,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "scannable_code": null,
    "references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "alipay",
    "zero_interest_installments": null
  },
  "schedule": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "status": "pending",
  "authorize_uri": "https://pay.omise.co/offsites/ofsp_test_5jk1z3x04gi784mhw67/pay",
  "return_uri": "https://example.com/orders/345678/complete",
  "created_at": "2020-04-15T08:02:30Z",
  "paid_at": null,
  "expires_at": "2020-04-22T08:02:30Z",
  "expired_at": null,
  "reversed_at": null,
  "zero_interest_installments": true
}

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=400000" \
  -d "currency=THB" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source[type]=alipay"

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.

This sequence diagram shows the entire flow.

sequenceDiagram participant customer participant omise.js participant merchant participant api.omise.co customer->>omise.js: Send payment details for purchase omise.js->>api.omise.co: Request source using payment details api.omise.co-->>omise.js: Return source omise.js->>merchant: Merchant gets returned source merchant->>api.omise.co: Request charge using source and purchase details api.omise.co-xmerchant: Send "charge.create" webhook api.omise.co-->>merchant: Return charge merchant->>customer: Redirect to "authorize_uri" for pending charge customer->>api.omise.co: Provide charge authorization details at "authorize_uri" api.omise.co-->>customer: Redirect to "return_uri" api.omise.co-xmerchant: Send "charge.complete" webhook merchant-xcustomer: Send charge result (e.g. via email)

Authorizing the charge

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

You can simulate this authorization phase in test mode by visiting the 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 you specified in return_uri.

Receiving the charge completion event

The best way for you to be notified of the completion of a charge is using webhook events. Set up a location on your server to receive webhook events, and add this location as a webhook endpoint on the dashboard.

Once a charge is completed, a POST request will be sent to this endpoint with the charge response embedded.

The key attribute for the event object contains charge.complete and the data attribute contains the charge object. See Events API for event object structure.

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 has updated to successful, you got paid. If the value of status has updated to failed, check the failure_code and failure_message in the charge object for an explanation.

Possible failure codes are listed below.

Failure Code Description
failed_processing General payment processing failure.
insufficient_balance Insufficient funds in the account or the payment method has reached its limit.
payment_rejected Payment rejected by issuer.
timeout Payer did not take action before charge expiration.

Voids and refunds

You can create a full or partial refund through our refund API or from the charge page on your dashboard.

Alipay (Online) charges can only be refunded within three months of the transaction date.

Limits

  • Minimum: 2000 (THB20.00)
  • Maximum: 4900000 (THB49,000.00)

Next steps