Philippines Over the Counter & ATM - Purchase

When performing a purchase, the customer is redirected to the provider service where they make a purchase.


Countries and regions	Philippines
Payment currencies	PHP
Payment amount limits	Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time	Contact your key account manager at Monetix for details.
Currency conversion	On the Monetix side
Refund	On the provider side. To request a full or partial refund, the customer has to submit the online refund form.
Onboarding and access fee	Contact your key account manager at Monetix for details.

Operations support


	Interfaces
	Payment Page	Gate	Dashboard
Purchase

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 then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Philippines Over the Counter & ATM payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the Philippines Over the Counter & ATM payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page

The customer initiates a purchase in your system.
Your system sends the request for the purchase through Payment Page to the Monetix URL.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the Philippines Over the Counter & ATM payment method.
The payment platform processes the request and forwards it to the provider service.
The provider service sends the customer redirection data to the payment platform.
The checkout page redirects the customer to the provider service.
The customer completes the purchase.
The customer is redirected back to the checkout page.
The provider service sends the purchase result information to the payment platform.
The payment platform sends a callback with the payment result to your system.
The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Philippines Over the Counter & ATM payment method.

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Parameter Description

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: PHP

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 1000.00 PHP must be sent as 100000

force_payment_method
string
optional

Parameter that allows you to enforce the Philippines Over the Counter & ATM payment method for your customer and skip the page with payment method selections.

To enforce the Philippines Over the Counter & ATM payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to philippines-atm. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'philippines-atm'

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

