EPay

Overview

EPay is a payment method that allows customers to perform purchases by using payment terminals in Malaysia. Purchases through this method are performed by using Payment Page and Gate.

General information

Payment method type cash payments through payment terminals
Countries and regions MY
Payment currencies MYR
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee Refer to your key account manager ECommPay

Interaction diagram

Payment processing by using the EPay payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, provider's the technical facilities and payment terminals.



Operations support

  Interfaces Amounts
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum
Purchases + +

Processing scenarios

In the EPay method, to perform a purchase operation, a customer should receive on Payment Page or in the merchant's web service a payment code to complete the payment at one of the terminals.

Figure: Purchase by using Payment Page procedure



Figure: Purchase by using Gate procedure



The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the EPay method, when processing a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the EPay method selected. For more information about preselecting payment methods, see in Preselecting payment method.

The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence by using Payment Page

  1. Customer initiates payment on the merchant's web service side.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the EPay payment method.
  8. The payment form is displayed to the customer corresponding to the request.
  9. The customer enters the necessary data.
  10. The payment platform receives the purchase request for payment processing.
  11. The payment platform performs the internal purchase request processing and sends it to the EPay service.
  12. The purchase request is processed and a QR code and barcode are generated on the EPay service side.
  13. The EPay service sends the codes to the payment platform.
  14. The payment platform sends the codes and the payment instruction to Payment Page.
  15. The codes and the payment instruction are displayed to the customer on Payment Page.
  16. The customer completes the payment according to the instruction at one of the available payment terminals by using one of the received codes.
  17. The payment is processed on the payment terminals service side.
  18. The terminals service sends the payment result to the EPay.
  19. The EPay service sends the result notification to the payment platform.
  20. The payment platform sends a callback to the web service.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the EPay payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the EPay method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
  2. The currency of payment can only be THB.
  3. There are the mandatory parameters: customer_first_name, customer_last_name, customer_email, customer_phone—the first and last names, email address and phone number of the customer.
  4. If you need to have payment form displayed with the EPay method selected, set the force_payment_method parameter to epaycash.
  5. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available, see Payment Page invocation parameters.
  6. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the EPay method must include project, customer and payment IDs, the currency and the amount of the payment in the appropriate currency, and the customer data, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 500000, 
      payment_currency: 'MYR', 
      project_id: 250, 
      customer_id: '123',
      customer_first_name: 'Putra',
      customer_last_name: 'Cane',
      customer_phone: '60321669552',
      customer_email: 'putra@mail.com'
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

The EPay method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 5,000.00 MYR purchase made by a customer in the 635 project.

Figure: Example of a successful purchase callback

