Purchase 4: displaying payment instructions

When performing a purchase, the customer follows the payment instructions displayed in your system.

Countries and regions Cameroon
Payment currencies XAF
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

The amounts for the XAF currency must be specified in major currency units (without any fractional part) according to the ISO-4217 alpha-3 standard.

For example, if the customer initiates a 1000 XAF purchase in your system, you are required to submit the 1000 as the payment amount in your purchase 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 Africa (Host2host) payment method.

Table 1. Supported mobile network operators
Mobile network operator ID Countries Currencies
MTN MTN Cameroon XAF
Orange ORANGE Cameroon XAF

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.

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 Gate

General information

To perform a purchase by using Gate with the Mobile Commerce in Africa (Host2host) payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Show the screen with payment instructions to the customer.
  3. 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 Africa (Host2host) payment method.

Figure 2. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to the Monetix payment platform.
  3. 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.)
  4. The payment platform generates the data for displaying the payment instructions to the customer and sends the data to your system in the display_data array.
  5. Your system displays the payment instructions to the customer.
  6. The customer completes the purchase.
  7. The provider service informs the payment platform about the purchase result.
  8. The payment platform sends the callback with the payment result to your system.
  9. 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 Africa (Host2host) payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/mobile/sale
Table 3. Basic parameters of a purchase request

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

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

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

payment
object
strictly required

currency
string
strictly required

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

Example: XAF

amount
integer
strictly required

Payment amount in major currency units (without fractional part).

If the currency has minor units (i.e. the number of digits for minor currency units is not zero), set this parameter to the amount in the minor currency units without any decimal point or comma. To check whether the currency has any minor units, see Currency units and Currency codes.

Example: 100 XAF must be sent as 100

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 Africa (Host2host) payment method:

Figure 3. 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": "233123456789",
        "service_provider": "ORANGE"
    },
    "payment": {
        "currency": "XAF",
        "amount": 100
    }
}

Displaying the payment instructions to the customer

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

Use the data from the display_data array to display the payment instructions to the customer.

Table 4. Description of the display_data array
Element Description 
{
    "type": "add_info",
    "title": "amount",
    "data": "100"
}
 Payment amount.

Example: 100

 
{
    "type": "add_info",
    "title": "currency",
    "data": "XAF"
}
 Payment currency.

Example: XAF

 
{
    "type": "add_info",
    "title": "bank_name",
    "data": "ORANGE"
}
 Payment recipient's mobile network operator.

Example: ORANGE

 
{
    "type": "add_info",
    "title": "receiver_account",
    "data": "233987654321"
}
 Payment recipient's phone number.

Example: 233987654321

 
{
    "type": "add_info",
    "title": "lifetime",
    "data": "1200"
}
 The lifetime of the payment details (in seconds).

Example: 1200

The following is the callback fragment containing display_data array.

"display_data": [
    {
        "type": "add_info",
        "title": "amount",
        "data": "100"
    },
    {
        "type": "add_info",
        "title": "currency",
        "data": "XAF"
    },
    {
        "type": "add_info",
        "title": "bank_name",
        "data": "ORANGE"
    },
    {
        "type": "add_info",
        "title": "receiver_account",
        "data": "233987654321"
    },
    {
        "type": "add_info",
        "title": "lifetime",
        "data": "1200"
    }
]

Callback

In the Mobile Commerce in Africa (Host2host) 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 4. 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": 100,
            "currency": "XAF"
        },
        "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": 100,
            "currency": "XAF"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "XAF"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "233123456789",
        "type": "ORANGE"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an 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": "2024-12-07T19:08:45+0000",
        "method": "mobile",
        "sum": {
            "amount": 100,
            "currency": "XAF"
        },
        "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": 100,
            "currency": "XAF"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "XAF"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "233123456789",
        "type": "ORANGE"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics