Skip to content

payout/payout-ruby

Repository files navigation

Gem Version Build Status Code Climate Test Coverage

Payout Ruby SDK

The Payout Ruby SDK allows you to more quickly integrate with the Payout API.

Installation

The SDK is available as gem, which you can install like so:

gem install payout

Alternatively, you can add it to you Gemfile.

gem 'payout', '~> 0.1.0'

And then run bundle install.

Ruby Versions

The SDK has been tested on Linux with the following ruby versions:

  • 1.9.3
  • 2.0.0-p247
  • 2.1.6
  • 2.2.2
  • 2.3.1

Configuration

Payout.api_url =      ENV['PAYOUT_API_URL']           # Defaults to https://live.payout.com
Payout.api_token =    ENV['PAYOUT_API_TOKEN']         # You can find your credentials at
Payout.api_secret =   ENV['PAYOUT_API_SECRET']        # https://dashboard.payout.com/api
Payout.open_timeout = ENV['PAYOUT_OPEN_TIMEOUT'].to_i # Defaults to 30
Payout.read_timeout = ENV['PAYOUT_READ_TIMEOUT'].to_i # Defaults to 80

Documentation

See full documentation here.