Card payments via partner (in different countries)

Overview

Payment method that supports purchase and refund processing via partner by using payment cards. You can perform purchases through this method by using Payment Page and Gate, refunds by using Gate.

Download the logo in vector format here.
Payment method type Card payments via partner
Countries and regions Global *
Payment currencies KES, USD
Currency conversion
Purchases
Payouts
COF payments
Full refunds
Partial refunds
Chargebacks
Special considerations
Onboarding and access fee Refer to your Monetix key account manager

* Refer to your Monetix key account manager for additional information.

Interaction diagram

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

Operations support

Interfaces Amounts, KES Amounts, USD
Payment Page Gate Dashboard minimum maximum minimum maximum
Purchases 10.00 200, 000.00 1.00 3, 000.00
Full refunds

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

To perform a purchase operation, you need to redirect customer to the partner service, while to perform a refund, you need to notify customer via merchant's web service.

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

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.

Purchase by using Payment Page

General information

In the 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 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.

Figure 4. Purchase by using Payment Page
  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified Monetix URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the payment method.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing.
  10. The payment platform sends the customer redirection data to Payment Page.
  11. The customer is redirected to the partner website.
  12. The customer completes all the required payment steps .
  13. The payment is processed on the partner side.
  14. The result is displayed to the customer on the partner website.
  15. The customer is redirected to Payment Page.
  16. The partner service sends the result notification to the payment platform.
  17. The payment platform sends a callback with the payment result to the web service.
  18. The payment platform sends the result to Payment Page.
  19. A 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 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 method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • 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.
    • 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
  2. It is recommended to specify the phone number and e-mail address of the customer in the customer_phone and customer_email additional parameters. If the request is missing the parameters, on Payment Page the additional fields are displaying to the customer to input missing data. For more details about clarification, see Submission of additional payment information.
  3. The currency of payment can only be KES or USD.
  4. If you need to have payment form displayed with the partner method selected, set the force_payment_method parameter to card-partner.
  5. If required, you can also add any other additional parameters Payment Page supports.
  6. 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 purchase request.

    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'KES', 
      project_id: 250, 
      customer_id: 'customer1',
      customer_first_name: 'John', 
      customer_last_name: 'Doe',
      customer_email: 'johndoe@example.com', 
      customer_phone: '123456789',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yoASCQ9vyS...wX6R\/ekpZhkIQg=="
    }

For information about all parameters available in the partner method, see Payment Page invocation parameters.

Callback format

The partner 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 10.00 KES purchase made in the 2924 project.

Figure 5. Example of a successful purchase callback
{
        "project_id": 2924,
        "payment": {
            "id": "EP79a6-d2db",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-26T15:03:20+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "12345678900"
        },
        "operation": {
            "id": 389,
            "type": "sale",
            "status": "success",
            "date": "2020-08-26T15:03:19+0000",
            "created_date": "2020-08-26T15:03:05+0000",
            "request_id": "0be9d6d54056a9dd9d99fd1c...95768e7c5eb5d-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KES"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2377,
                "payment_id": "1598454195644A",
                "auth_code": ""
            }
        },
        "signature": "pwg+4nslNir5KFxiokPtOX6M...nDfcqf4nvNRWahe6L4qzT9Q=="
    }

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

