# Maya {#pm_maya} **Parent topic:**[Digital wallet payments](en_pm_ewallet.md) ## Overview {#en_pm_maya_overview} An article about the payment method which allows you to process payments in Philippine pesos by using e-wallets in the Philippines and supports purchases and payouts. ### Introduction {#section_t5z_rlg_ytb .section} Maya \(PayMaya\) is a payment method which allows you to process payments in Philippine pesos in the Philippines.This method supports purchasesand payouts. This article provides information about working with the Maya 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|digital wallet payments| |Payment instruments|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 key account manager| ### Interaction diagram {#section_tsp_gzk_ggb .section} Payment processing by using the Maya method involves the merchant's web service, one of Ecommpay interfaces, the Ecommpay payment platform, and technical facilities of the Maya service. ![](images/pm/en_maya_functional.svg) ### Operations support {#section_rnx_4cl_ggb .section} Various platform interfaces can be used to process payments and perform operations using the Maya method. Purchases can be processed by using Payment Page, Gate and Dashboard \(using payment links\), payouts—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following limitations are applicable. | |Amounts, [PHP](references/en/currencies/PHP.md)¹| |minimum|maximum| |--|------------------------------------------------| |-------|-------| |Purchases|\*|\*| |Payouts|\*|\*| **Note:** 1. Refer to your Ecommpay key account manager for information. ### Processing scenarios {#section_fgt_sdl_ggb .section} To perform a purchase by using the Maya method, you need to redirect customer to the Maya service, while to initiate a payout, you need to notify the customer via the web service. The customer payment scenario via Payment Page looks like this. ![](images/ecommpay/pm_pp_scenario/en_pp_customer_scenario_maya_1.svg "Proceeding to payment") ![](images/ecommpay/pm_pp_scenario/en_pp_customer_scenario_maya_2.svg "Selecting method") ![](images/ecommpay/pm_pp_scenario/en_pp_customer_scenario_maya_3.svg "Authentication") ![](images/ecommpay/pm_pp_scenario/en_pp_customer_scenario_maya_4.svg "Confirming payment") ![](images/ecommpay/pm_pp_scenario/en_pp_customer_scenario_maya_5.svg "Redirecting to the payment form") ![](images/ecommpay/pm_pp_scenario/en_pp_customer_scenario_maya_6.svg "Redirecting to the web service") General scenarios of processing purchasesand payouts can be presented as follows. ![](images/pm/en_maya_interfaces_pp.svg "Purchase by using Payment Page") ![](images/pm/en_maya_interfaces_gate.svg "Purchase by using Gate") ![](images/pm/en_maya_interfaces_gate_payout.svg "Payout 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_maya_pp_purchase} ### General information {#section_gtg_vxk_m2b .section} To process a purchase through Payment Pageby using the Maya 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_maya_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 Maya method. 8. The payment platform receives the request for processing the payment by using the Maya method. 9. The payment platform processes the request and sends it to the Maya service. 10. The request is processed on the Maya service side. 11. The data for redirecting the customer to the Maya service is sent from the Maya service to the payment platform. 12. The data for redirecting the customer is sent from the payment platform to Payment Page. 13. The customer is redirected to the Maya service. 14. The customer completes all required payment steps. 15. The purchase is processed on the in the Maya service. 16. The result information is displayed to the customer in the Maya service. 17. The customer is redirected to Payment Page. 18. The Maya service sends a notification about the result to the payment platform. 19. The payment platform sends the payment result callback to the web service. 20. The payment platform sends the result information to Payment Page. 21. 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 Maya 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 Maya 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. Additionally, depending on the provider, it may be necessary to specify the email address of the customer in the `customer_email` parameter. Refer to your Ecommpay key account manager for more information. 3. If you need to have the payment form displayed with the Maya method selected, set the `force_payment_method` parameter to `paymaya-wallet`. 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 Maya method must contain the project identifier, basic payment information \(identifier, amount, and currency code\), customer identifier, signature and customer email \(if necessary\). ```language-json { "project_id": 120, "payment_id": "580", "payment_amount": 1000, "payment_currency": "PHP", "customer_id": "customer1", "customer_email": "customer@example.com", "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg==" } ``` ### Callback format {#section_dpx_2hl_ggb .section} The Maya 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 an information about a `10.00 PHP` purchase in the `239` project. ```language-json { "project_id": 239, "payment": { "id": "EPfa87-bcfd", "type": "purchase", "status": "success", "date": "2020-03-06T14:11:00+0000", "method": "PayMaya wallet", "sum": { "amount": 1000, "currency": "PHP" }, "description": "" }, "operation": { "id": 464, "type": "sale", "status": "success", "date": "2020-03-06T14:11:00+0000", "created_date": "2020-03-06T14:10:34+0000", "request_id": "f6ab99eb0940e43a774b969cb74a88ef08eec6c8951-00000001", "sum_initial": { "amount": 1000, "currency": "PHP" }, "sum_converted": { "amount": 1000, "currency": "PHP" }, "code": "0", "message": "Success", "provider": { "id": 1369, "payment_id": "7QKID3P3", "auth_code": "", "date": "2020-03-06T14:10:54+0000" } }, "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGoA==" } } ``` The following is the example of a callback for a declined purchase. ```language-json { "project_id": 239, "payment": { "id": "EPfa87-bcfc", "type": "purchase", "status": "decline", "date": "2020-03-07T14:11:00+0000", "method": "PayMaya wallet", "sum": { "amount": 200000000, "currency": "PHP" }, "description": "" }, "operation": { "id": 465, "type": "sale", "status": "decline", "date": "2020-03-07T14:11:00+0000", "created_date": "2020-03-06T14:10:34+0000", "request_id": "f6ab99eb0940e43a774b969cb74a88ef08eec6c8951-00000002", "sum_initial": { "amount": 200000000, "currency": "PHP" }, "sum_converted": { "amount": 200000000, "currency": "PHP" }, "code": "20101", "message": "Decline due to amount or frequency limit", "provider": { "id": 1369, "payment_id": "7QKID3P3", "auth_code": "", "date": "2020-03-06T14:10:54+0000" } }, "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob==" } } ``` ### 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_maya_gate_purchase} ### General information {#section_lsx_3jl_ggb .section} To process a purchase through Gate by using the Maya 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 redirect the customer to the Maya service. 3. Receive the final callback from the payment platform. The full sequence and special aspects of purchase processing are provided below. ![](images/pm/en_maya_uml_gate.svg) 1. A customer initiates a purchase by using the Maya 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 Maya service. 7. The request is processed on the Maya service side. 8. The Maya service sends the redirection data to the payment platform. 9. The payment platform sends the callback with the redirection data to the web service. 10. The customer is redirected to the Maya service. 11. The customer completes all required payment steps. 12. The purchase is processed on the side of the Maya service. 13. The result is displayed to the customer. 14. The customer is redirected to the web service. 15. The Maya service sends the payment result notification to the payment platform. 16. The payment platform sends the payment result callback to the web service. 17. 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 Maya 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 Maya method: 1. To initiate each purchase, send a separate POST request to the `v2/payment/wallet/paymaya/sale` endpoint. This is an e-wallet payments request group: [/v2/payment/wallet/\{payment\_method\}/sale](https://api-developers.ecommpay.com/api-specification/wallet/post-v2-payment-wallet-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 - Object `return_url`—contains the URLs to which customer is redirected while or after payment processing: - `success`—URL to return customer to the web service after a processed payment. - `decline`—URL to return customer to the web service after a declined payment. 3. Additionally, depending on the provider, it may be necessary to specify the email address of the customer in the `email` parameter of the `customer` object. Refer to your Ecommpay key account manager for more information. 4. Additionally, any other parameters included in the specification can be used. Thus, a correct purchase request by using the Maya method must contain the project identifier, basic payment information \(identifier, amount, and currency code\), customer identifier and IP address, signature and customer email address \(if necessary\). ```language-json { "general": { "project_id": 580, "payment_id": "test_paymaya_sale", "signature": "pgwRHcfv2OTsdILn33R5Nr/ymu08nMx/9FSeIqYHTTd6YhIiLWw==" }, "payment": { "amount": 1000, "currency": "PHP" }, "customer": { "email": "test_customer@example.com", "ip_address": "192.0.2.0", "id": "123" }, "return_url": { "success": "http://example.com/success", "decline": "http://example.com/decline" } } ``` ### Formats of intermediate callbacks for customer redirection {#section_nxg_hmn_zgb .section} Each payment made with the Maya method requires redirection of customers from the merchant's web service to the Maya service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the `redirect_data` object. The format of such callbacks is standard \([details](en_platform_callbacks.md#)\), and the following objects and parameters are included in the `redirect_data` object: - `body`—object with data to be sent in the request body - `method`—parameter specifying the HTTP method for sending the request \(`GET` or `POST`\) - `url`—parameter containing a link for redirection ```language-json "redirect_data": { "body": {}, "method": "GET", "url": "https://www.example.com/pay" } ``` ### Final cllback format {#section_wsx_3jl_ggb .section} The Maya 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 an information about a `10.00 PHP` purchase in the `239` project. ```language-json { "project_id": 239, "payment": { "id": "EPfa87-bcfd", "type": "purchase", "status": "success", "date": "2020-03-06T14:11:00+0000", "method": "PayMaya wallet", "sum": { "amount": 1000, "currency": "PHP" }, "description": "" }, "operation": { "id": 464, "type": "sale", "status": "success", "date": "2020-03-06T14:11:00+0000", "created_date": "2020-03-06T14:10:34+0000", "request_id": "f6ab99eb0940e43a774b969cb74a88ef08eec6c8951-00000001", "sum_initial": { "amount": 1000, "currency": "PHP" }, "sum_converted": { "amount": 1000, "currency": "PHP" }, "code": "0", "message": "Success", "provider": { "id": 1369, "payment_id": "7QKID3P3", "auth_code": "", "date": "2020-03-06T14:10:54+0000" } }, "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGoA==" } } ``` The following is the example of a callback for a declined purchase. ```language-json { "project_id": 239, "payment": { "id": "EPfa87-bcfc", "type": "purchase", "status": "decline", "date": "2020-03-07T14:11:00+0000", "method": "PayMaya wallet", "sum": { "amount": 200000000, "currency": "PHP" }, "description": "" }, "operation": { "id": 465, "type": "sale", "status": "decline", "date": "2020-03-07T14:11:00+0000", "created_date": "2020-03-06T14:10:34+0000", "request_id": "f6ab99eb0940e43a774b969cb74a88ef08eec6c8951-00000002", "sum_initial": { "amount": 200000000, "currency": "PHP" }, "sum_converted": { "amount": 200000000, "currency": "PHP" }, "code": "20101", "message": "Decline due to amount or frequency limit", "provider": { "id": 1369, "payment_id": "7QKID3P3", "auth_code": "", "date": "2020-03-06T14:10:54+0000" } }, "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob==" } } ``` ### 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. ## Payouts by using Gate {#en_pm_maya_gate_payout} ### General information {#section_lsx_3jl_ggb .section} To process a payout through Gateby using the Maya method, 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 payout processing are provided below. ![](images/pm/en_maya_uml_gate_payout.svg) 1. A customer initiates a payout by using the Maya method in the web service. 2. The web service sends the request for processing the payout 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 Maya service. 7. The payout is processed on the side of the Maya service. 8. The Maya service sends the result notification to the payment platform. 9. The payment platform sends the result callback to the web service. 10. The customer receives the payout result information from the web service. Information about the formats of requests and callbacks used for processing payouts by using the Maya 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 payout requests by using the Maya method: 1. To initiate each payout send a separate POST request to the `/v2/payment/wallet/paymaya/payout` endpoint. This request belongs to e-wallets request group: [/v2/payment/wallet/\{payment\_method\}/payout](https://api-developers.ecommpay.com/api-specification/wallet/post-v2-payment-wallet-payment-method-payout). 2. The following objects and parameters must be specified in any request: - Object `general`—general payout 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`—payout amount in the smallest currency unit - `currency`—payout 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 payout - Object `account`—customer account information: - `number`—account identifier, must consist of 11 digits starting with `09` - `customer_name`—full customer name 3. Additionally, any other parameters included in the specification can be used. Thus, a correct payout request by using the Maya method must contain the project identifier, basic payment information \(identifier, amount, and currency code\), customer information, as well as account number and signature. ```language-json { "general": { "project_id": 603, "payment_id": "1000003", "signature": "PJkV8ej/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV...==" }, "customer": { "id": "111232323", "ip_address": "192.0.2.0" }, "payment": { "amount": 1000, "currency": "PHP" }, "account": { "number": "09123456789", "customer_name": "John Doe" } } ``` ### Callback format {#section_wsx_3jl_ggb .section} The Maya 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 the information about a `10.00 PHP` payout made for the customer in the `445` project. ```language-json { "project_id": 445, "payment": { "id": "10615_110613_51729356", "type": "payout", "status": "success", "date": "2021-06-15T08:06:25+0000", "method": "PayMaya wallet", "sum": { "amount": 1000, "currency": "PHP" }, "description": "payout" }, "account": { "number": "123123" }, "customer": { "id": "1234", "phone": "09123456789" }, "operation": { "id": 592, "type": "payout", "status": "success", "date": "2021-06-15T08:06:25+0000", "created_date": "2021-06-15T08:06:14+0000", "request_id": "bdec3c53155f87d1f59c0e16043cf7c9a-00000001", "sum_initial": { "amount": 1000, "currency": "PHP" }, "sum_converted": { "amount": 1000, "currency": "PHP" }, "code": "0", "message": "Success", "provider": { "id": 1994, "payment_id": "RS2PHYOBG5", "auth_code": "", "endpoint_id": "GRPY", "date": "2021-06-15T00:06:24+0000" } }, "signature": "xndoWc28knuz24ZeVBdQadwSRXgPYIDqN/M3ZOEYI7A==" } ``` The following is the example of a callback for a payout rejected due to amount or frequency limitation. ```language-json { "project_id": 445, "payment": { "id": "10615_110613_51729357", "type": "payout", "status": "decline", "date": "2021-06-15T08:07:25+0000", "method": "PayMaya wallet", "sum": { "amount": 1000, "currency": "PHP" }, "description": "payout" }, "account": { "number": "123123" }, "customer": { "id": "1234", "phone": "09123456789" }, "operation": { "id": 592, "type": "payout", "status": "decline", "date": "2021-06-15T08:06:25+0000", "created_date": "2021-06-15T08:06:14+0000", "request_id": "bdec3c53155f87d1f59c0e16043cf7c9a-00000002", "sum_initial": { "amount": 1000, "currency": "PHP" }, "sum_converted": { "amount": 1000, "currency": "PHP" }, "code": "20000", "message": "General decline", "provider": { "id": 1994, "payment_id": "RS2PHYOBG6", "auth_code": "", "endpoint_id": "GRPY", "date": "2021-06-15T00:06:24+0000" } }, "signature": "xndoWc28knuz24ZeVBdQadwSRXgPYIDqN/M3ZOEYI6A==" } ``` ### Useful links {#section_xsx_3jl_ggb .section} The following articles can be useful when implementing payouts 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. - [Payouts](en_Gate_payout.md)—about processing of payouts 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. ## Payouts by using Dashboard {#en_pm_dash_payout} When working with Dashboard, you can process *single* and *mass* payoutsby using the Maya method. - To process a single payout, open the payout form, specify all required parameters \(including the payment method\), send a request and verify that the payout has been processed. - To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed. Use a CSV file structured according to the requirements presented in the [Mass payments data](en_dbl_payments.md#) section.The payout parameters must comply with the [requirements](pm_maya.md#) \(you do not have to generate a signature because it is specified by Dashboard\). More information about processing payouts by using Dashboard is presented in a [separate section](en_dbl_payments.md#). ## Analysis of payments results {#en_pm_maya_dash_analysis} To analyse information about payments made with the Maya 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.