PayNow BETA

Enable your customers to make purchases directly from their bank accounts using PayNow. PayNow helps your business receive secure and instant payments from buyers across Singapore. No need to fill out payment details; customers can simply scan your QR code for faster checkout.

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

How To Enable

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

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

Payment Flow

Customers paying via PayNow go through a offline payment flow. This means that once the charge is created, it can only be authorized offline. In this case, the customer must scan the generated QR code using a banking app on their phone to complete the flow.

After the customer selects PayNow as their preferred payment method, your site should generate the PayNow QR code. The following screenshots demonstrate two flows: one using a desktop browser and one using a mobile browser. In both cases, once the QR code is visible, the customer must scan it to complete the payment.

Using a Desktop Browser

PayNow Desktop

To scan the QR code, the customer logs into their bank app on their mobile phone ❷. The customer scans the code using their bank app ❸. The customer confirms the purchase using the bank app ❹. Once you receive a webhook completion event, confirm the payment with the user ❺.

Using a Mobile Browser

PayNow Mobile

To scan the QR code, the customer takes a screenshot of the QR code ❶ and logs into their bank using their mobile phone ❷. The customer loads the screenshot containing the QR code using their bank app ❸. The customer confirms the purchase using the bank app ❹. Once you receive a webhook completion event, confirm the payment with the user ❺.

Implementation

To create a PayNow charge, make the following API requests.

  1. Create a new payment source 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 PayNow source on the client (a customer's browser or mobile phone). Use your secret key to create the PayNow 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

PayNow 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 PayNow source for S$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.

Omise.setPublicKey(omise_public_key);

Omise.createSource('paynow', {
  "amount": 400000,
  "currency": "SGD"
}, 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=SGD" \
  -d "type=paynow"
{
  "object": "source",
  "id": "src_5hllj57zhvczucwem20",
  "livemode": true,
  "location": "/sources/src_5hllj57zhvczucwem20",
  "type": "paynow",
  "flow": "offline",
  "amount": 400000,
  "currency": "sgd",
  "created": "2019-10-18T04:47:27Z",
  "mobile_number": null,
  "phone_number": null,
  "references": null,
  "name": null,
  "email": null,
  "barcode": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "installment_terms": null,
  "absorption_type": null,
  "scannable_code": 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=SGD" \
  -d "source=$SOURCE_ID"
{
  "object": "charge",
  "id": "chrg_5hllj5e4o6pqpdbeupm",
  "livemode": true,
  "location": "/charges/chrg_5hllj5e4o6pqpdbeupm",
  "amount": 400000,
  "currency": "sgd",
  "funding_amount": 400000,
  "funding_currency": "sgd",
  "description": null,
  "metadata": {},
  "status": "pending",
  "capture": true,
  "authorized": false,
  "schedule": null,
  "reversed": false,
  "reversed_at": null,
  "expires_at": "2019-10-25T04:47:28Z",
  "expired": false,
  "expired_at": null,
  "voided": false,
  "paid": false,
  "paid_at": null,
  "transaction": null,
  "refunded": 0,
  "refunds": {
    "object": "list",
    "from": "1970-01-01T00:00:00Z",
    "to": "2019-10-18T04:47:29Z",
    "offset": 0,
    "limit": 20,
    "total": 0,
    "order": "chronological",
    "location": "/charges/chrg_5hllj5e4o6pqpdbeupm/refunds",
    "data": []
  },
  "return_uri": null,
  "failure_code": null,
  "failure_message": null,
  "card": null,
  "customer": null,
  "ip": null,
  "dispute": null,
  "created": "2019-10-18T04:47:28Z",
  "source": {
    "object": "source",
    "id": "src_5hllj4bfnqdeivnlkzz",
    "livemode": true,
    "location": "/sources/src_5hllj4bfnqdeivnlkzz",
    "type": "paynow",
    "flow": "offline",
    "amount": 400000,
    "currency": "sgd",
    "created": "2019-10-18T04:47:23Z",
    "mobile_number": null,
    "phone_number": null,
    "references": null,
    "name": null,
    "email": null,
    "barcode": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "installment_terms": null,
    "absorption_type": null,
    "scannable_code": {
      "object": "barcode",
      "type": "qr",
      "image": {
        "object": "document",
        "id": "docu_5hllj5nkn8hlqtvfxlh",
        "livemode": true,
        "location": "/charges/chrg_5hllj5e4o6pqpdbeupm/documents/docu_5hllj5nkn8hlqtvfxlh",
        "filename": "QRCode.png",
        "created": "2019-10-18T04:47:29Z",
        "download_location": "https://api.omise.co/charges/chrg_5hllj5e4o6pqpdbeupm/documents/docu_5hllj5nkn8hlqtvfxlh/downloads/51638FB2F72A68E6"
      }
    }
  },
  "disputable": false,
  "capturable": false,
  "reversible": false,
  "refundable": false,
  "reference": null,
  "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=SGD" \
  -d "source[type]=paynow"

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

To complete the charge, the customer must scan the QR code image generated by the API.

Within the charge response, find the barcode in the key starting with download_ within the image object of the scannable_code (barcode) object within the source object.

{
  "object": "barcode",
  "type": "qr",
  "image": {
    "object": "document",
    "id": "docu_5hllj50ig7ld9qh0i6z",
    "livemode": true,
    "location": "/charges/chrg_5hllj4gzs5ka9p8dan7/documents/docu_5hllj50ig7ld9qh0i6z",
    "filename": "QRCode.png",
    "created": "2019-10-18T04:47:26Z",
    "download_location": "https://api.omise.co/charges/chrg_5hllj4gzs5ka9p8dan7/documents/docu_5hllj50ig7ld9qh0i6z/downloads/24C7AF994EC985B2"
  }
}

You must display this barcode for the user.

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.

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, retrieving 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 card has reached the credit limit.
payment_cancelled Payment cancelled by payer.
timeout Payer did not take action before charge expiration.

Voids and Refunds

PayNow charges cannot be voided or refunded through Omise.

Limits

  • Minimum: 100 (S$1)
  • Maximum: 100000 (S$1,000)

Next Steps