Philippines Payment Centers

Interaction diagram

Payment processing by using the Philippines Payment Centers payment method requires merchant's web service, one of Monetix interfaces, and the Monetix payment platform, as well as provider technical facilities.

Operations support

	Interfaces			Amounts, PHP**		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				1.00	1,000,000.00	2 days	5 days
Payouts				10.00	100, 000.00	24 hours	48 hours
Full refunds	*	*	*	*	*	*	*
Partial refunds	*	*	*	*	*	*	*

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

** 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 Philippines Payment Centers method, to perform a purchase operation, you need to redirect customer to the provider service, while to perform a payout, you need to notify customer via merchant's web service.

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 provides information on these retail channels for informational purposes, it may change without additional notice; for the most recent list of supported channels, contact your Monetix key account manager, or by using the request /v2/info/banks/cash/philippines/sale/list, which belongs to the following request group: /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list.

The request must contain the project and payment IDs, signature, currency, and payment amount, as shown in the example. It is important to specify real payment data, but if the payment has not yet been generated, you can specify a random value for the payment ID in the request.

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

Supported cash pick-up points services

Payments through the Philippines Payment Centers method are carried out through cash pick-up points services that work with the method. Each of service has its own ID that identifies it in the request of payout by using Gate.

The table below provides information on these identifiers for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your Monetix key account manager or send the /v2/info/banks/cash/philippines/payout/list request that belongs the /v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list request group.

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 Philippines Payment Centers 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 Philippines Payment Centers methods selected. For more information about preselecting payment methods, see in Preselecting payment methods. The full sequence and particularities of the purchase process are provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Philippines Payment Centers 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 Philippines Payment Centers method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
   • project_id—project ID you obtained from Monetix
   • payment_id—payment ID unique within the project
   • customer_id—the unique ID of the customer within your project
   • customer_email—customer email. If the request is missing the parameter, on Payment Page the additional field is displayed to the customer to input missing data. If the parameter is specified in the request, n Payment Page the additional pre-filled field is displayed to the customer. The field contains the value specified in the request, the customer can verify or change the email.
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_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.

2. You can customize the selecting payment method page on Payment Page.

   By default the physical retail channels are grouped in one Philippines Payment Centers button on Payment Page, so the selection of a channel is carried out in two steps. First, the Philippines Payment Centers method is chosen among others, and then a retail channel is selected on the next page with the list of channels.

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

   • To display physical retail channels grouped in one Philippines Payment Centers button on Payment Page in the list of payment methods.
   • To display physical retail channels with separate buttons in the list of payment methods. You need to pass true in the split_banks parameter in the request for opening in the payment_methods_options object.

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

   • To display a button of a specific retail channel (one or several) from Philippines Payment Centers group on Payment Page in the list of payment methods, pass the identifier in the banks_id parameter. If it is necessary to display several retail channels from a group, pass the identifiers of these IDs separated by a comma with a space.

     payment_methods_options={"philippines_cash": {"split_banks": true, "banks_id": [2591, 2601]}}

   • To display only one Philippines Payment Centers button without other payment methods. To preselect Philippines Payment Centers as the payment method on Payment Page, pass the code philippines-cash in the force_payment_method parameter. The list of the channels from Philippines Payment Centers group with separate buttons are displayed to a customer on Payment Page bypassing the page with the payment method selection.
   • To display only one button of the physical retail channel on Payment Page. You need to specify the ID of the channel in the banks_id of the payment_methods_options parameter.

     Here is the example of a request for opening Payment Page with a preselected physical retail channel.

         { payment_id: 'X03936', 
           payment_amount: 10000, 
           payment_currency: 'PHP', 
           project_id: 123,
           customer_id: 'customer1',
           customer_email: 'test@example.com',
           force_payment_method: 'philippines-cash',
           payment_methods_options: {"philippines_cash": {"banks_id": [2601]}},
           signature: "kUi2x9dKHAVNU0FYldJrxh+...tT4DqtVUkDJrOcZzUCwX6R\/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 request for Payment Page opening:

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,    
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Philippines Payment Centers method, see Payment Page invocation parameters.

Callback format

The Philippines Payment Centers 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 10.00 PHP purchase in the 239 project.

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfd",
            "type": "purchase",
            "status": "success",
            "date": "2020-03-06T14:11:00+0000",
            "method": "Philippines cash",
            "sum": {
                "amount": 1000,
                "currency": "PHP"
            },
            "description": ""
        },
        "operation": {
            "id": 464,
            "type": "sale",
            "status": "success",
            "date": "2020-03-06T14:11:00+0000",
            "created_date": "2020-03-06T14:10:34+0000",
            "request_id": "f6ab99eb0940e43a774b969cb74a88ef08eec6c8951-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PHP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "endpoint_id": "BOG",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGoA=="
    }
}

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

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfc",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "method": "Philippines cash",
            "sum": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "description": ""
        },
        "operation": {
            "id": 465,
            "type": "sale",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "created_date": "2020-03-06T14:10:34+0000",
            "request_id": "f6ab99eb0940e43a774b969cb74a88ef08eec6c8951-00000002",
            "sum_initial": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "endpoint_id": "BOG",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob=="
    }
}

