edsonmichaque / mpesa-ruby-sdk

A Ruby library aiming to help developers integrating their products with M-Pesa Platform

M-Pesa SDK for Ruby

M-Pesa SDK for Ruby is an unofficial library aiming to help businesses integrating every M-Pesa operations to their Ruby applications.

Contents

• Features
• Usage
  • Quickstart
  • Receive Money from a Mobile Account
  • Send Money to a Mobile Account
  • Send Money to a Business Account
  • Revert a Transaction
  • Query the Status of a Transaction
  • Examples
• Prerequisites
• Installation
  • Using RubyGems
  • Using Bundler
  • Installation Scenario 3
  • Installation Scenario 4
• Configuration
  • Configuration Scenario 1
  • Configuration Scenario 2
  • Configuration Scenario 3
  • Configuration Scenario 4
• Related Projects
  • Dependencies
  • Friends
  • Alternatives
• Contributing
• Changelog
• Authors
• Credits
• License

Features

• Receive money from a mobile account to a business account
• Send money from a business account to a mobile account
• Send money from a business account to a another business account
• Revert a transaction
• Query the status of a transaction

Usage

Quickstart

Receive Money from a Mobile Account

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'
end

Send Money to a Mobile Account

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 = {
      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'
end

Send Money to a Business Account

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 = {
      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'
end

Revert a Transaction

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

Query the Status of a Transaction

Examples

Prerequisites

• Ruby 2.5+
• RubyGems
• Bundler

Installation

Using RubyGems

gem install paymentsds-mpesa

Using Bundler

#Gemfile
gem 'paymentsds-mpesa'

Installation Scenario 3

Configuration

Configuration Scenario 1

Configuration Scenario 2

Configuration Scenario 3

Related Projects

Dependencies

Production Dependencies

• Faraday
• OpenSSL

Development Dependencies

• RSpec
• Rake
• RuboCop
• Overcommit

Friends

• M-Pesa SDK for Javascript
• M-Pesa SDK for PHP
• M-Pesa SDK for Ruby
• M-Pesa SDK for Python

Alternatives

• Alternative 1
• Alternative 2
• Alternative 3
• Alternative 4

Inspiration

• rosariopfernandes/mpesa-node-api
• karson/mpesa-php-sdk
• codeonweekends/mpesa-php-sdk
• abdulmueid/mpesa-php-api
• realdm/mpesasdk

Contributing

Changelog

Authors

• Edson Michaque
• Nélio Macombo

Credits

License

Copyright 2020 Anísio Mandlate, Edson Michaque, Elton Laice and Nélio Macombo

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.