Banks of the Philippines

Interaction diagram

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

Operations support

	Interfaces			Amounts, PHP		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				*	*	*	*
Payouts				*	*	*	*

* Refer to your Monetix key account manager for more information.

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Processing scenarios

In the Banks of the Philippines method, to perform a payout, you need to notify customer via merchant's web service.

Supported banks

Payments through the Banks of the Philippines method are carried out through banks that support the method. To initiate payouts and purchases by using Gate, you use bank identifiers, which are also used to display banks on Payment Page where your customer can choose payment method.

The table below provides information about supported banks. Note that this list is intended for informational purposes only.

Table 1. Banks that support the Banks of the Philippines method

Bank	ID	Purchase	Payout
AL-AMANAH ISLAMIC BANK	67971
All Bank	5461
ASIA UNITED BANK	65341
AUB Online/Cash Payment	485
AUSTRALIA & NEW ZEALAND BANK	67981
BANANA FINTECH SERVICES CORPORATION	68001
BANGKO KABAYAN	68291
Bangko Mabuhay	5581
BANGKO NUESTRA SENORA DEL PILAR	68451
BANGKOK BANK PUBLIC CO., LTD.	68011
BANK OF AMERICA	68031
Bank of China	68881
Bank of Commerce	1561
BANK OF FLORIDA	68041
BANK OF MAKATI	68391
BANK OF MONTALBAN, INC.	68621
Bayad Center	2601
BAYANIHAN BANK	68581
BDO Network Bank Inc	68461
BDO Corporate Internet Banking	2241
BDO Unibank, Inc	486
BINAN RURAL BANK, INC.	68821
Binangonan Rural Bank	55741
BPI Direct BanKO, Inc., A Savings Bank	5471
BPI ExpressOnline/Mobile (Fund Transfer)	487
BPI Family Bank	488
Camalig Bank	55751
Cantilan Bank	68111
CARD Bank	55761
CARD SME BANK INC	68131
CATHAY UNITED BANK CO. LTD	68791
Cebuana Lhuilier Rural Bank	68071
CENTURY SAVINGS BANK	68081
Chinabank Online	489
Chinabank Savings	1531
Chinatrust	1571
CIMB BANK PHILIPPINES INC	68101
Citibank, N.A.	5371
CITY SAVINGS BANK	68831
Community Rural Bank of Romblon, Inc.	70812
COOPERATIVE BANK OF QUEZON PROVINCE	68061
COUNTRY BUILDERS BANK, INC.	68121
CTBC Bank	5481
DCPay Philippines Inc.	5491
Deutsche Bank	5381
Development Bank of the Philippines	5391
DM BANK	68161
Dumaugete City Development Bank Inc	68151
Dungganon Bank	5501
East West Banking Corporation	55771
East West Rural Bank	21831
Entrepreneur Rural Bank, Inc	70892
Equicom Savings Bank	5511
FILIDIAN RURAL BANK OF ANTIPOLO	68181
FIRST CONSOLIDATED BANK	68171
G-Xchange	5521
GATEWAY RURAL BANK	68221
GM BANK OF LUZON, INC.	68191
GoTyme Bank	68201
GUAGUA RURAL BANK	68211
HK AND SHANGHAI BANKING CORP.	68241
HSBC SAVINGS BANK PHILS	68231
INDUSTRIAL BANK OF KOREA - MANILA	68251
INDUSTRIAL COMMERCIAL BANK OF CHINA	68271
ING Bank N.V.	5591
INNOVATIVE BANK	68281
Isla Bank (A Thrift Bank), Inc.	5601
JPMORGAN CHASE BANK	68091
KEB HANA BANK	68301
LAGUNA PRESTIGE BANKING CORPORATION	68331
LANDBANK / OFBank	70902
Landbank ATM Online	2291
Landbank CA/SA	491
LEGAZPI SAVINGS BANK	68311
LOLC BANK PHILIPPINES	68901
LULU FINANCIAL SERVICES PHILS INC	68321
Luzon Development Bank	70912
MALARAYAT RURAL BANK	68841
Malayan Bank Savings	68341
Maya Bank (Instapay)	68431
Maya Bank (Pesonet)	68421
Maybank	1541
Maybank Online Banking	2281
Maybank Phils. Inc.	5421
MEGA INTL CMML BANK CO. LTD	68261
MEGA RURAL BANK (LUCENA CITY)	68361
Metrobank	492
METROSOUTH COOPERATIVE BANK	68351
MINDANAO CONSOLIDATED COOPERATIVE	68381
MIZUHO BANK	68371
MONEY MALL RURAL BANK	68401
MUFG BANK, LTD.	68051
MVSM BANK RURAL BANK	68411
Netbank Rural Bank, Inc.	68141
NEW RURAL BANK OF SAN LEONARDO (NUEVA ECIJA)	68441
Omnipay, Inc.	5611
Own Bank	68471
Pacific Ace Savings Bank	68481
Partner Rural Bank (Cotabato), Inc.	5621
Paymaya Philippines, Inc.	5541
PAYMONGO PAYMENTS, INC	68911
PBCom	1511
Philippine Bank of Communications	68891
Philippine Business Bank (A Savings Bank)	5631
PHILIPPINE DIGITAL ASSET EXCHANGE (INSTAPAY)	68491
PHILIPPINE DIGITAL ASSET EXCHANGE (PESONET)	68861
Philippine National Bank (Pesonet)	68501
Philippine Trust Company	70922
Philtrust Bank	5431
PNB E-Banking (Instapay)	493
PNB e-Banking Bills Payment	2301
PNB Savings Bank	70942
PORAC RURAL BANK	55781
Producers Savings Bank Corporation	68521
PSBank	1501
Queen City Development Bank, Inc.	55791
Quezon Capital Rural Bank	5641
Rang-Ay Bank	68531
RBT RURAL BANK	68541
RCBC Online Banking	494
RobinsonsBank Online Bills Payment	495
RURAL BANK OF BACOLOD CITY	68591
RURAL BANK OF BAUANG	68601
RURAL BANK OF CAUAYAN INCORPORATED	67991
RURAL BANK OF DIGOS	68611
Rural Bank of Guinobatan, Inc.	55801
RURAL BANK OF LA PAZ	68631
RURAL BANK OF LEBAK (SULTAN KUDARAT)	68561
RURAL BANK OF ROSARIO	68641
RURAL BANK OF SAGAY	68661
RURAL BANK OF SAN MEDJUGORJE	68551
RURAL BANK OF STA. IGNACIA	68561
SeaBank Philippines	66671
Security Bank Online Transfer	496
SHINHAN BANK	68681
Standard Chartered Bank	5441
Starpay Corporation	68701
Sterling Bank	1551
SUMITOMO MITSUI BANKING CORP	68691
Sun Savings Bank	5571
TAYOCASH INC	68711
Tonik Bank	68721
TONIK DIGITAL BANK, INC.	68731
Topjuan Tech Corporation	68741
TRAXION PAY, INC.	68751
UCPB Connect	498
UCPB Savings Bank	5651
Unionbank	497
Unionbank EON	2321
Unionbank Internet Banking	2311
UnionDigital Bank	68781
UNITED COCONUT PLANTERS BANK	498
United Overseas Bank	5451
UNObank	68771
USSC Money Services Inc	55721
Veterans Bank	1521
Wealth Development Bank Corporation	5661
Yuanta Savings Bank	55811
ZAMBALES RURAL BANK	68801
ZYBI Tech, Inc.	70862

