A gem developed with the express purpose of reducing development time when integrating with Stripe payments.

This gem is targeted at API development and assumes your frontend is able to generate and send tokenized payment data to your endpoints.

1. Installation
2. Configuration
3. Usage
   1. Handling Credit Cards
      1. Creating a Stripe Customer
      2. Deleting a Stripe Customer
   2. Handling Bank Accounts
      1. Creating a Stripe Connect Custom Account
         1. Further Reading
      2. Deleting a Stripe Connect Custom Account
   3. Creating a Charge
      1. Without a Payout
      2. With a Payout
   4. Creating a Transfer

1. Add gem "cash_out" to your Gemfile.
2. bundle install
3. rails generate cash_out:install
4. Update the items in config/initializers/cash_out.rb with your Stripe API keys.
5. Create a migration to add a stripe_id (String) field to User or whichever model will hold the Stripe token.
6. If using Stripe Connect (for making payouts), add date_of_birth(Date), first_name, and last_name to your User as well.

CashOut needs to be configured with your Stripe API keys. You can find the config file in config/initializers/cash_out.rb. If it's not there, run rails generate cash_out:install.

CashOut.configure do |config|
  config.stripe_publishable_key = 'your_stripe_public_key'
  config.stripe_secret_key = 'your_stripe_secret_key'
end

All CashOut services utilize ActiveInteraction and will return an appropriate service object.

Stripe Customer objects are used for making credit card purchases. You can create a Stripe Customer and store the token on your User with the following code.

Sample Code:

def create
  CashOut::Payments::Customer::Create.run(customer_params)
end

def customer_params
  { user: current_user, stripe_token: params[:token] }
end

To remove payment information from your user, run the appropriate delete service

Sample Code:

def destroy
  CashOut::Payments::Customer::Delete.run(user: current_user)
end

Note: This currently deletes the entire Customer account. Support for deleting individual cards will be added in a future release.

A Stripe Connect Custom Account is used when your app needs to pay independent contractors. This will connect the user's bank account with a Stripe account you create for them. This will allow you to make payments out to the user's account and make transfers from the user's bank account to settle any outstanding balance.

Setting up a Connect Account requires several params. user can be any object that responds to stripe_id, valid?, save, date_of_birth, first_name, and last_name.

Sample Code:

def create
  CashOut::Connect::Account::Create.run(account_params)
end

def account_params
  {
    user: current_user,
    external_account_token: params[:external_account_token],
    ip_address: ,
    legal_entity_type: params[:legal_entity_type],
    ssn_last_4: params[:ssn_last_4],
    stripe_terms_accepted: params[:stripe_terms_accepted],
    legal_entity_address: legal_entity_params
  }
end

def legal_entity_params
  params.require(:address).permit(
    :line1,
    :line2,
    :city,
    :state,
    :country,
    :postal_code
  )
end

Further documentation regarding Connect accounts may be found on Stripe's Official Connect Documentation

To remove payment information from your user, run the appropriate delete service

Sample Code:

def destroy
  CashOut::Connect::Account::Delete.run(user: current_user)
end

When creating a charge without a payout, you can send just 2 params

Example:

CashOut::Charge::Create.run(charge_params)

def charge_params
  { payor: paying_user, amount_to_charge: charge_in_cents }
end

Making a charge with a payout is a little more complex, but CashOut aims to handle the difficult parts for you. There are 4 params that need to be sent:

Example:

CashOut::Charge::Create.run(charge_params)

def charge_params
  {
    payor: paying_user,
    amount_to_charge: charge_in_cents,
    payee: user_getting_paid,
    amount_to_payout: payout_in_cents
  }
end

It's important to know that amount_to_payout can be either positive or negative.

In the case of a positive payout, the user will receive the amount_to_payout in their Stripe account. For negative payouts, the amount_to_payout will be transfered from the user to the platform (business owned) Stripe account.

CashOut attempts to handle transfers automatically. However, should the case arise that you need to create one manually, you can do so with the following.

CashOut::Connect::Transfer::Create.run(transfer_params)

def transfer_params
  {
    payee: user_getting_paid,
    amount_to_payout: payout_in_cents
  }
end

Important Note When creating a transfer without a corresponding payment, or when the transfer amount exceeds the amount of associated charges, the platform Stripe account MUST have enough available funds to cover the transfer, or the transfer will fail.