africastalking-ruby 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a117033fd96f8fd02fea7b920c4de4ca4fc3f867fd49e237f4c61a9db5a714f
-  data.tar.gz: 5ff1623f5cadeb1535c52edae7810875ae96d9d189da4b99051adc72ebde43fc
+  metadata.gz: dca31bfa111626fd5bb545355e8e5153fcc5802506f0ff0130d42ec7684e4010
+  data.tar.gz: 891a67cb4eddc687c65b34cf914768539018a0265b94003c3d0f03493c360ebd
 SHA512:
-  metadata.gz: 1cccc4bb7c8d0b427fd0e0a5e7bc3c22761d16a651b9970a621c750416a9b4a5b28057f09458aeb0f4c6b6fd5cd0a480013e86e2f63a2075cf7ddcb76969b1d0
-  data.tar.gz: c25f68df3fda65f73978dd18cf864bb0e013f7ba0b246633f4b6f7ee051d975aa03b7999812072c5e2d138a66d38e971f454a812830990466583cebaa52529d0
+  metadata.gz: 44b4c9251a44965e922280d21b56e802564953048e2dd7216c58c206f3c1b7fcbd90bb71afcfb0577ee7106eafeebd0656183c593c80af6b761eba3214506f1c
+  data.tar.gz: f10b0d58c5f0b85a100c7925e3fd035b009e35cc7297ae212fba36ff74d81de5f0b53ee8efbf9696a500499742bba65a710283e85f3f185c876dafe003808adb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    africastalking-ruby (2.0.0)
+    africastalking-ruby (2.1.0)
       httparty (= 0.16.1)
 
 GEM

data/README.md

@@ -1,3 +1,4 @@
+
 # AfricasTalking SDK
 
 > Provides convenient access to the Africa's Talking API from applications written in ruby.
@@ -5,12 +6,14 @@
 ## Documentation
 Take a look at the [API docs here](http://docs.africastalking.com).
 
+[![Gem Version](https://badge.fury.io/rb/africastalking-ruby.svg)](https://badge.fury.io/rb/africastalking-ruby)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "africastalking-ruby", :git => "git@github.com:AfricasTalkingLtd/africastalking-ruby.git"
+gem "africastalking-ruby"
 ```
 
 And then execute:
@@ -19,7 +22,7 @@ And then execute:
 
 <!-- Or install it yourself as:
 
-    $ gem install AfricasTalking -->
+    $ gem install africastalking-ruby -->
 
 ## Usage
 
@@ -69,8 +72,9 @@ airtime.send options
 ```
 - `options`
     - `recipients`: Contains an hash of arrays containing the following keys
-        - `phoneNumber`: Recipient of airtime
-        - `amount`: Amount sent `>= 10 && <= 10K` with currency e.g `KES 100`
+        - `phoneNumber`: Recipient of airtime `REQUIRED`
+        - `currency`:3-digit ISO format currency code . `REQUIRED`
+        - `amount`: Amount sent `>= 10 && <= 10K` with currency e.g `KES 100` `REQUIRED`
 
 ### Sms
 
@@ -129,9 +133,18 @@ sms.fetchSubscriptions options
 ```
 - `options`
     - `shortCode`: This is a premium short code mapped to your account. `REQUIRED`
-    - `keyword`: Value is a premium keyword under the above short code and mapped to your account. `REQUIRED`
+    - `keyword`: Premium keyword under the above short code and mapped to your account. `REQUIRED`
     - `lastReceivedId`: ID of the subscription you believe to be your last. Defaults to `0`
 
+#### Delete Subscription
+```ruby
+sms.deleteSubscriptions options
+```
+- `options`
+    - `shortCode`: This is a premium short code mapped to your account. `REQUIRED`
+    - `keyword`: Premium keyword under the above short code and mapped to your account. `REQUIRED`
+    - `phoneNumber`: PhoneNumber to be unsubscribed `REQUIRED`
+
 ### Voice
 ```ruby
 voice = @AT.voice
@@ -178,7 +191,7 @@ payments = @AT.payments
 ```
 #### Credit card checkout
 ```ruby
-payments.cardCheckout options
+payments.cardCheckoutCharge options
 ```
 - `options`
     - `productName`: Payment Product as setup on your account. `REQUIRED`
@@ -190,6 +203,7 @@ payments.cardCheckout options
         - `number`: The payment card number. `REQUIRED`
         - `cvvNumber`: The 3 or 4 digit Card Verification Value. `REQUIRED`
         - `expiryMonth`: The expiration month on the card (e.g `8`) `REQUIRED`
+        - `expiryYear`: The expiration year on the card (e.g `2020`) `REQUIRED`
         - `authToken`: The card's ATM PIN. `REQUIRED`
         - `countryCode`: The 2-Digit countryCode where the card was issued (only `NG` is supported). `REQUIRED`
     - `metadata`: Some optional data to associate with transaction. `OPTIONAL`
@@ -197,7 +211,7 @@ payments.cardCheckout options
 #### Validate credit card checkout
 
 ```ruby
-payments.validateCardCheckout options
+payments.cardCheckoutValidate options
 ```
 - `options`
     - `transactionId`: The transaction that your application wants to validate. `REQUIRED`
@@ -206,7 +220,7 @@ payments.validateCardCheckout options
 
 #### Initiate bank charge checkout
 ```ruby
-payments.initiateBankChargeCheckout options
+payments.bankCheckoutCharge options
 ```
 - `options`
     - `productName`: Payment Product as setup on your account. `REQUIRED`
@@ -214,8 +228,15 @@ payments.initiateBankChargeCheckout options
 
         - `accountName`: The name of the bank account. `REQUIRED`
         - `accountNumber`: The account number. `REQUIRED`
-        - `bankCode`: A 6-Digit [Integer Code](http://docs.africastalking.com/bank/checkout) for the bank that we allocate. See `payments.BANK.*` for supported banks. `REQUIRED`
         - `dateOfBirth`: Date of birth of the account owner (`YYYY-MM-DD`). Required for Zenith Bank Nigeria.
+        - `bankCode`: A 6-Digit [Integer Code](http://docs.africastalking.com/bank/checkout) for the bank that we allocate. Supported banks at the moment are: `REQUIRED`
+        ```ruby
+        payments.class::BANK_CODES['FCMB_NG']
+        payments.class::BANK_CODES['ZENITH_NG']
+        payments.class::BANK_CODES['ACCESS_NG']
+        payments.class::BANK_CODES['PROVIDUS_NG']
+        payments.class::BANK_CODES['STERLING_NG']
+        ```
 
     - `currencyCode`: 3-digit ISO format currency code (only `NGN` is supported). `REQUIRED`
     - `amount`: Payment amount. `REQUIRED`
@@ -225,7 +246,7 @@ payments.initiateBankChargeCheckout options
 
 #### Validate bank checkout
 ```ruby
-payments.validateBankCheckout options
+payments.bankCheckoutValidate options
 ```
 - `options`
     - `transactionId`: The transaction that your application wants to validate. `REQUIRED`
@@ -243,7 +264,7 @@ payments.bankTransfer options
     	- `bankAccount`: Bank account to be charged:
     	    - `accountName`: The name of the bank account.
     	    - `accountNumber`: The account number `REQUIRED`
-    	    - `bankCode`: A 6-Digit Integer Code for the bank that we allocate; See `payments.BANK.*` for supported banks. `REQUIRED`
+    	    - `bankCode`: A 6-Digit Integer Code for the bank that we allocate; See `payments.class::BANK_CODES` for supported banks. `REQUIRED`
     	- `currencyCode`: 3-digit ISO format currency code (only `NGN` is supported). `REQUIRED`
     	- `amount`: Payment amount. `REQUIRED`
     	- `narration`: A short description of the transaction `REQUIRED`
@@ -274,7 +295,6 @@ payments.mobileB2C options
         - `amount`: Payment amount. `REQUIRED`
         - `providerChannel`: This represents the payment channel the payment will be made from. eg paybill number. The payment channel must be mapped to you. The AfricasTalking default provider channel is used if not specified.
         - `reason`: This field contains a string showing the purpose for the payment. If set, it should be one of the following
-            
             ```
             SalaryPayment
             SalaryPaymentWithWithdrawalChargePaid
@@ -282,7 +302,6 @@ payments.mobileB2C options
             BusinessPaymentWithWithdrawalChargePaid
             PromotionPayment
             ```
-
         - `metadata`: Some optional data to associate with transaction.
 
 #### Mobile B2B
@@ -298,23 +317,84 @@ payments.mobileB2B options
     	    ```
     	      Athena - Please note: This is not available on our production systems
     	      Mpesa
+
     	    ```
     	- `transferType`: This contains the payment provider that is facilitating this transaction. Supported providers at the moment are:
-    	    
-    	    ```
-    	      BusinessBuyGoods
-    	      BusinessPayBill
-    	      DisburseFundsToBusiness
-    	      BusinessToBusinessTransfer
-    	    ```
+	       ```
+	      BusinessBuyGoods
+	      BusinessPayBill
+	      DisburseFundsToBusiness
+	      BusinessToBusinessTransfer
+	       ```
     	- `destinationChannel`: This value contains the name or number of the channel that will receive payment by the provider. `REQUIRED`
     	- `destinationAccount`: This value contains the account name used by the business to receive money on the provided destinationChannel. `REQUIRED`
     - `currencyCode`: 3-digit ISO format currency code (e.g `KES`, `USD`, `UGX` etc.) `REQUIRED`
-
     - `amount`: Payment amount. `REQUIRED`
-    - `metadata`: Some optional data to associate with transaction.`OPTIONAL`
+    - `metadata`: Some optional data to associate with transaction.`REQUIRED`
 
+#### Wallet Transfer
+```ruby
+payments.walletTransfer options
+```
+- `options`
+    - `productName`: Your Payment Product as setup on your account. `REQUIRED`
+    - `targetProductCode`: Unique code ode of payment product receiving funds on Africa's Talking `REQUIRED`
+    - `currencyCode`: 3-digit ISO format currency code. `REQUIRED`
+    - `amount`: Amount to transfer. `REQUIRED`
+    - `metadata`: Additional data to associate with the transaction. `REQUIRED`
 
+#### Topup Stash
+```ruby
+payments.topupStash options
+```
+- `options`
+    - `productName`: Your Payment Product as setup on your account. `REQUIRED`
+    - `currencyCode`: 3-digit ISO format currency code. `REQUIRED`
+    - `amount`: Amount to transfer. `REQUIRED`
+    - `metadata`: Additonal data to associate with the transaction. `REQUIRED`
+
+#### Fetch Product Transactions
+```ruby
+payments.fetchProductTransactions options
+```
+- `options`
+    - `productName`: Your Payment Product as setup on your account. `REQUIRED`
+    - `filters`: Filters to use when fetching transactions:
+        - `pageNumber`: Page number to fetch results from. Starts from `1`. `REQUIRED`
+        - `count`: Number of results to fetch. `REQUIRED`
+        - `startDate`: Start Date to consider when fetching
+        - `endDate`: End Date to consider when fetching
+        - `category`: Category to consider when fetching
+        - `provider`: Provider to consider when fetching
+        - `status`: Status to consider when fetching
+        - `source`: Source to consider when fetching
+        - `destination`: Destination to consider when fetching
+        - `providerChannel`: Provider to consider when fetching
+
+#### fetch Wallet Transactions
+```ruby
+payments.fetchWalletTransactions options
+```
+- `options`
+    - `filters`: Filters to use when fetching transactions:
+        - `pageNumber`: Page number to fetch results from. Starts from `1`. `REQUIRED`
+        - `count`: Number of results to fetch. `REQUIRED`
+        - `startDate`: Start Date to consider when fetching
+        - `endDate`: End Date to consider when fetching
+        - `categories`: Comma delimited list of categories to consider when fetching
+
+#### Find Transaction
+```ruby
+payments.findTransaction options
+```
+- `options`
+    - `transactionId`: ID of trancation to find `REQUIRED`
+
+#### Fetch Wallet Balance
+```ruby
+payments.fetchWalletBalance
+```
+- Fetch your payment wallet balance
 
 
 ## Development

data/lib/AfricasTalking.rb

@@ -60,10 +60,6 @@ module AfricasTalking
 			uri		 	     = URI.parse(url_)
 			http		     = Net::HTTP.new(uri.host, uri.port)
 			http.use_ssl     = true
-			headers = {
-				"apikey" => @apikey,
-				"Accept" => "application/json"
-			}
 			if(data_ != nil)
 				request = Net::HTTP::Post.new(uri.request_uri)
 				request.set_form_data(data_)
@@ -82,19 +78,21 @@ module AfricasTalking
 			return response.body
 		end
 
-		def sendJSONRequest (url_, data_)
+		def sendJSONRequest url_, data_, get_request = false
 			uri	       = URI.parse(url_)
 			http         = Net::HTTP.new(uri.host, uri.port)
 			http.use_ssl = true
-			req          = Net::HTTP::Post.new(uri.request_uri, 'Content-Type'=>"application/json")
+			if get_request === true
+				uri.query = URI.encode_www_form(data_)
+				req = Net::HTTP::Get.new(uri.request_uri, 'Content-Type'=>"application/json")
+			else
+				req = Net::HTTP::Post.new(uri.request_uri, 'Content-Type'=>"application/json")
+				req.body = data_.to_json
+			end
 			
 			req["apikey"] = @apikey
 			req["Accept"] = "application/json"
-			
-			req.body = data_.to_json
-
 			response  = http.request(req)
-			
 			if (DEBUG)
 				puts "Full response #{response.body}"
 			end
@@ -112,7 +110,5 @@ module AfricasTalking
 				end
 			}
 			return true
-
 		end
-			
 end

data/lib/AfricasTalking/Airtime.rb

@@ -10,14 +10,18 @@ class Airtime
 	end
 
 	def send options
-		recipients = options.collect{ |r| r }
-		post_body = {
-						'username'   => @username,
-						'recipients' => recipients.to_json
-					}
 		url      = getAirtimeUrl() + "/send"
-		response = sendNormalRequest(url, post_body)
-		# 
+
+		recipients = options.each{|item| 
+			validateParamsPresence? item, %w(phoneNumber currencyCode amount)
+			item['amount'].to_s.prepend(item['currencyCode'].to_s + " ") 
+			item.delete('currencyCode')
+		}
+		post_body = {
+					'username'   => @username,
+					'recipients' => recipients.to_json,
+				}
+		response = sendNormalRequest(url, post_body) 
 		if (@response_code == HTTP_CREATED)
 			responses = JSON.parse(response, :quirky_mode =>true)
 			if (responses['responses'].length > 0)
@@ -31,7 +35,6 @@ class Airtime
 			else
 				raise AfricasTalkingException, responses['errorMessage']
 			end
-		else
 			raise AfricasTalkingException, response
 		end
 	end

data/lib/AfricasTalking/Payments.rb

@@ -2,7 +2,6 @@ class Payments
 	include AfricasTalking
 	HTTP_CREATED     = 201
 	HTTP_OK          = 200
-	#Set debug flag to to true to view response body
 	BANK_CODES = {
 		'FCMB_NG' => 234001,
 		'ZENITH_NG' => 234002,
@@ -27,26 +26,31 @@ class Payments
 		'WEMA_NG' => 234021,
 		'FIRST_NG' => 234022,
 	}
+	PROVIDERS = {
+		'MPESA'   => 'Mpesa',
+		'SEGOVIA' => 'Segovia',
+		'FLUTTERWAVE' => 'Flutterwave',
+		'ADMIN' => 'Admin',
+		'ATHENA' => 'Athena',
+	}
 	def initialize username, apikey
 		@username    = username
 		@apikey      = apikey
 	end
 
 	def mobileCheckout options
+		validateParamsPresence? options, %w(productName phoneNumber currencyCode amount metadata)
+		parameters = {
+			'username'     => @username,
+			'productName'  => options['productName'],
+			'phoneNumber'  => options['phoneNumber'],
+			'currencyCode' => options['currencyCode'],
+			'amount'       => options['amount'],
+			'metadata'     => options['metadata']
+		}
 		url      = getMobilePaymentCheckoutUrl()
-		if validateParamsPresence?(options, ['productName', 'phoneNumber', 'currencyCode', 'amount', 'metadata'])
-			parameters = {
-				'username'     => @username,
-				'productName'  => options['productName'],
-				'phoneNumber'  => options['phoneNumber'],
-				'currencyCode' => options['currencyCode'],
-				'amount'       => options['amount'],
-				'metadata'     => options['metadata']
-			}
-			response = sendJSONRequest(url, parameters)
-		end
-
-		if (@response_code == HTTP_CREATED)
+		response = sendJSONRequest(url, parameters)
+		if @response_code == HTTP_CREATED
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			# 
 			if (resultObj['status'] == 'PendingConfirmation')
@@ -58,48 +62,44 @@ class Payments
 	end
 
 	def mobileB2B options
-		validOptions = validateParamsPresence?(options, ['productName', 'providerData', 'currencyCode', 'amount', 'metadata'])
-		validProviderData = validateParamsPresence?(options['providerData'], ['provider', 'destinationAccount', 'destinationChannel', 'transferType'])
-		if validOptions && validProviderData
-			parameters = {
-				'username'           => @username,
-				'productName'        => options['productName'],
-				'provider'           => options['providerData']['provider'],
-				'destinationChannel' => options['providerData']['destinationChannel'],
-				'destinationAccount' => options['providerData']['destinationAccount'],
-				'transferType'       => options['providerData']['transferType'],
-				'currencyCode'       => options['currencyCode'],
-				'amount'             => options['amount'],
-				'metadata'           => options['metadata']
-			}
-			url      = getMobilePaymentB2BUrl()   
-			response = sendJSONRequest(url, parameters)
-		end
-
+		validateParamsPresence? options, %w(productName providerData currencyCode amount metadata)
+		validateParamsPresence? options['providerData'], %w(provider destinationAccount destinationChannel transferType)
+		parameters = {
+			'username'           => @username,
+			'productName'        => options['productName'],
+			'provider'           => options['providerData']['provider'],
+			'destinationChannel' => options['providerData']['destinationChannel'],
+			'destinationAccount' => options['providerData']['destinationAccount'],
+			'transferType'       => options['providerData']['transferType'],
+			'currencyCode'       => options['currencyCode'],
+			'amount'             => options['amount'],
+			'metadata'           => options['metadata']
+		}
+		url      = getMobilePaymentB2BUrl()   
+		response = sendJSONRequest(url, parameters)
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			# 
-			return MobileB2BResponse.new resultObj['status'], resultObj['transactionId'], resultObj['transactionFee'], resultObj['providerChannel']
+			return MobileB2BResponse.new resultObj['status'], resultObj['transactionId'], resultObj['transactionFee'], resultObj['providerChannel'], resultObj['errorMessage']
 		end
 		raise AfricasTalkingException, response
 	end
 
 
 	def mobileB2C options
-		if validateParamsPresence?(options, ['recipients', 'productName'])
-			parameters = {
-				'username'    => @username,
-				'productName' => options['productName'],
-				'recipients'  => options['recipients']
-			}
-			url      = getMobilePaymentB2CUrl()
-			response = sendJSONRequest(url, parameters)
-		end
+		validateParamsPresence? options, %w(recipients productName)
+		parameters = {
+			'username'    => @username,
+			'productName' => options['productName'],
+			'recipients'  => options['recipients']
+		}
+		url      = getMobilePaymentB2CUrl()
+		response = sendJSONRequest(url, parameters)
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			if (resultObj['entries'].length > 0)
 				results = resultObj['entries'].collect{ |subscriber|
-					MobileB2CResponse.new subscriber['provider'], subscriber['phoneNumber'], subscriber['providerChannel'], subscriber['transactionFee'], subscriber['status'], subscriber['value'], subscriber['transactionId']
+					MobileB2CResponse.new subscriber['provider'], subscriber['phoneNumber'], subscriber['providerChannel'], subscriber['transactionFee'], subscriber['status'], subscriber['value'], subscriber['transactionId'], subscriber['errorMessage']
 				}
 				# 
 				return results
@@ -110,20 +110,19 @@ class Payments
 		raise AfricasTalkingException, response
 	end
 
-	def bankCheckout options
-		if validateParamsPresence?(options, ['bankAccount', 'productName', 'currencyCode', 'amount', 'narration', 'metadata'])
-			parameters = {
-				'username'    => @username,
-				'productName' => options['productName'],
-				'bankAccount'  => options['bankAccount'],
-				'currencyCode' => options['currencyCode'],
-				'amount' => options['amount'],
-				'narration' => options['narration'],
-				'metadata' => options['metadata']
-			}
-			url      = getBankChargeCheckoutUrl()
-			response = sendJSONRequest(url, parameters)
-		end
+	def bankCheckoutCharge options
+		validateParamsPresence? options, %w(bankAccount productName currencyCode amount narration metadata)
+		parameters = {
+			'username'    => @username,
+			'productName' => options['productName'],
+			'bankAccount'  => options['bankAccount'],
+			'currencyCode' => options['currencyCode'],
+			'amount' => options['amount'],
+			'narration' => options['narration'],
+			'metadata' => options['metadata']
+		}
+		url      = getBankChargeCheckoutUrl()
+		response = sendJSONRequest(url, parameters)
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			# 
@@ -132,17 +131,16 @@ class Payments
 		raise AfricasTalkingException, response
 	end	
 
-	def validateBankCheckout options
-		if validateParamsPresence?(options, ['transactionId', 'otp'])
-			parameters = {
-				'username'    => @username,
-				'transactionId' => options['transactionId'],
-				'otp'  => options['otp']
-			}
-			# 
-			url      = getValidateBankCheckoutUrl()
-			response = sendJSONRequest(url, parameters)
-		end
+	def bankCheckoutValidate options
+		validateParamsPresence? options, %w(transactionId otp)
+		parameters = {
+			'username'    => @username,
+			'transactionId' => options['transactionId'],
+			'otp'  => options['otp']
+		}
+		# 
+		url      = getValidateBankCheckoutUrl()
+		response = sendJSONRequest(url, parameters)
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			return ValidateBankCheckoutResponse.new resultObj['status'], resultObj['description']
@@ -151,15 +149,14 @@ class Payments
 	end
 
 	def bankTransfer options
-		if validateParamsPresence?(options, ['productName', 'recipients'])
-			parameters = {
-				'username'    => @username,
-				'productName' => options['productName'],
-				'recipients'  => options['recipients']
-			}
-			url      = getBankTransferRequestUrl()
-			response = sendJSONRequest(url, parameters)		
-		end
+		validateParamsPresence? options, %w(productName recipients)
+		parameters = {
+			'username'    => @username,
+			'productName' => options['productName'],
+			'recipients'  => options['recipients']
+		}
+		url      = getBankTransferRequestUrl()
+		response = sendJSONRequest(url, parameters)		
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 
@@ -178,30 +175,31 @@ class Payments
 		
 	end
 
-	def cardCheckout options
-		if validateParamsPresence?(options, ['productName', 'currencyCode', 'amount', 'narration', 'metadata'])
-			parameters = {
-				'username'    => @username,
-				'productName' => options['productName'],
-				'currencyCode' => options['currencyCode'],
-				'amount' => options['amount'],
-				'narration' => options['narration'],
-				'metadata' => options['metadata']
-			}
-			if (options['checkoutToken'] == nil && options['paymentCard'] == nil)
-				raise AfricasTalkingException "Please make sure either the checkoutToken or paymentCard parameter is not empty"
-			elsif (options['checkoutToken'] != nil && options['paymentCard'] != nil)
-				raise AfricasTalkingException "If you have a checkoutToken please make sure paymentCard parameter is empty"
-			end
-			if (options['checkoutToken'] != nil)
-				parameters['checkoutToken'] = options['checkoutToken']
-			end
-			if (options['paymentCard'] != nil)
+	def cardCheckoutCharge options
+		validateParamsPresence? options, %w(productName currencyCode amount narration metadata)
+		parameters = {
+			'username'    => @username,
+			'productName' => options['productName'],
+			'currencyCode' => options['currencyCode'],
+			'amount' => options['amount'],
+			'narration' => options['narration'],
+			'metadata' => options['metadata']
+		}
+		if (options['checkoutToken'] == nil && options['paymentCard'] == nil)
+			raise AfricasTalkingException, "Please make sure either the checkoutToken or paymentCard parameter is not empty"
+		elsif (options['checkoutToken'] != nil && options['paymentCard'] != nil)
+			raise AfricasTalkingException, "If you have a checkoutToken please make sure paymentCard parameter is empty"
+		end
+		if (options['checkoutToken'] != nil)
+			parameters['checkoutToken'] = options['checkoutToken']
+		end
+		if (options['paymentCard'] != nil)
+			if validateParamsPresence?(options['paymentCard'], ['number', 'cvvNumber', 'expiryMonth', 'expiryYear', 'countryCode', 'authToken'])
 				parameters['paymentCard'] = options['paymentCard']
 			end
-			url      = getCardCheckoutChargeUrl()
-			response = sendJSONRequest(url, parameters)
 		end
+		url      = getCardCheckoutChargeUrl()
+		response = sendJSONRequest(url, parameters)
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			# 
@@ -211,17 +209,15 @@ class Payments
 
 	end
 
-	def validateCardCheckout options
-		if validateParamsPresence?(options, ['transactionId', 'otp'])
-			parameters = {
-				'username'    => @username,
-				'transactionId' => options['transactionId'],
-				'otp'  => options['otp']
-			}
-			url      = getValidateCardCheckoutUrl()
-			# 
-			response = sendJSONRequest(url, parameters)
-		end
+	def cardCheckoutValidate options
+		validateParamsPresence? options, %w(transactionId otp)
+		parameters = {
+			'username'    => @username,
+			'transactionId' => options['transactionId'],
+			'otp'  => options['otp']
+		}
+		url      = getValidateCardCheckoutUrl()
+		response = sendJSONRequest(url, parameters)
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			return ValidateCardCheckoutResponse.new resultObj['status'], resultObj['description'], resultObj['checkoutToken']
@@ -230,19 +226,18 @@ class Payments
 		raise AfricasTalkingException, response
 	end
 
-	def walletTransferRequest options
-		if validateParamsPresence?(options, ['productName', 'targetProductCode', 'currencyCode', 'amount', 'metadata'])
-			parameters = {
-				'username'    => @username,
-				'productName' => options['productName'],
-				'targetProductCode' => options['targetProductCode'],
-				'currencyCode' => options['currencyCode'],
-				'amount' => options['amount'],
-				'metadata' => options['metadata'] 
-			}
-			url      = getWalletTransferUrl()
-			response = sendJSONRequest(url, parameters)
-		end
+	def walletTransfer options
+		validateParamsPresence? options, %w(productName targetProductCode currencyCode amount metadata)
+		parameters = {
+			'username'    => @username,
+			'productName' => options['productName'],
+			'targetProductCode' => options['targetProductCode'],
+			'currencyCode' => options['currencyCode'],
+			'amount' => options['amount'],
+			'metadata' => options['metadata'] 
+		}
+		url      = getWalletTransferUrl()
+		response = sendJSONRequest(url, parameters)
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			# 
@@ -251,18 +246,17 @@ class Payments
 		raise AfricasTalkingException, response
 	end
 
-	def topupStashRequest options
-		if validateParamsPresence?(options, ['productName', 'currencyCode', 'amount', 'metadata'])
-			parameters = {
-				'username'    => @username,
-				'productName' => options['productName'],
-				'currencyCode' => options['currencyCode'],
-				'amount' => options['amount'],
-				'metadata' => options['metadata'] 
-			}
-			url      = getTopupStashUrl() 
-			response = sendJSONRequest(url, parameters)
-		end
+	def topupStash options
+		validateParamsPresence? options, %w(productName currencyCode amount metadata)
+		parameters = {
+			'username'    => @username,
+			'productName' => options['productName'],
+			'currencyCode' => options['currencyCode'],
+			'amount' => options['amount'],
+			'metadata' => options['metadata'] 
+		}
+		url      = getTopupStashUrl() 
+		response = sendJSONRequest(url, parameters)
 		if (@response_code == HTTP_CREATED)
 			resultObj = JSON.parse(response, :quirky_mode =>true)
 			return TopupStashResponse.new resultObj['status'], resultObj['description'], resultObj['transactionId']
@@ -270,6 +264,104 @@ class Payments
 		raise AfricasTalkingException, response
 	end
 
+	def fetchProductTransactions options
+		validateParamsPresence? options, %w(productName filters)
+		filters = options['filters']
+		validateParamsPresence? filters, %w(pageNumber count)
+		parameters = {
+			'username'    => @username,
+			'productName' => options['productName'],
+			'pageNumber' => filters['pageNumber'],
+			'count' => filters['count']
+		}
+		parameters['startDate'] = filters['startDate'] if !(filters['startDate'].nil? || filters['startDate'].empty?)
+		parameters['endDate'] = filters['endDate'] if !(filters['endDate'].nil? || filters['endDate'].empty?)
+		parameters['category'] = filters['category'] if !(filters['category'].nil? || filters['category'].empty?)
+		parameters['status'] = filters['status'] if !(filters['status'].nil? || filters['status'].empty?)
+		parameters['source'] = filters['source'] if !(filters['source'].nil? || filters['source'].empty?)
+	 	parameters['destination'] = filters['destination'] if !(filters['destination'].nil? || filters['destination'].empty?)
+		parameters['providerChannel'] = filters['providerChannel'] if !(filters['providerChannel'].nil? || filters['providerChannel'].empty?)
+		url      = getFetchTransactionsUrl() 
+		response = sendJSONRequest(url, parameters, true)
+		if (@response_code == HTTP_OK)
+			resultObj = JSON.parse(response, :quirky_mode =>true)
+			results = []
+			if (resultObj['responses'].length > 0)
+				results = resultObj['responses'].collect{ |item|
+					FetchTransactionsEntries.new item['sourceType'], item['source'], item['provider'], item['destinationType'], item['description'], item['providerChannel'], item['providerMetadata'],
+					item['status'], item['productName'], item['category'], item['destination'], item['value'], item['transactionId'], item['creationTime'], item['requestMetadata']  
+				}
+			end
+			return FetchTransactionsResponse.new resultObj['status'], resultObj['description'], results
+		end
+		raise AfricasTalkingException, response
+	end
+
+	def fetchWalletTransactions options
+		validateParamsPresence? options, ['filters']
+		filters = options['filters']
+		validateParamsPresence? filters, %w(pageNumber count)
+		parameters = {
+			'username'    => @username,
+			'pageNumber' => filters['pageNumber'],
+			'count' => filters['count']
+		}
+		parameters['startDate'] = filters['startDate'] if !(filters['startDate'].nil? || filters['startDate'].empty?)
+		parameters['endDate'] = filters['endDate'] if !(filters['endDate'].nil? || filters['endDate'].empty?)
+		parameters['categories'] = filters['categories'] if !(filters['categories'].nil? || filters['categories'].empty?)
+		url      = getFetchWalletUrl() 
+		response = sendJSONRequest(url, parameters, true)
+		if (@response_code == HTTP_OK)
+			resultObj = JSON.parse(response, :quirky_mode =>true)
+			results = []
+			if (resultObj['responses'].length > 0)
+				results = resultObj['responses'].collect{ |item|
+					transactionData = TransactionData.new item['transactionData']['requestMetadata'], item['transactionData']['sourceType'],
+					item['transactionData']['source'], item['transactionData']['provider'], item['transactionData']['destinationType'],item['transactionData']['description'],
+					item['transactionData']['providerChannel'], item['transactionData']['providerRefId'], item['transactionData']['providerMetadata'],item['transactionData']['status'],
+					item['transactionData']['productName'], item['transactionData']['category'], item['transactionData']['transactionDate'], item['transactionData']['destination'],
+					item['transactionData']['value'], item['transactionData']['transactionId'], item['transactionData']['creationTime']
+					FetchWalletEntries.new item['description'], item['balance'], item['date'], item['category'], item['value'], item['transactionId'], transactionData 
+				}
+			end
+			return FetchWalletResponse.new resultObj['status'], resultObj['description'], results
+		end
+		raise AfricasTalkingException, response
+	end
+
+	def findTransaction options
+		validateParamsPresence? options, ['transactionId']
+		parameters = {
+			'username'    => @username,
+			'transactionId' => options['transactionId']
+		}
+		url      = getFindTransactionUrl() 
+		response = sendJSONRequest(url, parameters, true)
+		if (@response_code == HTTP_OK)
+			resultObj = JSON.parse(response, :quirky_mode =>true)
+			transactionData = nil
+			if resultObj['status'] === 'Success'
+				transactionData = TransactionData.new resultObj['data']['requestMetadata'], resultObj['data']['sourceType'],resultObj['data']['source'], resultObj['data']['provider'], resultObj['data']['destinationType'],resultObj['data']['description'],
+					resultObj['data']['providerChannel'], resultObj['data']['providerRefId'], resultObj['data']['providerMetadata'],resultObj['data']['status'], resultObj['data']['productName'], resultObj['data']['category'], 
+					resultObj['data']['transactionDate'], resultObj['data']['destination'], resultObj['data']['value'], resultObj['data']['transactionId'], resultObj['data']['creationTime']
+			end
+			return FindTransactionResponse.new resultObj['status'], transactionData
+		end
+		raise AfricasTalkingException, response
+	end
+
+	def fetchWalletBalance
+		parameters = { 'username' => @username }
+		url        = getFetchWalletBalanceUrl()
+		response = sendJSONRequest(url, parameters, true)
+		if (@response_code == HTTP_OK)
+			resultObj = JSON.parse(response, :quirky_mode =>true)
+			
+			return FetchWalletBalanceResponse.new resultObj['status'], resultObj['balance']
+		end
+		raise AfricasTalkingException, response
+	end
+
 	private
 
 		def getPaymentHost()
@@ -320,6 +412,22 @@ class Payments
 			return getPaymentHost() + "/topup/stash"
 		end
 
+		def getFetchWalletUrl()
+			return getPaymentHost() + "/query/wallet/fetch"
+		end
+
+		def getFetchWalletBalanceUrl()
+			return getPaymentHost() + "/query/wallet/balance"
+		end
+
+		def getFetchTransactionsUrl()
+			return getPaymentHost() + "/query/transaction/fetch"
+		end
+
+		def getFindTransactionUrl()
+			return getPaymentHost() + "/query/transaction/find"
+		end
+
 		def getApiHost()
 			if(@username == "sandbox")
 				return "https://api.sandbox.africastalking.com"
@@ -330,10 +438,11 @@ class Payments
 		
 end
 
+
 class MobileB2CResponse
-	attr_reader :provider, :phoneNumber, :providerChannel, :transactionFee, :status, :value, :transactionId
+	attr_reader :provider, :phoneNumber, :providerChannel, :transactionFee, :status, :value, :transactionId, :errorMessage
 
-	def initialize provider_, phoneNumber_, providerChannel_, transactionFee_, status_, value_, transactionId_
+	def initialize provider_, phoneNumber_, providerChannel_, transactionFee_, status_, value_, transactionId_, errorMessage_
 			@provider        = provider_
 			@phoneNumber     = phoneNumber_
 			@providerChannel = providerChannel_
@@ -341,17 +450,19 @@ class MobileB2CResponse
 			@status          = status_
 			@value           = value_
 			@transactionId   = transactionId_
+			@errorMessage   = errorMessage_
 	end
 end	
 
 class MobileB2BResponse
-	attr_reader :status, :transactionId, :transactionFee, :providerChannel
+	attr_reader :status, :transactionId, :transactionFee, :providerChannel, :errorMessage
 			
-	def initialize status_, transactionId_, transactionFee_, providerChannel_
+	def initialize status_, transactionId_, transactionFee_, providerChannel_, errorMessage_
 			@providerChannel    = providerChannel_
 			@transactionId = transactionId_
 			@transactionFee  = transactionFee_
 			@status          = status_
+			@errorMessage   = errorMessage_
 	end
 end	
 
@@ -375,12 +486,12 @@ class BankTransferResponse
 end
 
 class MobileCheckoutResponse
-	attr_reader :status, :transactionFee, :transactionId, :providerChannel
-	def initialize accountNumber_, status_, transactionId_, transactionFee_
-			@accountNumber = accountNumber_
+	attr_reader :status, :description, :transactionId, :providerChannel
+	def initialize status_, description_, transactionId_, providerChannel_
+			@description = description_
 			@status = status_
 			@transactionId  = transactionId_
-			@transactionFee  = transactionFee_
+			@providerChannel  = providerChannel_
 	end
 end
 class InitiateBankCheckoutResponse
@@ -433,4 +544,97 @@ class TopupStashResponse
 			@status = status_
 			@transactionId = transactionId_
 	end
+end
+
+class FetchTransactionsEntries
+	attr_reader :sourceType, :source, :provider, :destinationType, :description, :providerChannel, 
+	:providerMetadata, :status, :productName, :category, :destination, :value, :transactionId, :creationTime, :requestMetadata
+
+	def initialize sourceType_, source_, provider_, destinationType_, description_, providerChannel_, providerMetadata_, status_, productName_, category_, destination_, value_, transactionId_, creationTime_, requestMetadata_
+		@sourceType = sourceType_
+		@source = source_
+		@provider = provider_
+		@destinationType = destinationType_
+		@description = description_
+		@providerChannel = providerChannel_
+		@providerMetadata = providerMetadata_
+		@status = status_
+		@productName = productName_
+		@category = category_
+		@destination = destination_
+		@value = value_
+		@transactionId = transactionId_
+		@creationTime = creationTime_
+		@requestMetadata = requestMetadata_ 
+	end
+end
+
+class FetchTransactionsResponse
+	attr_reader :status, :description, :entries
+	def initialize status_, description_, entries_
+		@description = description_
+		@status = status_
+		@entries = entries_
+	end
+end
+
+class FetchWalletBalanceResponse
+	attr_reader :status, :balance
+	def initialize status_, balance_
+		@status = status_
+		@balance = balance_
+	end
+end
+
+class FetchWalletResponse
+	attr_reader :status, :description, :responses
+	def initialize status_, description_, responses_
+		@description = description_
+		@status = status_
+		@responses = responses_
+	end
+end
+
+class FetchWalletEntries 
+	attr_reader :description, :balance, :date, :category, :value, :transactionId, :transactionData
+	def initialize description_, balance_, date_, category_, value_, transactionId_, transactionData_
+		@description = description_
+		@balance = balance_
+		@date = date_
+		@category = category_
+		@value = value_
+		@transactionId = transactionId_
+		@transactionData = transactionData_
+	end
+end
+
+class FindTransactionResponse
+	attr_reader :status, :transactionData
+	def initialize status_, transactionData_
+		@status = status_
+		@transactionData = transactionData_
+	end
+end
+
+class TransactionData
+	attr_reader :requestMetadata, :sourceType, :source, :provider, :destinationType, :description, :providerChannel, :providerRefId, :providerMetadata, :status, :productName, :category, :transactionDate, :destination, :value, :transactionId, :creationTime
+	def initialize requestMetadata_, sourceType_, source_, provider_, destinationType_, description_, providerChannel_, providerRefId_, providerMetadata_, status_, productName_, category_, transactionDate_, destination_, value_, transactionId_, creationTime_
+		@requestMetadata =requestMetadata_
+		@sourceType = sourceType_
+		@source = source_
+		@provider = provider_
+		@destinationType = destinationType_
+		@description = description_
+		@providerChannel = providerChannel_
+		@providerRefId = providerRefId_
+		@providerMetadata = providerMetadata_
+		@status = status_
+		@productName = productName_
+		@category = category_
+		@transactionDate = transactionDate_
+		@destination = destination_
+		@value = value_
+		@transactionId = transactionId_
+		@creationTime = creationTime_
+	end
 end

data/lib/AfricasTalking/Sms.rb

@@ -27,8 +27,8 @@ class Sms
 		if options['from'] != nil
 			post_body['from'] = options['from']
 		end
-		if options['enqueue'] != nil
-			post_body['enqueue'] = options['enqueue']
+		if options['enqueue'] === true
+			post_body['enqueue'] = 1
 		end
 		if options['bulkSMSMode'] != nil
 			post_body['bulkSMSMode'] = options['bulkSMSMode']
@@ -160,6 +160,28 @@ class Sms
 		end
 	end
 
+	def deleteSubcription options
+		post_body = {
+						'username'    => @username,
+						'phoneNumber' => options['phoneNumber'],
+						'shortCode'   => options['shortCode'],
+						'keyword'     => options['keyword']
+					}
+		if options['checkoutToken'] != nil
+			post_body['checkoutToken'] = options['checkoutToken']
+		end
+		url = getSmsSubscriptionUrl() + "/delete"
+		if validateParamsPresence?(options, ['shortCode', 'keyword', 'phoneNumber'])
+			response = sendNormalRequest(url, post_body)
+		end
+		if(@response_code == HTTP_CREATED)
+			r = JSON.parse(response, :quirky_mode => true)
+			return DeleteSubscriptionResponse.new r['status'], r['description'] 
+		else
+			raise AfricasTalkingException, response
+		end
+	end
+
 	private
 
 		def getSmsUrl()
@@ -218,6 +240,14 @@ class CreateSubscriptionResponse
 	end
 end
 
+class DeleteSubscriptionResponse
+	attr_reader :status, :description
+	def initialize status_, description_
+		@description = description_
+		@status = status_
+	end
+end
+
 
 class SendPremiumMessagesResponse
 	attr_reader :recipients, :overview 

data/lib/AfricasTalking/version.rb

@@ -1,3 +1,3 @@
 module AfricasTalking
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: africastalking-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Michael Mwirigi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler