Increase

Tip

I, @garyhtou, maintained the increase ruby gem up until June 15th, 2025. At which point, I passed the gem name ownership over to Increase since they shipped their own Ruby gem! You can find the official gem source code at Increase/increase-ruby.

The last release of this unofficial increase gem was v0.3.3.

Installation

$ bundle add increase -v 0.3.2

$ gem install increase -v 0.3.2

Usage

require 'increase'
# Grab your API key from https://dashboard.increase.com/developers/api_keys
Increase.api_key = 'my_api_key'
Increase.base_url = 'https://api.increase.com'
# List transactions
Increase::Transactions.list
# Retrieve a transaction
Increase::Transactions.retrieve('transaction_1234abcd')
# Create an ACH Transfer
Increase::AchTransfers.create(
 account_id: 'account_1234abcd',
 amount: 100_00, # 10,000 cents (100ドル dollars)
 routing_number: '123456789',
 account_number: '9876543210',
 statement_descriptor: 'broke the bank for some retail therapy'
)

Per-request Configuration

sandbox = Increase::Client.new(
 api_key: 'playing_it_safe',
 base_url: 'https://sandbox.increase.com'
)
# This request will use the `sandbox` client and its configurations
Increase::Transactions.with_config(sandbox).list
# => [{some sandbox transactions here}, {transaction}, {transaction}, ...]
# This request will still use the global configurations (using production key)
Increase::Transactions.list
# => [{some production transactions here}, {transaction}, {transaction}, ...]

Increase::Transactions.with_config(api_key: 'time_is_money', base_url: :sandbox).list
# => [{some sandbox transactions here}, {transaction}, {transaction}, ...]

Pagination

Increase::Transactions.list(limit: :all) do |transactions|
 # This block will be called once for each page of results
 puts "I got #{transactions.count} transactions!"
end
# Or, if you'd like a gargantuan array of all the transactions
Increase::Transactions.list(limit: :all)
# You can also use the `next_cursor` to manually paginate through the results
txns = Increase::Transactions.list(
 limit: 2_000,
 'created_at.after': '2022-01-15T06:34:23Z'
)
# => [{transaction}, {transaction}, {transaction}, ...]
txns.next_cursor
# => "eyJwb2NpdGlvbiI6eyJvZmlzZXQiOjEwMH0sIm3pbHRlclI6e319"

Error Handling

begin
 Increase::Transactions.retrieve('i_dont_exist')
rescue Increase::ApiError => e
 puts e.message # "[404: object_not_found_error] Could not find the ..."
 puts e.title # "Could not find the specified object."
 puts e.detail # "No resource of type transaction was found with ID ..."
 puts e.status # 404
 puts e.response # This contains the full response, including headers!
 # => #<Faraday::Response:0x000000010b1fe2b0 ...>
 puts e.class # Increase::ObjectNotFoundError (subclass of Increase::ApiError)
end

Increase.raise_api_errors = false # Default: true
Increase::Transactions.retrieve('i_dont_exist')
# => {"status"=>404, "type"=>"object_not_found_error", ... }

Configuration

# Set the configurations directly
Increase.api_key = 'terabytes_of_cash' # Default: nil (you'll need one tho!)
Increase.base_url = :production # Default: :production
Increase.raise_api_errors = true # Default: true
# Or, you can pass in a hash
Increase.configure(api_key: 'just_my_two_cents')
# Or, you can use a block!
Increase.configure do |config|
 config.api_key = 'digital_dough'
 config.base_url = :sandbox # Default: :production
 config.raise_api_errors = false # Default: true
end

# config/initializers/increase.rb
Increase.configure do |config|
 # Your Increase API Key!
 # Grab it from https://dashboard.increase.com/developers/api_keys
 config.api_key = Rails.application.credentials.dig(:increase, :api_key)
 # The base URL for Increase's API.
 # You can use
 # - :production (https://api.increase.com)
 # - :sandbox (https://sandbox.increase.com)
 # - or set an actual URL
 config.base_url = Rails.env.production? ? :production : :sandbox
 # Whether to raise an error when the API returns a non-2XX status.
 # If disabled (false), the client will return the error response as a normal,
 # instead of raising an error.
 # 
 # Learn more about...
 # - Increase's errors: https://increase.com/documentation/api#errors
 # - Error classes: https://github.com/garyhtou/increase-ruby/blob/main/lib/increase/errors.rb
 config.raise_api_errors = true # Default: true
end

File Uploads

Increase::Files.create(
 purpose: 'identity_document',
 file: '/path/to/file.jpg'
) 

file = File.open('/path/to/file.jpg')
Increase::Files.create(
 purpose: 'identity_document',
 file: file
) 

file = Increase::FileUpload.new(
 '/path/to/file.jpg',
 content_type: 'image/jpeg',
 filename: 'my_file.jpg'
)
Increase::Files.create(
 purpose: 'identity_document',
 file: file
) 

Webhooks

class IncreaseController < ApplicationController
 protect_from_forgery except: :webhook # Ignore CSRF checks
 def webhook
 payload = request.body.read
 sig_header = request.headers['Increase-Webhook-Signature']
 secret = Rails.application.credentials.dig(:increase, :webhook_secret)
 Increase::Webhook::Signature.verify(
 payload: payload,
 signature_header: sig_header,
 secret: secret
 )
 # It's a valid webhook! Do something with it...
 render json: {success: true}
 rescue Increase::WebhookSignatureVerificationError => e
 render json: {error: 'Webhook signature verification failed'}, status: :bad_request
 end
end

Idempotency

card = Increase::Cards.create(
 {
 # Card parameters
 account_id: 'account_1234abcd',
 description: 'My Chipotle card'
 },
 {
 # Request headers
 'Idempotency-Key': 'use a V4 UUID here'
 }
)
# => {"id"=>"card_1234abcd", "type"=>"card", ... }
card.idempotent_replayed
# => nil
# Repeat the exact same request
card = Increase::Cards.create(...)
# => {"id"=>"card_1234abcd", "type"=>"card", ... }
card.idempotent_replayed
# => "true"

Development

Contributing

License