Ruby client for Contactpay API
Install the gem and add to the application's Gemfile by executing:
$ bundle add contactpay
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install contactpay
When you get your Site approved you can use it's secret key for making API requests.
require 'contactpay'
contactpay_config = Contactpay::Config.new(
base_url: "<BASE API URL>", # "https://api.contactpay.com.com"
account_secret_key: "<YOUR ACCOUNT SECRET KEY>",
shop_id: <YOUR ACCOUNT SHOP ID>,
faraday_block: # if needed
)Now you can make API calls
Contactpay::Shop.new(contactpay_config).balance data = { ... }
Contactpay::Invoice.new(contactpay_config).prelim_calc(data) data = { ... }
Contactpay::Invoice.new(contactpay_config).create(data) data = { ... }
Contactpay::Invoice.new(contactpay_config).status(data) data = { ... }
Contactpay::Invoice.new(contactpay_config).hold_funds(data) data = { ... }
Contactpay::Invoice.new(contactpay_config).charge(data) data = { ... }
Contactpay::Invoice.new(contactpay_config).unhold_funds(data) Contactpay::Invoice.new(contactpay_config).payment_methods data = { ... }
Contactpay::Withdraw.new(contactpay_config).prelim_calc(data) data = { ... }
Contactpay::Withdraw.new(contactpay_config).check_account(data) data = { ... }
Contactpay::Withdraw.new(contactpay_config).create(data) data = { ... }
Contactpay::Withdraw.new(contactpay_config).status_by_id(data) data = { ... }
Contactpay::Withdraw.new(contactpay_config).status_by_shop_number(data) Contactpay::Withdraw.new(contactpay_config).payment_methods data = { ... }
Contactpay::Refund.new(contactpay_config).create(data) data = { ... }
Contactpay::Refund.new(contactpay_config).status(data) data = { ... }
Contactpay::PaymentToken.new(contactpay_config).create(data) data = { ... }
Contactpay::PaymentToken.new(contactpay_config).complete(data) data = { ... }
Contactpay::PaymentToken.new(contactpay_config).status(data) data = { ... }
Contactpay::PaymentToken.new(contactpay_config).delete(data)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.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contactpay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Contactpay project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.