ShopeePay App Redirection

Accept online payments from ShopeePay users through your website using the ShopeePay App-to-app Redirection (Jump App) payment method. This guide walks you through the payment flow and details how to implement it.

How to enable

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

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

Payment flow

Customers paying via ShopeePay go through a redirect payment flow. They are redirected from your website to the ShopeePay mobile application, where they can scan, authorize, and confirm the payment.

The following screenshots demonstrate this flow.

❶ The customer chooses the wallet they want to pay with ❷ they are redirected to their wallet app to confirm the payment. ❸ The payment details are shown. ❹ The customer can be redirected to the merchant's confirmation details page by pressing Back to merchant. ❺ The customer redirected back to the merchant's page.

ShopeePay users can make payments using the following payment methods:

Implementation

Make the following API requests to create a charge using the ShopeePay Jump App.

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

When the customer confirms that they wish to pay with this payment method, create a new source specifying the amount, currency, platform_type, and type.

The following examples demonstrate creating a new ShopeePay Jump App source for S$50. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with the test public key on your dashboard.

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

Omise.setPublicKey(omise_public_key);

Omise.createSource('shopeepay_jumpapp', {
  "amount": 5000,
  "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=5000" \
  -d "currency=SGD" \
  -d "type=shopeepay_jumpapp"

{
  "object": "source",
  "id": "src_5tzpprlk9fhk44a0duf",
  "livemode": true,
  "location": "/sources/src_5tzpprlk9fhk44a0duf",
  "amount": 5000,
  "barcode": null,
  "bank": null,
  "created_at": "2022-12-01T18:38:00Z",
  "currency": "SGD",
  "email": null,
  "flow": "app_redirect",
  "installment_term": null,
  "absorption_type": null,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "shopeepay_jumpapp",
  "zero_interest_installments": null,
  "charge_status": "unknown",
  "receipt_amount": null,
  "discounts": []
}

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

Creating a charge

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

• return_uri specifies the location on your website to which the customer should be redirected after completing the payment authorization step.
• source specifies the source identifier.
• amount and currency must match the source.

Omise recommends not using the charge attributes net, fee, fee_vat, and transaction_fees until a charge status is successful.

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

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=5000" \
  -d "currency=SGD" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"

{
  "object": "charge",
  "id": "chrg_5tzpprqgatnvocdffg1",
  "location": "/charges/chrg_5tzpprqgatnvocdffg1",
  "amount": 5000,
  "net": 0,
  "fee": 0,
  "fee_vat": 0,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 5000,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": null,
    "fee_rate": null,
    "vat_rate": "0.0"
  },
  "platform_fee": {
    "fixed": null,
    "amount": null,
    "percentage": null
  },
  "currency": "SGD",
  "funding_currency": "SGD",
  "ip": null,
  "refunds": {
    "object": "list",
    "data": [],
    "limit": 20,
    "offset": 0,
    "total": 0,
    "location": "/charges/chrg_5tzpprqgatnvocdffg1/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2022-12-01T18:38:01Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_5tzppr5vvh5uajb97se",
    "livemode": true,
    "location": "/sources/src_5tzppr5vvh5uajb97se",
    "amount": 5000,
    "barcode": null,
    "bank": null,
    "created_at": "2022-12-01T18:37:58Z",
    "currency": "SGD",
    "email": null,
    "flow": "app_redirect",
    "installment_term": null,
    "absorption_type": null,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "platform_type": null,
    "scannable_code": null,
    "references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "shopeepay_jumpapp",
    "zero_interest_installments": null,
    "charge_status": "pending",
    "receipt_amount": null,
    "discounts": []
  },
  "schedule": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "status": "pending",
  "authorize_uri": "https://wsa.uat.wallet.airpay.sg/universal-link/wallet/pay?deep_and_deferred=1&token=dVltTnFnT2JJenVSW1sOvUKHG_lpVvCqLs1KSg480Z_DOIhbce3XlNmruBKsk53_FphC",
  "return_uri": "http://example.com/orders/345678/complete",
  "created_at": "2022-12-01T18:38:01Z",
  "paid_at": null,
  "expires_at": "2022-12-01T18:58:01Z",
  "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": true,
  "refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": false
}

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=5000" \
  -d "currency=SGD" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source[type]=shopeepay_jumpapp"

Setting the charge to expire

By default, the charge expires 20 mins after creation.

You can also assign different expiration periods to each charge by entering a timestamp not exceeding 60 minutes in the expires_at field of the Charge API. If the timestamp is entered correctly, the charge will expire at the designated time instead of the default period.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=5000" \
  -d "currency=SGD" \
  -d "source[type]=shopeepay_jumpapp"
  -d "expires_at=2020-07-01T15:00:00Z"

If you wish to expire the link before that period ends, use the following API request to deactivate it.

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

Completing the charge

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.

Authorizing the charge

Redirect the customer to the location specified in authorize_uri so they can authorize the charge.

You can simulate this authorization phase in test mode by visiting the authorize_uri to manually mark the charge as Successful or Failed. After the customer has completed the authorization phase, they will be redirected to the location you specified in return_uri.

Receiving the charge completion event

The best way to be notified of a charge completion is by 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 with the charge response embedded will be sent to this endpoint.

The key attribute for the event object contains charge.complete, and the data attribute contains the charge object. See Events API for the 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.

Voids and Refunds

You can create a partial or full refund within 180 days of the transaction date through our refund API or from the charge page on your dashboard.

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)

Next steps

• Charge API
• Source API
• Webhooks API