Skip to content

Latest commit

 

History

History
181 lines (116 loc) · 7.17 KB

README.md

File metadata and controls

181 lines (116 loc) · 7.17 KB
Raw

MTN MoMo API Ruby Gem

Gem Version Build Status Coverage Status Join the community on Spectrum

Usage

Installation

Add this line to your application's Gemfile:

gem 'momoapi-ruby'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install momoapi-ruby

Creating a sandbox environment API user

Type this command into your terminal:

momoapi-ruby --host Your-Provider-Callback-Host --key Your-Ocp-Apim-Subscription-Key

A User ID and API Key will be generated:

User ID: Generated user ID
API key: Generated API key

Using live credentials

Add the following configurations in an initializer file (for example, config/initializers/momoapi-ruby.rb in a Rails app):

Momoapi.configure do |config|
  config.base_url = 'Your MoMo account base URL'
  config.callback_host = 'Your Provider Callback Host'
end

Collections

The collections client can be created with the following paramaters. Note that the COLLECTION_USER_ID and COLLECTION_API_SECRET for production are provided on the MTN OVA dashboard.

Add the following to your configuration block:

  config.collection_primary_key = 'Your Collection Subscription Key'
  config.collection_user_id = 'Your Collection User ID'
  config.collection_api_secret = 'Your Collection API Key'
  • collection_primary_key: Primary Key for the Collection product on the developer portal.
  • collection_user_id: For sandbox, use the one generated with the momoapi-ruby command.
  • collection_api_secret: For sandbox, use the one generated with the momoapi-ruby command.

You can create a collection client with the following:

require 'momoapi-ruby'

collection = Momoapi::Collection.new

Methods

  1. request_to_pay: This operation is used to request a payment from a consumer (Payer). The payer will be asked to authorize the payment. The transaction is executed once the payer has authorized the payment. The transaction will be in status PENDING until it is authorized or declined by the payer or it is timed out by the system. The status of the transaction can be validated by using get_transaction_status.

  2. get_transaction_status: Retrieve transaction information using the transaction_reference returned by request_to_pay. You can invoke it at intervals until the transaction fails or succeeds. If the transaction has failed, it will throw an appropriate error.

  3. get_balance: Get the balance of the account.

Disbursements

The disbursements client can be created with the following paramaters. The DISBURSEMENT_USER_ID and DISBURSEMENT_API_SECRET for production are provided on the MTN OVA dashboard.

Add the following to your configuration block:

  config.disbursement_primary_key = 'Your Disbursement Subscription Key'
  config.disbursement_user_id = 'Your Disbursement User ID'
  config.disbursement_api_secret = 'Your Disbursement API Key'
  • disbursement_primary_key: Primary Key for the Disbursement product on the developer portal.
  • disbursement_user_id: For sandbox, use the one generated with the momoapi-ruby command.
  • disbursement_api_secret: For sandbox, use the one generated with the momoapi-ruby command.

You can create a disbursement client with the following:

require 'momoapi-ruby'

disbursement = Momoapi::Disbursement.new

Methods

  1. transfer: Used to transfer an amount from the owner’s account to a payee account. The status of the transaction can be validated by using the get_transaction_status method.

  2. get_transaction_status: Retrieve transaction information using the transaction_reference returned by transfer. You can invoke it at intervals until the transaction fails or succeeds. If the transaction has failed, it will throw an appropriate error.

  3. get_balance: Get the balance of the account.

Remittances

The remittances client can be created with the following paramaters. The REMITTANCES_USER_ID and REMITTANCES_API_SECRET for production are provided on the MTN OVA dashboard.

Add the following to your configuration block:

  config.remittance_primary_key = 'Your Remittance Subscription Key'
  config.remittance_user_id = 'Your Remittance User ID'
  config.remittance_api_secret = 'Your Remittance API Key'
  • remittance_primary_key: Primary Key for the Remittance product on the developer portal.
  • remittance_user_id: For sandbox, use the one generated with the momoapi-ruby command.
  • remittance_api_secret: For sandbox, use the one generated with the momoapi-ruby command.

You can create a remittance client with the following:

require 'momoapi-ruby'

remittance = Momoapi::Remittance.new

Methods

  1. transfer: Used to transfer an amount from the owner’s account to a payee account. The status of the transaction can be validated by using the get_transaction_status method.

  2. get_transaction_status: Retrieve transaction information using the transaction_reference returned by transfer. You can invoke it at intervals until the transaction fails or succeeds. If the transaction has failed, it will throw an appropriate error.

  3. get_balance: Get the balance of the account.

Sample Code

require 'momoapi-ruby'

collection = Momoapi::Collection.new 

collection.is_user_active('256772123456')

collection.get_balance

transaction = collection.request_to_pay(
    phone_number="256772123456", amount=600, external_id="123456789", payee_note="dd", payer_message="dd", currency="EUR")

transaction_ref = transaction[:transaction_reference]

collection.get_transaction_status(transaction_ref)

Points to note:

All methods for Disbursements and Remittances follow the same format as the examples shown above for Collections

The 'transfer' method for Disbursements and Remittances follows the same format as 'request_to_pay' above.

An extra argument, callback_url, can be passed to the 'request_to_pay' and 'transfer' methods, denoting the URL to the server where the callback should be sent.

Additional documentation

For additional documentation, please refer to this link: https://www.rubydoc.info/gems/momoapi-ruby/1.0.1

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sparkplug/momoapi-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Momoapi::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.