Alipay (Barcode)

Topics covered on this page

Please be informed that the Alipay (Barcode) service will be discontinued on Oct 1st, 2024. Merchants can continue to use other payment methods as usual. We apologize for any inconvenience this may cause.

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 (Barcode), send an email requesting this feature to support@opn.ooo. You will need to review and accept new terms and conditions.

Payment flow

Payers using Alipay (In-Store) present their Quick Pay payment code to you. You must scan the payment code using a barcode reader and use it to create a new charge.

Flow

Alipay will process the charge. In some cases, the payer may be required to authorize the payment using the Alipay application. Once you receive the charge completion webhook, you may verify the charge status and confirm the payment with the user.

Implementation

To create a charge using Alipay (Barcode), 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 (Barcode) 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[type] string (required) barcode_alipay
source[store_id] string (conditionally required) Store identifier. If store identifier is already configured on your account, this parameter must not be present. Please consult our support team to check if this parameter is required.
source[store_name] string (conditionally required) Store name. If store name is already configured on your account, this parameter must not be present. Please consult our support team to check if this parameter is required.
source[terminal_id] string (optional) Terminal identifier

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]=BJ_ZZ_001" \
  -d "source[store_name]=Some Store" \
  -d "source[terminal_id]=T80001"

{
  "object": "charge",
  "id": "chrg_test_611bhre3nt4hyzyo4rd",
  "location": "/charges/chrg_test_611bhre3nt4hyzyo4rd",
  "amount": 400000,
  "acquirer_reference_number": null,
  "net": 392938,
  "fee": 6600,
  "fee_vat": 462,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 400000,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": "0.0",
    "fee_rate": "1.65",
    "vat_rate": "7.0"
  },
  "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_611bhre3nt4hyzyo4rd/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2024-09-10T03:55:05Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_611bhrdm5l5uwa1kynl",
    "livemode": false,
    "location": "/sources/src_test_611bhrdm5l5uwa1kynl",
    "amount": 400000,
    "barcode": "1234567890",
    "bank": null,
    "created_at": "2024-09-10T03:55:05Z",
    "currency": "THB",
    "email": null,
    "flow": "offline",
    "installment_term": null,
    "ip": null,
    "absorption_type": null,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "platform_type": null,
    "scannable_code": null,
    "billing": null,
    "shipping": null,
    "items": [],
    "references": {
      "expires_at": "2024-09-11T03:55:05Z",
      "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
    },
    "provider_references": null,
    "store_id": "BJ_ZZ_001",
    "store_name": "Some Store",
    "terminal_id": "T80001",
    "type": "barcode_alipay",
    "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": null,
  "return_uri": null,
  "created_at": "2024-09-10T03:55:05Z",
  "paid_at": null,
  "authorized_at": null,
  "expires_at": "2024-09-11T03:55:05Z",
  "expired_at": null,
  "reversed_at": null,
  "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
}

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.

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 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.

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.
payment_expired Payment expired.

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_611bhs5emsnqygfrcvr",
  "location": "/charges/chrg_test_611bhr71nkfa9u6h7xz/refunds/rfnd_test_611bhs5emsnqygfrcvr",
  "livemode": false,
  "voided": true,
  "currency": "THB",
  "amount": 400000,
  "metadata": {},
  "charge": "chrg_test_611bhr71nkfa9u6h7xz",
  "terminal": null,
  "transaction": "trxn_test_611bhs5ycgmyskz7t5w",
  "status": "closed",
  "funding_amount": 400000,
  "funding_currency": "THB",
  "created_at": "2024-09-10T03:55:08Z",
  "acquirer_reference_number": null,
  "approval_code": null
}

Limits

  • Minimum: 2000 (THB20.00)
  • Maximum: 15000000 (THB150,000.00)

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.

Omise uses cookies to improve your overall site experience and collect information on your visits and browsing behavior. By continuing to browse our website, you agree to our Privacy Policy. Learn more