Figure 6. Example of a declined purchase callback
{
        "project_id": 2924,
        "payment": {
            "id": "EPee51-5d3f",
            "type": "purchase",
            "status": "decline",
            "date": "2020-08-26T15:15:39+0000",
            "method": "Card partner",
            "sum": {
                "amount": 11300,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "12345678900"
        },
        "operation": {
            "id": 390,
            "type": "sale",
            "status": "decline",
            "date": "2020-08-26T15:15:39+0000",
            "created_date": "2020-08-26T15:15:24+0000",
            "request_id": "b49045c4fce49592b1ef5...4801c2566c9404ed5-00000001",
            "sum_initial": {
                "amount": 11300,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 11300,
                "currency": "KES"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2377,
                "payment_id": "1598454934830A",
                "auth_code": ""
            }
        },
        "signature": "2vi4mi6gY/r+EI4z+6fBPd0d...EjR/tohNOjjhOm5ex5z/hA=="
    }

Related topics

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

Purchase by using Gate

General information

In the method, 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 partner 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.

Figure 7. Purchase by using Gate
  1. A customer initiates a purchase through partner on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified 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 of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response structure.
  6. The payment platform performs the internal purchase request processing.
  7. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  8. The customer is redirected from the web service to the partner service.
  9. The customer completes all the required payment steps .
  10. The payment is processed on the partner side.
  11. The result is displayed to the customer.
  12. The customer is redirected to the merchant's web service.
  13. The partner service sends the payment result notification to the payment platform.
  14. The payment platform sends a callback to the web service.
  15. The customer receives the payment result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the partner payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the partner method:
  1. You send purchase requests by sending the /v2/payment/card-partner/sale request by using HTTP method POST.
  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—customer device IP
      • first_name—customer first name
      • last_name—customer last name
      • email—customer email
    • payment—object with payment information:
      • 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.
      • currency—purchase currency in ISO-4217 alpha-3 format
  3. It is recommended to specify the phone number and e-mail address of the customer. If the request is missing the parameters, the list of parameters is sent in the clarification callback. For more details, see Submission of additional payment information. It is recommend to use the following objects and parameters:
    • customer—object with customer information:
      • phone—phone number
      • email—email address
  4. The currency of payment can only be KES or USD.
  5. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. 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.
    • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
      • success—the URL to redirect the customer to after the payment is successfully completed
      • decline—the URL to redirect the customer to after the payment is declined
      • 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
  6. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request.

Figure 8. Example of a purchase request
{
    "general": {
    "project_id": 125,
    "payment_id": "TEST_184",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVL...8yJA=="
  },
  "customer": {
    "id": "123",
    "ip_address": "198.51.100.47",
    "phone": "123456789",
    "first_name": "John",
    "last_name": "Doe",
    "email": "johndoe@example.com"
    },
  "payment": {
    "amount": 1000,
    "currency": "KES"
  },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://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 partner 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": "POST",
    "body": {
        "example_parameter_1": "value_1",
        "example_parameter_2": "value_2"
    },
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

The partner 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 10.00 KES purchase made in the 2924 project.

Figure 9. Example of a successful purchase callback
{
        "project_id": 2924,
        "payment": {
            "id": "EP79a6-d2db",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-26T15:03:20+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "12345678900"
        },
        "operation": {
            "id": 389,
            "type": "sale",
            "status": "success",
            "date": "2020-08-26T15:03:19+0000",
            "created_date": "2020-08-26T15:03:05+0000",
            "request_id": "0be9d6d54056a9dd9d99fd1c...95768e7c5eb5d-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KES"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2377,
                "payment_id": "1598454195644A",
                "auth_code": ""
            }
        },
        "signature": "pwg+4nslNir5KFxiokPtOX6M...nDfcqf4nvNRWahe6L4qzT9Q=="
    }

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

Figure 10. Example of a declined purchase callback
{
        "project_id": 2924,
        "payment": {
            "id": "EPee51-5d3f",
            "type": "purchase",
            "status": "decline",
            "date": "2020-08-26T15:15:39+0000",
            "method": "Card partner",
            "sum": {
                "amount": 11300,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "12345678900"
        },
        "operation": {
            "id": 390,
            "type": "sale",
            "status": "decline",
            "date": "2020-08-26T15:15:39+0000",
            "created_date": "2020-08-26T15:15:24+0000",
            "request_id": "b49045c4fce49592b1ef5...4801c2566c9404ed5-00000001",
            "sum_initial": {
                "amount": 11300,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 11300,
                "currency": "KES"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2377,
                "payment_id": "1598454934830A",
                "auth_code": ""
            }
        },
        "signature": "2vi4mi6gY/r+EI4z+6fBPd0d...EjR/tohNOjjhOm5ex5z/hA=="
    }

Related topics

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

Refund by using Gate

General information

This method supports full refunds processing. In the method, any refund follows the usual procedure which is common to Gate: merchant's web service sends a request with all the required parameters and signature to Monetix URL, Gate accepts the request and redirects to the payment platform for further processing. The full sequence of the refund process is provided below.

Figure 11. Refund by using Gate
  1. A customer orders a refund on the merchant's web service side.
  2. Merchant's web service sends the request for the refund processing by using Gate to the appropriate Monetix URL.
  3. Gate redirects the request to the Monetix payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response structure.
  6. The payment platform redirects the refund request to the partner service.
  7. The refund is processed on the partner side.
  8. The partner service sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the refund result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the payment method and provide the information on the format of callbacks with refund results.

Request format

There are several things you must consider when using refund requests in the payment method:

  1. You perform a refund by sending the request to the /v2/payment/card-partner/refund endpoint by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • general—object with general refund information:
      • project_id—project identifier
      • payment_id—unique refund identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
  3. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a refund request.

Figure 12. Example of a refund request 
{  
  "general": {    
    "project_id": 239,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSK4XL1QFaDH3p9Mh...SwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
 }
}

Callback format

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

The following is the example of a callback with an information about successful 10.00 KES refund made in the 2924 project.

Figure 13. Example of a successful refund callback
{
        "project_id": 2924,
        "payment": {
            "id": "EP79a6-d2db",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-08-26T15:32:50+0000",
            "method": "Card partner",
            "sum": {
                "amount": 0,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "64647626828"
        },
        "operation": {
            "id": 391,
            "type": "refund",
            "status": "success",
            "date": "2020-08-26T15:32:50+0000",
            "created_date": "2020-08-26T15:32:47+0000",
            "request_id": "f62983a57ccb816598c012...7c990f66c1db9905-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "KES"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2377,
                "payment_id": "1598455969395",
                "auth_code": ""
            }
        },
        "signature": "T21fEFhc7a0NTi9IqTaTYssHrj8b...jIoWnPqamuEmxvxWiJ9g=="
    }
}

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

Figure 14. Example of a declined refund callback
{
        "project_id": 2924,
        "payment": {
            "id": "EPacf3-b6d0",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-27T08:24:54+0000",
            "method": "Card partner",
            "sum": {
                "amount": 61900,
                "currency": "KES"
            },
            "description": ""
        },
        "customer": {
            "phone": "4534343543"
        },
        "operation": {
            "id": 398,
            "type": "refund",
            "status": "decline",
            "date": "2020-08-27T08:24:54+0000",
            "created_date": "2020-08-27T08:24:51+0000",
            "request_id": "7cbdf5fad13c7f6a92...379b3ca7c2f78fb11de-00000001",
            "sum_initial": {
                "amount": 61900,
                "currency": "KES"
            },
            "sum_converted": {
                "amount": 61900,
                "currency": "KES"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2377,
                "payment_id": "1598516693232RF",
                "auth_code": ""
            }
        },
        "signature": "hzDDj7hxql8FwbWUCCpiGxCh0LQsas...iw4cK4m+zZk4uGa9A=="
    }
}

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.