Since the list may change without additional notice, to get the most recent list of supported banks, you need to use the Gate API to send a POST request to one of the /v2/info/banks/{payment_method}/{operationType}/list endpoints.

Use following endpoints for the Banks of the Philippines method:

• /v2/info/banks/philippines/sale/list—to get the list of banks that support purchase processing.
• /v2/info/banks/philippines/payout/list—to get the list of banks that support payout processing

The following objects and parameters must be specified in request for the list of supported banks:

• general—object with general request information:
  • project_id—the project ID obtained from Monetix
  • 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—object with payment information:
  • amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
  • currency—purchase currency in ISO-4217 alpha-3 format

Here is an example of the data from a request for the supported banks list. 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"
  }
}

[
    {
        "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units)
        "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units)
        "limitCurrency": "PHP", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format
        "id": 123, // Bank ID
        "abbr": "EXB", // Bank shortcut name (for internal use)
        "name": "Example Bank", // General bank name
        "nativeName": "Example Bank", // Native bank name
        "currencies": [ // Array with currencies supported by the bank
            {
                "id": 123, // Currency ID in the payment platform
                "alpha_3_4217": "PHP", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format
                "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format
                "currency_type": "fiat", // Type of the currency
                "exponent": 2 // Number of decimal places after decimal point
            }
        ]
    }
]

