This is a library willing to help you to integrate the Vodacom M-Pesa operations to your application.
Using this library, you can implement the following operations:
- Receive money from a mobile account to a business account (C2B)
- Send money from a business account to a mobile account (B2C)
- Send money from a business account to another business account (B2B)
- Revert any of the transactions above mentioned
- Valid credentials obtained from the Mpesa Developer portal
- Port 18352 open on your server (usually open on local env)
- Ruby 2.5
- RubyGems
- Bundler
gem install paymentsds-mpesa#Gemfile
gem 'paymentsds-mpesa'Using this SDK is very simple and fast, let us see some examples:
require 'paymentsds/mpesa'
client = Paymentsds::MPesa::Client.new do |config|
config.api_key = '<REPLACE>' # API Key
config.public_key = '<REPLACE>' # Public Key
config.service_provider_code = '<REPLACE>' # input_ServiceProviderCode
end
begin
payment_data = {
from: '841234567', # input_CustomerMSISDN
reference: '11114', # input_ThirdPartyReference
transaction: 'T12344CC', # input_TransactionReference
amount: '10' # input_Amount
}
result = client.receive(payment_data)
if result.success?
puts result.data
end
rescue
puts 'Operation failed'
endrequire 'paymentsds/mpesa'
client = Paymentsds::MPesa::Client.new do |config|
config.api_key = '<REPLACE>' # API Key
config.public_key = '<REPLACE>' # Public Key
config.service_provider_code = '<REPLACE>' # input_ServiceProviderCode
end
begin
payment_data = {
to: '841234567', # input_CustomerMSISDN
reference: '11114', # input_ThirdPartyReference
transaction: 'T12344CC', # input_TransactionReference
amount: '10' # input_Amount
}
result = client.send(payment_data)
if result.success?
puts result.data
end
rescue
puts 'Operation failed'
endrequire 'paymentsds/mpesa'
client = Paymentsds::MPesa::Client.new do |config|
config.api_key = '<REPLACE>' # API Key
config.public_key = '<REPLACE>' # Public Key
config.service_provider_code = '<REPLACE>' # input_ServiceProviderCode
end
begin
payment_data = {
to: '979797', # input_ReceiverPartyCode
reference: '11114', # input_ThirdPartyReference
transaction: 'T12344CC', # input_TransactionReference
amount: '10' # input_Amount
}
result = client.send(payment_data)
if result.success?
puts result.data
end
rescue
puts 'Operation failed'
endrequire 'paymentsds/mpesa'
client = Paymentsds::MPesa::Client.new do |config|
config.api_key = '<REPLACE>' # API Key
config.public_key = '<REPLACE>' # Public Key
config.service_provider_code = '<REPLACE>' # input_ServiceProviderCode
config.initiator_identifier = '<REPLACE>' # input_InitiatorIdentifier,
config.security_identifier = '<REPLACE>' # input_SecurityCredential
end
begin
reversion_data = {
reference: '11114', # input_ThirdPartyReference
transaction: 'T12344CC', # input_TransactionReference
amount: '10' # input_ReversalAmounts
}
result = client.reversion(payment_data)
if result.success?
# Handle success scenario
end
rescue
# Handle failure scenario
endThank you for considering contributing to this package. If you wish to do it, email us at [email protected] and we will get back to you as soon as possible.
If you discover a security vulnerability, please email us at [email protected] and we will address the issue with the needed urgency.
Copyright 2022 © The PaymentsDS Team
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.