{
        "project_id": 635,
        "payment": {
            "id": "EPf0a7-e8d1",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-22T06:37:14+0000",
            "method": "ePayViaEGHL",
            "sum": {
                "amount": 500000,
                "currency": "MYR"
            },
            "description": "123"
        },
        "customer": {
            "phone": "640991025894"
        },
        "operation": {
            "id": 1000000128,
            "type": "sale",
            "status": "success",
            "date": "2019-03-22T06:37:15+0000",
            "created_date": "2019-03-22T06:36:43+0000",
            "request_id": "bfe58066b0f4331c",
            "sum_initial": {
                "amount": 500000,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 500000,
                "currency": "MYR"
            },
            "provider": {
                "id": 1353,
                "payment_id": "123123",
                "date": "2019-03-22T06:37:13+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Y+RRAvAzF7aCMYHvoEsQjZf8DrBR1xHVlAzfdNHgUEJe4POy6ZpkEQ=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
        "project_id": 635,
        "payment": {
            "id": "EPe02d-985c",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T06:29:59+0000",
            "method": "ePayViaEGHL",
            "sum": {
                "amount": 10,
                "currency": "MYR"
            },
            "description": "123"
        },
        "customer": {
            "phone": "640991025894"
        },
        "operation": {
            "id": 1000000127,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T06:30:00+0000",
            "created_date": "2019-03-22T06:29:28+0000",
            "request_id": "201ed6b216c",
            "sum_initial": {
                "amount": 10,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 10,
                "currency": "MYR"
            },
            "provider": {
                "id": 1353,
                "payment_id": "123123",
                "date": "2019-03-22T06:29:57+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "3nAGOrfkfY/+VqUqhSVkRDfaTgja8pDzQKSzpMh6eVE7ipxDRNz1IO4AxA3A=="
    }
}

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase by using Gate

General information

In the EPay methods, when processing a purchase by using Gate, the merchant 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 the callback with the EPay payment code from the payment platform and send it to the customer.
  3. Receive the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase through the EPay method on the merchant's web service side.
  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 for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the EPay service.
  7. The request is processed on the EPay side.
  8. The EPay service sends the payment code for the customer to the payment platform.
  9. The payment platform sends the callback with the payment code in the redirect_data object to the web service.
  10. The codes and the payment instruction are displayed to the customer on the web service.
  11. The customer completes the payment according to the instruction at one of the available payment terminals by using one of the received codes.
  12. The payment is processed on the payment terminal service side.
  13. The payment terminal service sends the payment result to the EPay.
  14. The EPay service sends the payment result notification to the payment platform.
  15. The ECommPay payment platform sends a callback to the web service.
  16. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the EPay payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using purchase requests in the EPay method:
  1. You perform purchase by sending the /v2/payment/cash/epay/sale request by using POST (HTTP) method. This is a cash payments request group: /v2/payment/cash/{payment_method}/sale
  2. The following objects and parameters must be specified in the request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address
      • first_name—first name
      • last_name—last name
      • email—email address
      • phone—phone number
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency in the ISO-4217 alpha-3 format
      • description—payment description
  3. The currency of a purchase can only be THB.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the EPay method must include project, customer and payment IDs, customer data, signature, currency and amount of the purchase, as shown in the following example:

Figure: Purchase request example

{
  "general": {
    "project_id": 318,
    "payment_id": "EP5fb7-bdg6",
    "signature": "testiuhgfcvbnm8f/kjhg\lkjhgvxbnmcvgfjdssAPOPKSJiojhbnm"
  },
  "payment": {
    "amount": 50000,
    "currency": "MYR",
    "description": "payment cash"
  },
  "customer": {
    "id": "123",
    "first_name":"Petra",
    "last_name":"Davis",
    "ip_address":"172.10.123.11",
    "phone":"640991025894",
    "email":"d@df.com"
  }
}

Formats of the customer redirection data

To complete the payment, customers must get the payment instructions from you. To display the payment data (barcode, QR code, etc.) in the form of instructions, you need to receive a callback from the payment platform containing the redirect_data object with the necessary data in the redirect_data.body:
  • reference_number—reference number to complete payment
  • valid_time—time the payment is valid to
  • user_name—customer name

The following is the callback fragment containing the token for purchase.

"redirect_data": {
                    "body": {
                      "reference_number": "045-050-000",
                      "valid_time": "2019-06-15 14:17:26",
                      "user_name": "THANAPAT JISAMANYA"
                    },
                    "method": "GET",
                    "url": "https://onlinepayment.epay.com"
                }

Callback format

The EPay method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 5,000.00 MYR purchase on account 035209875690435 made by a customer in the 635 project.

Figure: Example of a successful purchase callback

{
        "project_id": 635,
        "payment": {
            "id": "EPf0a7-e8d1",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-22T06:37:14+0000",
            "method": "ePayViaEGHL",
            "sum": {
                "amount": 500000,
                "currency": "MYR"
            },
            "description": "123"
        },
        "customer": {
            "phone": "640991025894"
        },
        "operation": {
            "id": 1000000128,
            "type": "sale",
            "status": "success",
            "date": "2019-03-22T06:37:15+0000",
            "created_date": "2019-03-22T06:36:43+0000",
            "request_id": "9bfe58066b0f4331c",
            "sum_initial": {
                "amount": 500000,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 500000,
                "currency": "MYR"
            },
            "provider": {
                "id": 1353,
                "payment_id": "123123",
                "date": "2019-03-22T06:37:13+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Y+RRAvAzF7aCMYHvoEsQjZf8unaN+4AtGHUICJe4POy6mRSZUbZmF55U00c7WEZZpkEQ=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
        "project_id": 635,
        "payment": {
            "id": "EPe02d-985c",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T06:29:59+0000",
            "method": "ePayViaEGHL",
            "sum": {
                "amount": 10,
                "currency": "MYR"
            },
            "description": "123"
        },
        "customer": {
            "phone": "640991025894"
        },
        "operation": {
            "id": 1000000127,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T06:30:00+0000",
            "created_date": "2019-03-22T06:29:28+0000",
            "request_id": "201ed6b216c",
            "sum_initial": {
                "amount": 10,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 10,
                "currency": "MYR"
            },
            "provider": {
                "id": 1353,
                "payment_id": "123123",
                "date": "2019-03-22T06:29:57+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "3nAGOrfkfY/+VqUqhSVkzpMh6eVE7ipxDRNz1IO4AxA3A=="
    }
}

Related topics

The following topics might be useful when implementing payments through Payment Page:

Analysis of payments results

As with other payment methods ECommPay offers, when using the EPay method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.