Boost Wallet

General information

In the Boost Wallet method, to perform 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 Boost Wallet method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

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

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Boost Wallet 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 Boost Wallet 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 MYR.
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 Boost Wallet method selected, set the force_payment_method parameter to boost.
5. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available, see Parameters for opening payment form.
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 Boost Wallet 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 Boost Wallet 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 1000,00 MYR purchase made by a customer in the 635 project.

{
        "project_id": 635,
        "payment": {
            "id": "EP9a11-3704",
            "type": "purchase",
            "status": "success",
            "date": "2019-03-22T06:20:51+0000",
            "method": "boostViaEGHL",
            "sum": {
                "amount": 10000,
                "currency": "MYR"
            },
            "description": "123"
        },
        "account": {
            "number": "qwe@qwe.qwqw"
        },
        "customer": {
            "id": "sasha",
            "phone": "555"
        },
        "operation": {
            "id": 126,
            "type": "sale",
            "status": "success",
            "date": "2019-03-22T06:20:51+0000",
            "created_date": "2019-03-22T06:20:35+0000",
            "request_id": "f587b6309ccb",
            "sum_initial": {
                "amount": 10000,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "MYR"
            },
            "provider": {
                "id": 1352,
                "payment_id": "123123",
                "date": "2019-03-22T06:20:49+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "AoBE429Tp7suALwVK81YfHPVW75FFHYyezXIZ1ZopQZDRjGEBx9kXpi5Q=="
    }

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

{
        "project_id": 635,
        "payment": {
            "id": "EP0ec0-9074",
            "type": "purchase",
            "status": "decline",
            "date": "2019-03-22T06:23:56+0000",
            "method": "boostViaEGHL",
            "sum": {
                "amount": 10,
                "currency": "MYR"
            },
            "description": "123"
        },
        "account": {
            "number": "qwe@qwe.qwqw"
        },
        "customer": {
            "id": "sasha",
            "phone": "555"
        },
        "operation": {
            "id": 1000000126,
            "type": "sale",
            "status": "decline",
            "date": "2019-03-22T06:23:56+0000",
            "created_date": "2019-03-22T06:23:32+0000",
            "request_id": "73201c0a413f",
            "sum_initial": {
                "amount": 10,
                "currency": "MYR"
            },
            "sum_converted": {
                "amount": 10,
                "currency": "MYR"
            },
            "provider": {
                "id": 1352,
                "payment_id": "123123",
                "date": "2019-03-22T06:23:54+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "LDuxQYuGsgNXeV6aCKbsfNec7J8pRoliCf2n0/RkmXfRL1ElQ8vTw3v0f4SFg=="
    }

Related topics

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

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

General information

In the Boost Wallet 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. Perform redirection of a customer to the Boost Wallet service.
3. Receive the callback with the payment result from the payment platform.

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

The sections that follow discuss in more details the request format and the Gate parameters to use in the Boost Wallet 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

1. You perform purchase by sending the /v2/payment/cash/boost/sale request by using POST (HTTP) method. This is a cash payments request group: /v2/payment/wallet/{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 MYR.
4. If required, you can also add any other additional parameters Gate supports.

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

{
  "general": {
    "project_id": 318,
    "payment_id": "EP5fb7-bdg6",
    "signature": "testiuhgfcvbnm8f/kjhg\lkjhgvxbnmcvgfjdssAPOPKSJiojhbnm"
  },
  "payment": {
    "amount": 50000,
    "currency": "MYR",
    "description": "payment"
  },
  "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 redirect a customer from the web service to the Boost Wallet site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

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

"redirect_data": {
    "body": [],
    "method": "GET",
    "url": "https://onlinepayment.boost-my.com/index.php?token=c639de48340c4a532ba6a03d5"
  }

Callback format

The Boost Wallet 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.

{
        "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 purchase declined due to insufficient funds on customer account.

{
        "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": "20105",
            "message": "Insufficient funds on customer account"
         },
        "signature": "3nAGOrfkfY/+VqUqhSVkzpMh6eVE7ipxDRNz1IO4AxA3A=="
    }
}

Related topics

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

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

As with other payment methods ecommpay offers, when using the Boost Wallet 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.