7-Eleven

Interaction diagram

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

Operations support

	Interfaces			Amounts, PHP		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				100.00	50,000.00	*	*

* For more information, refer to the Monetix key account manager.

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 7-Eleven method, to perform a purchase operation, you need to redirect customer to the 7-Eleven service, where the payment instruction is displayed to the customer. After that customer needs to pay by cash in the chosen 7-Eleven department.

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 7-Eleven 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 the 7-Eleven method 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 7-Eleven 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 7-Eleven method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
   • customer_id—unique ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email address
   • project_id—the project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
2. If you need to have payment form displayed with the 7-Eleven method selected, set the force_payment_method parameter to eleven7.
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 opening Payment Page:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 20000, 
      payment_currency: 'PHP', 
      customer_id: 'customer_123',
      customer_first_name: 'John', 
      customer_last_name: 'Doe,
      customer_email: 'johndoe@example.com',
      project_id: 125, 
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOc
                                                                 ZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the 7-Eleven method, see Payment Page invocation parameters.

Callback format

The 7-Eleven 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 500.00 PHP purchase made by the 1 customer in the 200 project.

{
        "project_id": 200,
        "payment": {
            "id": "156134233",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-27T14:31:04+0000",
            "method": "eleven7",
            "sum": {
                "amount": 50000,
                "currency": "PHP"
            },
            "description": "1561627597648"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 27366000003239,
            "type": "sale",
            "status": "success",
            "date": "2019-06-27T14:31:04+0000",
            "created_date": "2019-06-27T14:15:21+0000",
            "request_id": "16e4b13bc4f5c85aadb1c47d027aff623",
            "sum_initial": {
                "amount": 50000,
                "currency": "PHP"
            },
            "provider": {
                "id": 1249,
                "payment_id": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "XnjxlE92RED3b2bbk0cPsse+EQ/RbmJkRR0COo3/255CMaZaalHveue8
                                             9jPQYdB3bFPWbza65qFr9Mqv25ohXQ=="
    }
}

The following is the example of a callback for a purchase declined due to the merchant’s account being blocked.

{
        "project_id": 200,
        "payment": {
            "id": "156134233",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-27T14:31:04+0000",
            "method": "eleven7",
            "sum": {
                "amount": 50000,
                "currency": "PHP"
            },
            "description": "1561627597648"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 27366000003239,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-27T14:31:04+0000",
            "created_date": "2019-06-27T14:15:21+0000",
            "request_id": "16e4b13bc4f5c85aadb1c47d027aff623",
            "sum_initial": {
                "amount": 50000,
                "currency": "PHP"
            },
            "provider": {
                "id": 1249,
                "payment_id": ""
            },
            "code": "20705",
            "message": "Merchant account is blocked"
        },
        "signature": "XnjxlE92RED3b2bbk0cPsse+EQ/RbmJkRR0COo3/255CMaZaalHveue8
                                             9jPQYdB3bFPWbza65qFr9Mqv25ohXQ=="
    }
}

Related topics

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

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

General information

In the 7-Eleven methods, 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 7-Eleven 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 7-Eleven 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/eleven7/sale request by using HTTP method POST. This is payments by cash 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 information:
     • project_id—the project ID obtained from Monetix
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • 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
   • Object return_url—contains the URLs to which customer is redirected while or after payment processing:
     • success—URL to return customer to the web service after a successful payment
     • decline—URL for redirecting the customer after a declined purchase.
3. The following parameter is optional, but we strongly advise you to specify it in the request to provide your customer a better user experience.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request.
4. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request.

{
    "general": {
        "project_id": 12345,
        "payment_id": "123",
        "signature": "pgwRHcfv33R5Nr/ymu08nMx/9FSeIqYHTTd6YhIiLWw=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "example@email.com"
    },
    "payment": {
        "amount": 10000,
        "currency": "PHP"
    },
    "return_url": {
        "success": "http://example.com/success",
        "decline": "http://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 7-Eleven 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 7-Eleven 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 500.00 PHP purchase made by the 1 customer in the 200 project.

{
    "project_id": 12345,
    "payment": {
        "id": "156134233",
        "type": "purchase",
        "status": "success",
        "date": "2019-06-27T14:31:04+0000",
        "method": "eleven7",
        "sum": {
            "amount": 50000,
            "currency": "PHP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 27366000003239,
        "type": "sale",
        "status": "success",
        "date": "2019-06-27T14:31:04+0000",
        "created_date": "2019-06-27T14:15:21+0000",
        "request_id": "16e4b13bc4f5c85aadb1c47d027aff623",
        "sum_initial": {
            "amount": 50000,
            "currency": "PHP"
        },
        "provider": {
            "id": 1249,
            "payment_id": ""
        },
        "code": "0",
        "message": "Success"
    },
    "signature": "XnjxlE92RED3b2...v25ohXQ=="
}

The following is the example of a callback for a purchase declined due to the merchant’s account being blocked.

{
    "project_id": 200,
    "payment": {
        "id": "156134233",
        "type": "purchase",
        "status": "decline",
        "date": "2019-06-27T14:31:04+0000",
        "method": "eleven7",
        "sum": {
            "amount": 50000,
            "currency": "PHP"
        },
        "description": "1561627597648"
    },
    "customer": {
        "id": "1"
    },
    "operation": {
        "id": 27366000003239,
        "type": "sale",
        "status": "decline",
        "date": "2019-06-27T14:31:04+0000",
        "created_date": "2019-06-27T14:15:21+0000",
        "request_id": "16e4b13bc4f5c85aadb1c47d027aff623",
        "sum_initial": {
            "amount": 50000,
            "currency": "PHP"
        },
        "provider": {
            "id": 1249,
            "payment_id": ""
        },
        "code": "20705",
        "message": "Merchant account is blocked"
    },
    "signature": "XnjxlE92....v25ohXQ=="
}

Related topics

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

• Synchronous and asynchronous message processing
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

You can perform test purchases with the 7-Eleven payment method by using Payment Page and Gate.

To perform test purchases, you'll need the test project ID and the secret key to it. To get them, please contact the technical support team at support@monetix.pro and then contact your Monetix key account manager to set up a test environment to work with the 7-Eleven payment method.

When performing test payments, keep in mind that:

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

Test payments statuses

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

• 40000 and 40400—to receive a callback with the decline status
• 90000—to receive a callback with the success status and a purchase amount different from the amount in the request
• any other value—to receive a callback with the success status

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

1. Send a request for purchase through Payment Page to the payment platform.
2. Choose a payment method on the test checkout page. If you've passed the force_payment_method parameter with the eleven7 value in the request, you won't have to choose the payment method.
3. Specify a random first name and last name in the data entry fields. The payment instructions will be displayed to you after.
4. Accept a callback with information about the test purchase result.
5. Wait a few seconds until the result of the test purchase is displayed to you on the test checkout page.

See the detailed information about purchase processing through Payment Page in the 7-Eleven payment method in the Purchase by using Payment Page section.

Testing purchase by using Gate

To perform a test purchase by using Gate:

1. Send a request for performing a test purchase to the payment platform.
2. Accept a callback with the data for displaying payment instructions. Your system will display the payment instructions to you after.
3. Accept a callback with information about the test payment result.
4. Wait a few seconds until your system shows you the result of the test purchase.

See the detailed information about purchase processing through Gate in the 7-Eleven payment method in the Purchase by using Gate section.

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

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

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

• Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by means of sending requests to the /operations/get endpoint.

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