Fawry Voucher

Overview


Fawry Voucher, a popular payment method in Egypt, offers your customers a convenient way of paying for your services. In the Fawry Voucher payment method, customers make purchases by using vouchers. With Fawry Voucher, you can accept payments from your customers by using Payment Page and Gate. Download the logo in the vector format here.


Payment method type	Voucher payments
Countries and regions	Egypt
Payment currencies	EGP
Currency conversion	On the Monetix side
Purchases
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Special considerations
Onboarding and access fee	Contact your key account manager at Monetix for details.

Operations support


	Interfaces			Payment amount, EGP		Payment processing time
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchase				100.00	150,000.00	40 minutes	30 days

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 select Payment methods.

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 Fawry Voucher 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 Fawry Voucher 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 Monetix payment platform receives the request.
The payment platform processes the request and checks whether it contains all the required parameters and the signature is correct.
The payment platform creates the checkout page based on the project settings and request parameters.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the Fawry Voucher payment method.
Payment Page forwards the purchase request to the payment platform.
The payment platform processes the request and forwards it to the provider service.
The provider service processes the purchase request.
The provider service sends the customer redirection data to the payment platform.
The payment platform forwards the data to Payment Page.
Payment Page redirects the customer to the provider service.
The customer completes the purchase.
The provider service processes 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 sends the payment result to Payment Page.
Payment Page 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 Payment Page with the Fawry Voucher payment method.

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you don't specify this parameter in your request, the checkout page will contain an additional field for the customer to enter the missing information. For more information on how to act in such cases, see Submission of additional payment information.

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: 123

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 purchase currency in the ISO-4217 alpha-3 format.

Example: EGP

payment_amount
integer
strictly required

Purchase 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: 500.00 EGP must be sent as 50000

customer_account_number
string
required

Customer's phone number linked to the account (specified using a country code and without the + sign).

Example: 12345678910

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.

force_payment_method
string
optional

Parameter that allows you to enforce the Fawry Voucher payment method for your customer and skip the page with payment method selections.

To enforce the Fawry Voucher payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to fawry. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'fawry'

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',
        customer_account_number: '12345678910',
        payment_currency: 'EGP',
        payment_amount: 50000,    
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=='
    }
)

Callback

In the Fawry Voucher 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 2. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "Voucher Fawry",
        "sum": {
            "amount": 50000,
            "currency": "EGP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 50000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 50000,
            "currency": "EGP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 3. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "Voucher Fawry",
        "sum": {
            "amount": 50000,
            "currency": "EGP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 50000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 50000,
            "currency": "EGP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the Fawry Voucher payment method:

Send the 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 Fawry Voucher payment method.

Figure 4. 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 Gate.
The Monetix payment platform receives the request.
The payment platform checks whether the request contains all the required parameters and correct signature.
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 processes the purchase request.
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 provider service processes 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 purchase request through Gate by using the Fawry Voucher payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/voucher/fawry/sale
Full API endpoint specification	/v2/payment/voucher/{payment_method}/sale

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you omit this parameter from the request, the payment platform will request the parameter by sending your system a callback with the list of all the missing parameters you are required to submit. For more information on how to act in such cases, see Submission of additional payment information.

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: 123

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

email
string
strictly required

Customer's email.

Example: johndoe@example.com

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

account
object
strictly required

number
string
strictly required

Customer's phone number linked to the account (specified using a country code and without the + sign).

Example: 12345678910

payment
object
strictly required

amount
integer
strictly required

Example: 500.00 EGP must be sent as 50000

currency
string
strictly required

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

Example: EGP

return_url
object
optional

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/

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/

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 Fawry Voucher payment method.

Figure 5. Example of the data from a purchase request

{
    "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": {
        "number": "12345678910"
    },
    "payment": {
        "amount": 50000,
        "currency": "EGP"
    },
    "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 Fawry Voucher 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 6. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "Voucher Fawry",
        "sum": {
            "amount": 50000,
            "currency": "EGP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 50000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 50000,
            "currency": "EGP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 7. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "Voucher Fawry",
        "sum": {
            "amount": 50000,
            "currency": "EGP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 50000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 50000,
            "currency": "EGP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Analysis of payments results

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.

Fawry Voucher

Overview

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

Analysis of payments results