EPayWidget.run(
	{
		project_id: 1234,
		payment_id: 'payment_47',
		customer_id: 'customer_123',
		customer_first_name: 'John',
		customer_last_name: 'Doe',
		customer_email: 'johndoe@example.com',
		payment_currency: 'PHP',
		payment_amount: 100000,
		force_payment_method: 'philippines-atm',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Displaying bank branches and ATM networks icons on the checkout page

In the Philippines Over the Counter & ATM payment method, the payments are performed through specific bank branches and ATM networks. When making a purchase on the checkout page, the customer first chooses a payment method and then selects their bank branch and ATM network.

The Philippines Over the Counter & ATM payment method offers several options to display bank branches and ATM networks icons on the checkout page:

Choosing the bank branch or ATM network in two steps First, the customer chooses Philippines Over the Counter & ATM among other payment methods, and then selects their bank branch or ATM network from the list. This is the default behavior.
Displaying bank branches and ATM networks alongside other payment methods To display bank branches and ATM networks as separate buttons on the checkout page alongside the other payment methods, add the payment_methods_options object with the split_banks parameter to the request and set the value of this parameter to true.
Here is an example of the payment_methods_options object from the link to open the checkout page:
```
payment_methods_options={"philippines_atm": {"split_banks": true}} 
```
Displaying only bank branches and ATM networks of the Philippines Over the Counter & ATM payment method For the customer to see only bank branches and ATM networks available in the Philippines Over the Counter & ATM payment method (without other payment methods), add the force_payment_method parameter to the request and set it to philippines-atm.
Displaying only specific bank branches and ATM networks To show the customer only specific bank branches and ATM networks available in the Philippines Over the Counter & ATM payment method, use the force_payment_method parameter with the philippines-atm value in the request, add the payment_methods_options object with the split_banks parameter and set this parameter to true. Next, specify the IDs of the bank branches and ATM networks to display in the banks_id array.
Here is an example of the payment_methods_options object from the link to open the checkout page:
```
payment_methods_options={"philippines_atm": {"split_banks": true, "banks_id": [140, 141]}}
```
Here is an example of the data from a request with preselected banks to open the checkout page with EPayWidget.
Figure 2. Example of the data from a request to open the checkout page with preselected bank branches and ATM networks
```
EPayWidget.run( 
    { 
        project_id: 1234, 
        payment_id: 'payment_47', 
        customer_id: 'customer_123', 
        customer_first_name: 'John', 
        customer_last_name: 'Doe', 
        customer_email: 'johndoe@example.com', 
        payment_currency: 'PHP', 
        payment_amount: 100000, 
        force_payment_method: 'philippines-atm', 
        payment_methods_options: '{"philippines_atm": {"banks_id": [140, 141]}}', 
        signature: 'kUi2x9dKHA5VNU0FY...vySO2RLCv1htT4DqtVUkDJrOcZzUCwX6Re1kpZhkIQg==' 
    } 
)
```
Enforcing only one bank branch or ATM network If you want the customer to go directly to their bank branch or ATM network service to complete the payment (without choosing a payment method and bank branch or ATM network on the checkout page), use the force_payment_method parameter with the philippines-atm value in the request, add the payment_methods_options object with the split_banks parameter and set the value of this parameter to true. Next, specify the ID of the required bank branch or ATM network in the banks_id array.
Here is an example of the payment_methods_options object from the link to open the checkout page:
```
payment_methods_options={"philippines_atm": {"split_banks": true, "banks_id": [140]}}
```
Here is an example of the data from a request to open the checkout page with one preselected bank branch by using EPayWidget.
Figure 3. Example of the data from a request to open the checkout page with one preselected bank branch
```
EPayWidget.run( 
    { 
        project_id: 1234, 
        payment_id: 'payment_47', 
        customer_id: 'customer_123', 
        customer_first_name: 'John', 
        customer_last_name: 'Doe', 
        customer_email: 'johndoe@example.com', 
        payment_currency: 'PHP', 
        payment_amount: 100000, 
        force_payment_method: 'philippines-atm', 
        payment_methods_options: '{"philippines_atm": {"banks_id": [140]}}', 
        signature: 'kUi2x9dKHA5VNU0FY...vySO/RLCv1htT4DqtVUkDJrOcZzUCwX6Rek7pZhkIQg==' 
    } 
)
```

Bank branches IDs and ATM networks IDs to be passed in the banks_id parameter

Bank branches IDs and ATM networks IDs that you can pass in the banks_id parameter to display the icons of specific bank branches or ATM networks on the checkout page are listed in the corresponding section Banks available for purchase.

Callback

In the Philippines Over the Counter & ATM payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 4. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "ATM philippines banking",
        "sum": {
            "amount": 100000,
            "currency": "PHP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "PHP"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "PHP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "johndoe@example.com"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 5. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "ATM philippines banking",
        "sum": {
            "amount": 100000,
            "currency": "PHP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "PHP"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "PHP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "johndoe@example.com"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the Philippines Over the Counter & ATM payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Redirect the customer to the provider service.
Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Philippines Over the Counter & ATM payment method.

Figure 6. Purchase processing flow when performing a purchase by using Gate

The customer initiates a purchase in your system.
Your system sends the purchase request to the Monetix payment platform.
The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
The payment platform processes the request and forwards it to the provider service.
The provider service sends the customer redirection data to the payment platform.
The payment platform forwards the data to your system in the redirect_data object.
Your system redirects the customer to the provider service.
The customer completes the purchase.
The customer is redirected to your system.
The provider service informs the payment platform about the purchase result.
The payment platform sends the callback with the payment result to your system.
Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Philippines Over the Counter & ATM payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/payment/atm/philippines/sale`
Full API endpoint specification	/v2/payment/atm/{payment_method}/sale

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

account
object
strictly required

bank_id
integer
strictly required

Customer's bank branch ID or ATM network ID. For the information on how to get the list of supported bank branch IDs or ATM network IDs, see Banks available for purchase.

Example: 2331

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: PHP

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

Example: 1000.00 PHP must be sent as 100000

return_url
object
strictly required

success
string
strictly required

The URL to redirect the customer to after the payment is successfully completed.

Your request must include at least one of the parameters with the URL to redirect the customer: return_url.success or return_url.return.

Example: https://example.com/success/

decline
string
optional

The URL to redirect the customer to after the payment is declined.

Example: https://example.com/decline/

return
string
strictly required

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. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.

Your request must include at least one of the parameters with the URL to redirect the customer: return_url.success or return_url.return.

Example: https://example.com/return/

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the Philippines Over the Counter & ATM payment method:

Figure 7. Example of the purchase request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "bank_id": 2331
    },
    "payment": {
        "currency": "PHP",
        "amount": 100000
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Customer redirection

After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting the customer to the provider 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 send in the request body
method—the HTTP method for retrieving the website page (for example, POST or GET)
encrypted—this is the service parameter. Ignore it.

Here is an example of the callback snippet with the data to redirect the customer.

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

Callback

In the Philippines Over the Counter & ATM payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 8. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "ATM philippines banking",
        "sum": {
            "amount": 100000,
            "currency": "PHP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "PHP"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "PHP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "johndoe@example.com"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 9. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "ATM philippines banking",
        "sum": {
            "amount": 100000,
            "currency": "PHP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "PHP"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "PHP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "johndoe@example.com"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Banks available for purchase

Supported bank branches and ATM networks

In the Philippines Over the Counter & ATM payment method, payments are performed at bank branches or ATM networks the payment method supports. For the purchase to be performed, your request must contain the account.bank_id parameter with your customer's bank branch ID or their ATM network ID.

The table below lists the bank branches and ATM networks available for purchase in the Philippines Over the Counter & ATM payment method.

Table 3. Bank branches and ATM networks available for purchase
Bank branch or ATM network	ID
AUB Online/Cash Payment	485
Banco de Oro ATM	2331
Banco de Oro Cash Payment	2341
BDO Cash Deposit w/ Ref	2351
BDO Network Bank (formerly ONB) Cash Dep	2361
BPI Bills Payment	2381
BPI Over-the-Counter	2371
Chinabank ATM/Cash Payment	2391
EastWest Bank Over-the-counter	2401
EastWest Online/Cash Payment	2411
Landbank Cash Payment	2421
Metrobank Cash Payment	2441
Metrobank Over-the-Counter	2431
PNB Cash Payment	2471
PNB e-Banking Bills Payment	2301
PNB Over-the-Counter	2461
PNB Remit	2451
RCBC Cash Payment	2481
RCBC Over-the-Counter/ATM	2491
RCBC Savings Cash Payment	2511
RobinsonsBank Over-the-Counter	2501
SB Regular OTC	2541
Security Bank ATM	2521
Security Bank Cash Payment	2531
UCPB ATM/Cash Payment	2571
UCPB Over-the-Counter/ATM	2581
Unionbank ATM	2561
Unionbank Cash Payment	2551

The table with the list of bank branches and ATM networks is provided for informational purposes only. It may change without notice. To get the current list of bank branches and ATM networks the Philippines Over the Counter & ATM payment method supports, send a request to the payment platform.

Request for the list of available bank branches and ATM networks

This section provides the instructions on how to build the request for the list of bank branches and ATM networks supported in the Philippines Over the Counter & ATM payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/info/banks/atm/philippines/sale/list`
Full API endpoint specification	/v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list

strictly required—parameter is required in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained when integrating with Monetix.

Example: 123

payment_id
string
strictly required

Payment ID unique within the project.

If the payment is not yet created, set this parameter to a unique value.

Example: payment_47

signature
string
strictly required

Signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.

payment
object
strictly required

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

Example: 1000.00 PHP must be sent as 100000

currency
string
strictly required

Code of the purchase currency in the ISO-4217 alpha-3 format.

Example: PHP

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from the request for the list of bank branches and ATM networks available in the Philippines Over the Counter & ATM payment method.

Figure 10. Example of the data from the request for the list of available bank branches and ATM networks

{ 
	"general": { 
		"project_id": 200, 
		"payment_id": "ORDER_155860015", 
		"signature": "K6jll2ym+PtOb3ocZtr345st...==" 
	}, 
	"payment": { 
		"amount": 100000, 
		"currency": "PHP" 
	} 
}

Figure 11. Example of the response with the list of bank branches and ATM networks available in the payment method

[ 
    { 
        "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 branch ID or ATM network ID 
        "abbr": "EXB", // Bank branch or ATM network shortcut name (for internal use) 
        "name": "Example Bank", // General bank branch name or ATM network name 
        "nativeName": "Example Bank", // Native bank branch name or ATM network name 
        "currencies": [ // Array with currencies supported by the bank branch or ATM network 
            { 
                "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 
            } 
        ] 
    } 
]

Philippines Over the Counter & ATM - Purchase

Operations support

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Customer redirection

Callback

Related topics

Banks available for purchase

Supported bank branches and ATM networks

Request for the list of available bank branches and ATM networks