Philippines Over the Counter & ATM

Interaction diagram

Payment processing by using the Philippines Over the Counter & ATM 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	1 day	2 days
Full refunds	*	*	*	*	*	*	*
Partial refunds	*	*	*	*	*	*	*

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

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 Over the Counter & ATM method, to perform a purchase operation, you need to redirect customer to the provider service.

Supported banks

Payments through the Philippines Over the Counter & ATM method are carried out through physical bank branches and ATMs of supported banks that support the work with this method. The branches and ATMs have their own identifiers, which are used to initiate payments by using Gate, and to display branches or ATMs on Payment Page when choosing a payment method. The table below provides information on branches and ATMs for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your Monetix key account manager, or by using the request /v2/info/banks/atm/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"
  }
}

[
    {
        "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 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 Over the Counter & ATM 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 Over the Counter & ATM 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 Over the Counter & ATM 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 Over the Counter & ATM method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
   • 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.
   • customer_id—customer ID unique within the project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email

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

   By default the physical bank branches and ATMs are grouped in one Philippines Over the Counter / ATM button on Payment Page, so the selection of a branch or ATM is carried out in two steps. First, the Philippines Over the Counter & ATM method is chosen among others, and then a branch or ATM is selected on the next page with the list of branches and ATMs.

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

   • To display physical bank branches and ATMs grouped in one Philippines Over the Counter / ATM button on Payment Page in the list of payment methods.
   • To display physical bank branches and ATMs 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_atm": {"split_banks": true}}
     

   • To display a button of a specific bank branch or ATM (one or several) from Philippines Over the Counter & ATM 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 bank branches or ATMs from a group, pass the identifiers of these IDs separated by a comma with a space.

     payment_methods_options={"philippines_atm": {"split_banks": true, "banks_id": [2421, 2371]}}

   • To display only one Philippines Over the Counter / ATM button without other payment methods. To preselect Philippines Over the Counter & ATM as the payment method on Payment Page, pass the code philippines-atm in the force_payment_method parameter. The list of the bank branches and ATMs from Philippines Over the Counter & ATM 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 bank branche or ATM on Payment Page. You need to specify the ID of the branch or ATM in the banks_id of the payment_methods_options parameter.

     Here is the example of a request for opening Payment Page with a preselected bank branch.

         { payment_id: 'X03936', 
           payment_amount: 10000, 
           payment_currency: 'PHP', 
           project_id: 123,
           customer_id: 'customer1',
           customer_first_name: 'John', 
           customer_last_name: 'Doe',
           customer_email: 'johndoe@example.com', 
           force_payment_method: 'philippines-atm',
           payment_methods_options: {"philippines_atm": {"banks_id": [2371]}},
           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 purchase request.

{
      payment_id: 'ECT_TEST_1547', 
      payment_amount: 1000, 
      payment_currency: 'PHP', 
      project_id: 210,
      customer_id: 'customer13636',
      customer_first_name: 'John',
      customer_last_name: 'Doe',
      customer_email: 'example@email.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+K...tT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

For information about all parameters available in the Philippines Over the Counter & ATM method, see Payment Page invocation parameters.

Callback format

The Philippines Over the Counter & ATM 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 atm",
            "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 atm",
            "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 Over the Counter & ATM 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 Over the Counter & ATM 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/atm/philippines/sale request by using the POST HTTP method. This is the corresponding payments request group: /v2/payment/atm/{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.
   • 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
   • customer—object with customer information:
     • id—the ID of the customer within the merchant project
     • ip_address—IP address
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • account—object with information on the physical bank branch or ATM:
     • bank_id—identifier of the physical bank branch or ATM
   • return_url—object with the URLs to redirect customer to redirected after payment processing:
     • success—URL to return customer to the web service after a successful payment.
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. 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.
   • 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. 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 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.

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

Formats of the 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 Over the Counter & ATM 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 atm",
            "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 atm",
            "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

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.