Currently API integration for non-HSBC Business Internet Banking Customers is not supported. We are currently working on this, so please stay tuned!

Please kindly contact your integration manager

As a prerequisite to access PayMe APIs, you must open a PayMe for Business account. Once you have your account, you will need to register your interest via PayMe for Business app following the steps outlined in our sign-up section.

At the start of your integration journey with us, we will provide you with sandbox testing credentials only. Provided the integration is successfully completed and testing evidence is satisfactory, our PayMe Developer Support Team will provide you with the Production API credentials for live transactions.

A set of API credentials is valid for 1 year from the date of creation, after which they will expire.

Yes, you can. We will send you reminders via email 3 months prior to the expiry date and then additional reminders will be sent every 2 weeks. To receive new API credentials, you'll need to request them via your PayMe for Business app.

Go to Help centre > Send an enquiry and select Online Payments as the topic. Input your request for renewing credentials and submit.

Once submitted, our PayMe Developers Support Team will share your new credentials via the usual process. This may take up to two working days.

The maximum number of ACTIVE API credential sets you can have at any point in time is 5.

Configuration files can be downloaded in the Postman collection & Swagger API sub-section.

Yes. It is highly recommended that you add your business logo to the QR Code (PayCode). When registering your PayMe for Business account via our mobile app, you can provide your business logo to us.

The design on your business logo is at your own discretion. PayMe returns the images of the logos in 5 different sizes: tiny (40x40 pixels), small (60x60 pixels), normal (300x300 pixels), large (600x600 pixels) and full. Details can be found in Creating a payment request sub-section.

Webhook is the primary source of receiving payment notifications. Webhooks are HTTP callbacks that provide your applications with a way to receive notifications from an endpoint. PayMe gateway will send payment request status to Webhook notification endpoint (specified in payment request) when the payment request is completed successfully or failed.

If no notification message is received within 60 seconds, then we suggest you could start polling for payment status update. It is recommended to poll no more than once every 10 seconds.

For more details, please refer the Webhooks sub-section.

A dedicated error code and subsequent handling section is available for your reference in Errors & troubleshoot sub-section.

Issuing a new access token will not trigger deactivation of another token as long as both are within the expiry date & time. However, we recommend re-using the token as much as possible, and not request a new token for each API request.

When you call our API with an invalid or expired token, error message of “Error validating JWT” will be returned.

Every time when you create a payment, a suggested way is to check if the token has expired or not. If it is valid, you can use the same token to make the payment. If it has expired, then you can call the get token API to obtain a new access token.

Yes. Please refer the API integration testing section for more details.

For the test cases that do not apply to your product, please mark them as "Won't Do" and share it back with us. We will validate the necessity of the test cases and get back to you in case we have questions.

It is not mandatory to test scenarios involving the refund and transaction reporting API if you have no plan to use them. For any support or advice regarding PayMe APIs, please contact your integration manager.

The PayMe payment experience is based on QR code, or, using our terminology, PayCode. The customer will scan the PayCode using the PayMe application to retrieve payment details (desktop journey) or a deep link into the PayMe application (mobile journey) to authorize the payment.

AppLink is the link to jump from your mobile app to PayMe mobile app for customer to continue the payment. WebLink is the link to handle payment on desktop. Embedding this link into PayCode will create a PayMe QR code for customer to complete the payment.

QR code is registered trademark of DENSO WAVE INCORPORATED

PayMe only support universal link. So there is no need to whitelist universal link to perform app switch. When payment is requested, the universal link is returned to direct customer to PayMe mobile app. You will need to provide us with a universal link in appSuccessCallback and appFailCalback to switch back to your application upon payment success or failure.

This is testable on production environment only.

The “Trace-Id” in our API request header follows universally unique identifier (UUID) format i.e. length 32 digits representing 128-bit. An error will be thrown if consumed otherwise. The UUID can be generated using the open source library that matches with the programming language. You can also refer to the Message signing section for more details on Signature HTTP header.

Yes, transactionId is a unique identifier generated by PayMe for each transaction. All refund transaction IDs indicate completed fund.

You can call the transaction list API to list the details of transactions within a time range and check for the existence of a refund.

You can set your internal refund ID in "reference" field of the postRefund API, and check if there is a refund that matches with your internal refund ID using getTransaction API.

In practice, we highly recommend you to use Webhook as a primary source of notification. If no Webhook notification is received within 60 seconds, then you can start polling in 10 seconds intervals.

On Transaction Type:
003 - Purchase (consumer to merchant)
004 - Refund (merchant to consumer)
006 - Fund Out
014 - Adjustment (operational adjustment to handle error/loss)

On Transaction Status Code:
001 - Success
002 - Failure
003 - Submitted

Please refer the Asset Library sub-section of Design Guidelines for the PayMe logos that can be used.

You can use any background color scheme for your checkout page. However, you should follow our Design Guidelines when displaying PayMe logo and payment option on your website.

PayMe QR code can be generated with PayMe Styling module using code sample in our Asset Library.

You can find the pricing in our PayMe public website.

Please refer to Access PayMe APIs.

Please refer to Message signing >> Digest Header subsection for more information on troubleshooting.