Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

African eWallets and eBanking for API only

Add African eWallets and eBanking to an existing API integration.

Accept African eWallets and eBanking payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

These instructions explain how to add African eWallets and eBanking to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.

Before starting your African eWallets and eBanking integration:

  1. Make sure that you have set up your back end implementation.
  2. Add African eWallets and eBanking in your Customer Area.

When building your integration, note that you can already collect optional parameters from the shopper. This enhances the shopper experience as they won't have to fill these in later when they're redirected to the Cellulant payment form.

African shoppers expect merchant's email and direct phone number for requesting refunds and cancellations on the payment form. Take this into account when building your payment form for African eWallets and eBanking.

Build your payment form for African eWallets and eBanking

Include Cellulant in the list of available payment methods.

If you are using /paymentMethods to show available payment methods to the shopper, specify the following parameters:

The response contains paymentMethod.type: cellulant.

We provide logos for Cellulant which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

From your server, make a /payments request, specifying:

Parameter name Required Description
paymentMethod.type -white_check_mark- cellulant
paymentMethod.issuer Specify this to skip the MNOs selection step and switch the shopper directly to the specified payment method page. For possible values, refer to the list of issuers.
reference -white_check_mark- Your unique reference for this payment. Keep the value to less than 15 characters as some MNOs restrict using longer values. If reference is longer than 15 characters, it will be stripped but not rejected.
countryCode -white_check_mark- The country's two-letter country code.
returnUrl -white_check_mark- URL to where the shopper should be taken back to after a redirection. The URL can contain a maximum of 1024 characters and should include the protocol: http:// or https://. You can also include your own additional query parameters, for example, shopper ID or order reference number.
shopperEmail The shopper's email address.
shopperName The shopper's first name and last name.
telephoneNumber The shopper's telephone number.

List of issuers.
Country name Country code MNO issuer
Ghana GH AirtelTigo
MTN
Vodafone
TIGOGH
MTNGH
VODAGH
Kenya KE Airtel
Equitel
Safaricom (M-Pesa)
AIRTELKE
EQUITELKE
SAFKE
Tanzania TZ Airtel
Vodacom
AIRTELTZ
VODATZ
Uganda UG Airtel
MTN
AIRTELUG
MTNUG
Zambia ZM Airtel
MTN
MTNZM
Zimbabwe ZI Ecocash
MTN
ECOCASH
Mozambique MZ Vodacom
Mpesa
VODACOMMZ

Here is how you would make a payment request for 10 KES.

curl https://checkout-test.adyen.com/v66/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "paymentMethod":{
    "type":"cellulant"
  },
  "amount":{
    "currency":"KES",
    "value":1000
  },
  "countryCode":"KE",
  "telephoneNumber":"+254712123456",
  "shopperEmail":"shopper@example.com",
  "shopperName":{
     "firstName":"Simon",
     "lastName":"Hopper"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.env = :test
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "cellulant"
  },
  :amount => {
    :currency => "KES",
    :value => 1000
  },
  :countryCode => "KE",
  :shopperEmail => "shopper@example.com",
  :shopperName => {
    :firstName => "Simon",
    :lastName => "Hopper"
  },
  :telephoneNumber => "+254712123456",
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy.."
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

PaymentsRequest paymentsRequest = new PaymentsRequest();

paymentsRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
paymentsRequest.setReference("YOUR_ORDER_REFERENCE");

PaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.setType("cellulant");

paymentsRequest.setPaymentMethod(paymentMethodDetails);

Amount amount = new Amount();
amount.setCurrency("KES");
amount.setValue(1000L);

paymentsRequest.setAmount(amount);
paymentsRequest.setCountryCode("KE");
paymentsRequest.setTelephoneNumber("+254712123456");
paymentsRequest.setShopperEmail("shopper@example.com");

Name shopperDetails = new Name();
shopperDetails.setFirstName("Simon");
shopperDetails.setLastName("Hopper");

paymentsRequest.setShopperName(shopperDetails);
paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = [
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT",
  "reference" => "YOUR_ORDER_REFERENCE",
  "paymentMethod" => [
     "type" => "cellulant"
  ],
  "amount" => [
     "currency" => "KES",
     "value" => "1000"
  ],
  "countryCode" => "KE",
  "telephoneNumber" => "+254712123456",
  "shopperEmail" => "shopper@example.com",
  "shopperName" => [
     "firstName" => "Simon",
     "lastName" => "Hopper"
  ],
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy.."
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "reference": "YOUR_ORDER_REFERENCE",
  "paymentMethod": {
    "type": "cellulant"
  },
  "amount": {
    "currency": "KES",
    "value": "1000"
  },
  "countryCode": "KE",
  "telephoneNumber": "+254712123456",
  "shopperEmail": "shopper@example.com",
  "shopperName": {
    "firstName": "Simon",
    "lastName": "Hopper"
  },
  "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy.."
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
   MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
   Reference = "YOUR_ORDER_REFERENCE",
   PaymentMethod = new DefaultPaymentMethodDetails { Type = "cellulant" },
   Amount = new Model.Checkout.Amount(Currency: "KES", Value: 1000),
   CountryCode = "KE",
   TelephoneNumber = "+254712123456",
   ShopperEmail = "shopper@example.com",
   ShopperName = new Model.Checkout.Name
   {
       FirstName = "Simon",
       LastName = "Hopper"
   },
   ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy.."
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
  merchantAccount: "YOUR_MERCHANT_ACCOUNT",
  reference: "YOUR_ORDER_REFERENCE",
  paymentMethod: {
     type: "cellulant"
  },
  amount: {
     currency: "KES",
     value: "1000"
  },
  countryCode: "KE",
  telephoneNumber: "+254712123456",
  shopperEmail: "shopper@example.com",
  shopperName: {
     firstName: "Simon",
     lastName: "Hopper"
  },
  returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

The /payments response contains:

  • action.url: Link to where you should redirect your shopper.
  • action.method: GET. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.

/payments response
{
   "resultCode":"RedirectShopper",
   "action":{
      "method":"GET",
      "paymentData":"Ab02b4c0!BQABAgCSZT7t...",
      "paymentMethodType":"cellulant",
      "type":"redirect",
      "url":"https://test.adyen.com/hpp/skipDetails.shtml?brandCode=cellulant..."
   },
   "details":[
      {
        "key":"redirectResult",
        "type":"text"
      }
   ],
   ...
}

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.
    When using the HTTP GET method:
    For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.
  2. After the shopper is redirected back to your website or app, check the payment result by making a /payments/details request, specifying:
    • paymentData: The value your received in the /payments response.
    • details.redirectResult: Object that was returned when the shopper was redirected back to your website or app.
    /payments/details request
    {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "redirectResult":"Ab02b4c0!BQABAgCW5sxB4e/=="
         }
    }
    You receive a response containing:
    • resultCode: Use this to present the result to your shopper.
    • pspReference: Our unique identifier for the transaction.
    /payments/details response
     {
       "resultCode": "Authorised",
       "pspReference": "88154795347618C"
     }

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for African eWallets and eBanking are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful and proceed with the order.
You will receive the funds in 7 days.
Cancelled The shopper canceled the payment while on the website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.

If the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment. The notification webhooks you can receive for are:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.

Test and go live

Use the Cellulant's sandbox to test African eWallets and eBanking payments.
Check the status of African eWallets and eBanking test payments in your Customer Area > Transactions > Payments.

Before you can accept live African eWallets and eBanking payments, you need to submit a request for Cellulant in your live Customer Area.

See also