African eWallets and eBanking for API only

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

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:

• 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.

The response contains paymentMethod.type: cellulant.

Make a payment

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

• paymentMethod.type: cellulant.
• 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.

• paymentMethod.issuerId: Skip the MNOs selection step and switch the shopper directly to the specified payment method page. See the following table for details.

  Country name	Country code	MNO	issuerId
  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

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",
  "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 or POST. 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.
  The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

To verify the payment result in the next step, you also need the following from the /payments response:

• action.paymentData: The paymentData value that you send in your /payments/details request.
• details: Array of parameters that you need to send in your /payments/details request. For example, payload or redirectResult.
  The parameters can vary based on the payment method configuration. Always check the details array for the parameters that you need to send in your next API request.

{
   "resultCode":"RedirectShopper",
   "action":{
      "method":"GET",
      "paymentData":"Ab02b4c0!BQABAgCSZT7t...",
      "paymentMethodType":"cellulant",
      "type":"redirect",
      "url": "https://test.adyen.com/hpp/checkout.shtml?u=skipDetails..."

   },
   "details":[
      {
         "key":"payload",
         "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: Value you received in 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 website or app. 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/paytm/api-only#-payments-details-request

   /payments/details request

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

   You receive a response containing:
   • resultCode: Use this to present the result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   https://docs.adyen.com/payment-methods/paytm/api-only#-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