Banks of the Philippines

Overview

Introduction

Banks of the Philippines is a payment method which allows you to process payments Philippine pesos by using bank accounts in the Philippines. This method supports purchases and payouts.

This article provides information about working with the Banks of the Philippines 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

Payment method type bank payments
Payment instruments bank accounts
Countries and regions PH
Payment currencies PHP
Currency conversion available only for purchases—on the ecommpay side
One-time purchases +
Credential-on-file purchases
Full refunds +
Partial refunds +
Payouts +
Chargebacks
Notes
  • additional parameters can be specified while generating Payment Page
  • full and partial refunds are available only directly from the provider service
Onboarding and access fee refer to your ecommpay key account manager; additional information is available in ecommshop

Interaction diagram

Payment processing by using the Banks of the Philippines method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of one of the bank services which works with this payment method.

Operations support

Various platform interfaces can be used to process payments and perform operations using the Banks of the Philippines method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), payouts—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the Banks of the Philippines the following properties and limitations are applicable.

Amounts, PHP Times ¹
minimum maximum basic threshold
Purchases 1.00 1,000,000.00 30 minutes 1 day
Refunds * * * *
Payouts 10.00 100, 000.00 up to 10 minutes 48 hours

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

Note:
  1. The base and threshold times are defined as follows:
    • The base 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 web service. The base 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 the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

To perform a purchase by using the Banks of the Philippines method, you need to redirect the customer to the Banks of the Philippines service, to process a payout, you need to notify the customer via the 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.

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

At the same time, the specifics of working with the method include the necessity of selecting a bank for each payment. When Payment Page is used for payment processing, the customer usually selects a bank while already in the payment form. When Payment Page is opened with the method and bank preselected as well as when payments are initiated through Gate, the bank must be selected on the side of the web service and the identifier of this bank 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 banks.

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

Supported banks

The following table lists the names and identifiers of banks supported by the Banks of the Philippines 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.

Figure 11. List of banks
Bank Purchase Payout ID Code
AUB Online/Cash Payment + 485 AUB
Bank of Commerce + + 1561 BOC
BDO Corporate Internet Banking + 2241 BDOC
BDO Internet Banking + + 486 BDO
BDO Internet Banking (Bills Payment) + 2231 BDOP
BDO Mobile Internet Banking + 2251 BDOM
BPI ExpressOnline/Mobile (Fund Transfer) + + 487 BPI
BPI ExpressOnline/Mobile (new) + 2261 BPIA
BPI ExpressOnline (Bills Payment) + 2271 BPIB
BPI Family Bank + 488 BFB
Chinabank Online + + 489 CBC
Chinabank Savings + 1531 CBCS
Chinatrust + 1571 CTBC
EastWest CA/SA + 490 EWB
Landbank ATM Online + 2291 LBPA
Landbank CA/SA + 491 LBP
Maybank + 1541 MAY
Maybank Online Banking + 2281 MAYB
Metrobankdirect + + 492 MBTC
PBCom + 1511 PBCM
PNB E-Banking + 493 PNB
PNB e-Banking Bills Payment + 2301 PNBB
PSBank + 1501 PSB
RCBC Online Banking + + 494 RCBC
RobinsonsBank Online Bills Payment + + 495 RSB
Security Bank Online Transfer + + 496 SBC
Sterling Bank + 1551 SBA
UCPB Connect + + 498 UCPB
Unionbank CA/SA, EON + 497 UBP
Unionbank EON + 2321 UBE
Unionbank Internet Banking + 2311 UBPB
Veterans Bank + 1521 PVB

Since the list of available banks may change over time, it is recommended to send a POST request to the /v2/info/banks/philippines/payout/list (for payouts) or /v2/info/banks/philippines/sale/list (for purchases) endpoints to obtain up-to-date information. These endpoints belong 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.

