Project

Paychangu

0.0
The project is in a healthy, maintained state
Paychangu is a Ruby gem that allows you to interact with Paychangu.com's API and perform several operations like: creating payment links, creating virtual cards etc
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Paychangu Rails Gem

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add paychangu

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install paychangu

Usage

Create an initializer in your application's config > initializers folder, for example paychangu.rb and paste the following

require "paychangu"

Then use it in your application like below with your Paychangu secret key, you can get this key in your Paychangu account settings

paychangu = Paychangu::Payment.new("sec-test-SDsYTCSh...")

Creating a Payment Link

 payload = {
        amount: "50000",
        currency: "MWK",
        email: "test@example.com",
        first_name: "Danny",
        last_name: "Simfukwe",
        callback_url: "https://webhook.site/9d0b00ba-9a69-44fa-a43d-a82c33c36fdc",
        return_url: "https://webhook.site",
        tx_ref: SecureRandom.hex(10),
        title: "Title of payment",
        description: "Description of payment",
        logo: "https://assets.piedpiper.com/logo.png"
    }

link = paychangu.create_payment_link(payload)

Creating a Virtual Card

card_payload = {
        amount: "500",
        currency: "USD",
        first_name: "Danny",
        last_name: "Simfukwe",
        callback_url: "https://webhook.site/9d0b00ba-9a69-44fa-a43d-a82c33c36fdc"
    }

card = paychangu.create_virtual_card(card_payload)

Funding a Virtual Card

 fund_card_payload = {
      amount: "50000",
      card_hash: card[:card_hash],
    }

paychangu.fund_card(fund_card_payload)

Withdrawing from a Virtual Card

withdraw = paychangu.withdraw_card_funds(fund_card_payload)

Buying Airtime

First get all operators

 operators = paychangu.airtime_operators

Then use the operator's ID to buy Airtime

  airtime_payment_payload = {
      operator: "123",
      amount: "300",
      phone: "0900000000",
      callback_url: "https://webhook.site/9d0b00ba-9a69-44fa-a43d-a82c33c36fdc"
  }

  paychangu.airtime_payment(airtime_payment_payload)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dannysimfukwe/paychangugem.

License

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