Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1d3o/satispay
Unofficial Satispay API for Ruby
https://github.com/1d3o/satispay
gem payments ruby ruby-satispay rubygem satispay
Last synced: 26 days ago
JSON representation
Unofficial Satispay API for Ruby
- Host: GitHub
- URL: https://github.com/1d3o/satispay
- Owner: 1d3o
- License: mit
- Created: 2017-06-01T15:05:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-26T10:40:23.000Z (over 6 years ago)
- Last Synced: 2024-11-20T16:46:20.366Z (about 1 month ago)
- Topics: gem, payments, ruby, ruby-satispay, rubygem, satispay
- Language: HTML
- Homepage:
- Size: 344 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Satispay Ruby API
[](https://badge.fury.io/rb/satispay)
## Installation
To use the gem you need to add it on your Gemfile
Latest version
```ruby
gem 'satispay', git: 'https://github.com/ideonetwork/satispay'
```
Legacy version
```ruby
gem 'satispay'
```
## Usage
To use the API you need to initialize a new instance
```ruby
satispay = Satispay::Api.new(env, security_bearer)
# NB: env sholud be 'prod' or 'staging'
```
### Check bearer
Allow application to check if bearer is valid.
```ruby
response = satispay.check_bearer
```
### Get all users
```ruby
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
```ruby
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
```ruby
response = satispay.get_user(user_id: user_satispay_id)
```
### Get all chanrges
```ruby
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
```ruby
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
```ruby
response = satispay.get_charge(charge_id: charge_id)
```
### Update charge
```ruby
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
```ruby
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:
```console
rdoc --op rdoc
```