African e-wallets and online banking Component

Add African e-wallets and online banking to an existing Components integration.

On this page, you can find additional configuration for adding African e-wallets and online banking to your Components integration.

Before you begin

This page assumes you've already:

When offering this payment method, note that African shoppers expect to see the email and phone number of your business on the payment form. Shoppers will use your contact information in case they need to refund or cancel their payment.

API reference

Select which endpoint you're integrating:

This is the default with Components v5.0.0 or later.

Parameter name	Required	Description
countryCode		The country's two-letter country code. For example, KE.
reference		For Cellulant, the value must be between 3 to 15 characters. Some MNOs restrict using longer values. If the reference is longer than 15 characters, it will be removed but the payment is not rejected.
shopperEmail		The shopper's email address.
shopperName		The shopper's first name and last name.
telephoneNumber		The shopper's telephone number.

If you already have the shopper's name, email, and phone number, you can provide them in the /sessions request to improve the shopper experience. We pass this information to Cellulant so your shoppers won't have to fill these in later when they're redirected to the payment form.

curl https://checkout-test.adyen.com/v68/sessions \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "reference": "YOUR_ORDER_REFERENCE",
  "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.."
}'

Client client = new Client("Your X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

CreateCheckoutSessionRequest sessionRequest = new CreateCheckoutSessionRequest();
sessionRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
sessionRequest.setReference("YOUR_ORDER_REFERENCE");

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

sessionRequest.setCountryCode("KE");
sessionRequest.setTelephoneNumber("+254712123456");
sessionRequest.setShopperEmail("shopper@example.com");

Name shopperName = new Name();
shopperName.setFirstName("Simon");
shopperName.setLastName("Hopper");
sessionRequest.setShopperName(shopperName);

sessionRequest.returnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

CreateCheckoutSessionResponse sessionResponse = checkout.sessions(sessionRequest);

var checkoutSessionRequest = new CreateCheckoutSessionRequest
{
    MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
    Reference = "YOUR_ORDER_REFERENCE",
    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.."
};
var client = new Client("YOUR_X-API-KEY", Model.Enum.Environment.Test);
var checkout = new Checkout(client);
var createCheckoutSessionResponse = checkout.Sessions(checkoutSessionRequest);

https://docs.adyen.com/payment-methods/africa-cellulant/web-component#cellulant-web-sessions

If you implemented an advanced use case, or integrated Components before v5.0.0.

Parameter name	Required	Description
countryCode		The country's two-letter country code. For example, KE.
reference		For Cellulant, the value must be between 3 to 15 characters. Some MNOs restrict using longer values. If the reference is longer than 15 characters, it will be removed but the payment is not rejected.
shopperEmail		The shopper's email address.
shopperName		The shopper's first name and last name.
telephoneNumber		The shopper's telephone number.
paymentMethod.issuer		Specify an issuer to skip the MNO selection step and switch the shopper directly to the page of the issuer. For example, ORANGE_CI.

If you already have the shopper's name, email, and phone number, you can provide them in the /payments request to improve the shopper experience. We pass this information to Cellulant so your shoppers won't have to fill these in later when they're redirected to the payment form.

curl https://checkout-test.adyen.com/v68/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
   "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.
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.."
})

// Create a Client to establish a connection to our services with your API Key from the Customer Area.
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);

https://docs.adyen.com/payment-methods/africa-cellulant/web-component#cellulant-web-payments

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="cellulant-container"></div>

Step 2: Create an instance of the Component

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

const cellulantComponent = checkout.create('cellulant').mount('#cellulant-container');

Test and go live

Make a test payment then follow Cellulant's payment simulation instructions. Use the test credentials provided by Cellulant.

Then check the status of the test payment in your test Customer Area > Transactions > Payments.

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

Are you looking for test card numbers?

Would you like to contact support?