Philippines Over the Counter & ATM

Introduction

Philippines Over the Counter & ATM is a payment method which allows you to process payments in Philippine pesos by using payment cards and cash in the Philippines. This method supports purchases.

This article provides information about working with the Philippines Over the Counter & ATM 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

Interaction diagram

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

Operations support

Various platform interfaces can be used to process payments and perform operations using the Philippines Over the Counter & ATM 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 following properties and limitations are applicable.

When working with the Philippines Over the Counter & ATM the following properties and limitations are applicable.

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

Processing scenarios

To perform a purchase by using the Philippines Over the Counter & ATM method, you need to redirect the customer to the provider service.

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.

At the same time, the specifics of working with the method include the necessity of selecting a bank branch or ATM chain for each payment. When Payment Page is used for payment processing, the customer usually selects a bank branch or ATM chain while already in the payment form. When Payment Page is opened with the method and bank branch or ATM chain preselected as well as when payments are initiated through Gate, the bank branch or ATM chain must be selected on the side of the web service and the identifier of this branch or chain must be specified in requests. Possible options for bank selection when working with Payment Page are described in Purchases by using Payment Page, ways of using bank identifiers—in the next subsection, Supported bank branches and ATM chains.

At the same time, different options for selecting a bank branch or ATM chain are supported for payments by using this method; they are described in the Purchases by using Payment Page section of this article.

Supported bank branches and ATM chains

The following table lists the names and identifiers of bank branches and ATM chains supported by the Philippines Over the Counter & ATM method. Keep in mind that this list is presented for informational purposes.

Since the list of available bank branches and ATM chains may change over time, it is recommended to send a POST request to the /v2/info/banks/atm/philippines/sale/list endpoint to obtain up-to-date information. This endpoint belongs to the /v2/info/banks/{payment_method}/{operationType}/list group of the Gate API. The request must contain the project and payment identifiers, signature, currency code, and payment amount, as shown in the example. Specify real payment data if possible. However, random values are also allowed.

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

[
  {
    "id": 2331, // Bank branch or ATM chain ID
    "abbr": "BDOA", // Bank branch or ATM chain abbreviation (for internal use)
    "name": "Banco de Oro ATM", // International bank branch or ATM chain name
    "nativeName": "Banco de Oro ATM", // Local bank branch or ATM chain name
    "currencies": [ // Array with information about the currencies supported by the bank branch or ATM chain
      {
        "id": 1076, // Currency ID in the payment platform
        "alpha_3_4217": "PHP", // ISO-4217 alphabetic currency code
        "number_3_4217": "608", // ISO-4217 numeric currency code
        "exponent": 2 // The number of decimal units of the currency
      }
    ]
  },
  {
    "id": 2371,
    "abbr": "BPIX",
    "name": "BPI Over-the-Counter",
    "nativeName": "BPI OTC",
    "currencies": [
      {
        "id": 1076,
        "alpha_3_4217": "PHP",
        "number_3_4217": "608",
        "exponent": 2
      }
    ]
  },
  {
    "id": 2451,
    "abbr": "PNBR",
    "name": "PNB Remit",
    "nativeName": "PNB Remit",
    "currencies": [
      {
        "id": 1076,
        "alpha_3_4217": "PHP",
        "number_3_4217": "608",
        "exponent": 2
      }
    ]
  }
]

If you have any questions about working with bank branches and ATM chains supported by the Philippines Over the Counter & ATM method, refer to your ecommpay account manager.

General information

To process a purchase through Payment Page by using the Philippines Over the Counter & ATM 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.

Generally, when a customer confirms their intention to pay on the side of the web service, they are redirected to Payment Page where they select the payment method and, in the case of working with the Philippines Over the Counter & ATM method, additionally select one of the available bank branches or ATM chains. However, in some situations, other options for choosing a payment method and bank branch or ATM chain may be relevant. For example, upon opening Payment Page, you can immediately redirect the customer to the bank branch or chain selection page or limit the list of supported branches or chains for a particular payment and display only target branch or chain selection buttons to the customer. The specific option of selecting the payment method and branch or chain is determined depending on the parameters specified in the request for opening Payment Page (details). The following options are available:

