# Hong Kong FPS QR {#pm_hk_qr} An article about the payment method which allows you to process payments in Hong Kong dollars and Chinese yuan by using bank accounts in Hong Kong and supports purchases. **Parent topic:**[QR code payments](en_pm_qr.md) ## Overview {#en_pm_hk_qr_overview} An article about the payment method which allows you to process payments in Hong Kong dollars and Chinese yuan by using bank accounts in Hong Kong and supports purchases. ### Introduction {#section_t5z_rlg_ytb .section} Hong Kong FPS QR is a payment method which allows you to process payments in Hong Kong dollars and Chinese yuan by using bank accounts in Hong Kong. Various applications that support the [QRIS](https://qris.id/homepage) \(Quick Response Code Indonesian Standard\) standard can be used to work with this method.This method supports purchases. This article provides information about working with the Hong Kong FPS QR method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow. ### General information {#section_tbf_2zk_ggb .section} |Payment method type|QR code payments| |Payment instruments|bank accounts| |Countries and regions|[HK](references/en/countries/HK.md)| |Payment currencies|[HKD](references/en/currencies/HKD.md), [CNY](references/en/currencies/CNY.md)| |Currency conversion|–| |One-time purchases|+| |Credential-on-file purchases|–| |Full refunds|–| |Partial refunds|–| |Payouts|–| |Chargebacks|–| |Special considerations|–| |Obtaining access to the payment method and access fee|refer to your Ecommpay key account manager| ### Interaction diagram {#section_tsp_gzk_ggb .section} Payment processing by using the Hong Kong FPS QR method involves the merchant's web service, one of Ecommpay interfaces, the Ecommpay payment platform, and technical facilities of the provider service. ![](images/pm/eng_hk_qr_functional.svg) ### Operations support {#section_rnx_4cl_ggb .section} Various platform interfaces can be used to process payments and perform operations using the Hong Kong FPS QR method. Purchases can be processed by using Payment Page, Gate and Dashboard \(using payment links\). At the same time, regardless of the interfaces used, the following limitations are applicable. | |Amounts, [HKD](references/en/currencies/HKD.md)| |minimum|maximum| |--|-----------------------------------------------| |-------|-------| |Purchases|–|10,000.00| ### Processing scenarios {#section_fgt_sdl_ggb .section} To perform a purchase by using the Hong Kong FPS QR method, the customer needs to scan a QR code by using a mobile banking application. The customer payment scenario via Payment Page \(in the basic case where the customer chooses the method and is redirected from the final page of the payment form to the web service\) looks like this. ![](images/pm/pp_scenario/en_pp_customer_scenario_fpsqr_1.svg "Proceeding to payment") ![](images/pm/pp_scenario/en_pp_customer_scenario_fpsqr_2.svg "Selecting method") ![](images/pm/pp_scenario/en_pp_customer_scenario_fpsqr_3.svg "Receiving instructions") ![](images/pm/pp_scenario/en_pp_customer_scenario_fpsqr_4.svg "Paying according to instructions") ![](images/pm/pp_scenario/en_pp_customer_scenario_fpsqr_5.svg "Redirecting to the payment form") ![](images/pm/pp_scenario/en_pp_customer_scenario_fpsqr_6.svg "Redirecting to the web service") General scenarios of processing purchases can be presented as follows. ![](images/pm/eng_hk_qr_interfaces_pp.svg "Purchase by using Payment Page") ![](images/pm/eng_hk_qr_interfaces_gate.svg "Purchase by using Gate") Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features \(such as payment links\) are used, scenarios for performing operations also correspond to the specifics of those features. ## Purchases by using Payment Page {#en_pm_hk_qr_pp_purchase} ### General information {#section_gtg_vxk_m2b .section} To process a purchase through Payment Pageby using the Hong Kong FPS QR method, the merchant's web service is required to send a request with all required parameters and signature to the Ecommpay URL and receive a callback with the result.The full sequence and special aspects of purchase processing are provided below. ![](images/pm/eng_hk_qr_uml_pp.svg) 1. A customer initiates a purchase in the web service. 2. The web service sends the request for opening Payment Page to the specified Ecommpay URL. 3. The request for opening Payment Page is sent to the payment platform. 4. The payment platform receives the request and validates the required parameters and signature. 5. Payment Page is generated based on the project and request parameters. 6. Payment Page is displayed to the customer. 7. The customer selects the Hong Kong FPS QR method. 8. The request for processing the payment by using the Hong Kong FPS QR method is received by the payment platform. 9. The payment platform processes the request. 10. The data for displaying the payment instructions is sent from the payment platform to Payment Page. 11. The payment instructions are displayed to the customer. 12. The customer completes all required payment steps. 13. The purchase is processed in the provider service. 14. The provider service sends a notification about the result to the payment platform. 15. The payment platform sends the payment result callback to the web service. 16. The payment platform sends the result information to Payment Page. 17. The result information is displayed to the customer on Payment Page. Information about the formats of requests and callbacks used for processing payments by using the Hong Kong FPS QR method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in [Interaction concepts](en_pp_interaction_organisation.md). ### Request format {#section_p5j_fgl_ggb .section} There are several things you need to consider when using the Hong Kong FPS QR method: 1. The following parameters required for any payment must be specified: - `project_id`—project identifier obtained from Ecommpay during integration - `payment_id`—payment identifier unique within the project - `payment_currency`—payment currency code in the ISO-4217 alpha-3 format - `payment_amount`—payment amount in the smallest currency unit - `customer_id`—customer identifier unique within the project 2. The currency of payment can only be [HKD](references/en/currencies/HKD.md) or [CNY](references/en/currencies/CNY.md). 3. If you need to have the payment form displayed with the Hong Kong FPS QR method selected, set the `force_payment_method` parameter to `hk-qr`. 4. Additionally, any other parameters available for working with Payment Page can be used \([details](en_PP_Parameters.md)\). 5. After all target parameters are specified, generate a signature \([details](en_platform_signature.md)\). Thus, a correct request for opening the payment form using the Hong Kong FPS QR method must contain the project identifier, basic payment information \(identifier, amount, and currency code\), customer identifier and signature. ```language-json { "project_id": 120, "payment_id": "580", "payment_amount": 1000, "payment_currency": "HKD", "customer_id": "customer1", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" } ``` ```language-json { "project_id": 120, "payment_id": "580", "payment_amount": 1000, "payment_currency": "HKD", "customer_id": "customer1", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" } ``` ### Callback format {#section_dpx_2hl_ggb .section} The Hong Kong FPS QR method uses the standard format for callbacks to deliver purchase results. For more information, see [Handling callbacks](en_platform_callbacks.md). The following is the example of a callback with information about a `100.00 HKD` purchase made in the `123` project. ```language-json { "project_id": 123, "payment": { "id": "123123123", "type": "purchase", "status": "success", "date": "2021-04-26T08:40:29+0000", "method": "hk-qr", "sum": { "amount": 10000, "currency": "HKD" }, "description": "" }, "customer": { "id": "customer1" }, "operation": { "id": 5205000010711, "type": "sale", "status": "success", "date": "2021-04-26T08:40:29+0000", "created_date": "2021-04-26T08:39:53+0000", "request_id": "23fdebfc248b0676209a5e0694487738a...08525", "sum_initial": { "amount": 10000, "currency": "HKD" }, "sum_converted": { "amount": 10000, "currency": "HKD" }, "code": "0", "message": "Success", "provider": { "id": 5161, "payment_id": "", "auth_code": "" } }, "signature": "Dj2MN6VS9yDGrRAnJ5sMRnr/J4C7FPOl8...nLN08qIVqFA7pTlw==" } } ``` The following is the example of a callback with information about a declined purchase. ```language-json { "project_id": 0123, "payment": { "id": "12341234", "type": "purchase", "status": "decline", "date": "2021-04-26T08:40:29+0000", "method": "hk-qr", "sum": { "amount": 10000, "currency": "HKD" }, "description": "" }, "customer": { "id": "customer1" }, "operation": { "id": 4991000010711, "type": "sale", "status": "decline", "date": "2021-04-26T08:40:29+0000", "created_date": "2021-04-26T08:39:53+0000", "request_id": "3d12732e00fb397dbe99ad866e05ecfc...004992", "sum_initial": { "amount": 10000, "currency": "HKD" }, "sum_converted": { "amount": 10000, "currency": "HKD" }, "code": "20000", "message": "General decline", "provider": { "id": 5161, "payment_id": "", "auth_code": "" } }, "signature": "LbcKUUDELHz8wxx56WCT0T/W00cC6rEAXax7u1kORhK32...wYqSekS6Kg==" } } ``` ### Useful links {#section_xpz_thl_ggb .section} The following articles can be useful when implementing purchases via Payment Page: - [Interaction concepts](en_pp_interaction_organisation.md)—about the interaction with the payment platform by using Payment Page. - [Signature generation and verification](en_platform_signature.md)—about the procedure of generating and verifying signatures in requests and callbacks. - [Payment processing](en_platform_payment_model.md)—about the types, processing models, and possible statuses of supported payments and operations. - [One-time one-step purchase](en_platform_sms_model.md)—about processing of one-time one-step purchases by using Payment Page. - [Handling operation processing information](en_platform_payment_info_codes.md)—about error and response codes that are used in the payment platform to record information about performing of operations. ## Purchases by using Gate {#en_pm_hk_qr_gate_purchase} ### General information {#section_lsx_3jl_ggb .section} To process a purchase through Gate by using the Hong Kong FPS QR method, the merchant's web service is required to do the following: 1. Send a request with all the required parameters and signature to the Ecommpay URL. 2. Receive an intermediate callback from the payment platform and display the payment instructions to the customer. 3. Receive the final callback from the payment platform. The full sequence and special aspects of purchase processing are provided below. ![](images/pm/eng_hk_qr_uml_gate.svg) 1. A customer initiates a purchase by using the Hong Kong FPS QR method in the web service. 2. The web service sends the request for processing the purchase by using Gate to the specified Ecommpay URL. 3. The payment platform receives the request. 4. The payment platform validates the required parameters and signature in the request. 5. The payment platform sends the response to the web service with information about the receipt of the request and its validity \([details](en_gate_interaction_organisation.md)\). 6. The payment platform performs further processing of the request \(with parameter consistency check\). 7. The data for displaying the payment instructions is sent from the payment platform to the web service. 8. The payment instructions are displayed to the customer. 9. The customer completes all required payment steps. 10. The purchase is processed in the provider service. 11. The provider service sends the payment result notification to the payment platform. 12. The payment platform sends the payment result callback to the web service. 13. The customer receives the payment result information from the web service. Information about the formats of requests and callbacks used for processing payments by using the Hong Kong FPS QR method via Gate is presented further in this section. General information about working with the Gate API is presented in [Interaction concepts](en_gate_interaction_organisation.md). ### Request format {#section_osx_3jl_ggb .section} There are several things you need to consider when sending purchase requests by using the Hong Kong FPS QR method: 1. To initiate each purchase, send a separate POST request to the `/v2/payment/banks/hk-qr/sale` endpoint. This endpoint belongs to the group [/v2/payment/banks/\{payment\_method\}/sale](https://api-developers.ecommpay.com/api-specification/banks/post-v2-payment-banks-payment-method-sale). 2. Each request must include the following objects and parameters: - Object `general`—general purchase information: - `project_id`—project identifierobtained from Ecommpay during integration - `payment_id`—payment identifierunique within the project - `signature`—request signaturegenerated after all required parameters are specified \(details—in the [Signature generation and verification](en_platform_signature.md)\) - Object `payment`—payment information: - `amount`—payment amount in the smallest currency unit - `currency`—payment currency codein the ISO-4217 alpha-3 format - Object `customer`—customer information: - `id`—customer identifierunique within the project - `ip_address`—customer IP addressrelevant for the initiated payment 3. The currency of payment can only be [HKD](references/en/currencies/HKD.md) or [CNY](references/en/currencies/CNY.md). 4. Additionally, any other parameters included in the specification can be used. Thus, a correct purchase request by using the Hong Kong FPS QR method must contain the project identifier, basic payment information \(identifier, amount, and currency code\), customer identifier and IP address, as well as signature. ```language-json { "general": { "project_id": 383000, "payment_id": "abc123456", "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAaQlYc9...xI5vOA7w==" }, "customer": { "ip_address": "192.0.2.0", "id": "123" }, "payment": { "amount": 10000, "currency": "HKD" } } ``` ```language-json { "general": { "project_id": 383000, "payment_id": "abc123456", "signature": "GINgwlggTvpF9AnkT8rUUVC7bmSCAaQlYc9...xI5vOA7w==" }, "customer": { "ip_address": "192.0.2.0", "id": "123" }, "payment": { "amount": 10000, "currency": "HKD" } } ``` ### Formats of intermediate callbacks containing data for displaying payment instructions {#section_eqw_zbz_r4b .section} To display the payment instructions to the customer, you must receive and process a callback from the payment platform containing the payment data in the in the `display_data` array and display the customer the payment instructions to the customer. Along with the payment instructions, it is recommended to display to the customer the information about the expiration date for performing the required steps. If the customer does not confirm the payment prior to expiration of the spectified time, an error message is displayed. The payment instructions to be displayed to the customer are provided below. |Payment instructions in Traditional Chinese|Payment instructions in English| |-------------------------------------------|-------------------------------| |二維碼有效期|QR code expiration date| |請下載二維碼並在網上銀行應用程序的二維碼掃描功能中使用|Please download the QR code and use it in the QR scan function of your online banking application| |此二維碼僅供一次性掃描|For one-time use only| The array `display_data` contains the following parameters: - `type`—data type \(the value is always `qr_data`\) - `title`—title of the data which needs to be displayed to the customer \(the value is always `QR code`\) - `data`—string which contains the coded image of the QR code. The following is the callback fragment containing the payment data. ```language-json "display_data": [ { "type": "qr_data", "title": "QR code", "data": "1213323442...523521424" } ] ``` ### Final callback format {#section_wsx_3jl_ggb .section} The Hong Kong FPS QR method uses the standard format for callbacks to deliver purchase results. For more information, see [Handling callbacks](en_platform_callbacks.md). The following is the example of a callback with information about a `100.00 HKD` purchase made in the `456` project. ```language-json { "project_id": 456, "payment": { "id": "123123123", "type": "purchase", "status": "success", "date": "2021-04-26T08:40:29+0000", "method": "hk-qr", "sum": { "amount": 10000, "currency": "HKD" }, "description": "" }, "customer": { "id": "customer1" }, "operation": { "id": 5205000010711, "type": "sale", "status": "success", "date": "2021-04-26T08:40:29+0000", "created_date": "2021-04-26T08:39:53+0000", "request_id": "23fdebfc248b0676209a5e0694487738a...08525", "sum_initial": { "amount": 10000, "currency": "HKD" }, "sum_converted": { "amount": 10000, "currency": "HKD" }, "code": "0", "message": "Success", "provider": { "id": 5161, "payment_id": "", "auth_code": "" } }, "signature": "Dj2MN6VS9yDGrRAnJ5sMRnr/J4C7FPOl8...nLN08qIVqFA7pTlw==" } } ``` The following is the example of a callback with information about a declined purchase. ```language-json { "project_id": 0123, "payment": { "id": "12341234", "type": "purchase", "status": "decline", "date": "2021-04-26T08:40:29+0000", "method": "hk-qr", "sum": { "amount": 10000, "currency": "HKD" }, "description": "" }, "customer": { "id": "customer1" }, "operation": { "id": 4991000010711, "type": "sale", "status": "decline", "date": "2021-04-26T08:40:29+0000", "created_date": "2021-04-26T08:39:53+0000", "request_id": "3d12732e00fb397dbe99ad866e05ecfc...004992", "sum_initial": { "amount": 10000, "currency": "HKD" }, "sum_converted": { "amount": 10000, "currency": "HKD" }, "code": "20000", "message": "General decline", "provider": { "id": 5161, "payment_id": "", "auth_code": "" } }, "signature": "LbcKUUDELHz8wxx56WCT0T/W00cC6rEAXax7u1kORhK32...wYqSekS6Kg==" } } ``` ### Useful links {#section_xsx_3jl_ggb .section} The following articles can be useful when implementing purchases via Gate: - [Interaction concepts](en_gate_interaction_organisation.md)—about the interaction with the payment platform by using Gate. - [Signature generation and verification](en_platform_signature.md)—about the procedure of generating and verifying signatures in requests and callbacks. - [Payment processing](en_platform_payment_model.md)—about the types, processing models, and possible statuses of supported payments and operations. - [One-time one-step purchase](en_platform_sms_model.md)—about processing of one-time one-step purchases by using Gate. - [Handling operation processing information](en_platform_payment_info_codes.md)—about error and response codes that are used in the payment platform to record information about performing of operations. ## Analysis of payment results {#en_pm_hk_qr_dash_analysis} To analyse information about payments made with the Hong Kong FPS QR method and other methods, you can use: - Dashboardinterface toolkitwith various lists and analytic panels. - Reports in CSV file format, available via the **Reports** section \(one-time and periodically\). - Data in JSON format, sent by program requests to a specified URL by using the Data API interface. If you have any questions, refer to the documentation \([Dashboard](en_dbl_about.md) and [Using Data API](en_dbl_api_protocol.md)\) and Ecommpay technical support.