User-Presented Mode Payment (B scan C)

Accept in-store payments from Alipay+ users through your point-of-sale system (POS) using the Alipay+ User-Presented Mode Payment (B scan C) payment method.

This guide walks you through the payment flow and details on how to implement.

How to enable

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

To enable User-Presented Mode Payment (B scan C), send an email requesting this feature to support@opn.ooo. You will need to review and accept new terms and conditions.

Payment flow

Customers paying via User-Presented Mode Payment (B scan C) present their payment code (barcode or QR code) to you. You must scan the payment code using a barcode reader and use it to create a new charge.

❶ The customer opens an Alipay+ supported wallet on their mobile phone. ❷ Then, the customer chooses to generate a QR code in the wallet application and displays to the merchant. ❸ The merchant scans the QR code with QR code reader. ❹ The customer confirms payment in the wallet application. ❺ When the payment is successful, the customer will be notified in the wallet application.

Implementation

To create a charge using User-Presented Mode Payment (B scan C), 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 User-Presented Mode Payment (B scan C) 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] (alipayplus_upm), and source[barcode].

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=150000" \
  -d "currency=THB" \
  -d "source[type]=alipayplus_upm" \
  -d "source[barcode]=2897991359827699709"

{
  "object": "charge",
  "id": "chrg_test_611binawoqhcagslthw",
  "location": "/charges/chrg_test_611binawoqhcagslthw",
  "amount": 150000,
  "acquirer_reference_number": null,
  "net": 147352,
  "fee": 2475,
  "fee_vat": 173,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 150000,
  "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_611binawoqhcagslthw/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2024-09-10T03:57:36Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_611binao6nfn751k7e1",
    "livemode": false,
    "location": "/sources/src_test_611binao6nfn751k7e1",
    "amount": 150000,
    "barcode": "2897991359827699709",
    "bank": null,
    "created_at": "2024-09-10T03:57:36Z",
    "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": null,
    "provider_references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "alipayplus_upm",
    "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:57:36Z",
  "paid_at": null,
  "authorized_at": null,
  "expires_at": "2024-09-17T03:57:36Z",
  "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

User-Presented Mode Payment (B scan C) 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.

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.

Voids and refunds

User-Presented Mode Payment (B scan C) charges can be voided until 16:15 UTC of the transaction date, and can be partially or fully refunded within 1 year of the transaction date.

Limits

Thailand

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

Singapore

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

Malaysia

• Minimum: 100 (MYR 1.00)
• Maximum: 3000000 (MYR 30,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.