Mobile Commerce in MENA - Scenario 1. Purchase with customer redirection

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


Countries and regions	Egypt
Payment currencies	EGP
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.
Special considerations If the customer enters an amount which is different from the amount specified in the purchase request, the payment processing will proceed as described in Handling payments with amount changed by customer. The payment will be declined if the customer doesn't complete the purchase within a certain period after they were redirected to the provider service. The payment amount in EGP must be strictly integer, otherwise the payment platform will round the payment amount to the nearest integer when processing the request. For example, if you specify a 95.50 EGP amount in the request, the payment platform will perform a 96.00 EGP payment. In requests, the payment amount must be specified only in minor currency units! For example, a 95.00 EGP payment amount must be submitted as 9500 in the request. You can check the number of digits for minor currency units for any currency in Currency codes.

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.

Supported mobile network operators

The table below lists the mobile network operators available for performing purchase with the Mobile Commerce in MENA payment method.

Table 1. Supported mobile network operators
Mobile network operator	ID	Countries	Currencies
Etisalat	`ETISALAT`	Egypt	EGP
Orange	`ORANGE`	Egypt	EGP
Vodafone	`VODAFONE`	Egypt	EGP
WePay	`WEPAY`	Egypt	EGP

Note that the list of mobile network operators in the table is provided for informational purposes only. To get the current list of mobile network operators, send a request to the payment platform as described below:


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/info/mobile/sale/list
Full API endpoint specification	/v2/info/mobile/{operation_type}/list

Table 2. Parameters required in the request for the list of available mobile network operators
Object	Parameter	Description
general	project_id integer strictly required	Project ID you obtained when integrating with Monetix.
general	signature string strictly required	Signature created after you specify all the required parameters. For more information about, signature generation, see Signature generation and verification.

Here is an example of the data from the request for the list of available mobile network operators:

Figure 1. Example of the data from the request for the list of available mobile network operators

{
	"general": {
	    "project_id": 1234,
	    "signature": "K6jllym+PtObocZtr345st...=="
	}
}

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Mobile Commerce in MENA 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 Mobile Commerce in MENA payment method.

Figure 2. 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 Mobile Commerce in MENA payment method.
The payment platform processes the request and forwards it to the provider service.
The provider service sends the customer redirection data to the payment platform.
The checkout page redirects the customer to the provider service.
The customer completes the purchase.
The customer is redirected back to the checkout page.
The provider service sends the purchase result information to the payment platform.
The payment platform sends a callback with the payment result to your system.
The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Mobile Commerce in MENA 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: EGP

payment_amount
integer
strictly required

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

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

Example: 1000.00 EGP must be sent as 100000

force_payment_method
string
optional

Parameter that allows you to enforce the Mobile Commerce in MENA payment method for your customer and skip the page with payment method selections.

To enforce the Mobile Commerce in MENA payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to mobile. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'mobile'

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: 'EGP',
		payment_amount: 100000,
		force_payment_method: 'mobile',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

You can enforce a country or mobile network operator for your customer on the checkout page. To do so, add the following parameters to the request for the checkout page opening:

Table 4. Parameters to enforce a country or mobile network operator on the checkout page
Object/parameter	Parameter	Description
force_payment_method string optional		Parameter that allows you to enforce the Mobile Commerce in MENA payment method for your customer and skip the page with payment method selections. Set the value of this parameter to `mobile`. Example: `force_payment_method: 'mobile'`
payment_methods_options object optional	enable_mobile_service integer optional	Set the value of this parameter to `1` to enable enforcing a country or mobile network operator on the checkout page.
	selected_operator string optional	ID of the customer's mobile network operator. For the information on how to get the list of supported mobile network operators IDs, see Supported mobile network operators. Example: `VODAFONE`
	selected_country string optional	Customer's country code in the ISO 3166-1 alpha-2 format. Example: `EG`

Here is an example of the data from the request to open the checkout page with a mobile network operator enforced for the customer:

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: 'EGP',
		payment_amount: 100000,
		force_payment_method: 'mobile',
		payment_methods_options: {"enable_mobile_service": 1, "selected_operator": "VODAFONE"},  
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Here is an example of the data from the request to open the checkout page with a country enforced for the customer:

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: 'EGP',
		payment_amount: 100000,
		force_payment_method: 'mobile',
		payment_methods_options: {"enable_mobile_service": 1, "selected_country": "EG"},
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Callback

In the Mobile Commerce in MENA payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

In this payment method, callbacks also have the account object with the number and type parameters containing information about the customer's phone number and their mobile network operator.

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

Figure 3. 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": "mobile",
        "sum": {
            "amount": 100000,
            "currency": "EGP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "EGP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "201012345678",
        "type": "VODAFONE"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 4. 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": "mobile",
        "sum": {
            "amount": 100000,
            "currency": "EGP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "EGP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "201012345678",
        "type": "VODAFONE"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the Mobile Commerce in MENA 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 Mobile Commerce in MENA payment method.

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

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

Request

This section provides the instructions on how to build the request for purchase with the Mobile Commerce in MENA payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/mobile/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

number
string
strictly required

Customer's mobile phone number. The phone number must include a country code and must be specified without punctuation or special characters.

Example: 201012345678

service_provider
string
strictly required

ID of the customer's mobile network operator. For the information on how to get the list of supported mobile network operators IDs, see Supported mobile network operators.

Example: VODAFONE

payment
object
strictly required

currency
string
strictly required

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

Example: EGP

amount
integer
strictly required

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

Example: 1000.00 EGP must be sent as 100000

return_url
object
optional

success
string
optional

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 Mobile Commerce in MENA payment method:

Figure 6. 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": {
        "number": "201012345678",
        "service_provider": "VODAFONE"
    },
    "payment": {
        "currency": "EGP",
        "amount": 100000
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Customer redirection

After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting the customer to the provider service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

url—the URL to redirect the customer to
body—the data to send in the request body
method—the HTTP method for retrieving the website page (for example, POST or GET)
encrypted—this is the service parameter. Ignore it.

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

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

Callback

In the Mobile Commerce in MENA payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

In this payment method, callbacks also have the account object with the number and type parameters containing information about the customer's phone number and their mobile network operator.

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

Figure 7. 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": "mobile",
        "sum": {
            "amount": 100000,
            "currency": "EGP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "EGP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "201012345678",
        "type": "VODAFONE"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 8. 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": "mobile",
        "sum": {
            "amount": 100000,
            "currency": "EGP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "EGP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "201012345678",
        "type": "VODAFONE"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Mobile Commerce in MENA - Scenario 1. Purchase with customer redirection

Operations support

Supported mobile network operators

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Customer redirection

Callback

Related topics