Alipay (In-Store)

Accept in-store payments from Alipay users through your point-of-sale system (POS) or the OmisePay application using the Alipay In-Store 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 in-store Alipay payments using a barcode reader. See Get paid with Alipay for accepting Alipay payments using the OmisePay application. See Alipay (Online) for accepting online Alipay payments.

How To Enable

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

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

Payment Flow

The following diagram shows the interactions among the customer, merchant, Omise, and Alipay in a typical Alipay In-Store charge.

Flow

  1. When the payer is ready to checkout, they open the Alipay application on their phone and click the Pay button.
  2. You scan the barcode generated in the Alipay application using your barcode reader
  3. You create a charge (status=pending) using the barcode, payment information, details about your store and terminal.
  4. Alipay will process the charge. In some cases, the payer may be required to authorize the payment using the Alipay application.
  5. Once processed, a webhook event will be sent to the your server (if configured) with an updated charge status.
  6. You verify the charge status by retrieving the charge.

If the charge is marked status=successful the amount has been successfully paid.

Implementation

To create a Alipay In-Store charge, make the following API requests.

  1. Create a new payment source
  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 In-Store source. Use your secret key to create the Alipay In-Store charge.

You can also create and charge the source in a single API request using your secret key.

Creating a Source

Alipay In-Store payments are implemented as sources. When the customer confirms that they wish to pay with this payment method, create a new source specifying the type, amount, and currency.

The following examples demonstrate the creation of a new Alipay In-Store source for ฿4,000. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with your test public key found on the dashboard: https://dashboard.omise.co/test/keys

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

For testing, you can create the request using curl.

curl https://api.omise.co/sources \
  -u $OMISE_PUBLIC_KEY: \
  -d "amount=400000" \
  -d "currency=THB" \
  -d "type=barcode_alipay" \
  -d "barcode=1234567890" \
  -d "store_id=store_1234" \
  -d "store_name=Some Store" \
  -d "terminal_id=POS-01"

{
  "object": "source",
  "id": "src_test_5h21djzabt87e7klf2s",
  "livemode": false,
  "location": "/sources/src_test_5h21djzabt87e7klf2s",
  "created_at": "2019-08-29T04:35:26Z",
  "type": "barcode_alipay",
  "flow": "offline",
  "amount": 400000,
  "currency": "THB",
  "mobile_number": null,
  "phone_number": null,
  "references": null,
  "name": null,
  "email": null,
  "barcode": "1234567890",
  "store_id": "store_1234",
  "store_name": "Some Store",
  "terminal_id": "POS-01",
  "installment_term": null,
  "zero_interest_installments": null
}

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

Creating a Charge

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

  • source specifies the source identifier.
  • return_uri specifies the location on your website to which the customer should be redirected after completing the payment authorization step.
  • 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 the dashboard: https://dashboard.omise.co/test/keys. 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_5h21dk2ao7eemv5g1uu",
  "livemode": false,
  "location": "/charges/chrg_test_5h21dk2ao7eemv5g1uu",
  "created_at": "2019-08-29T04:35:27Z",
  "amount": 400000,
  "currency": "THB",
  "funding_amount": 400000,
  "funding_currency": "THB",
  "fee": 6600,
  "fee_vat": 462,
  "interest": 0,
  "interest_vat": 0,
  "net": 392938,
  "description": null,
  "metadata": {},
  "status": "pending",
  "capture": true,
  "authorized": false,
  "schedule": null,
  "reversed": false,
  "reversed_at": null,
  "expires_at": "2019-08-30T04:35:27Z",
  "expired": false,
  "expired_at": null,
  "voided": false,
  "paid": false,
  "paid_at": null,
  "transaction": null,
  "refunded_amount": 0,
  "refunds": {
    "object": "list",
    "from": "1970-01-01T00:00:00Z",
    "to": "2019-08-29T04:35:27Z",
    "offset": 0,
    "limit": 20,
    "total": 0,
    "order": "chronological",
    "location": "/charges/chrg_test_5h21dk2ao7eemv5g1uu/refunds",
    "data": []
  },
  "link": null,
  "return_uri": "https://example.com/orders/345678/complete",
  "failure_code": null,
  "failure_message": null,
  "card": null,
  "customer": null,
  "ip": null,
  "dispute": null,
  "source": {
    "object": "source",
    "id": "src_test_5h21djog90dpy0wxnw7",
    "livemode": false,
    "location": "/sources/src_test_5h21djog90dpy0wxnw7",
    "created_at": "2019-08-29T04:35:25Z",
    "type": "barcode_alipay",
    "flow": "offline",
    "amount": 400000,
    "currency": "THB",
    "mobile_number": null,
    "phone_number": null,
    "references": {
      "expires_at": "2019-08-30T04:35:27Z",
      "device_id": null,
      "customer_amount": null,
      "customer_currency": null,
      "customer_exchange_rate": null,
      "omise_tax_id": null,
      "reference_number_1": null,
      "reference_number_2": null,
      "barcode": null,
      "payment_code": null,
      "va_code": null
    },
    "name": null,
    "email": null,
    "barcode": "1234567890",
    "store_id": "store_1234",
    "store_name": "Some Store",
    "terminal_id": "POS-01",
    "installment_term": null,
    "zero_interest_installments": null
  },
  "platform_fee": {
    "percentage": null,
    "fixed": null,
    "amount": null
  },
  "disputable": false,
  "capturable": false,
  "reversible": false,
  "refundable": false,
  "authorize_uri": 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=400000" \
  -d "currency=THB" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source[type]=barcode_alipay" \
  -d "source[barcode]=1234567890" \
  -d "source[store_id]=store_1234" \
  -d "source[store_name]=Some Store" \
  -d "source[terminal_id]=POS-01"

Completing the Charge

At this point, you have created a new charge with its status set to pending. Possible values for charge status are pending, 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

In some cases, the payer may be required to confirm the payment on their Alipay app.

Receiving the Charge Completion Event

The best way 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 at https://dashboard.omise.co/test/webhooks. 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, or after you have manually marked the charge, check the charge status again.

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
payment_cancelled Payment cancelled by payer.
failed_processing General payment processing failure.
insufficient_balance Insufficient funds in the account or the card has reached the credit limit.
payment_rejected Payment rejected by issuer.
timeout Payer did not take action before charge expiration.

Setting the Charge to Expire

Alipay In-Store charges that have not yet been authorized (status=pending) can be set to expire.

curl https://api.omise.co/charges/$CHARGE_ID/expire \
  -X POST \
  -u $OMISE_SECRET_KEY:

Voids and Refunds

Alipay In-Store charges can be partially or fully refunded within 12 months of the transaction date.

Limits

  • Minimum: 2000 (฿20)
  • Maximum: 100000000 (฿1,000,000)

Next Steps