African eWallets and eBanking Component

Our African eWallets and eBanking Component renders the available payment methods in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

Before you begin

This page explains how to add African eWallets and eBanking to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your African eWallets and eBanking integration:

1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
2. Add African eWallets and eBanking in your test 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 Celullant payment form.

• shopperEmail: The shopper's email address.
• shopperName: The shopper's first name and last name.
• telephoneNumber: The shopper's telephone number.

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.

Show African eWallets and eBanking in your payment form

To present the Component in your payment form:

1. From your server, make a POST /paymentMethods request specifying:

   • countryCode: Any supported country. For example, KE.
   • amount.currency: Any supported currency. For example, KES.
   • amount.value: The value of the payment, in minor units.

2. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

3. Add the African eWallets and eBanking Component:
   a. Create a DOM element for African eWallets and eBanking, placing it where you want the form to be rendered:

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

   b. Create and mount an instance of the African eWallets and eBanking Component using its component name, cellulant. This renders a button on your payment form.

   function handleOnSubmit(state, component) {
       // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
       state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
       state.data // Provides the data that you need to pass in the `/payments` call.
       component // Provides the active component instance that called this event.
   }
   const cellulantComponent =  checkout.create('cellulant', {
       onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
   }).mount('#cellulant-container');

   When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

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.

Make a payment

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

• paymentMethod: The state.data.paymentMethod from the onChange or onSubmit event from your front end.
• returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. 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.
• countryCode: The country's two-letter country code.
• reference: Required. Your reference to uniquely identify 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.

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

curl https://checkout-test.adyen.com/v64/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "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 an action object with type: redirect.

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

If your integration is set up correctly, the action object is passed from your server to the client, and the action.paymentData temporarily stored on your server.

When making a /payments request, you can additionally specify paymentMethod.issuerId to skip the MNOs selection step and switch the shopper directly to the specified payment method page.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

1. Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:

   checkout.createFromAction(action).mount('#my-container');

   The Component redirects the shopper to the Cellulant payment form to complete the payment.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • paymentData: The value from the /payments response.
   • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your site. For example, payload or redirectResult.

   The parameters can vary based on the payment method configuration. To check which parameters you should submit, always check the details array from the /payments response.

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

   /payments/details request

   {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "{hint:Verify the parameters from /payments response}payload{/hint}":"Ab02b4c0!BQABAgCW5sxB4e/=="
         }
   }

   The /payments/details response contains:

   • resultCode: Use this to present the payment result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   https://docs.adyen.com/payment-methods/africa-cellulant/web-component#-payments-details-response

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

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:

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