Banks of the Philippines

General information

Interaction diagram

Payout processing by using the Banks of the Philippines payment method requires merchant's web service, one of the interfaces and the payment platform of ecommpay, as well as one of the bank services which works with this payment method.

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 Banks of the Philippines method, to perform a payout, you need to notify customer via merchant's web service.

The customer payment scenario via Payment Page (in the basic case where the customer chooses the method and bank and is redirected from the final page of the payment form to the web service) looks like this.

Figure: Opening the payment form

Figure: Selecting method

Figure: Selecting bank

Figure: Authentication

Figure: Confirming payment

Figure: Redirecting to the payment form

Figure: Redirecting to the web service

General scenarios of processing purchases and payouts can be presented as follows.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

Figure: Payout by using Gate

Supported banks

Payments through the Banks of the Philippines method are carried out through banks that work with the method. Each of banks has its own ID that identifies the bank in the request of payout by using Gate, as well as each of banks has its own code that identifies the bank in callbacks.

The table below provides information on these banks for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your ecommpay key account manager or send the /v2/info/banks/philippines/payout/list (for payouts) or /v2/info/banks/philippines/sale/list (for purchases) requests that belong the /v2/info/banks/{payment_method}/{operationType}/list request group.

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

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.

General information

In the Banks of the Philippines 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 Banks of the Philippines 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 Banks of the Philippines 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 Banks of the Philippines 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. It is also recommended to specify e-mail address of the customer in the customer_email additional parameter. It may also be required to specify customer first name in the customer_first_name parameter and customer last name in the customer_last_name parameter. Refer to your ecommpay Key Account Manager for more information on the necessity of using theses parameters. If at least one of the parameters needs to be specified and was not included in the request, additional fields are displayed on Payment Page so the customer could fill in the missing data. For more details about clarification, see Submission of additional payment information.

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

   By default the banks are grouped in one Philippines Online Banking button on Payment Page, so the selection of a bank is carried out in two steps. First, the Banks of the Philippines method is chosen among others, and then a bank is selected on the next page with the list of banks.

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

   • To display banks grouped in one Philippines Online Banking button on Payment Page in the list of payment methods.
   • To display banks 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": "{\"online_philippines_banks\": {\"split_banks\": true}}"
     

   • To display a button of a specific bank (one or several) from Banks of the Philippines 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 banks from a group, pass the identifiers of these IDs separated by a comma with a space.

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

   • To display only one Philippines Online Banking button without other payment methods. To preselect Banks of the Philippines as the payment method on Payment Page, pass the code online-philippines-banks in the force_payment_method parameter. The list of the banks from Banks of the Philippines 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 a bank on Payment Page. You need to specify the ID of the bank 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.

     Figure: Example of the request with a preselected bank

         { payment_id: 'X03936', 
           payment_amount: 10000, 
           payment_currency: 'PHP', 
           project_id: 123,
           customer_id: '123',
           customer_email: 'test@example.com',
           customer_first_name: 'John',
           customer_last_name: 'Doe',
           force_payment_method: 'online-philippines-banks',
           payment_methods_options: '{\"online_philippines_banks\": {\"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 Banks of the Philippines method must include project, customer and payment IDs, the currency and the amount of a payment, customer information and signature as shown in the following example:

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

For information about all parameters available in the Banks of the Philippines method, see Parameters for opening payment form.

Callback format

The Banks of the Philippines 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 banks",
            "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 banks",
            "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 Banks of the Philippines 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 Banks of the Philippines payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You send purchase requests by sending the request to v2/payment/banks/philippines/sale by using the POST (HTTP) method. This is the corresponding payments request group: /v2/payment/banks/{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 unique ID of the customer within your project
     • email—email address
     • ip_address—IP address
   • Object account—information on the bank:
     • bank_id—bank identifier
   • Object return_url—contains the URLs to which customer is redirected during or after payment processing:
     • success—URL for redirecting the customer after a successful payment.
3. It may also be required to specify the first name and the last name of the customer in the corresponding parameters:
   • Object customer—customer information:
     • first_name—customer first name
     • last_name—customer last name
   Refer to your ecommpay Key Account Manager for more information on the necessity of using theses parameters. If at least one of these parameters needs to be specified and was not included in the request, the payment platform requires additional data and the corresponding procedure is used—Submission of additional payment information.
4. If required, you can also add any other additional parameters Gate 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 Banks of the Philippines method must include project and payment IDs, signature, currency and amount of the purchase, customer information, bank ID and URL for redirection, as shown in the following example:

{
    "general": {
        "project_id": 580,
        "payment_id": "test_cash_sale",
        "signature": "pgwRHcfv2OTsdILn33R5Nr/ymu08nMx/9FSeIqYHTTd6YhIiLWw=="
    },
    "payment": {
        "amount": 1000,
        "currency": "PHP"
    },
    "customer": {
        "id": "123",
        "email": "test_customer@example.com",
        "ip_address": "1.1.1.1",
        "first_name": "John",
        "last_name": "Doe"
    },
    "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 Banks of the Philippines 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 Banks of the Philippines 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 banks",
            "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 banks",
            "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

General information

To perform a payout by using the Banks of the Philippines method, merchant's web service sends a request with all the required parameters and signature to ecommpay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Banks of the Philippines payment method and provide the information on the format of callbacks with payout results.

Request format

1. You perform payouts by sending the resuest to /v2/payment/banks/philippines/payout by using POST (HTTP) method. This is an online banking request group: /v2/payment/banks/{payment_method}/payout.
2. The following objects and parameters must be specified in any request:
   • Object general—general payout 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.
   • customer—object that contains customer information:
     • id—the unique ID of the customer within your project
     • ip_address—customer IP address
   • Object payment—payout information:
     • amount—payout amount in minor units
     • currency—payout currency in ISO-4217 alpha-3 format
     • description—payout description
   • Object account—customer account information:
     • bank_id—bank ID
     • customer_name—bank account holder's name
     • number—customer account number
3. The currency of payout can only be PHP.
4. If required, you can also add any other additional parameters that are supported by Gate .

Thus, a correct payout request in the Banks of the Philippines method must include project and payment IDs, signature, currency, amount and description of the payout, and customer account information such as bank ID, customer name and number (for crediting), as shown in the following example:

{
  "general": {
    "project_id": 445,
    "payment_id": "1000003",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsa789ajQVVLhNN5e
                        7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
  },
 "customer": {
    "id": "123",
    "ip_address": "1.1.1.1"
  },
  "payment": {
    "amount": 1000,
    "currency": "PHP",
    "description": "Payout description"
  },
    "account": {
    "bank_id": 486,
    "customer_name": "John Doe",
    "number": "1670033323"
  }
}

Callback format

In the Banks of the Philippines method, the callbacks that deliver payout results use the standard format described in Callbacks.

Note that unlike other payment methods, in the Banks of the Philippines method, the callbacks contain the name of bank passed in the endpoint_id parameter of the operation.provider object. (For more detailed information about banks and their codes, see List of banks.)

The following is the example of a callback with the information about successful 10.00 PHP payout made for account 1670033323 of the Banco de Oro CA/SA bank for the123 customer in the 445 project.

 {
        "project_id": 445,
        "payment": {
            "id": "100011",
            "type": "payout",
            "status": "success",
            "date": "2019-03-18T08:06:13+0000",
            "method": "Philippines banks",
            "sum": {
                "amount": 1000,
                "currency": "PHP"
            },
            "description": "payout"
        },
        "account": {
            "number": "1670033323"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 147,
            "type": "payout",
            "status": "success",
            "date": "2019-03-18T08:06:13+0000",
            "created_date": "2019-03-18T08:06:06+0000",
            "request_id": "9499286583e3d43bcf14dbd0d4502260b85fb
                                78b-a9058f99ef1102f752a9cd47d2887469cc613e11",
            "sum_initial": {
                "amount": 1000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PHP"
            },
            "provider": {
                "id": 1346,
                "payment_id": "6Q2G5D83",
                "date": "2019-03-18T08:06:11+0000",
                "auth_code": "",
                "endpoint_id": "BDO"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "oFGfjOtZZkFxi7Pd1yikCw01b0BsedgKr8QQrAUZS5LA
                            3+xEZP6cIOiB0v21vBp6O7KfQgcPJ+Gz/E8qfizh1A=="
    }

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

{
        "project_id": 445,
        "payment": {
            "id": "100014",
            "type": "payout",
            "status": "decline",
            "date": "2019-03-18T10:49:50+0000",
            "method": "Philippines banks",
            "sum": {
                "amount": 900,
                "currency": "PHP"
            },
            "description": "payout"
        },
        "account": {
            "number": "1670033323"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 148,
            "type": "payout",
            "status": "decline",
            "date": "2019-03-18T10:49:51+0000",
            "created_date": "2019-03-18T10:49:46+0000",
            "request_id": "d626cece0855a8863f687985e6169c9f07b17e91c-
                            f5fb6c317444750d8301e8ff8c57935d9872183c",
            "sum_initial": {
                "amount": 900,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 900,
                "currency": "PHP"
            },
            "provider": {
                "id": 1346,
                "payment_id": "YDK0QS4X",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "fz0Yu5BFLRLJez747kDfZHgmKGtCmzduW27YGzLvo649gXqxPIOgMa5DAzPE/4GLWlZSzCwkdkqyrTqUQvLp6A=="
    }

Related topics

The following topics might be useful when implementing payments by using 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 Banks of the Philippines 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.