API Reference

Redirect URL

Overview

As a vital part of integrating with our payment platform, merchants are required to specify a redirect_url. This URL is where customers will be redirected after completing a payment process on another page. To provide comprehensive transaction details, our platform appends three parameters to this URL:

  1. transaction_id
  2. merchant_reference
  3. status

Below, we provide detailed information about each of these parameters and how they can be utilized for an efficient post-transaction process.

Parameters

  1. Transaction ID (transaction_id)

This is a unique identifier for the transaction on our platform. It can be used for tracking and reconciliation purposes.

Example: transaction_id=123456789

  1. Merchant Reference (merchant_reference)

This parameter represents the reference ID provided by the merchant during the transaction initiation. It helps in correlating the transaction with the merchant's internal records.

Example: merchant_reference=order1234

  1. Transaction Status (status)

This parameter indicates the final status of the transaction. It can have various values such as succeeded, failed, or pending, allowing the merchant to take appropriate actions based on the transaction outcome.

Example: status=succeeded

Handling Redirection

After a transaction is processed, customers will be redirected to the URL provided by the merchant with the aforementioned parameters appended. It is crucial for merchants to handle these parameters appropriately to ensure a seamless post-transaction experience for their customers.

Example of a Complete Redirect URL:

  • https://www.merchantwebsite.com/payment-confirmation?transaction_id=123456789&merchant_reference=order1234&status=succeeded

📘

Mobile Money / QR Code

For transactions using Mobile Money or External payment methods, where payment instructions are directly presented to the customer, the redirect_url is not necessary.

In these scenarios, payment confirmation is achieved by the customer's actions, without the need for redirection to an external page.

Best Practices

  • Validate Parameters: Ensure the integrity of the parameters received in the redirect URL.
  • Display Relevant Information: Use the parameters to display transaction-related information to the customer, such as order status, transaction ID, etc.
  • Error Handling: Be prepared to handle different transaction statuses, including failed or pending transactions, and inform the customer accordingly.

Support

If you require any assistance or have questions regarding the redirect URL configuration, please feel free to contact our support team.