https://github.com/devato/hyperwallet-ruby
Hyperwallet REST api
https://github.com/devato/hyperwallet-ruby
Last synced: about 1 year ago
JSON representation
Hyperwallet REST api
- Host: GitHub
- URL: https://github.com/devato/hyperwallet-ruby
- Owner: devato
- License: mit
- Created: 2016-07-28T12:05:57.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-01-29T16:03:17.000Z (over 9 years ago)
- Last Synced: 2025-03-28T05:11:15.239Z (about 1 year ago)
- Language: Ruby
- Size: 24.4 KB
- Stars: 2
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/hyperwallet-ruby)
[](https://travis-ci.org/devato/hyperwallet-ruby)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'hyperwallet-ruby'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install hyperwallet-ruby
## Configuration
To configure the gem using your credentials:
```
Hyperwallet.api_user = ENV['HYPERWALLET_API_USER']
Hyperwallet.api_password = ENV['HYPERWALLET_API_PASS']
Hyperwallet.api_base = ENV['HYPERWALLET_API_BASE']
```
## Users API
To create a user:
```
Hyperwallet::User.create({valid: user_data})
```
To find a user:
```
Hyperwallet::User.find(user_key_id)
```
## Payments API
To create a payment:
```
Hyperwallet::Payment.create({valid: payment_data})
```
## TODO
1. Add Prepaid Cards methods - WIP
2. Add Bank Accounts methods - WIP
3. Add Status Transitions methods - WIP
4. Add Transfer Method Configurations methods - WIP
5. Add Balances methods - WIP
6. Add Programs method - WIP
7. Add Accounts method - WIP
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/Devato/hyperwallet-ruby.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).