PayMe for API only

Follow this flow to show the shopper a QR code on their desktop or laptop that they can scan to pay using their PayMe app.

When the shopper selects to pay with PayMe QR, make a /payments request with:

Parameter name	Required	Description
paymentMethod.type		Set to payme.
returnUrl		The URL where the shopper is redirected back to after completing the payment.
channel		To determine whether the shopper is using a desktop, laptop or mobile.
lineItems.quantity		The number of items. Must be between 0 and 9999.
lineItems.sku		The stock keeping unit. Maximum length 200 characters. Available if you use Checkout API v70 and later.
lineItems.description		The order description to display to the shopper. Maximum length 200 characters.
lineItems.amountIncludingTax		Item amount including the tax, in minor units. Must be between 1 and 100000000.
lineItems.itemCategory		The item category. Maximum length 200 characters.

Sample /payments request:

The /payments response contains:

• action.qrCodeData: Use this to render the QR code on your checkout page.

{
"resultCode": "Pending",
    "action": {
"expiresAt": "2021-01-30T16:09:09Z",
        "paymentData": "Ab02b4c0!BQABAgCS3pcqSJK0PVsLw839",
        "paymentMethodType": "payme",
        "url": "https://qr.payme.hsbc.com.hk/...",
        "qrCodeData": "https://qr.payme.hsbc.com.hk/...",
        "type": "qrCode"
    }
}

Show the QR code

Follow these steps to render the QR code on your checkout page:

1. Use the qrCodeData from the action object to render the QR code on your checkout page.
2. After the shopper scans the QR code and completes the payment, we send a webhook informing you of the payment result.
3. Show the payment result to your shopper.

Follow this flow to redirect the shopper from their mobile browser to the PayMe app.

When the shopper selects to pay with PayMe QR, make a /payments request with:

• paymentMethod.type: payme
• returnURL: The URL where the shopper is redirected back to after completing the payment.

Sample /payments request:

The /payments response contains:

{
    "resultCode": "RedirectShopper",
    "action": {
        "expiresAt": "2021-01-30T16:09:09Z",
        "paymentMethodType": "payme",
        "url": "https://qr.payme.hsbc.com.hk/...",
        "method": "GET",
        "type": "redirect"
    }
}

Handle the redirect

1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

   When using the HTTP GET method:
   For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

3. In the response note the following:

   • resultCode: use this to present the result to your shopper.
   • pspReference: our unique identifier for the transaction.