Figure 12. Example of data in the request for receiving the list of banks
{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "PHP"
  }
}
Figure 13. Example of data in the response containing the information about banks
[
  {
    "id": 2241, // Bank ID
    "abbr": "BDOC", // Bank abbreviation (for internal use)
    "name": "BDO Corporate Internet Banking", // International bank name
    "nativeName": "BDO Corporate Banking", // Local bank name
    "currencies": [ // Array with information about the currencies supported by the bank
      {
        "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": 1571, 
    "abbr": "CTBC", 
    "name": "Chinatrust", 
    "nativeName": "Chinatrust",
    "currencies": [
      {
        "id": 1076,
        "alpha_3_4217": "PHP",
        "number_3_4217": "608",
        "exponent": 2
      }
    ]
  },
  {
    "id": 2241, 
    "abbr": "MAY", 
    "name": "Maybank", 
    "nativeName": "Maybank",
    "currencies": [
      {
        "id": 1076,
        "alpha_3_4217": "PHP",
        "number_3_4217": "608",
        "exponent": 2
      }
    ]
  }
]

Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the Banks of the Philippines 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. At the same time, various options are available for choosing a method and a bank by specifying the appropriate parameters in requests. The full sequence and special aspects of purchase processing are provided below.



Figure 14. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Banks of the Philippines method.
  8. The payment platform receives the request for processing the payment by using the Banks of the Philippines method.
  9. The payment platform processes the request and sends it to the bank service.
  10. The request is processed on the bank service side.
  11. The data for redirecting the customer to the bank service is sent from the bank service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to bank.
  13. The customer is redirected to the bank service.
  14. The customer completes all required payment steps.
  15. The purchase is processed in the bank service.
  16. The result information is displayed to the customer in the bank service.
  17. The customer is redirected to Payment Page.
  18. The bank service sends a notification about the result to the payment platform.
  19. The payment platform sends the payment result callback to the web service.
  20. The payment platform sends the result information to Payment Page.
  21. The result information is displayed to the customer on Payment Page.

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 Banks of the Philippines method, additionally select one of the available banks. However, in some situations, other options for choosing a payment method and bank may be relevant. For example, upon opening Payment Page, you can immediately redirect the customer to the bank selection page or limit the list of supported banks for a particular payment and display only target bank selection buttons to the customer. The specific option of selecting the payment method and bank 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 Banks of the Philippines 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 Banks of the Philippines 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 e-mail address of the customer in the parameter customer_email. 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 any of these parameters are missing, the payment form may display input fields for entering the missing values (details are available in Submission of additional payment information).
  4. The following are the bank selection options:

    1. Selecting the method and the bank 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 bank among other methods on Payment Page (2)—for this option in the payment_methods_options object specify the online_philippines_banks object containing the split_banks parameter with the value true:
      "payment_methods_options": "{\"online_philippines_banks\": {\"split_banks\": true}}"
    3. Selecting a bank among all available ones on Payment Page (3)—for this option specify the method code online-philippines-banks in the force_payment_method parameter.
    4. Selecting a bank among specific ones on Payment Page (4)—for this option specify the following:
      • the online-philippines-banks code in the force_payment_method parameter
      • the payment_methods_options object with the online_philippines_banks object that contains the split_banks parameter with the value true and a banks_id object with an array containing the target bank identifiers:
        "payment_methods_options": "{\"online_philippines_banks\": {\"split_banks\": true, \"banks_id\": [2421, 2371]}}"
    5. Confirming redirection to the service of the specific bank on Payment Page (5)—for this option specify the following:
      • the online-philippines-banks code in the force_payment_method parameter
      • the payment_methods_options object with the online_philippines_banks object that contains the split_banks parameter with the value true and a banks_id object with an array containing the target bank identifier:
        "payment_methods_options": "{\"online_philippines_banks\": {\"split_banks\": true, \"banks_id\": [2371]}}"
  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 Banks of the Philippines method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_email": "test@example.com",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 20. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_email": "test@example.com",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "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",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "force_payment_method": "online-philippines-banks",
   "payment_methods_options": {"online_philippines_banks": {"split_banks": true, "banks_id": [2421, 2371]}}
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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 information about a 10.00 PHP purchase made in the 239 project.

Figure 21. Example of callback data indicating that the purchase has been processed
 {
        "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 with information about a declined purchase.

Figure 22. Example of callback data indicating that the purchase has been declined
 {
        "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=="
    }
}

Useful links

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

Purchases by using Gate

General information

To process a purchase through Gate by using the Banks of the Philippines 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 bank service.
  3. Receive the final callback from the payment platform.

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



Figure 23. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the Banks of the Philippines method in the web service.
  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.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the bank service.
  7. The request is processed on the bank service side.
  8. The bank service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the bank service.
  11. The customer completes all required payment steps.
  12. The purchase is processed in the bank service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The bank service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the Banks of the Philippines 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 Banks of the Philippines method:

  1. To initiate each purchase, send a separate POST request to the v2/payment/banks/philippines/sale endpoint. This endpoint belongs to the group /v2/payment/banks/{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
      • email—customer email address
      • ip_address—customer IP address relevant for the initiated payment
    • 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 cccount manager for more information on the necessity of using theses parameters. If any of these parameters are missing, the payment platform may send the list of missing parameters in a callback requesting additional information submission (details are available in Submission of additional payment information).

  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Banks of the Philippines method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, bank ID and URL for redirection, as well as signature.

{
    "general": {
        "project_id": 580,
        "payment_id": "test_philippines_sale",
        "signature": "pgwRHcfv2OTsdILn33R5Nr/yMx/9FSeIqYHTTd6YhIiLWw=="
    },
    "payment": {
        "amount": 1000,
        "currency": "PHP"
    },
    "customer": {
        "id": "123",
        "email": "test_customer@example.com",
        "ip_address": "192.0.2.0",
        "first_name": "John",
        "last_name": "Doe"
    },
    "account": {
        "bank_id": 2681
    },
    "return_url": {
        "success": "http://example.com/success"
    }
}
Figure 24. Example of sufficient data in a purchase request
{
    "general": {
        "project_id": 580,
        "payment_id": "test_philippines_sale",
        "signature": "pgwRHcfv2OTsdILn33R5Nr/yMx/9FSeIqYHTTd6YhIiLWw=="
    },
    "payment": {
        "amount": 1000,
        "currency": "PHP"
    },
    "customer": {
        "id": "123",
        "email": "test_customer@example.com",
        "ip_address": "192.0.2.0",
        "first_name": "John",
        "last_name": "Doe"
    },
    "account": {
        "bank_id": 2681
    },
    "return_url": {
        "success": "http://example.com/success"
    }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the Banks of the Philippines method requires redirection of customers from the merchant's web service to the bank 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
Figure 25. redirect_data example
"redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://test.ph/Pay.aspx?tokenid=3f511c2d&procid=BITC"
  }

Final 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 information about a 10.00 PHP purchase made in the 239 project.

Figure 26. Example of callback data indicating that the purchase has been processed
 {
        "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 with information about a declined purchase.

Figure 27. Example of callback data indicating that the purchase has been declined
 {
        "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=="
    }
}

Useful links

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

Payouts by using Gate

General information

To process a payout through Gate by using the Banks of the Philippines method, 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 payout processing are provided below.



Figure 28. Payout processing by using Gate: step-by-step description
  1. A customer initiates a payout by using the Banks of the Philippines method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the bank service.
  7. The payout is processed on the side of the bank service.
  8. The bank service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the Banks of the Philippines 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 payout requests by using the Banks of the Philippines method:

  1. To initiate each payout send a separate POST request to the /v2/payment/banks/philippines/payout endpoint. This endpoint belongs to the group /v2/payment/banks/{payment_method}/payout.
  2. Each request must include the following objects and parameters:
    • Object general—general payout 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—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
      • description—payout description
    • customer—object that contains customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payout
    • 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. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Banks of the Philippines method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer and account information, as well as signature.

{
  "general": {
    "project_id": 445,
    "payment_id": "1000003",
    "signature": "PJkV8ej\/UG0Di8hTng6fBaNIipTv+AWoXW\/9MTO8yJA=="
  },
 "customer": {
    "id": "123",
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 1000,
    "currency": "PHP",
    "description": "Payout description"
  },
    "account": {
    "bank_id": 486,
    "customer_name": "John Doe",
    "number": "1670033323"
  }
}
Figure 29. Example of sufficient data in a payout request
{
  "general": {
    "project_id": 445,
    "payment_id": "1000003",
    "signature": "PJkV8ej\/UG0Di8hTng6fBaNIipTv+AWoXW\/9MTO8yJA=="
  },
 "customer": {
    "id": "123",
    "ip_address": "192.0.2.0"
  },
  "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 Supported banks.)

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

Figure 30. Example of callback data indicating that the payout has been processed
 {
        "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": "9499286583e3d1102f752a9cd47d2fb7469cc613e11",
            "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": "oFGfjOtZZkFxi7Pd1yikCw01b0BsedgKr8z/E8qfizh1A=="
    }

The following is the example of a callback with information about a declined payout.

Figure 31. Example of callback data indicating that the payout has been declined
{
        "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": "d626cece0855a8863f687985e6c57935d9872183c",
            "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": "fz0Yu5BFLRLJez747kDfZHgmKGIOgMa5DAzPE/4GLWlZSzCwkdkqyrTqUQvLp6A=="
    }

Useful links

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

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the Banks of the Philippines method.

  • To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.
  • To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.

Analysis of payments results

To analyse information about payments made with the Banks of the Philippines method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.