PayMe Redirect Component

Use our Redirect Component to handle the redirect to the PayMe app. When adding PayMe to your existing Components integration, you also need to:

1. Show PayMe in your payment form.
2. Handle the redirect result when the shopper returns to your app.

Before you begin

This page explains how to add PayMe to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your PayMe integration:

1. Make sure that you have set up your back end implementation for making API requests.
2. Add PayMe in your test Customer Area.

Show PayMe in your payment form

Include PayMe in the list of available payment methods.

1. Specify in your /paymentMethods request:

   • countryCode: HK.
   • amount.currency: HKD.

The response contains paymentMethod.type: payme.

Make a payment

1. When the shopper selects the button to pay, make a /payments request, specifying:

Parameter name	Required	Description
paymentMethod.type		payme
returnURL		The URL to redirect the shopper back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).
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.
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.

The /payments response contains:

• action: Object containing information about the redirect.

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

1. Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

1. Use the Redirect Component to redirect the shopper to PayMe.

2. After the shopper returns to your app, make a POST /payments/details request from your server, providing:

   • details: The actionComponentData.details object from the Redirect Component.

You receive a response containing:

• resultCode: Use this to present the payment result to your shopper.
• pspReference: Our unique identifier for the transaction.

See the Android Components integration guide to get the payment outcome and show your shopper the result of the payment.

Test and go live

Use the PayMe sandbox to test your integration. You do not need to use the PayMe app to test using the sandbox.

Use the amounts specified below to simulate different payment outcomes.

Amount ending in	Result	Description
81	Authorised	Successful payment.
77	OfferCancelled	The payment request expired after PayMe's default expiry time of ten minutes.
44	Error	There was an error when creating the payment request.

See also