Related topics

The following topics might be useful when implementing payments by using Payment Page:

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

General information

In the Philippines Payment Centers 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 Philippines Payment Centers payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You send purchase requests by sending the /v2/payment/cash/philippines/sale request by using the POST HTTP method . This is the corresponding payments request group: /v2/payment/cash/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID you 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—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • email—customer email
     • first_name—customer first name
     • last_name—customer last name
   • account—object with information on the physical retail channel:
     • bank_id—ID of the physical retail channel
   • payment—object with purchase 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—code of purchase currency in the ISO-4217 alpha-3 format
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • success—the URL to redirect the customer to after the payment is successfully completed
3. The following parameters with the return URLs are optional, but we strongly advise you to specify them 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:
     • decline—the URL to redirect the customer to after the payment is declined
     • return—the URL to redirect the customer to when they prematurely terminate the payment.
4. If required, you can also add any other additional parameters Gate supports.
5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

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

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "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": {
        "amount": 1000,
        "currency": "PHP"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://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 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 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 Philippines Payment Centers 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 10.00 PHP purchase in the 239 project.

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfd",
            "type": "purchase",
            "status": "success",
            "date": "2020-03-06T14:11:00+0000",
            "method": "Philippines cash",
            "sum": {
                "amount": 1000,
                "currency": "PHP"
            },
            "description": ""
        },
        "operation": {
            "id": 464,
            "type": "sale",
            "status": "success",
            "date": "2020-03-06T14:11:00+0000",
            "created_date": "2020-03-06T14:10:34+0000",
            "request_id": "f6ab99eb0940e43a774b969cb74a88ef08eec6c8951-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PHP"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "endpoint_id": "BOG",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGoA=="
    }
}

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

 {
        "project_id": 239,
        "payment": {
            "id": "EPfa87-bcfc",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "method": "Philippines cash",
            "sum": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "description": ""
        },
        "operation": {
            "id": 465,
            "type": "sale",
            "status": "decline",
            "date": "2020-03-07T14:11:00+0000",
            "created_date": "2020-03-06T14:10:34+0000",
            "request_id": "f6ab99eb0940e43a774b969cb74a88ef08eec6c8951-00000002",
            "sum_initial": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 200000000,
                "currency": "PHP"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
            "provider": {
                "id": 1369,
                "payment_id": "7QKID3P3",
                "auth_code": "",
                "endpoint_id": "BOG",
                "date": "2020-03-06T14:10:54+0000"
            }
        },
        "signature": "YZKXHr2ZdK3tPqiMzPpSJZ...+WGku5dANQAVWPteHKmwzMQ+mvGob=="
    }
}

