Meeza Wallet

Overview

Meeza Wallet is a payment method that allows customers to perform purchasesby using Meeza Wallet e-wallets. With Meeza Wallet, you can perform purchases by using Payment Page and Gate.

Download the logo in vector format here.
Payment method type Payments by using e-wallets
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 The code for payment from the SMS is valid for use for 1 hour.
Onboarding and access fee Refer to your key account manager at Monetix.

Interaction diagram

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

Operations support

Interfaces Amounts, EGP Times
Payment Page Gate Dashboard minimum maximum basic threshold
Purchases 1.00 150,000.00 * *

* Refer to your Monetix Key Account Manager for the 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 Meeza Wallet method, the customer receives a payment code from the provider's service and uses it in the mobile application to perform a purchase.

Figure 1. Purchase by using Payment Page
Figure 2. Purchase by using Gate

The sections that follow provide more information about what you need to perform payments and how you can analyze payments and operations information.

Purchase by using Payment Page

General information

In the Meeza Wallet method, when processing a purchase by using Payment Page, the merchant web service sends a request with all the required parameters and signature to the Monetix URL and accepts the callback with the payment result from the payment platform.

When opening Payment Page, you can have Payment Page opened with the Meeza Wallet method pre-selected. (For more information about pre-selecting payment methods, see Preselecting payment methods.)

The full sequence of the purchase workflow is provided below.

Figure 3. Purchase workflow when using Payment Page
  1. The customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for the Payment Page opening to the Monetix URL.
  3. The request for opening Payment Page is redirected to the payment platform.
  4. The payment platform performs the initial request processing that includes validation whether all the required parameters are available and signature is correct.
  5. The requested Payment Page is generated by the Monetix payment platform as specified in the project settings and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects Meeza Wallet as the payment method.
  8. The payment platform receives the purchase request for the payment processing from Payment Page.
  9. The payment platform performs the internal payment request processing and redirects the request to the provider service.
  10. The provider processes the request.
  11. The provider service sends to the customer the SMS with code for payment.
  12. The customer uses the code in the mobile application to make a payment.
  13. The provider service processes the payment.
  14. The result is displayed to the customer on the provider website.
  15. The provider service sends the result notification to the payment platform.
  16. The payment platform sends a callback with the payment result to the web service.
  17. The payment platform sends the result to Payment Page.
  18. The page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Meeza Wallet payment method and provide the information about the format of callbacks with payment results. For the general information about how to use the Payment Page API, see Payment Page API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the Meeza Wallet 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_first_name—customer first name
    • customer_last_name—customer last name
    • customer_email—customer email
    • account_number—customer phone number. The number must contain +20 (Egypt's code) and 10 digits without a plus sign (+), spaces and punctuation. If the parameter is missing from the request, Payment Page will contain an additional field for the customer to enter missing information. For more information about additional information submission, see Submission of additional payment information.
    • 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 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.
  2. If you need to have the payment form displayed with the Meeza Wallet method pre-selected, set the force_payment_method parameter to the code on the meeza-wallet payment method.
  3. You can also add any other additional parameters Payment Page supports. For more information about parameters supported by Payment Page, see Payment Page invocation parameters.
  4. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign payment requests, see Signature generation and verification.

Here is an example of the data from a request for the 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@email.com',
        account_number: '+201234567890',
        payment_currency: 'EGP',
        payment_amount: 10000,
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=='
    }
)

Callback format

The Meeza Wallet method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Payment Page.

The following is an example of a callback with information about a successful 10,000.00 EGP purchase.

Figure 4. 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": "Wallet Meeza",
        "sum": {
            "amount": 10000,
            "currency": "EGP"
        },
        "description": ""
    },
    "account": {
        "number": "+201234567890"
    },
    "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": 10000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EGP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 5. 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": "Wallet Meeza",
        "sum": {
            "amount": 10000,
            "currency": "EGP"
        },
        "description": ""
    },
    "account": {
        "number": "+201234567890"
    },
    "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": 10000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EGP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

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

Purchase by using Gate

General information

In the Meeza Wallet method, the merchant web service is required to do the following when processing a purchase by using Gate:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

Figure 6. Purchase by using Gate
  1. The customer initiates a purchase with Meeza Wallet on the merchant's web service side.
  2. The web service sends a request for processing the purchase by using Gate to the Monetix URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation whether all the required parameters are available and signature is correct.
  5. The payment platform sends the response with the request receipt confirmation and validation result to the web service. For more information about the response format, see Response structure.
  6. The payment platform performs the internal payment request processing and redirects the request to the provider service.
  7. The provider service processes the request.
  8. The provider service sends to the customer the SMS with code for payment.
  9. The customer uses the code in the mobile application to make a payment.
  10. The provider service processes the payment.
  11. The result is displayed to the customer.
  12. The provider service sends the payment result notification to the payment platform.
  13. The payment platform sends the callback with the payment result to the web service.
  14. The web service sends the payment result to the customer.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Meeza Wallet payment method and provide the information about the format of callbacks with purchase results. For the general information on how to use the Gate API, see API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the Meeza Wallet method:

  1. You initiate a purchase by submitting a purchase request to the /v2/payment/wallet/meeza/sale endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the payments by using e-wallets: /v2/payment/wallet/{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
      • first_name—customer first name
      • last_name—customer last name
      • email—customer email
    • account—object with customer account information:
      • number—customer phone number, must contain +20 (Egypt's code) and 10 digits without a plus sign (+), spaces and punctuation.
    • 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 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—code of the purchase currency in the ISO-4217 alpha-3 format
  3. If required, you can add any other additional (optional) parameters Gate supports.

Here is an example of the data from a purchase request in the Meeza Wallet method.

Figure 7. 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": "+201234567890"
    },
    "payment": {
        "amount": 10000,
        "currency": "EGP"
    } 
}

Callback format

The Meeza Wallet method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Gate.

The following is an example of a callback with information about a successful 10,000.00 EGP purchase.

Figure 8. 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": "Wallet Meeza",
        "sum": {
            "amount": 10000,
            "currency": "EGP"
        },
        "description": ""
    },
    "account": {
        "number": "+201234567890"
    },
    "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": 10000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EGP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 9. 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": "Wallet Meeza",
        "sum": {
            "amount": 10000,
            "currency": "EGP"
        },
        "description": ""
    },
    "account": {
        "number": "+201234567890"
    },
    "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": 10000,
            "currency": "EGP"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EGP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

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

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.