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

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

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.

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 charge using Alipay (In-Store), make the following API requests.

  1. Create a new charge specifying the required parameters.
  2. After receiving the charge completion webhook event, retrieve the charge to verify its status (optional, but recommended).

Use your secret key to create the Alipay (In-Store) charge.

Creating a charge

When the payer confirms they wish to use this payment method, create a new charge specifying the following parameters: amount, currency, source[type] (barcode_alipay), source[barcode], source[store_id], source[store_name], and source[terminal_id].

Parameter Type Description
amount integer (required) See Limits
currency string (required) THB
source[barcode] string (required) Alipay barcode number
source[store_id] string (required) Store identifier
source[store_name] string (required) Store name
source[terminal_id] string (required) Terminal identifier
source[type] string (required) barcode_alipay

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

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=400000" \
  -d "currency=THB" \
  -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"
{
  "object": "charge",
  "id": "chrg_test_5jsp6bucd0we55mli0q",
  "location": "/charges/chrg_test_5jsp6bucd0we55mli0q",
  "amount": 400000,
  "net": 392938,
  "fee": 6600,
  "fee_vat": 462,
  "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_5jsp6bucd0we55mli0q/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2020-05-07T10:28:07Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_5jsp6btxts2x7v1qgrw",
    "livemode": false,
    "location": "/sources/src_test_5jsp6btxts2x7v1qgrw",
    "amount": 400000,
    "barcode": "1234567890",
    "created_at": "2020-05-07T10:28:07Z",
    "currency": "THB",
    "email": null,
    "flow": "offline",
    "installment_term": null,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "scannable_code": null,
    "references": {
      "expires_at": "2020-05-08T10:28:07Z",
      "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
    },
    "store_id": "store_1234",
    "store_name": "Some Store",
    "terminal_id": "POS-01",
    "type": "barcode_alipay",
    "zero_interest_installments": null
  },
  "schedule": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "status": "pending",
  "authorize_uri": null,
  "return_uri": null,
  "created_at": "2020-05-07T10:28:07Z",
  "paid_at": null,
  "expires_at": "2020-05-08T10:28:07Z",
  "expired_at": null,
  "reversed_at": null,
  "zero_interest_installments": true
}

Setting the charge to expire

Alipay In-Store charges that have not yet been authorized (status=pending) can be set to expire immediately. In effect, this cancels the charge.

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

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 merchant participant api.omise.co participant payment provider customer->>merchant: Present payment code for scanning merchant->>api.omise.co: Create charge using payment code api.omise.co-->>merchant: Return charge api.omise.co-xmerchant: Send "charge.create" webhook customer->>payment provider: Provide charge authorization payment provider-->>customer: Return payment result payment provider-->>api.omise.co: Return payment result api.omise.co-xmerchant: Send "charge.complete" webhook

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 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 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 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 payment method has reached its limit.
payment_rejected Payment rejected by issuer.
timeout Payer did not take action before charge expiration.

Voids and refunds

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

curl https://api.omise.co/charges/$REFUNDABLE_CHARGE_ID/refunds \
  -u $OMISE_SECRET_KEY: \
  -d "amount=400000"
{
  "object": "refund",
  "id": "rfnd_test_5jsp6ca67g6k6npa701",
  "location": "/charges/chrg_test_5jsp6blp2oql3kqygl4/refunds/rfnd_test_5jsp6ca67g6k6npa701",
  "livemode": false,
  "voided": true,
  "currency": "THB",
  "amount": 400000,
  "metadata": {},
  "charge": "chrg_test_5jsp6blp2oql3kqygl4",
  "transaction": "trxn_test_5jsp6canigzu0zqeaj6",
  "status": "closed",
  "funding_amount": 400000,
  "funding_currency": "THB",
  "created_at": "2020-05-07T10:28:09Z"
}

Limits

  • Minimum: 2000 (THB20.00)
  • Maximum: 100000000 (THB1,000,000.00)

Next steps