https://github.com/loqimean/monopay-ruby

The easiest way to make payments with Monobank acquiring API
https://github.com/loqimean/monopay-ruby

easy-to-use gem monobank monobank-acquiring monobank-api monobank-sdk payments ruby ruby-on-rails

Last synced: 12 days ago
JSON representation

The easiest way to make payments with Monobank acquiring API

• Host: GitHub
• URL: https://github.com/loqimean/monopay-ruby
• Owner: loqimean
• License: mit
• Created: 2023-06-15T15:49:07.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-14T13:31:51.000Z (about 1 year ago)
• Last Synced: 2024-06-16T09:34:15.367Z (5 months ago)
• Topics: easy-to-use, gem, monobank, monobank-acquiring, monobank-api, monobank-sdk, payments, ruby, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 39.1 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Actions Status](https://github.com/loqimean/monopay-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/loqimean/monopay-ruby/actions)

[![Listed on OpenSource-Heroes.com](https://opensource-heroes.com/badge-v1.svg)](https://opensource-heroes.com/r/loqimean/fake_picture)

# MonopayRuby

The "monopay-ruby" gem simplifies Monobank payment integration in Ruby and Rails applications. It provides an intuitive interface and essential functionalities for generating payment requests, verifying transactions, handling callbacks, and ensuring data integrity. With this gem, you can quickly and securely implement Monobank payments, saving development time and delivering a seamless payment experience to your users.

This gem was developed for Monobank API [https://api.monobank.ua/docs/acquiring.html](https://api.monobank.ua/docs/acquiring.html)

## Installation

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

```bash

bundle add "monopay-ruby"

```

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

```ruby

gem install "monopay-ruby"

```

## Usage

Add API token. There are two ways:

First - add to the initializer file:

```ruby

# config/initializers/monopay-ruby.rb

MonopayRuby.configure do |config|

  config.api_token = "your_api_token"

end

```

The second one - add to the environment variable:

```bash

# .env

MONOPAY_API_TOKEN=your_api_token

```

#### You can get the API token depending on the environment:

Development: [https://api.monobank.ua/](https://api.monobank.ua/)

Production: [https://fop.monobank.ua/](https://fop.monobank.ua/)

Just get the token and go to earn moneys! 🚀

### Generate payment request

```ruby

# app/controllers/payments_controller.rb

class PaymentsController < ApplicationController

  def create

    payment = MonopayRuby::Invoices::SimpleInvoice.new(

      "https://example.com",

      "https://example.com/payments/webhook"

    )

    if payment.create(amount: 100, destination: "Payment description",)

      # your success code processing

    else

      # your error code processing

      # flash[:error] = payment.error_messages

    end

  end

end

```

### Verify transaction

```ruby

# app/controllers/payments_controller.rb

class PaymentsController < ApplicationController

  skip_before_action :verify_authenticity_token, only: :webhook

  def webhook

    webhook_validator = MonopayRuby::Webhooks::Validator.new(request)

    if webhook_validator.valid?

      # your success code processing

    else

      # your error code processing

      # flash[:error] = webhook_validator.error_messages

    end

  end

end

```

## Useful

[Test cards](https://na-gateway.mastercard.com/api/documentation/integrationGuidelines/supportedFeatures/testAndGoLive.html?locale=en_US)

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/loqimean/monopay-ruby.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Thanks for your support!

[](https://github.com/railsjazz)