The response to the request for the list of supported banks contains no information on whether these banks support payouts through the InstaPay or PESONet services. The following table provides this information for you.

Table 2. Support of payout through InstaPay and PESONet by banks

Bank	InstaPay	PESONet	ID
AL-AMANAH ISLAMIC BANK			67971
ALLBANK			5461
AllBank Inc			68851
ASIA UNITED BANK			65341
AUSTRALIA & NEW ZEALAND BANK			67981
BANANA FINTECH SERVICES CORPORATION			68001
BANGKO KABAYAN			68291
Bangko Mabuhay			5581
BANGKO NUESTRA SENORA DEL PILAR			68451
BANGKOK BANK PUBLIC CO., LTD.			68011
BANK OF AMERICA			68031
Bank of China			68881
Bank of Commecre			1561
BANK OF FLORIDA			68041
BANK OF MAKATI			68391
BANK OF MONTALBAN, INC.			68621
Bayad Center			2601
BAYANIHAN BANK			68581
BDO Unibank, Inc			486
BDO Network Bank Inc			68461
BINAN RURAL BANK, INC.			68821
Binangonan Rural Bank			55741
BPI ExpressOnline/Mobile (Fund Transfer)			487
BPI Direct BanKO, Inc., A Savings Bank			5471
Camalig Bank			55751
Cantilan Bank			68111
CARD Bank			55761
CARD SME BANK INC			68131
CATHAY UNITED BANK CO. LTD			68791
Cebuana Lhuillier Rural Bank			68071
CENTURY SAVINGS BANK			68081
China Banking Corporation			489
Chinabank Savings			1531
CIMB BANK PHILIPPINES INC			68101
Citibank, N.A.			5371
CITY SAVINGS BANK			68831
COOPERATIVE BANK OF QUEZON PROVINCE			68061
COUNTRY BUILDERS BANK,INC.			68121
CTBC Bank			5481
DCPay Philippines Inc.			5491
Deutsche Bank			5381
Development Bank of the Philippines			5391
DM BANK			68161
Dumaugete City Development Bank Inc			68151
Dungganon Bank			5501
East West Banking Corporation			55771
East West Rural Bank			21831
Equicom Savings Bank			5511
FILIDIAN RURAL BANK OF ANTIPOLO			68181
FIRST CONSOLIDATED BANK			68171
GATEWAY RURAL BANK			68221
GM BANK OF LUZON, INC.			68191
GoTyme Bank			68201
GUAGUA RURAL BANK			68211
HK AND SHANGHAI BANKING CORP.			68241
HSBC SAVINGS BANK PHILS			68231
INDUSTRIAL BANK OF KOREA - MANILA			68251
INDUSTRIAL COMMERCIAL BANK OF CHINA			68271
ING Bank N.V.			5591
INNOVATIVE BANK			68281
Isla Bank (A Thrift Bank), Inc.			5601
JPMORGAN CHASE BANK			68091
KEB HANA BANK			68301
LAGUNA PRESTIGE BANKING CORPORATION			68331
LAND BANK OF THE PHILIPPINES			491
LEGAZPI SAVINGS BANK			68311
LOLC BANK PHILIPPINES			68901
LULU FINANCIAL SERVICES PHILS INC			68321
MALARAYAT RURAL BANK			68841
Malayan Bank Savings			68341
Maya Bank (Pesonet)			68431
Maya Bank (Instapay)			68421
Maybank Phils. Inc.			5421
MEGA INTL COMML BANK CO. LTD			68261
MEGA RURAL BANK (LUCENA CITY)			68361
Metrobank			492
METROSOUTH COOPERATIVE BANK			68351
MINDANAO CONSOLIDATED COOPERATIVE			68381
MIZUHO BANK			68371
MONEY MALL RURAL BANK			68401
MUFG BANK, LTD.			68051
MVSM BANK RURAL BANK			68411
Netbank Rural Bank, Inc.			68141
NEW RURAL BANK OF SAN LEONARDO (NUEVA ECIJA)			68441
Own Bank			68471
Pacific Ace Savings Bank			68481
Partner Rural Bank (Cotabato)			5621
Paymaya Philippines Inc.			5541
PAYMONGO PAYMENTS, INC			68911
Philippine Bank of Communications			68891
Philippine Business Bank (A Savings Bank)			5631
PHILIPPINE DIGITAL ASSET EXCHANGE (Instapay)			68491
PHILIPPINE DIGITAL ASSET EXCHANGE (Pesonet)			68861
Philippine National Bank (Pesonet)			68501
PNB E-Banking (Instapay)			493
Philtrust Bank			5431
PORAC RURAL BANK			55781
Producers Savings Bank Corporation			68521
Queen City Development Bank, Inc.			55791
Quezon Capital Rural Bank			5641
Rang-Ay Bank			68531
RBT RURAL BANK			68541
RCBC Online Banking			494
RURAL BANK OF BACOLOD CITY			68591
RURAL BANK OF BAUANG			68601
RURAL BANK OF CAUAYAN INCORPORATED			67991
RURAL BANK OF DIGOS			68611
Rural Bank of Guinobatan, Inc.			55801
RURAL BANK OF LA PAZ			68631
RURAL BANK OF LEBAK (SULTAN KUDARAT)			68561
RURAL BANK OF ROSARIO			68641
RURAL BANK OF SAGAY			68661
RURAL BANK OF SAN MEDJUGORJE			68551
RURAL BANK OF STA. IGNACIA			68651
SeaBank Philippines			66671
Security Bank Online Transfer			496
SHINHAN BANK			68681
Standard Chartered Bank			5441
Starpay Corporation			68701
Sterling Bank			1551
SUMITOMO MITSUI BANKING CORP			68691
Sun Savings Bank			5571
TAYOCASH INC			68711
Tonik Bank			68721
TONIK DIGITAL BANK, INC.			68731
Topjuan Tech Corporation			68741
TRAXION PAY, INC.			68751
UCPB Savings Bank			5651
Unionbank			497
UnionDigital Bank			68781
UNITED COCONUT PLANTERS BANK			498
United Overseas Bank			5451
UNObank			68771
USSC Money Services Inc			55721
Veterans Bank			1521
Wealth Development Bank Corporation			5661
Yuanta Savings Bank			55811
ZAMBALES RURAL BANK			68801

