# QR Ph {#pm_qrph} An article about the payment method which allows you to process payments in Philippine pesos by using bank accounts and e-wallets in the Philippines and supports purchases. **Parent topic:**[QR code payments](en_pm_qr.md) ## Overview {#en_pm_qrph_overview} An article about the payment method which allows you to process payments in Philippine pesos by using bank accounts and e-wallets in the Philippines and supports purchases. ### Introduction {#section_t5z_rlg_ytb .section} QR Ph is a payment method which allows you to process payments in Philippine pesos by using bank accounts and e-wallets in the Philippines.This method supports purchases. This article provides information about working with the QR Ph 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 - digital wallets | |Countries and regions|[PH](references/en/countries/PH.md)| |Payment currencies|[PHP](references/en/currencies/PHP.md)| |Currency conversion|on the Ecommpay side| |One-time purchases|+| |Credential-on-file purchases|–| |Full refunds|–| |Partial refunds|–| |Payouts|–| |Chargebacks|–| |Notes|–| |Onboarding and access fee|refer to your Ecommpay account manager| ### Interaction diagram {#section_tsp_gzk_ggb .section} Payment processing by using the QR Ph method involves the merchant's web service, one of Ecommpay interfaces, the Ecommpay payment platform, and technical facilities of the provider service. ![](images/pm/en_qrph_functional.svg) ### Operations support {#section_rn_4cl_ggb .section} Various platform interfaces can be used to process payments and perform operations using the QR Ph 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 amount of a single purchase can be 100.00 PHP minimum and 50,000.00 PHP maximum. For more information about limitations on purchase amounts, refer to your Ecommpay account manager. ### Processing scenarios {#section_fgt_sdl_ggb .section} To perform a purchase by using the QR Ph method, the customer needs to scan a QR code via a mobile 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_qrph_1.svg "Proceeding to payment") ![](images/pm/pp_scenario/en_pp_customer_scenario_qrph_2.svg "Selecting method") ![](images/pm/pp_scenario/en_pp_customer_scenario_qrph_3.svg "Receiving instructions") ![](images/pm/pp_scenario/en_pp_customer_scenario_qrph_4.svg "Paying according to instructions") ![](images/pm/pp_scenario/en_pp_customer_scenario_qrph_5.svg "Redirecting to the payment form") ![](images/pm/pp_scenario/en_pp_customer_scenario_qrph_6.svg "Redirecting to the web service") General scenarios of processing purchases can be presented as follows. ![](images/pm/en_qrph_interfaces_pp.svg "Purchase by using Payment Page") ![](images/pm/en_qrph_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_qrph_pp_purchase} ### General information {#section_gtg_vxk_m2b .section} To process a purchase through Payment Pageby using the QR Ph 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/en_qrph_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 QR Ph method. 8. The request for processing the payment by using the QR Ph method is received by the payment platform. 9. The payment platform processes the request and sends it to the provider service. 10. The request is processed on the side of the provider service. 11. The data for displaying a QR code to the customer is generated in the provider service and sent to the payment platform. 12. The data for displaying the QR code is sent from the payment platform to Payment Page. 13. The QR code and payment instructions are displayed to the customer. 14. The customer completes all required payment steps. 15. The purchase is processed in the provider service. 16. The provider service sends a notification about the result to the payment platform. 17. The payment platform sends the payment result callback to the web service. 18. The payment platform sends the result information to Payment Page. 19. 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 QR Ph 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 sending purchase requests by using the QR Ph 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 Depending on the payment processing provider, other parameters may be required in the purchase requests\(such as `customer_first_name`, `customer_last_name`, and `customer_email`\). For more informationabout potentially required parameters, contact your Ecommpay account manager. 2. If you need to have the payment form displayed with the QR Ph method selected, set the `force_payment_method` parameter to `ph-qr`. 3. Additionally, any other parameters available for working with Payment Page can be used \([details](en_PP_Parameters.md)\). 4. 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 QR Ph 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": 1000000, "payment_currency": "PHP", "customer_id": "customer1", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" } ``` ```language-json { "project_id": 120, "payment_id": "580", "payment_amount": 1000000, "payment_currency": "PHP", "customer_id": "customer1", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" } ``` ### Callback format {#section_dpx_2hl_ggb .section} The QR Ph 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 `10,000.00 PHP` purchase made by the `customer_123` customer in the `1234` project. ```language-json { "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "success", "date": "2022-03-25T11:08:45+0000", "method": "QRPH", "sum": { "amount": 1000000, "currency": "PHP" }, "description": "" }, "customer": { "id": "customer_123" }, "operation": { "id": 28, "type": "sale", "status": "success", "date": "2022-03-25T11:08:45+0000", "created_date": "2022-03-25T11:08:05+0000", "request_id": "9e32835fb27907e0b08569d7d336c5117242b5cf60a4e17839", "sum_initial": { "amount": 1000000, "currency": "PHP" }, "sum_converted": { "amount": 1000000, "currency": "PHP" }, "code": "0", "message": "Success", "provider": { "id": 00000, "payment_id": "123abc123-321", "auth_code": "" } }, "signature": "U7HQO7ToISZhMPKdM4Xr4DScs9CRd4xeYG2Q==" } ``` The following is the example of a callback with information about a declined purchase. ```language-json { "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "decline", "date": "2022-03-25T11:20:30+0000", "method": "QRPH", "sum": { "amount": 1000000, "currency": "PHP" }, "description": "" }, "customer": { "id": "customer_123" }, "operation": { "id": 31, "type": "sale", "status": "decline", "date": "2022-03-25T11:20:30+0000", "created_date": "2022-03-25T11:19:53+0000", "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb", "sum_initial": { "amount": 1000000, "currency": "PHP" }, "sum_converted": { "amount": 1000000, "currency": "PHP" }, "code": "20000", "message": "General decline", "provider": { "id": 00000, "payment_id": "0cf4215c-8978", "auth_code": "" } }, "signature": "J7W15rkqrLzTCD4HkoM4qoEnl4z2iFYv58P4VnHANu445/jmY+g==" } ``` ### 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_qrph_gate_purchase} ### General information {#section_lsx_3jl_ggb .section} To process a purchase through Gate by using the QR Ph 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 a QR code and 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/en_qrph_uml_gate.svg) 1. A customer initiates a purchase by using the QR Ph 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\) and sends it to the provider service. 7. The request is processed on the side of the provider service. 8. The data for displaying a QR code to the customer is sent from the provider service to the payment platform. 9. The data for displaying the QR code is sent from the payment platform to the web service. 10. The QR code and payment instructions are displayed to the customer. 11. The customer completes all required payment steps. 12. The purchase is processed in the provider service. 13. The provider service sends the payment result notification to the payment platform. 14. The payment platform sends the payment result callback to the web service. 15. 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 QR Ph 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 QR Ph method: 1. To initiate each purchase, send a separate POST request to the `/v2/payment/qr/ph-qr/sale` endpoint. 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 Depending on the payment processing provider, other parameters may be required in the purchase requests\(such as the parameters for specifying the customer's first and last names and email address\). For more informationabout potentially required parameters, contact your Ecommpay account manager. 3. Additionally, any other parameters included in the specification can be used. Thus, a correct purchase request by using the QR Ph method must contain the project identifier, basic payment information \(identifier, amount, and currency code\), customer identifier and IP address and the signature. ```language-json { "general": { "project_id": 210, "payment_id": "test_payment", "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA==" }, "payment": { "amount": 1000000, "currency": "PHP" }, "customer": { "id": "customer123", "ip_address": "192.0.2.0" } } ``` ```language-json { "general": { "project_id": 210, "payment_id": "test_payment", "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA==" }, "payment": { "amount": 1000000, "currency": "PHP" }, "customer": { "id": "customer123", "ip_address": "192.0.2.0" } } ``` ### Formats of intermediate callbacks for displaying QR codes to customers {#section_g1g_n3f_45b .section} Each payment made with the QR Ph method requires displaying QR codes to customers. To display QR codes it is necessary to receive an intermediate callback from the payment platform and use the information included in the `display_data` array. The format of such callbacks is standard \([details](en_platform_callbacks.md)\), and the following objects and parameters are included in the `display_data` array: - `type`—type of data \(the value is always `qr_img`\) - `title`—the name of the transferred data that needs to be displayed to the customer \(the value is always `qr_img`\) - `data`—a string based on which a QR code should be generated on the web service side \(according to [ISO/IEC 18004:2015](https://www.iso.org/standard/62021.html)\) ```language-json "display_data": [ { "type": "qr_img", "title": "qr_img", "data": "data:image\/png;base64,iVB..." } ] ``` ### Final callback format {#section_dpx_2hl_ggb .section} The QR Ph 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 `10,000.00 PHP` purchase made by the `customer_123` customer in the `1234` project. ```language-json { "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "success", "date": "2022-03-25T11:08:45+0000", "method": "QRPH", "sum": { "amount": 1000000, "currency": "PHP" }, "description": "" }, "customer": { "id": "customer_123" }, "operation": { "id": 28, "type": "sale", "status": "success", "date": "2022-03-25T11:08:45+0000", "created_date": "2022-03-25T11:08:05+0000", "request_id": "9e32835fb27907e0b0856e336c5117242b5cf60a4e17839", "sum_initial": { "amount": 1000000, "currency": "PHP" }, "sum_converted": { "amount": 1000000, "currency": "PHP" }, "code": "0", "message": "Success", "provider": { "id": 00000, "payment_id": "123abc123-321", "auth_code": "" } }, "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2toYzFvoB3cs9CRd4xeYG2Q==" } ``` The following is the example of a callback with information about a declined purchase. ```language-json { "project_id": 1234, "payment": { "id": "payment_47", "type": "purchase", "status": "decline", "date": "2022-03-25T11:20:30+0000", "method": "QRPH", "sum": { "amount": 1000000, "currency": "PHP" }, "description": "" }, "customer": { "id": "customer_123" }, "operation": { "id": 31, "type": "sale", "status": "decline", "date": "2022-03-25T11:20:30+0000", "created_date": "2022-03-25T11:19:53+0000", "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb", "sum_initial": { "amount": 1000000, "currency": "PHP" }, "sum_converted": { "amount": 1000000, "currency": "PHP" }, "code": "20000", "message": "General decline", "provider": { "id": 00000, "payment_id": "0cf4215c-8978", "auth_code": "" } }, "signature": "J7W15rkqrLzTCD4HkoM4qom8C4z2iFYv58P4VnHANu445/jmY+g==" } ``` ### 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_qrph_dash_analysis} To analyse information about payments made with the QR Ph 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.