Philippines Over the Counter & ATM

General information

Interaction diagram

Payment processing by using the Philippines Over the Counter & ATM payment method requires merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as provider technical facilities.

Operations support

* To request a full or partial refund, customer needs to submit the online refund form.

** The basic and threshold times are defined as follows:

• The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
• The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ecommpay technical support.

Processing scenarios

In the Philippines Over the Counter & ATM method, to perform a purchase operation, you need to redirect customer to the provider service.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

Supported banks

Payments through the Philippines Over the Counter & ATM method are carried out through physical bank branches and ATMs of supported banks that support the work with this method. The branches and ATMs have their own identifiers, which are used to initiate payments by using Gate, and to display branches or ATMs on Payment Page when choosing a payment method. The table below provides information on branches and ATMs for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your ecommpay key account manager, or by using the request /v2/info/banks/atm/philippines/sale/list, which belongs to the following request group: /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list.

The request must contain the project and payment IDs, signature, currency, and payment amount, as shown in the example. It is important to specify real payment data, but if the payment has not yet been generated, you can specify a random value for the payment ID in the request.

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "PHP"
  }
}

General information

In the Philippines Over the Counter & ATM 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 one of the Philippines Over the Counter & ATM methods 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 Philippines Over the Counter & ATM 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 Philippines Over the Counter & ATM method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
   • 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
   • customer_id—customer ID unique within the project
2. It is recommended to specify the e-mail address of the customer in the customer_email additional parameters. If the request is missing the parameter, on Payment Page the additional field is displayed to the customer to input missing data. If the parameter is specified in the request, n Payment Page the additional pre-filled field is displayed to the customer. The field contains the value specified in the request, the customer can verify or change the email.

3. You can customise the selecting payment method page on Payment Page.

   By default the physical bank branches and ATMs are grouped in one Philippines Over the Counter / ATM button on Payment Page, so the selection of a branch or ATM is carried out in two steps. First, the Philippines Over the Counter & ATM method is chosen among others, and then a branch or ATM is selected on the next page with the list of branches and ATMs.

   There are several options for displaying the page with the selecting of payment method on Payment Page:

   • To display physical bank branches and ATMs grouped in one Philippines Over the Counter / ATM button on Payment Page in the list of payment methods.
   • To display physical bank branches and ATMs with separate buttons in the list of payment methods. You need to pass true in the split_banks parameter in the request for opening in the payment_methods_options string.

     "payment_methods_options": "{\"philippines_atm\": {\"split_banks\": true}}"
     

   • To display a button of a specific bank branch or ATM (one or several) from Philippines Over the Counter & ATM group on Payment Page in the list of payment methods, pass the identifier in the banks_id parameter. If it is necessary to display several bank branches or ATMs from a group, pass the identifiers of these IDs separated by a comma with a space.

     "payment_methods_options": "{\"philippines_atm\": {\"split_banks\": true, \"banks_id\": [2421, 2371]}}"

   • To display only one Philippines Over the Counter / ATM button without other payment methods. To preselect Philippines Over the Counter & ATM as the payment method on Payment Page, pass the code philippines-atm in the force_payment_method parameter. The list of the bank branches and ATMs from Philippines Over the Counter & ATM group with separate buttons are displayed to a customer on Payment Page bypassing the page with the payment method selection.
   • To display only one button of the physical bank branche or ATM on Payment Page. You need to specify the ID of the branch or ATM in the banks_id of the payment_methods_options parameter.

     Here is the example of a request for opening Payment Page with a preselected bank branch.

     Figure: Example of the request with preselecting a physical bank branch

         { payment_id: 'X03936', 
           payment_amount: 10000, 
           payment_currency: 'PHP', 
           project_id: 123,
           customer_id: 'customer1',
           customer_email: 'test@example.com',
           force_payment_method: 'philippines-atm',
           payment_methods_options: '{\"philippines_atm\": {\"banks_id\": [2371]}}',
           signature: "kUi2x9dKHAVNU0FYldJrxh+...tT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
         }

4. If required, you can also add any other additional parameters Payment Page supports.
5. 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 Philippines Over the Counter & ATM method must include project and payment IDs, the currency and the amount of a payment, customer email address and signature as shown in the following example:

    { payment_id: 'ECT_TEST_1547', 
      payment_amount: 1000, 
      payment_currency: 'PHP', 
      project_id: 210,
      customer_email: 'test@example.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+K...tT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

For information about all parameters available in the Philippines Over the Counter & ATM method, see Parameters for opening payment form.

Callback format

The Philippines Over the Counter & ATM 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 10.00 PHP purchase in the 239 project.

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfd",
            "type": "purchase",
            "status": "success",
            "date": "2020-03-06T14:11:00+0000",
            "method": "Philippines atm",
            "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": "",
                "endpoint_id": "BOG",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGoA=="
    }
}

The following is the example of a callback for a purchase declined due to amount or frequency limitation.

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfc",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "method": "Philippines atm",
            "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": "",
                "endpoint_id": "BOG",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob=="
    }
}

Related topics

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

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

General information

In the Philippines Over the Counter & ATM method, 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 the redirection of a customer to the provider service.
3. Get 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 Philippines Over the Counter & ATM payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You send purchase requests by sending the v2/payment/atm/philippines/sale request by using the POST HTTP method. This is the corresponding payments request group: /v2/payment/atm/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • Object general—general request identification information:
     • project_id—the project ID obtained from ecommpay
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • Object payment—payment information:
     • amount—purchase amount in minor units
     • currency—purchase currency in ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—the ID of the customer within the merchant project
     • email—email address
     • ip_address—IP address
   • Object account—information on the physical bank branch or ATM:
     • bank_id—identifier of the physical bank branch or ATM
   • 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 successful payment.
3. If required, you can also add any other additional parameters Gate supports.
4. 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 Philippines Over the Counter & ATM method must include project and payment IDs, signature, currency and amount of the purchase, customer information, identifier of a physical bank branch or ATM and URL for redirection, as shown in the following example:

{
    "general": {
        "project_id": 580,
        "payment_id": "test_atm_sale",
        "signature": "pgwRHcfv2OTsdILn33R5Nr/ymu08nMx/9FSeIqYHTTd6YhIiLWw=="
    },
    "payment": {
        "amount": 1000,
        "currency": "PHP"
    },
    "customer": {
        "email": "test_customer@example.com",
        "ip_address": "1.1.1.1",
        "id": "123"
    },
    "account": {
        "bank_id": 2681
    },
    "return_url": {
        "success": "http://example.com/success"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the provider 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 redirection information.

"redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://test.ph/Pay.aspx?tokenid=3f511c2d&procid=BITC"
  }

Callback format

The Philippines Over the Counter & ATM 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 10.00 PHP purchase in the 239 project.

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfd",
            "type": "purchase",
            "status": "success",
            "date": "2020-03-06T14:11:00+0000",
            "method": "Philippines atm",
            "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": "",
                "endpoint_id": "BOG",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGoA=="
    }
}

The following is the example of a callback for a purchase declined due to amount or frequency limitation.

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfc",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "method": "Philippines atm",
            "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": "",
                "endpoint_id": "BOG",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob=="
    }
}

Related topics

The following topics might be useful when implementing payments through Gate:

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

As with other payment methods ecommpay offers, when using the Philippines Over the Counter & ATM 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.