The sections that follow provide detailed information about what you need to perform payments and how you can analyze 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 Monetix 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 of the purchase workflow is 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—unique ID of the customer within your project
   • customer_email—e-mail address of the customer
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • project_id—the project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
2. There are several options to customize the payment method selection page on Payment Page.
   • Bank selection in two steps This option is used by default. The banks that support Banks of the Philippines payment method are grouped in one button on Payment Page, therefore bank selection is carried out in two steps. On the first step, the Banks of the Philippines method is chosen among others, and then, on the second step, particular bank is selected on the next page with the list of the group banks.
   • Display each bank as a separate button along with other payment methods To show each bank of the Banks of the Philippines group as a separate button, set the split_banks parameter in the payment_methods_options object to true.

     payment_methods_options={"online_philippines_banks": {"split_banks": true}}

   • Show the banks of only one payment method To show only the banks available in the Banks of the Philippines payment method on Payment Page for customers, pass the code online-philippines-banks in the force_payment_method parameter. The customer will see only the banks available in the Banks of the Philippines method.
   • Show only selected banks To display a button of specific banks (one or several) from Banks of the Philippines group on Payment Page in the list of payment methods, set force_payment_method to online-philippines-banks and add an array with IDs of the banks to show on Payment Page in the banks_id parameter. Here an example:

     payment_methods_options={"online_philippines_banks": {"split_banks": true, "banks_id": [57001, 57011]}}

     Here is an example of a request to open Payment Page with specific pre-selected bank:

     EPayWidget.run(
         {
             project_id: 1234,
             payment_id: "X03936",
             customer_id: "customer_123",
             customer_first_name: 'John',
             customer_last_name: 'Doe',
             customer_email: 'johndoe@email.com',
             payment_currency: "PHP",
             payment_amount: 25000,
             force_payment_method: "online-philippines-banks",
             payment_methods_options: {"online_philippines_banks": {"banks_id": [133]}},
             signature: "kUi2x9dKHAVNU0FY...vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
         }
     )

