Philippines Payment Centers - 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
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 Payment Centers 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 Payment Centers 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 Payment Centers payment method.
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 Payment Centers 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: 10.00 PHP must be sent as 1000

force_payment_method
string
optional

Parameter that allows you to enforce the Philippines Payment Centers payment method for your customer and skip the page with payment method selections.

To enforce the Philippines Payment Centers 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-cash. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'philippines-cash'

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: 1000,
		force_payment_method: 'philippines-cash',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Displaying physical retail channels icons on the checkout page

In the Philippines Payment Centers payment method, the payments are performed through specific physical retail channels. When making a purchase on the checkout page, the customer first chooses a payment method and then selects the physical retail channels.

The Philippines Payment Centers payment method offers several options to display physical retail channels icons on the checkout page:

Choosing the physical retail channels in two steps First, the customer chooses Philippines Payment Centers among other payment methods, and then selects the physical retail channels from the list. This is the default behavior.
Displaying physical retail channels alongside other payment methods To display physical retail channels 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_cash": {"split_banks": true}}
```
Displaying only physical retail channels of the Philippines Payment Centers payment method For the customer to see only physical retail channels available in the Philippines Payment Centers payment method (without other payment methods), add the force_payment_method parameter to the request and set it to philippines-cash.
Displaying only specific physical retail channels To show the customer only specific physical retail channels available in the Philippines Payment Centers payment method, use the force_payment_method parameter with the philippines-cash 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 physical retail channels 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_cash": {"split_banks": true, "banks_id": [140, 141]}}
```
Here is an example of the data from a request with preselected physical retail channels to open the checkout page with EPayWidget.
Figure 2. Example of the data from a request to open the checkout page with preselected physical retail channels
```
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: 1000,
		force_payment_method: 'philippines-cash',
		payment_methods_options: '{"philippines_cash": {"banks_id": [140, 141]}}',
		signature: 'kUi2x9dKHA5VNU0FY...vySO2RLCv1htT4DqtVUkDJrOcZzUCwX6Re1kpZhkIQg=='
	}
)
```
Enforcing only one physical retail channels If you want the customer to go directly to their physical retail channels service to complete the payment (without choosing a payment method and physical retail channels on the checkout page), use the force_payment_method parameter with the philippines-cash 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 physical retail channels 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_cash": {"split_banks": true, "banks_id": [140]}}
```
Here is an example of the data from a request to open the checkout page with one preselected physical retail channels by using EPayWidget.
Figure 3. Example of the data from a request to open the checkout page with one preselected physical retail channels
```
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: 1000,
		force_payment_method: 'philippines-cash',
		payment_methods_options: '{"philippines_cash": {"banks_id": [140]}}',
		signature: 'kUi2x9dKHA5VNU0FY...vySO/RLCv1htT4DqtVUkDJrOcZzUCwX6Rek7pZhkIQg=='
	}
)
```

Bank IDs to be passed in the banks_id parameter

Bank IDs that you can pass in the banks_id parameter to display the icons of specific physical retail channels on the checkout page are listed in the corresponding section Supported physical retail channels.

Callback

In the Philippines Payment Centers 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": "Philippines Cash",
        "sum": {
            "amount": 1000,
            "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": 1000,
            "currency": "PHP"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "PHP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "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": "Philippines Cash",
        "sum": {
            "amount": 1000,
            "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": 1000,
            "currency": "PHP"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "PHP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the Philippines Payment Centers 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 Payment Centers 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 generates the data for redirecting the customer to the provider service and sends 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 Payment Centers payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/payment/cash/philippines/sale`
Full API endpoint specification	/v2/payment/cash/{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

ID of the physical retail channel.

Example: 2681

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: 10.00 PHP must be sent as 1000

return_url
object
strictly required

success
string
strictly required

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

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
optional

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.

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 Payment Centers 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": 2681
    },
    "payment": {
        "currency": "PHP",
        "amount": 1000
    },
    "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 Payment Centers 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": "Philippines Cash",
        "sum": {
            "amount": 1000,
            "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": 1000,
            "currency": "PHP"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "PHP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "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": "Philippines Cash",
        "sum": {
            "amount": 1000,
            "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": 1000,
            "currency": "PHP"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "PHP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Supported physical retail channels

Payments through the Philippines Payment Centers method are carried out through physical retail channels that support the work with this method. The channels have their own identifiers, which are used to initiate payments by using Gate, and to display channels on Payment Page when choosing a payment method.

The table below lists the physical retail channels available for purchase in the Philippines Payment Centers payment method.

Table 3. Physical retail channels available for purchase
Physical retail channels	ID
7-Eleven	2591
Bayad Center	2601
Cebuana Lhuillier PeraPal	2621
Cebuana Lhuillier Bills Payment	1581
ECPay (Pawnshops, Payment Centers)	2651
LBC	1591
M. Lhuillier	2631
Palawan Pawnshop	2661
Posible Partners	2671
RD Pawnshop	2681
RuralNet Banks and Coops	2691
Robinsons Dept Store	2641
SM Dept/Supermarket/Savemore Counter	2611

The table with the list of physical retail channels is provided for informational purposes only. It may change without notice. To get the current list of physical retail channels the Philippines Payment Centers payment method supports, send a request to the payment platform.

Request for the list of available physical retail channels

This section provides the instructions on how to build the request for the list of physical retail channels supported in the Philippines Payment Centers payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/info/banks/cash/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: 10.00 PHP must be sent as 1000

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 physical retail channels available in the Philippines Payment Centers payment method.

Figure 10. Example of the data from the request for the list of available physical retail channels

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

Figure 11. Example of the response with the list of physical retail channels 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, // Physical retail channel ID
		"abbr": "EXB", // Physical retail channel shortcut name (for internal use)
		"name": "Example Bank", // General physical retail channel name
		"nativeName": "Example Bank", // Native physical retail channel name
		"currencies": [ // Array with currencies supported by the physical retail channel
			{
				"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 Payment Centers - 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

Supported physical retail channels

Supported physical retail channels

Request for the list of available physical retail channels