Satispay Ruby API
Installation
To use the gem you need to add it on your Gemfile
Latest version
gem 'satispay', git: 'https://github.com/ideonetwork/satispay'Legacy version
gem 'satispay'Usage
To use the API you need to initialize a new instance
satispay = Satispay::Api.new(env, security_bearer)
# NB: env sholud be 'prod' or 'staging'Check bearer
Allow application to check if bearer is valid.
response = satispay.check_bearerGet all users
response = satispay.all_users(*extra_params)For extra params info watch the official documentation: https://s3-eu-west-1.amazonaws.com/docs.online.satispay.com/index.html#get-a-user-list
Create new user
response = satispay.create_user(phone_number: user_phone_number, *extra_params)For extra params info watch the official documentation: https://s3-eu-west-1.amazonaws.com/docs.online.satispay.com/index.html#create-a-user
Get user
response = satispay.get_user(user_id: user_satispay_id)Get all chanrges
response = satispay.all_charges(*extra_params)For extra params info watch the official documentation: https://s3-eu-west-1.amazonaws.com/docs.online.satispay.com/index.html#get-a-charge-list
Create new charges
response = satispay.create_charge(user_id: user_id, currency: 'EUR', amount: 100, *extra_params)For extra params info watch the official documentation: https://s3-eu-west-1.amazonaws.com/docs.online.satispay.com/index.html#create-a-charge
Get charge
response = satispay.get_charge(charge_id: charge_id)Update charge
response = satispay.update_charge(charge_id: charge_id, *extra_params)For extra params info watch the official documentation: https://s3-eu-west-1.amazonaws.com/docs.online.satispay.com/index.html#update-a-charge
Get all refunds
response = satispay.all_refunds(*extra_params)For extra params info watch the official documentation: https://s3-eu-west-1.amazonaws.com/docs.online.satispay.com/index.html#get-a-refunds-list
Development
RDoc documentation
To update the rdoc documentation run:
rdoc --op rdoc