The Africa's Talking C# API wrapper provides convenient access to the Africa's Talking API from applications written in C#. With support for .NET45, .NET46 and .NET Standard 2.0.
Take a look at the API docs here for more information.
- On a new project, Navigate to the Solution Explorer tab within Visual Studio.
- Right-click on the References node and click on the Manage Nuget Packages from the resulting context menu.
- On the Nuget Package Manager window navigate to the Browse Tab.
- Key in AfricasTalking.NET and select version 1.1.720 or higher.
- Click on the Install button and accept the licences to proceed.
For .NET Standard 2.0 projects yellow triangles may appear on your solution items,note that these are warnings due to deprecated support for some packages used by the wrapper.These will be reviewed in future releases,for now they will not affect the functionality of your project and can be safely ignored.Should there be a case where this package breaks your project kindly report the package via Nuget.
For more info on this follow this thread and this link .
- From the command prompt/powershell window opened in your project directory, key in the following and press Enter.
dotnet add package AfricasTalking.NET --version 1.1.720Ensure you have the latest version of the package. Visit Nuget for more info on the latest release of this package.
- On your Nuget package manager console,key in the following and press Enter
Install-Package AfricasTalking.NET -Version 1.1.720 Ensure you have the latest version of the package. Visit Nuget for more info on the latest release of this package
- To use this package ensure you add the following
usingstatement to your project file:
using AfricasTalkingCS;The package needs to be configured with your Africa's Talking username and API key (which you can get from the dashboard).
const string username = "sandbox"; // substitute with your username if mot using sandbox
const string apikey = "mySandboxKey"; // substitute with your production API key if not using sandbox var gateway = new AfricasTalkingGateway(username, apiKey);
Important:
If you register a callback URL with the API, always remember to acknowledge the receipt of any data it sends by responding with an HTTP 200; Here's a sample application you can use to test a call-back url
For example in an ASP.NET Core or ASP.NET MVC Project
[HttpPost]
public ActionResult SomeCoolMethod(awesome, params)
{
// Your awesome logic
//If not using MVC5
return new HttpStatusCodeResult(200);
//If using MVC5
return new HttpStatusCodeResult(HttpStatusCode.OK); // OK = 200
} try
{
var sms = gateway.SendMessage(recepients, msg);
foreach (var res in sms["SMSMessageData"]["Recipients"])
{
Console.WriteLine((string)res["number"] + ": ");
Console.WriteLine((string)res["status"] + ": ");
Console.WriteLine((string)res["messageId"] + ": ");
Console.WriteLine((string)res["cost"] + ": ");
}
}
catch (AfricasTalkingGatewayException exception)
{
Console.WriteLine(exception);
}-
SendMessage(to,message,from,bulkSmsMode,options): The following arguments are supplied to facilitate sending of messages via our APIsto: The recipient(s) expecting the messagemessage: The SMS body.from: (Optional) The Short-code or Alphanumeric ID that is associated with an Africa's Talking account.bulkSmsMode(Optional) : This parameter will be used by the Mobile Service Provider to determine who gets billed for a message sent using a Mobile-Terminated Short-code. Must be set to 1 for Bulk SMS. .options: (Optional). Passed as key-value pairsenque: This parameter is used for Bulk SMS clients that would like deliver as many messages to the API before waiting for an Ack from the Telcos. If enabled, the API will store the messages in its databases and send them out asynchronously after responding to the requestkeyword: This parameter is used for premium services. It is essential for subscription premium services.linkId: This parameter is used for premium services to send OnDemand messages. We forward the linkId to your application when the user send a message to your service. (Essential for premium subscription services)retryDurationInHours: This parameter is used for premium messages. It specifies the number of hours your subscription message should be retried in case it's not delivered to the subscriber. (Essential for premium subscription services)
​
You can register a callback URL with us and we will forward any messages that are sent to your account the moment they arrive. Read more
-
FetchMessages(lastReceivedId): Manually retrieve your messages.lastReceivedId: This is the id of the message that you last processed. If this is your first call, pass in 0.REQUIRED
-
CreateSubscription(phoneNumber,shortCode,keyWord,checkoutToken):shortCode: This is a premium short code mapped to your accountREQUIREDkeyWord: Value is a premium keyword under the above short code and mapped to your account.REQUIREDphoneNumber: The phoneNumber to be subscribedREQUIREDcheckoutToken: This is a token used to validate the subscription requestREQUIRED
If you have subscription products on your premium SMS short codes, you will need to configure a callback URL that we will invoke to notify you when users subscribe or unsubscribe from your products (currently supported on Safaricom).Visit this link to learn more on how to setup a subscription callback
Example - Creating Checkout Token
var username = "sandbox";
var apikey = "KEY";
var gateway = new AfricasTalkingGateway(username, apikey);
var phoneNum = "+254XXXXXXXXX"; // Ensure the phonenumber is properly formatted
try
{
var token = gateway.CreateCheckoutToken(phoneNumber);
Console.WriteLine("Your Token is: " + token);
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Yikes: " + e.StackTrace + ". " + e.Message);
}Example - Creating Premium SMS subscription
var username = "sandbox";
var apikey = "KEY";
var gateway = new AfricasTalkingGateway(username, apikey);
var shortCode = "NNNNN";
var keyword = "keyword";
var phoneNum = "+254XXXXXXXXX";
var token = "Token";
try
{
var response = gateway.CreateSubscription(phoneNum, shortCode, keyword, token);
Console.WriteLine(response);
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("We hit a snag: " + e.StackTrace + ". " + e.Message);
throw;
}Example -Sending Premium SMS
var username = "sandbox";
var apikey = "KEY";
var gateway = new AfricasTalkingGateway(username, apikey);
var opts = new Hashtable { ["keyword"] = "mykeyword" }; // ....
var from = "NNNNN";
var to = "+2547XXXXX,+2547XXXXY";
var message = "Super Cool Message";
try
{
var res = gateway.SendMessage(to, message, from, 1, opts); // Set Bulk to true
Console.WriteLine(res);
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Whoops: " + e.Message);
throw;
}- This allows you to push an outbound call to a set of phone numbers and sip addresses.
var callees = "[email protected],+2ABCXXYYYYYY,[email protected],[email protected]";
var callerId = "+2ABaxxyyyyyy";
var clientRequestId = "fieldAgents";
var callAction = gateway.Call(callerId, callees, clientRequestId); Call(from, to, clientRequestId):from: This is the set caller ID also known as the virtual number provided by Africa's Talking.REQUIRED.to: This is a list of destinations to which the call is to be terminated.REQUIREDclientRequestId: This is parameter that is set to track the particular outbound call session. The value will be sent to your callback url once the call is complete.OPTIONAL;
var username = "UserName";
var apiKey = "APIKEY";
var from = "virtualNumber";
var to = "Number";
var id = "RegionA";
var gateway = new AfricasTalkingGateway(username, apiKey);
try
{
var results = gateway.Call(from, to, id);
Console.WriteLine(results);
}
catch (AfricasTalkingGatewayException exception)
{
Console.WriteLine("Something went horribly wrong: " + exception.Message + ".\nCaused by :" + exception.StackTrace);
}Take a look at the voice sample application here VoiceCallbackSample
- This feature alllows you to upload a media file from a known url to our servers. This media file can then be played on demand for example when executing
<Play>action from your dialplan ormusicOnHoldorringBackToneattributes on a dialplan.
const string fileLocation = "http(s)://<url>.mp3/wav";
const string phoneNumber = "callerID";
var results = gateway.UploadMediaFile(fileLocation, phoneNumber); UploadMediaFile(url, phoneNumber):url: A valid web url pointing to the server on which the file is hosted.REQUIRED.phoneNumber: A registered virtual number provided by Africa's Talking.REQUIRED.
const string username = "UserName";
const string apikey = "APIKEY";
const string fileLocation = "http(s)://<url>.mp3||wav";
const string phoneNumber = "callerID";
var gateway = new AfricasTalkingGateway(username, apikey);
try
{
var results = gateway.UploadMediaFile(fileLocation, phoneNumber);
Console.WriteLine(results);
}
catch (AfricasTalkingGatewayException exception)
{
Console.WriteLine("Something went horribly wrong: " + exception.Message + ".\nCaused by :" + exception.StackTrace);
}This feature allows you to get number of queued calls from the service. Ideally for this to work you should have a virtual number whose dialplan is set to <Enqueue>.
const string queueNumber = "+2ABCXYYYYYY";
const string queueName = "myQueue";
var results = gateway.GetNumberOfQueuedCalls(queueNumber,queueName); GetNumberOfQueuedCalls(phoneNumber, queueName):phoneNumber: This is an Africa's Talking virtual number with an<Enqueue>dialplan.REQUIRED.queueName: This is a user defined name assigned to the queue.OPTIONAL
var airtimeTransaction = gateway.SendAirtime(airtimerecipients);SendAirtime(recipients):recipients: Contains JSON objects containing the following keysphoneNumber: Recipient of airtimeamount: Amount sent>= 10 && <= 10Kwith currency e.gKES 100
class AirtimeUsers {
[JsonProperty("phoneNumber")]
public string PhoneNumber { get; set; }
[JsonProperty("amount")]
public string Amount { get; set; }
}
const string username = "UserName";
const string apikey = "MyAPIKEY";
var airtimeUser = new AirtimeUsers();
airtimeUser.PhoneNumber = "+2547XXYYYYYY";
airtimeUser.Amount = "KES 100";
var airtimeRecipient = JsonConvert.SerializeObject(airtimeUser);
var gateway = new AfricasTalkingGateway(username, apikey);
try
{
var airtimeTransaction = gateway.SendAirtime(airtimeRecipient);
Console.WriteLine(airtimeTransaction);
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("We ran into issues: " + e.StackTrace + ": " + e.Message);
}Mobile Consumer To Business (C2B) functionality allows your application to receive payments that are initiated by a mobile subscriber. This is typically achieved by disctributing a PayBill or BuyGoods number (and optionally an account number) that clients can use to make payments from their mobile devices. Read more
-
Checkout(productName,phoneNumber,currencyCode,amount,providerChannel,metadata): Initiate Customer to Business (C2B) payments on a mobile subscriber's device. More info-
productName: Your Payment Product.REQUIRED -
phoneNumber: The customer phone number (in international format; e.g.+25471xxxxxxx).REQUIRED -
currencyCode: 3-digit ISO format currency code (e.gKES,USD,UGXetc.)REQUIRED -
amount: This is the amount.REQUIRED -
providerChannel: Default provider channel details.For exampleMPESAorAthenafor sandbox.-
(Sandbox) : Note that for sandbox you'll have to manually create a channel that will be associated with
Athena. This is the channel name that you will pass as an argument during a checkout. Example after creating a channel you will haveAthena:channel_name, passchannel_nameas the providerChannel .​
-
-
metadata: This value contains a map of any metadata that you would like us to associate with this request. You can use this field to send data that will map notifications to checkout requests, since we will include it when we send notifications once the checkout is complete.(Optional)​
-
Example
var username = "sandbox";
var apiKey = "";
var productName = "coolproduct";
var phoneNumber = "+254XXXXXXX";
var currency = "KES";
int amount = 35700;
var channel = "mychannel";
var metadata = new Dictionary<string, string>
{
{ "reason", "stuff" }
};
var gateway = new AfricasTalkingGateway(username, apiKey);
try
{
// You will get an object of type C2BDataResults :
// From which you can extract the following properties
// 1. C2BDataResults.ProviderChannel
// 2. C2BDataResults.Status
// 3. C2BDataResults.Description
// 4. C2BDataResults.TransactionId
// You also get a ToString() method
C2BDataResults checkout = gateway.Checkout(productName, phoneNumber, currency, amount, channel, metadata);
Console.WriteLine(checkout.Status);
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("We ran into problems: " + e.Message);
} -
MobileB2C(productName,recepients): Initiate payments to mobile subscribers from your payment wallet. More info-
productName: Your Payment Product.REQUIRED -
recipients: A list of up to 10 recipients info and metadata. Each recipient has:-
phoneNumber: The payee phone number (in international format; e.g.+25471xxxxxxx).REQUIRED -
currencyCode: 3-digit ISO format currency code (e.gKES,USD,UGXetc.)REQUIRED -
amount: Payment amount.REQUIRED -
metadata: Some optional data to associate with transaction.
-
-
Example
// Suppose a superhero unknowingly paid for a suit they did not like,and we want to refund them
// or you want to pay your employees,staff etc...
// Note::
/*
* Remember: In a live account ensure you have registered a credible B2C product and a callback url else these transactions will fail
*/
// Developer Details
string username = "sandbox";
string apiKey = "apikey";
string productName = "coolproduct";
string currencyCode = "KES";
// Recepient details,these can be retrieved from a db..or somewhere else then parsed...we'll keep it simple
string hero1PhoneNum = "+254xxxxxxx";
string hero2PhoneNum = "+254xxxxxxx";
string hero1Name = "Batman";
string hero2Name = "Superman";
decimal hero1amount = 15000M;
decimal hero2amount = 54000M;
// We invoke our gateway
var gateway = new AfricasTalkingGateway(username, apiKey);
// Let's create a bunch of people who'll be receiving the refund or monthly salary etc...
var hero1 = new MobileB2CRecepient(hero1Name, hero1PhoneNum, currencyCode, hero1amount);
// we can add metadata...like why we're paying them/refunding them etc...
hero1.AddMetadata("reason", "Torn Suit");
var hero2 = new MobileB2CRecepient(hero2Name, hero2PhoneNum, currencyCode, hero2amount);
hero2.AddMetadata("reason", "Itchy Suit");
// ....etc
// Next we create a recepients list
IList<MobileB2CRecepient> heroes = new List<MobileB2CRecepient>
{
hero1,
hero2
};
// let's refund them so that they can keep saving the planet
try
{
var response = gateway.MobileB2C(productName, heroes);
Console.WriteLine(heroes);
Console.WriteLine(response);
// The response type is of type DataResult.
// You can query :
// 1 - DataResult.NumQueued (type int)
// 2 - DataResult.Entries (type IList)
// 3 - DataResult.TotalValue (type string)
// 4 - DataResult.TotalTransactionFee (type string)
// You also have a DataResult.ToString() method available
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("We ran into problems: " + e.StackTrace + e.Message);
}
Console.ReadLine();
}-
MobileB2B(product,providerChannel,transfer,currency,transferAmount,channelReceiving,accountReceiving,b2Bmetadata): Mobile Business To Business (B2B) APIs allow you to initiate payments TO businesses eg banks FROM your payment wallet. More infoproduct: Your Payment Product as setup on your account.REQUIREDproviderChannel: This contains the payment provider that is facilitating this transaction.REQUIREDSupported providers at the moment are:
​
string provider = "Athena"; // or string provider = "MPESA";
​
-
transfer: This is the transfer type for the transaction:REQUIREDstring transferType = "BusinessToBusinessTransfer"; // Transfer Types /** * BusinessBuyGoods * BusinessPayBill * DisburseFundsToBusiness * BusinessToBusinessTransfer */
​
-
currency: 3-digit ISO format currency code (e.gKES,USD,UGXetc.)REQUIRED -
channelReceiving: This value contains the name or number of the channel that will receive payment by the provider.REQUIRED -
accountReceiving: This value contains the account name used by the business to receive money on the provided destinationChannel.REQUIRED -
transferAmount: Payment amount.REQUIRED -
b2Bmetadata: Some optional data to associate with transaction.REQUIRED
Example
// Suppose we want to move money from our *awesomeproduct* to *coolproduct*
/*
* Remember to register B2B products and callback urls:else these trasactions will fail
*/
string username = "sandbox";
string apiKey = "APIKEY";
string productName = "awesomeproduct";
string currencyCode = "KES";
decimal amount = 15;
string provider = "Athena";
string destinationChannel = "mychannel"; // This is the channel that will be receiving the payment
string destinationAccount = "coolproduct";
dynamic metadataDetails = new JObject();
metadataDetails.shopName = "cartNumber";
metadataDetails.Info = "Stuff";
string transferType = "BusinessToBusinessTransfer";
var gateWay = new AfricasTalkingGateway(username, apiKey);
try
{
string response = gateWay.MobileB2B(
productName,
provider,
transferType,
currencyCode,
amount,
destinationChannel,
destinationAccount,
metadataDetails);
Console.WriteLine(response);
// This method avails the B2BResults object that can be unpacked to obtain:
// 1 - B2BResults.ProviderChannel
// 2 - B2BResults.TransactionId
// 3 - B2BResults.TransactionFee
// 4 - B2BResults.Status
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Woopsies! We ran into issues: " + e.StackTrace + " : " + e.Message);
}
BankCheckout(productName,bankAccount,currencyCode,amount,narration,metadata): Bank Account checkout APIs allow your application to collect money into your Payment Wallet by initiating an OTP-validated transaction that deducts money from a customer's bank account. These APIs are currently only available in Nigeria.-
productName: This value identifies the Africa's Talking Payment Product that should be used to initiate this transaction.REQUIRED -
bankAccount: This is a complex type whose structure is described below. It contains the details of the bank account to be charged in this transaction.accountName: The name of the bank account.OptionalaccountNumber: The account number.REQUIREDbankCode: A 6-Digit Integer Code for the bank that we allocate.REQURED. See this link for more detailsdateOfBirth: Date of birth of the account owner.Optional/Required- for Zenith Bank NG.
-
currencyCode: This is the 3-digit ISO format currency code for the value of this transaction (e.g NGN, USD, KES etc). -
amount: This is the amount (in the provided currency) that the mobile subscriber is expected to confirm. -
narration: A short description of the transaction that can be displayed on the client's statement. -
metadata: This value contains a map of any metadata that you would like us to associate with this request. You can use this field to send data that will map notifications to checkout requests, since we will include it when we send notifications once the checkout is complete.
-
Example - For details on OTP see OTP
Console.WriteLine("Hello World!");
const string Username = "sandbox";
const string ApiKey = "Key";
const string Otp = "1234";
var gateway = new AfricasTalkingGateway(Username, ApiKey);
string transId = "id";
var productName = "coolproduct";
var accountName = "Fela Kuti";
var accountNumber = "1234567890";
var bankCode = 234001;
var currencyCode = "NGN";
var amount = 1000.5M;
var dob = "2017-11-22";
var metadata = new Dictionary<string, string> { { "Reason", "Buy Vega Records" } };
var narration = "We're buying something cool";
var receBank = new BankAccount(accountNumber, bankCode, dob, accountName);
try
{
// You get a BankCheckoutResponse object that contains the following properties
// 1. BankCheckoutResponse.Status
// 2. BankCheckoutResponse.TransactionId
// 3. BankCheckoutResponse.Description
// And a ToString() method
BankCheckoutResponse res = gateway.BankCheckout(productName, receBank, currencyCode, amount, narration, metadata);
Console.WriteLine(res);
if (res.Status == "PendingValidation")
{
transId = res.TransactionId;
Console.WriteLine("Validating...");
}
try
{
var valid = gateway.OtpValidate(transId, Otp);
valid = JsonConvert.DeserializeObject(valid);
if (valid["status"] == "Success")
{
Console.WriteLine("Whoooohoo...");
}
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Yikes: " + e.Message + e.StackTrace);
}
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Something odd happened: " + e.Message + e.StackTrace);
}
Console.ReadLine();
-
BankTransfer(productName,recipients): Our API allows you to initiate multiple transactions in one request, all of which will be queued in our gateways for processing.Once the payment provider confirms or rejects the payment request, our APIs will generate a payment notification and send it to the callback URL configured in your account. More infoproductName: This value identifies the Africa's Talking Payment Product that should be used to initiate this transaction.REQUIREDrecipients: This contains a list of Recipient elements, each of which corresponds to a B2C Transaction request. The format for each of these recipients is described in the table below.REQUIRED.-
bankAccount: This is a complex type whose structure is described below. It contains the details of the bank account to be charged in this transaction.accountName: The name of the bank account.OptionalaccountNumber: The account number.REQUIREDbankCode: A 6-Digit Integer Code for the bank that we allocate.REQURED. See this link for more detailsdateOfBirth: Date of birth of the account owner.Optional/Required- for Zenith Bank NG.
-
currencyCode: This is the 3-digit ISO format currency code for the value of this transaction (e.g NGN, USD, KES etc). -
amount: This is the amount (in the provided currency) that the mobile subscriber is expected to confirm. -
narration: A short description of the transaction that can be displayed on the client's statement. -
metadata: This value contains a map of any metadata that you would like us to associate with this request. You can use this field to send data that will map notifications to checkout requests, since we will include it when we send notifications once the checkout is complete.
-
Example
const string username = "sandbox";
const string apikey = "KEY";
const string productname = "coolproduct";
var gateway = new AfricasTalkingGateway(username, apikey);
var currency_code = "NGN";
var recipient1_account_name = "Alyssa Hacker";
var recipient1_account_number = "1234567890";
var recipient1_bank_code = 234001;
decimal recipient1_amount = 1500.50M;
var recipient1_narration = "December Bonus";
var recipient2_account_name = "Ben BitDiddle";
var recipient2_account_number = "234567891";
var recipient2_bank_code = 234004;
decimal recipient2_amount = 1500.50M;
var recipient2_narration = "November Bonus";
var recepient1_account = new BankAccount(recipient1_account_number, recipient1_bank_code, recipient1_account_name);
var recepient1 = new BankTransferRecipients(recipient1_amount, recepient1_account, currency_code, recipient1_narration);
recepient1.AddMetadata("Reason", "Early Bonus");
var recipient2_account = new BankAccount(recipient2_account_number, recipient2_bank_code, recipient2_account_name);
var recipient2 = new BankTransferRecipients(recipient2_amount, recipient2_account, currency_code, recipient2_narration);
recipient2.AddMetadata("Reason", "Big Wins");
IList<BankTransferRecipients> recipients = new List<BankTransferRecipients>
{
recepient1,
recipient2
};
try
{
// Responds with BankTransferResults object that contans:
// An IList object called Entries and a ToString() method
BankTransferResults res = gateway.BankTransfer(productname, recipients);
Console.WriteLine(res.Entries.ToString());
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("We had issues: " + e.Message);
}
Console.ReadLine();Checkout Validation APIs allow your application to validate bank/card charge requests that deduct money from a customer's bank account.
Card Validation
-
ValidateCardOtp(transactionId, otp): Payment Card Checkout Validation APIs allow your application to validate card charge requests that deduct money from a customer's Debit or Credit Card. More infotransactionId:This value identifies the transaction that your application wants to validate. This value is contained in the response to the charge request.REQUIREDotp: This contains the One Time Password that the card issuer sent to the client that owns the payment card.REQUIRED.
Bank Validation
OtpValidate(transactionId, otp): Bank Account checkout Validation APIs allow your application to validate bank charge requests that deduct money from a customer's bank account. More info.transactionId:This value identifies the transaction that your application wants to validate. This value is contained in the response to the charge request.REQUIREDotp: This contains the One Time Password that the card issuer sent to the client that owns the payment card.REQUIRED.
Example
// ....CARD
var gateway = new AfricasTalkingGateway(Username, ApiKey);
try
{
var validate = gateway.ValidateCardOtp(TransactionId, Otp);
var res = JsonConvert.DeserializeObject(validate);
if (res["status"] == "Success")
{
Console.WriteLine("Awesome");
}
else
{
Console.WriteLine("We had an error " + res["status"]);
}
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Validation Error occured : " + e.Message);
}
// ...// ....BANKING
var gateway = new AfricasTalkingGateway(Username, ApiKey);
try
{
var valid = gateway.OtpValidate(transId, Otp);
valid = JsonConvert.DeserializeObject(valid);
if (valid["status"] == "Success")
{
Console.WriteLine("Whoooohoo...");
}
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Yikes: " + e.Message + e.StackTrace);
}
// ...CardCheckout(productName,paymentCard,currencyCode,amount,narration,metadata): Payment Card Checkout APIs allow your application to collect money into your Payment Wallet by initiating transactions that deduct money from a customer's Debit or Credit Card. [More info]((http://docs.africastalking.com/card/checkout)productName: This value identifies the Africa's Talking Payment Product that should be used to initiate this transaction.REQUIRED-
paymentCard: TThis is a complex type whose structure is described below. It contains the details of the Payment Card to be charged in this transaction. Please note that you can EITHER provider this or provider a checkoutToken if you have one.REQUIRED.number: The payment card number.REQUIREDcountryCode: The 2-Digit countryCode where the card was issued (only NG is supported)..REQUIREDcvvNumber: The 3 or 4 digit Card Verification Value.REQUIREDexpiryMonth: The expiration month on the card (e.g 1, 5, 12).REQUIREDexpiryYear: The expiration year on the card (e.g 2019)OptionalauthToken: The card's ATM PIN.REQUIRED
-
currencyCode: This is the 3-digit ISO format currency code for the value of this transaction (e.g NGN, USD, KES etc). -
amount: This is the amount (in the provided currency) that the mobile subscriber is expected to confirm. -
narration: A short description of the transaction that can be displayed on the client's statement. -
metadata: This value contains a map of any metadata that you would like us to associate with this request. You can use this field to send data that will map notifications to checkout requests, since we will include it when we send notifications once the checkout is complete.
-
Example
const string Username = "sandbox";
const string Otp = "1234";
const string ApiKey = "Key";
var transactionId = "id";
var gateway = new AfricasTalkingGateway(Username, ApiKey);
const string ProductName = "awesomeproduct";
const string CurrencyCode = "NGN";
const decimal Amount = 7500.50M;
const string Narration = "Buy Aluku Records";
var metadata = new Dictionary<string, string>
{
{ "Parent Company", "Offering Records" },
{ "C.E.O", "Boddhi Satva" }
};
const short CardCvv = 123;
const string CardNum = "123456789012345";
const string CountryCode = "NG";
const string CardPin = "1234";
const int ValidTillMonth = 9;
const int ValidTillYear = 2019;
var cardDetails = new PaymentCard(CardPin, CountryCode, CardCvv, ValidTillMonth, ValidTillYear, CardNum);
try
{
// 1. Perform a card Checkout, recive the Tranasaction ID then,
// 2. validate against this OTP
var checkout = gateway.CardCheckout(
ProductName,
cardDetails,
CurrencyCode,
Amount,
Narration,
metadata);
/** Expect
* {
"status": "PendingValidation",
"description": "Waiting for user input",
"transactionId": "ATPid_SampleTxnId123"
}
*
*/
if (checkout.Status == "PendingValidation")
{
transactionId = resObject["transactionId"];
// Go ahead and validate with the OTP
Console.WriteLine(transactionId);
}
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("We encountred issues : " + e.Message + e.StackTrace);
throw;
}
Console.WriteLine("Attempting to Validate");
try
{
var validate = gateway.ValidateCardOtp(transactionId, Otp);
var res = JsonConvert.DeserializeObject(validate);
if (res["status"] == "Success")
{
Console.WriteLine("Awesome");
}
else
{
Console.WriteLine("We had an error " + res["status"]);
}
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Validation Error occured : " + e.Message);
throw;
}
Console.ReadLine();This feature allows you to transfer money between Africas's Talking hosted products
WalletTransfer( poductName, targetProductCode, currencyCode, amount, metadata):productName: Your Africa's Talking Payment product to initiate this transaction.REQUIRED.targetProductCode: Unique product code of the Africa's Talking Payment Product to transfer the funds to.REQUIRED.currencyCode: 3-digit ISO format currency code for the value of this transaction (e.g KES, UGX, USD, ...).REQUIRED.amount: Amount - in the provided currency - that the application will be topped up with.REQUIRED.metadata: A Map of any metadata that you would like us to associate with the request.REQUIRED.
StashResponse stashResponse = gateway.WalletTransfer(productName, productCode, currencyCode, amount, metadata);
// StashResponse is an object that contains the following properties:
// StashResponse.Status
// StashResponse.TransactionId
// StashResponse.Description
// And a ToString() methodTopup stash APIs allow you to move money from a Payment Product to an Africa's Talking application stash. An application stash is the wallet that funds your service usage expences
TopupStash(productName, currencyCode, amount, metadata):productName: Your Africa's Talking Payment product to initiate this transaction.REQUIRED.currencyCode: 3-digit ISO format currency code for the value of this transaction (e.g KES, UGX, USD, ...).REQUIRED.amount: Amount - in the provided currency - that the application will be topped up with.REQUIRED.metadata: A Map of any metadata that you would like us to associate with the request.REQUIRED.
StashResponse stashResponse = gateway.TopupStash(productName, currencyCode, amount, metadata);
// StashResponse is an object that contains the following properties:
// StashResponse.Status
// StashResponse.TransactionId
// StashResponse.Description
// And a ToString() methodThis functionality allows you to find a particular payment transaction by it's ID.
FindTransaction(transactionId):transactionId: ID of the transaction you would like to find.REQUIRED.
var findId = gateway.FindTransaction(transactionId);
// ... Unmarshall as so
JObject findIdObject = JObject.Parse(findId);
// ...This feature allows you to fetch transactions of a particular payment product.
Note, for the filters (except for
startDateandendDatewhich can be passed simultaneously) you can only use one filter for any given query, otherwise your query will return an empty set. Passnullfor those that you wont need.
FetchProductTransactions(productName, pageNumber, count, startDate, endDate, category, provider, status, source, destination, providerChannel):productName: The name of the payment product whose transactions you'd like to fetch.REQUIRED.pageNumber: The number of the page you'd like to read results from. Please Note: This STARTS from 1 and NOT 0.REQUIRED.count: The number of transaction results you would like for this query.REQUIRED.startDate: Transaction start date you would like to consider in the format YYYY-MM-DD.OPTIONAL. (Type = filter)endDate: Transaction end date you would like to consider in the format YYYY-MM-DD.OPTIONAL. (Type = filter)category: Transaction category you would like to consider. Possible values are:BankCheckout,CardCheckout,MobileCheckout,MobileC2B,MobileB2C,MobileB2B,BankTransfer,BankWithdrawal,AdminWalletTopup,AdminWalletRefund,UserWalletTransfer,UserWalletTopup,UserStashTopup.OPTIONAL. (Type = filter)provider: Transaction provider you would like to consider. Possible values are:Mpesa,Segovia,Flutterwave,Admin,Athena.OPTIONAL. (Type = filter)status: Transaction status you would like to consider. Possible values are:Success,Failed.OPTIONAL. (Type = filter)source: Transaction source you would like to consider. Possible values are:phoneNumber,BankAccount,Card,Wallet.OPTIONAL. (Type = filter)destination: Transaction destinatiom you would like to consider. Possible values are:PhoneNumber,BankAccount,Card,Wallet.OPTIONAL. (Type = filter)providerChannel: Transaction provider channel you would like to consider. This could, for example, be the Mobile Provider's Paybill or Buy Goods number that belongs to your organization.OPTIONAL. (Type = filter)
// Without filters
string fetchTransactionsResponse = gateway.FetchProductTransactions(productName, pageNumber,count);
JObject fetchTransactionsResponseJson = JObject.Parse(fetchTransactionsResponse);
// With filters (Date)
const string productName = "coolproduct";
const string pageNumber = "1";
const string count = "3";
DateTime today = DateTime.Today;
string startDate = today.ToString("yyyy-MM-dd");
string endDate = today.ToString("yyyy-MM-dd");
string fetchTransactionsResponse = gateway.FetchProductTransactions(productName, pageNumber,count, startDate, endDate);This feature allows you to fetch your wallet transactions.
Note, for the filters (except for
startDateandendDatewhich can be passed simultaneously) you can only use one filter for any given query, otherwise your query will return an empty set. Passnullfor those that you wont need.
FetchProductTransactions(pageNumber, count, startDate, endDate, categories, provider, status, source, destination, providerChannel):pageNumber: The number of the page you'd like to read results from. Please Note: This STARTS from 1 and NOT 0.REQUIRED.count: The number of transaction results you would like for this query. Must be > 1 and < 1,000.REQUIRED.startDate: Transaction start date you would like to consider in the format YYYY-MM-DD.OPTIONAL. (Type = filter)endDate: Transaction end date you would like to consider in the format YYYY-MM-DD.OPTIONAL. (Type = filter)categories: A comma delimited list of transaction categories you would like to consider. Possible values are:Debit,Credit,RefundandTopup.OPTIONAL. (Type = filter)
// Without filters
string fetchTransactionsResponse = gateway.FetchWalletTransactions(pageNumber,count);
JObject fetchTransactionsResponseJson = JObject.Parse(fetchTransactionsResponse);
// With filters (Date)
const string productName = "coolproduct";
const string pageNumber = "1";
const string count = "3";
DateTime today = DateTime.Today;
string startDate = today.ToString("yyyy-MM-dd");
string endDate = today.ToString("yyyy-MM-dd");
string fetchTransactionsResponse = gateway.FetchWalletTransactions(pageNumber,count, startDate, endDate);This feature allows you to fetch your current wallet balance.
string fetchBalanceResponse = _atGWInstance.FetchWalletBalance();
JObject fetchBalanceResponseJson = JObject.Parse(fetchBalanceResponse);A few things to note about USSD:
- USSD is session driven. Every request we send you will contain a sessionId, and this will be maintained until that session is completed
- USSD push currently works in Nigeria only
- For this to work properly ensure you have registered a callback URL in your account
const string Username = "sandbox";
const string Apikey = "Key";
var gateway = new AfricasTalkingGateway(Username, Apikey);
string tokenId = "tkn";
const string PhoneNumber = "+236XXXXXXXXX";
const string Menu = "CON You're about to love C#\n1.Accept my fate\n2.No Never\n";
// Let's create a checkout token first
try
{
var tkn = gateway.CreateCheckoutToken(PhoneNumber);
if (tkn["description"] == "Success")
{
tokenId = tkn["token"];
}
// Then send user menu...
var prompt = gateway.InitiateUssdPushRequest(PhoneNumber, Menu, tokenId);
if (prompt["errorMessage"] == "None")
{
Console.WriteLine("Awesome");
}
}
catch (AfricasTalkingGatewayException e)
{
Console.WriteLine("Woopsies : " + e.Message);
}
Console.ReadLine(); Expected Results
-
Start by creating a new Web ASP.NET project from any Visual Studio IDE instance
-
Select an Empty ASP.NET template and Ensure you have selected WebAPI as part of project options
-
On your newly created application, navigate to Solution Explorer and right-click on the Controllers folder to add/create a new Controller
-
From the resulting context menu, select Add>Controller
-
Go ahead and select the Web API 2 Controller -Empty Controller template from the Controller scaffold menu
-
Rename your Controller
-
Now, in our
USSDServiceController, go ahead and paste the following codeusing System; using System.Net; using System.Net.Http; using System.Text; using System.Web.Http; namespace USSDDemo.Controllers { [RoutePrefix("application/services")] // Your Application will be served as http(s)://<host>:port/application/services/... public class USSDServiceController : ApiController { [Route("ussdservice")] // http(s)://<host>:port/application/services/ussdservice [HttpPost,ActionName("ussdservice")] public HttpResponseMessage httpResponseMessage([FromBody] UssdResponse ussdResponse) { HttpResponseMessage responseMessage; string response; if (ussdResponse.text == null) { ussdResponse.text = ""; } if (ussdResponse.text.Equals("",StringComparison.Ordinal)) { response = "CON USSD Demo in Action\n"; response += "1. Do something\n"; response += "2. Do some other thing\n"; response += "3. Get my Number\n"; } else if (ussdResponse.text.Equals("1",StringComparison.Ordinal)) { response = "END I am doing something \n"; }else if (ussdResponse.text.Equals("2",StringComparison.Ordinal)) { response = "END Some other thing has been done \n"; }else if (ussdResponse.text.Equals("3",StringComparison.Ordinal)) { response = $"END Here is your phone number : {ussdResponse.phoneNumber} \n"; } else { response = "END Invalid option \n"; } responseMessage = Request.CreateResponse(HttpStatusCode.Created,response); responseMessage.Content = new StringContent(response, Encoding.UTF8, "text/plain"); return responseMessage; } } }
This code basically gives you 3 menus :, you can create more complex logic as you wish, also , as a hack, for deeper level menus use the
*symbol to separate between levels and sub-levels (menus and submenus). EgLevel1>Sublevel1>Sub-sublevel1can be represented as1*1*1e.t.c.We also have a class
UssdResponseas part of our controllers that makes getters and setters for whatever payload we receive from the server. It should look as so:namespace USSDDemo.Controllers { public class UssdResponse { public string text { get; set; } public string phoneNumber { get; set; } public string sessionId { get; set; } public string serviceCode { get; set; } } }
To wrap up our project, ensure you have at least
-
Build and Run
-
Your application will be served as
http(s)://<host>:port/application/services/ussdservice -
You can use Postman to test your USSD application as well
In Postman request body, send
"text":"1"for example and see the results.