• 1—when the payment form is opened, it sequentially displays separate pages for selecting a method and a bank. Then the customer selects the method and the bank (this option is used by default).
• 2—when the payment form is opened, the buttons for selecting other methods and banks supported by this method are displayed on one page. Then the customer selects one of these banks.
• 3—when the payment form is opened, it displays a page with buttons for selecting all available banks for this method. Then the customer selects one of these banks.
• 4—when the payment form is opened, it displays a page with buttons for selecting only specific banks supported by this method. Then the customer selects one of these banks.
• 5—when the payment form is opened, it displays a page requesting confirmation of redirection to the service of the specific bank. Then the customer confirms the redirection.

Information about the formats of requests and callbacks used for processing payments by using the Philippines Over the Counter & ATM method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Philippines Over the Counter & ATM 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. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. Additionally, it is recommended to specify the email address of the customer in the parameter customer_email. If any of this parameter is missing, the payment form may display the input field for entering the missing value (details are available in Submission of additional payment information).

4. The following are the bank branch and ATM chain selection options:

   1. Selecting the method and the branch or chain on Payment Page (1)—the default option, applied if the force_payment_method parameter and the payment_methods_options object are not used.
   2. Selecting a branch or chain among other methods on Payment Page (2)—for this option in the payment_methods_options object specify the philippines_atm object containing the split_banks parameter with the value true:

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

   3. Selecting a branch or chain among all available ones on Payment Page (3)—for this option specify the method code philippines-atm in the force_payment_method parameter.
   4. Selecting a branch or chain among specific ones on Payment Page (4)—for this option specify the following:
      • the philippines-atm code in the force_payment_method parameter
      • the payment_methods_options object with the philippines_atm object that contains the split_banks parameter with the value true and a banks_id object with an array containing the target branch or chain identifiers:

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

   5. Confirming redirection to the service of the specific branch or chain on Payment Page (5)—for this option specify the following:
      • the philippines-atm code in the force_payment_method parameter
      • the payment_methods_options object with the philippines_atm object that contains the split_banks parameter with the value true and a banks_id object with an array containing the target branch or chain identifier:

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

5. Additionally, any other parameters available for working with Payment Page can be used (details).
6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Philippines Over the Counter & ATM method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and email address, as well as signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "PHP",
   "customer_id": "customer1",
   "customer_email": "test@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "PHP",
   "customer_id": "customer1",
   "customer_email": "test@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

At the same time, in case of selecting a bank among specific banks (4), the request for opening Payment Page may contain additional data.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_email": "test@example.com",
   "force_payment_method": "philippines-atm",
   "payment_methods_options": {"philippines_atm": {"split_banks": true, "banks_id": [2421, 2371]}}
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The Philippines Over the Counter & ATM method uses the standard format for callbacks to deliver purchase results. For more information, see Handling callbacks.

The following is the example of a callback with information about a 10.00 PHP purchase made 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 with information about a declined purchase.

 {
        "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=="
    }
}

Useful links

The following articles can be useful when implementing purchases via Payment Page:

• Interaction concepts—about the interaction with the payment platform by using Payment Page.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment processing—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Handling operation processing information—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

To process a purchase through Gate by using the Philippines Over the Counter & ATM 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 Philippines Over the Counter & ATM service.
3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the Philippines Over the Counter & ATM method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Philippines Over the Counter & ATM method:

1. To initiate each purchase, send a separate POST request to the v2/payment/atm/philippines/sale endpoint. This endpoint belongs to the group /v2/payment/atm/{payment_method}/sale.
2. Each request must include the following objects and parameters:
   • Object general—general purchase information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
   • Object payment—payment information:
     • amount—payment amount in the smallest currency unit
     • currency—payment currency code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payment
     • email—email address
   • Object account—information on the physical bank branch or ATM chain:
     • bank_id—identifier of the physical bank branch or ATM chain
   • Object return_url—contains the URLs to which customer is redirected during or after payment processing:
     • success—URL for redirecting a customer after a performed purchase
3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Philippines Over the Counter & ATM method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier, IP and email addresses, identifier of a bank branch or ATM chain, URL for redirection, as well as signature.

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

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

Formats of intermediate callbacks for customer redirection

Each payment made with the Philippines Over the Counter & ATM method requires redirection of customers from the merchant's web service to the Philippines Over the Counter & ATM 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), 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

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

Final callback format

The Philippines Over the Counter & ATM method uses the standard format for callbacks to deliver purchase results. For more information, see Handling callbacks.

The following is the example of a callback with information about a 10.00 PHP purchase made 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 with information about a declined purchase.

 {
        "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=="
    }
}

Useful links

The following articles can be useful when implementing purchases via Gate:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment processing—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Gate.
• Handling operation processing information—about error and response codes that are used in the payment platform to record information about performing of operations.