PAGHIPER
Ruby gem for PAGHIPER API generation of "boletos" (brazilian cash payment method).
Currently, gem supports version v1.3 of PAGHIPER API
Installation
Add the following line in your Gemfile:
gem 'paghiper'
and execute:
$ bundle
Or install it through:
$ gem install paghiper
Configuration
Generate Rails initialization file
$ rails g paghiper:install
Configure your client settings
Paghiper.configure do |config|
config.api_key = 'apk_99999999-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
config.token = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
config.http_debug = true
end
Usage
Generating boletos
Paghiper::Transaction.create(transaction_data)
Check the API documentation for more information regarding this endpoint.
Responding to boletos webhook (Automatic status notification)
Paghiper::Transaction.notification(notification_data)
Check the API documentation for the detailed notification flow.
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 tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/coyosoftware/paghiper. 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 Paghiper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.