3. If required, you can also add any other additional parameters Payment Page 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.

Here is an example of data from a purchase request:

EPayWidget.run(
    {
        payment_id: '1547', 
        payment_amount: 1000, 
        payment_currency: 'PHP', 
        project_id: 12345,
        customer_id: 'customer_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 Payment Page invocation parameters.

Callback format

The Banks of the Philippines method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Payment Page.

The following is the example of a callback with an information about successful 100.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": 10000,
                "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": 10000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "PHP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "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": 20000,
                "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": 20000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 20000,
                "currency": "PHP"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "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:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

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 Monetix 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 initiate a purchase by submitting a purchase request to the /v2/payment/banks/philippines/sale endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the online banking payments: /v2/payment/banks/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • general—object with general request information:
     • project_id—the project ID obtained from Monetix
     • 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.
   • customer—object with customer information:
     • id—unique ID of the customer within your project
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email address
     • ip_address—IP address
   • payment—object with payment information:
     • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—purchase currency in ISO-4217 alpha-3 format
   • account—object with bank information:
     • bank_id—bank identifier
   • return_url—object with URLs to return the customer to the web service:
     • success—the URL to redirect the customer to after the payment is successfully completed
     • decline*—the URL to redirect the customer to after the payment is declined. Check with your Monetix Key Account Manager whether these parameters are required.
3. The following parameter with the return URL is optional, but we strongly advise you to specify it in the request to provide your customer a better user experience.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request.
4. If required, you can also add any other additional parameters Gate supports.
5. After you specify all the parameters you are required to create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Here is an example of data from a purchase request in the Banks of the Philippines method.

{
    "general": {
        "project_id": 580,
        "payment_id": "test_philippines_sale",
        "signature": "pgwRHcfv2OTsdILn33R5Nr/ymu08nMx/9FSeIqYHTTd6YhIiLWw=="
    },
    "payment": {
        "amount": 1000,
        "currency": "PHP"
    },
    "customer": {
        "id": "customer_123",
        "email": "test_customer@example.com",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe"
    },
    "account": {
        "bank_id": 2681
    },
    "return_url": {
        "success": "http://example.com/success",
        "decline": "http://example.com/decline",
        "return": "http://example.com/return"
    }
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the bank service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

• url—the URL to redirect the customer to
• body—the data to be sent in the request body
• method—the HTTP method to get an HTML page of the website (for example, POST or GET)
• encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

The Banks of the Philippines method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Gate.

The following is the example of a callback with an information about successful 100.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": 10000,
                "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": 10000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "PHP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "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": 12345,
        "payment": {
            "id": "EPfa87-bcfc",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "method": "Philippines banks",
            "sum": {
                "amount": 20000,
                "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": 20000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 20000,
                "currency": "PHP"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob=="
    }
}

Related topics

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

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

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 Monetix 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 initiate a payout by sending a payout request to the /v2/payment/banks/philippines/payout endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the online banking payments: /v2/payment/banks/{payment_method}/payout.
2. The following objects and parameters must be specified in any request:
   • general—object with 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 device IP
     • email—customer email address
   • payment—object with payout information:
     • amount—payout amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—payout currency in ISO-4217 alpha-3 format
     • description—payout description
   • account—object with customer account information:
     • bank_id—bank ID
     • customer_name—bank account holder's name
     • number—customer account number
3. If required, you can also add any other additional parameters that are supported by Gate .

Here is an example of data from a payout request:

{
  "general": {
      "project_id": 445,
      "payment_id": "1000003",
      "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsa789ajQVVLhNN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIi8yJA=="                   
  },
 "customer": {
      "id": "123",
      "ip_address": "198.51.100.47",
      "email": "example@email.com"
  },
  "payment": {
      "amount": 10000,
      "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 in Gate.

The following is the example of a callback with the information about successful 100.00 PHP payout.

 {
        "project_id": 445,
        "payment": {
            "id": "100011",
            "type": "payout",
            "status": "success",
            "date": "2019-03-18T08:06:13+0000",
            "method": "Philippines banks",
            "sum": {
                "amount": 10000,
                "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": 10000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "PHP"
            },
            "provider": {
                "id": 1346,
                "payment_id": "6Q2G5D83",
                "date": "2019-03-18T08:06:11+0000",
                "auth_code": ""
            },
            "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": 90000,
                "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": 90000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 90000,
                "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:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

• single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
• as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

General information

You can perform test payments with the Banks of the Philippines payment method. Test purchases are performed by using Payment Page and Gate. Test payouts are performed by using Gate

To perform test payments, you'll need the test project ID and the secret key to it. To get them, contact the technical support team at support@monetix.pro.

When performing test payments, keep in mind that:

• your requests must contain the test project ID
• the payment currency that you send in requests can be only PHP
• the values for the customer's bank ID can be only 486 and 487
• random values may be used as the payment ID and in the parameters with customer information
• the interface of the test checkout page may be different from the production one.

Test payments statuses

To receive one of the following statuses in the callback with the test purchase result, use a particular value for the purchase amount in the request:

• decline—when using 40000 or 40400 amount
• success—when using any amount other than those mentioned above

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

1. Send a request for purchase through Payment Page to the payment platform.
2. Choose a payment method on the test checkout page. If you've passed the force_payment_method parameter with the online-philippines-banks value in the request, you won't have to choose the payment method.
3. Choose the bank you want to make a test purchase with.
4. Click the Success or Decline button (the relevant button will be displayed depending on the amount sent in the request).
5. Accept a callback with information about the test purchase result.
6. Wait a few seconds until the result of the test purchase is displayed to you on the test checkout page.

See the detailed information about purchase processing through Payment Page in the Banks of the Philippines payment method in the Purchase by using Payment Page section.

Testing purchase by using Gate

To perform a test purchase by using Gate:

1. Send a request for performing a test purchase to the payment platform.
2. Accept a callback with redirection data.
3. Go to the received URL, choose the bank you want to make a test purchase with, and click the Success or Decline button (the relevant button will be displayed depending on the amount sent in the request).
4. Make sure that the test purchase confirmation page is displayed to you.
5. Accept a callback with information about the test payment result.

See the detailed information about purchase processing through Gate in the Banks of the Philippines payment method in the Purchase by using Gate section.

Testing payouts by using Gate

To perform a test payout by using Gate:

1. Send a request for performing a test payout to the payment platform.
2. Accept a callback with information about the test payout result.

See the detailed information about payout processing through Gate in the Banks of the Philippines payment method in the Payout by using Gate section.

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

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 format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• 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 means of sending requests to the /operations/get endpoint.

If you have any further questions regarding payment data analysis, contact Monetix technical support.