Related topics

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

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

General information

To perform a payout by using the Philippines Payment Centers 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 Philippines Payment Centers payment method and provide the information on the format of callbacks with payout results.

Request format

1. You perform payouts by sending the request to /v2/payment/cash/philippines/payout by using POST (HTTP) method. This is a cash request group: /v2/payment/cash/{payment_method}/payout.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID you 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—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • email—customer email
     • first_name—customer first name
     • last_name—customer last name
     • phone—phone number
     • country—country of residence
     • state—state or region of residence
     • city—city of residence
     • district—district of residence
     • address—address of residence
     • day_of_birth—date of birth in the DD-MM-YYYY format
     • citizenship—state of citizenship
   • account—object with customer account information:
     • bank_id—cash pick-up point service ID
   • 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 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—payout currency in ISO-4217 alpha-3 format
     • description—payout description
3. The currency of payout can only be PHP.
4. If required, you can also add any other additional parameters that are supported by Gate .

Here is an example of data from a payout request in the Philippines Payment Centers method.

 {
 "general": {
   "project_id": 603,
   "payment_id": "1000003",
   "signature": "PJkV8ej/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV...=="
 },
 "customer": {
   "id": "111232323",
   "ip_address": "198.51.100.47",
   "first_name": "John",
   "last_name": "Doe",
   "email": "johndoe@example.com",
   "phone": "49995559988",
   "country": "PH",
   "state": "Metro Manila",
   "city": "Pasig",
   "district": "Udong",
   "address": "123 Sesame street",
   "day_of_birth": "29-12-1984",
   "citizenship": "Philippines"
 },
 "account": {
   "bank_id": 1621
 },
 "payment": {
   "amount": 1000,
   "description": "payout",
   "currency": "PHP"
 }
}

Callback format

In the Philippines Payment Centers 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 10.00 PHP payout made for the 111232323 customer in the 445 project.

 {
        "project_id": 445,
        "payment": {
            "id": "100011",
            "type": "payout",
            "status": "success",
            "date": "2019-03-18T08:06:13+0000",
            "method": "phillipines_cash",
            "sum": {
                "amount": 1000,
                "currency": "PHP"
            },
            "description": "payout"
        },
        "customer": {
            "id": "111232323"
        },
        "operation": {
            "id": 147,
            "type": "payout",
            "status": "success",
            "date": "2019-03-18T08:06:13+0000",
            "created_date": "2019-03-18T08:06:06+0000",
            "request_id": "9499286583e3d43bcf14dbd0d45",
            "sum_initial": {
                "amount": 1000,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PHP"
            },
            "provider": {
                "id": 1346,
                "payment_id": "6Q2G5D83",
                "date": "2019-03-18T08:06:11+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "oFGfjOtZZkFxi7Pd1yikCw01b0BsedgKr8QQrAUZS5L...=="
    }

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": "phillipines_cash",
            "sum": {
                "amount": 900,
                "currency": "PHP"
            },
            "description": "payout"
        },
        "account": {
            "number": "1670033323"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 148,
            "type": "payout",
            "status": "decline",
            "date": "2019-03-18T10:49:51+0000",
            "created_date": "2019-03-18T10:49:46+0000",
            "request_id": "d626cece0855a8863f687985e6169c9f07b17e91c-
                            f5fb6c317444750d8301e8ff8c57935d9872183c",
            "sum_initial": {
                "amount": 900,
                "currency": "PHP"
            },
            "sum_converted": {
                "amount": 900,
                "currency": "PHP"
            },
            "provider": {
                "id": 1346,
                "payment_id": "YDK0QS4X",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "fz0Yu5BFLRLJez747kDfZHgmKGtCmzduW27YGzLvo649gXqxPIOgMa5DAzPE/4GLWlZSzCwkdkqyrTqUQvLp6A=="
    }

Related topics

The following topics might be useful when implementing payments by using Gate:

• 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.

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.