balanced 1.1.1 → 1.2.1

data/snippets/card-associate-to-customer.rb

@@ -0,0 +1,2 @@
+card = Balanced::Card.fetch(card_href)
+card.associate_to_customer(customer_href)

data/snippets/card-create-dispute.rb

@@ -0,0 +1,6 @@
+card = Balanced::Card.new(
+  :cvv => '123',
+  :expiration_month => '12',
+  :expiration_year => '2020',
+  :number => '6500000000000002'
+).save

data/snippets/card-create.rb

@@ -0,0 +1,7 @@
+card = Balanced::Card.new(
+  :name => 'John Doe',
+  :expiration_month => '12',
+  :number => '5105105105105100',
+  :expiration_year => '2020',
+  :security_code => '123'
+).save

data/snippets/card-credit.rb

@@ -0,0 +1,9 @@
+# card_href is the stored href for the Card
+# order_href is the stored href for the Order
+card = Balanced::Card.fetch(card_href)
+card.credit(
+  :amount => 5000,
+  :appears_on_statement_as => 'Some text',
+  :description => 'Some descriptive text for the debit in the dashboard',
+  :order => order_href
+)

data/snippets/card-debit.rb

@@ -0,0 +1,9 @@
+# card_href is the stored href for the Card
+# order_href is the stored href for the Order
+card = Balanced::Card.fetch(card_href)
+card.debit(
+  :amount => 5000,
+  :appears_on_statement_as => 'Statement text',
+  :description => 'Some descriptive text for the debit in the dashboard',
+  :order => order_href
+)

data/snippets/card-hold-capture.rb

@@ -0,0 +1,6 @@
+# card_hold_href is the stored href for the CardHold
+card_hold = Balanced::CardHold.fetch(card_hold_href)
+debit = card_hold.capture(
+  :description => 'Some descriptive text for the debit in the dashboard',
+  :appears_on_statement_as => 'ShowsUpOnStmt'
+)

data/snippets/card-hold-create.rb

@@ -0,0 +1,6 @@
+# card_href is the stored href for the Card
+card = Balanced::Card.fetch(card_href)
+card.hold(
+  :amount => 5000,
+  :description => 'Some descriptive text for the debit in the dashboard'
+)

data/snippets/card-hold-void.rb

@@ -0,0 +1,3 @@
+# card_hold_href is the stored href for the CardHold
+card_hold = Balanced::CardHold.fetch(card_hold_href)
+card_hold.unstore

data/snippets/create-buyer-and-card.rb

@@ -0,0 +1,13 @@
+buyer = Balanced::Customer.new(
+  :name => 'John Buyer'
+).save
+
+card = Balanced::Card.new(
+  :number => '5105105105105100',
+  :expiration_month => '12',
+  :expiration_year => '2020',
+  :cvv => '123',
+  :name => 'John Buyer'
+).save
+
+card.associate_to_customer(buyer)

data/snippets/credit-create.rb

@@ -0,0 +1,8 @@
+# bank_account_href is the stored href for the BankAccount
+# order_href is the stored href for the Order
+bank_account = Balanced::BankAccount.fetch(bank_account_href)
+credit = bank_account.credit(
+  :amount => 100000,
+  :description => 'Payout for order #1111',
+  :order => order_href
+)

data/snippets/credit-fetch.rb

@@ -0,0 +1 @@
+credit = Balanced::Credit.fetch(credit_href)

data/snippets/credit-marketplace-escrow.rb

@@ -0,0 +1,4 @@
+Balanced::Marketplace.mine.owner_customer.bank_accounts.first.credit(
+    :amount => 2000000,
+    :description => 'Credit from Balanced escrow'
+)

data/snippets/credit-reverse.rb

@@ -0,0 +1 @@
+credit.reverse

data/snippets/credit-soft-descriptor.rb

@@ -0,0 +1,9 @@
+# bank_account_href is the stored href for the BankAccount
+# order_href is the stored href for the Order
+bank_account = Balanced::BankAccount.fetch(bank_account_href)
+credit = bank_account.credit(
+  :amount => 100000,
+  :description => 'Payout for order #1111',
+  :appears_on_statement_as => 'GoodCo #1111',
+  :order => order_href
+)

data/snippets/credit-split.rb

@@ -0,0 +1,13 @@
+# bank_account_href_a is the stored href for the BankAccount for Person A
+bank_account_person_a = Balanced::BankAccount.fetch(bank_account_href_a)
+credit = bank_account_person_a.credit(
+  :amount => 50000,
+  :description => 'Payout for order #1111'
+)
+
+# bank_account_href_b is the stored href for the BankAccount for Person B
+bank_account_person_b = Balanced::BankAccount.fetch(bank_account_href_b)
+credit = bank_account_person_b.credit(
+  :amount => 50000,
+  :description => 'Payout for order #1111'
+)

data/snippets/customer-create.rb

@@ -0,0 +1,8 @@
+merchant = Balanced::Customer.new(
+  :name => 'Henry Ford',
+  :dob_month => 7,
+  :dob_year => 1963,
+  :address => {
+    :postal_code => '48120'
+  }
+).save

data/snippets/debit-dispute-show.rb

@@ -0,0 +1,3 @@
+# debit_href is the stored href of the debit
+debit = Balanced::Debit.fetch(debit_href)
+dispute = debit.dispute

data/snippets/debit-fetch.rb

@@ -0,0 +1 @@
+debit = Balanced::Debit.fetch(debit_href)

data/snippets/debit-marketplace-escrow.rb

@@ -0,0 +1,4 @@
+Balanced::Marketplace.mine.owner_customer.bank_accounts.first.debit(
+    :amount => 2000000,
+    :description => 'Pre-fund Balanced escrow'
+)

data/snippets/debit-refund.rb

@@ -0,0 +1 @@
+debit.refund

data/snippets/dispute-list.rb

@@ -0,0 +1 @@
+disputes = Balanced::Dispute.all

data/snippets/dispute-show.rb

@@ -0,0 +1,2 @@
+# dispute_href is the stored href of the dispute
+dispute = Balanced::Dispute.fetch(dispute_href)

data/snippets/examine-order-after-refund.rb

@@ -0,0 +1,3 @@
+order = Balanced::Order.find(order_href)
+order.amount           # original order amount
+order.amount_escrowed  # will decrease by amount of refunded debit

data/snippets/examine-order-after-reversal.rb

@@ -0,0 +1,3 @@
+order = Balanced::Order.find(order_href)
+order.amount           # original order amount
+order.amount_escrowed  # will increase by amount of reversed credit

data/snippets/example.rb

@@ -0,0 +1 @@
+require 'balanced'

data/snippets/marketplace-in-escrow.rb

@@ -0,0 +1 @@
+Balanced::Marketplace.mine.in_escrow

data/snippets/merchant-payable-account-fetch.rb

@@ -0,0 +1,2 @@
+# merchant is a Customer instance
+merchant.payable_account

data/snippets/order-amount-escrowed.rb

@@ -0,0 +1,3 @@
+order.reload # reload the order to get recent changes
+order.amount
+order.amount_escrowed

data/snippets/order-bank-account-create.rb

@@ -0,0 +1,8 @@
+bank_account = Balanced::BankAccount.new(
+  :name => 'Henry Ford',
+  :routing_number => '321174851',
+  :account_number => '0987654321',
+  :type => 'checking'
+).save
+
+bank_account.associate_to_customer(merchant)

data/snippets/order-create.rb

@@ -0,0 +1 @@
+order = merchant.create_order

data/snippets/order-credit-marketplace.rb

@@ -0,0 +1,5 @@
+marketplace_bank_account = Balanced::Marketplace.mine.owner_customer.bank_accounts.first
+order.credit_to(
+    :destination => marketplace_bank_account,
+    :amount => 2000
+)

data/snippets/order-credit-merchant-payable-account.rb

@@ -0,0 +1,4 @@
+order.credit_to(
+  :destination => account_href,
+  :amount => 8000
+)

data/snippets/order-credit.rb

@@ -0,0 +1,4 @@
+order.credit_to(
+  :destination => bank_account,
+  :amount => 8000
+)

data/snippets/order-credits-fetch.rb

@@ -0,0 +1 @@
+order.credits # instance of Balanced::Pager. Lazily iterate as an array.

data/snippets/order-debit.rb

@@ -0,0 +1,4 @@
+debit = order.debit_from(
+  :source => card,
+  :amount => 10000
+)

data/snippets/order-debits-fetch.rb

@@ -0,0 +1 @@
+order.debits # instance of Balanced::Pager. Lazily iterate as an array.

data/snippets/order-fetch.rb

@@ -0,0 +1 @@
+order = Balanced::Order.fetch(order_href)

data/snippets/order-update.rb

@@ -0,0 +1,5 @@
+order.description = 'Item description'
+order.meta = {
+  'item_url' => 'https://neatitems.com/12342134123'
+}
+order.save

data/snippets/refund-create.rb

@@ -0,0 +1,13 @@
+# debit_href is the stored href for the Debit
+# order_href is the stored href for the Order
+debit = Balanced::Debit.fetch(debit_href)
+debit.refund(
+  :amount => 3000,
+  :description => 'Refund for Order #1111',
+  :meta => {
+    'merchant.feedback' => 'positive',
+    'fulfillment.item.condition' => 'OK',
+    'user.refund_reason' => 'not happy with product'
+  },
+  :order => order_href
+)

data/snippets/reversal-create.rb

@@ -0,0 +1,13 @@
+# credit_href is the stored href for the Credit
+# order_href is the stored href for the Order
+credit = Balanced::Credit.fetch(credit_href)
+reversal = credit.reverse(
+  :amount => 100000,
+  :description => 'Reversal for Order #1111',
+  :meta => {
+    'merchant.feedback' => 'positive',
+    'fulfillment.item.condition' => 'OK',
+    'user.refund_reason' => 'not happy with product'
+  },
+  :order => order_href
+)

data/snippets/settlement-create.rb

@@ -0,0 +1,5 @@
+account.settle(
+  :appears_on_statement_as => 'ThingsCo',
+  :description => 'A simple description',
+  :funding_instrument => bank_account_href
+)

data/spec/balanced/resources/account_spec.rb

@@ -0,0 +1,265 @@
+require 'spec_helper'
+
+describe Balanced::Account, :vcr, :marketplace => true do
+
+  describe 'credit funds from order to account' do
+    before do
+      # create seller
+      @merchant = Balanced::Customer.new(
+          :name => 'Henry Ford',
+          :dob_month => 7,
+          :dob_year => 1963,
+          :address => {
+              :postal_code => '48120'
+          }
+      ).save
+
+      # create buyer
+      buyer = Balanced::Customer.new(
+          :name => 'John Buyer'
+      ).save
+      @card = buyer.cards.create(
+          :number => '5105105105105100',
+          :expiration_month => '12',
+          :expiration_year => '2020',
+          :cvv => '123'
+      )
+
+      # create order
+      @order = @merchant.create_order
+
+      # set amount for debit
+      @amount = 10000
+    end
+
+    it 'should increase an account balance when credited' do
+      @order.debit_from(
+          :source => @card,
+          :amount => @amount
+      )
+      
+      account_credit = @merchant.payable_account.credit(
+          :amount => @amount,
+          :order => @order
+      )
+
+      @merchant.payable_account.balance.should eq @amount
+      account_credit.status.should eq 'succeeded'
+
+    end
+  end
+
+  describe "settling an account" do
+    before do
+      # create seller
+      @merchant = Balanced::Customer.new(
+          :name => 'Henry Ford',
+          :dob_month => 7,
+          :dob_year => 1963,
+          :address => {
+              :postal_code => '48120'
+          }
+      ).save
+      @bank_account = @merchant.bank_accounts.create(
+          :name => 'William Henry Cavendish III',
+          :routing_number => '321174851',
+          :account_number => '0987654321',
+          :type => 'checking'
+      )
+      @bank_account.associate_to_customer(@merchant)
+
+      # create buyer
+      buyer = Balanced::Customer.new(
+          :name => 'John Buyer'
+      ).save
+      @card = buyer.cards.create(
+          :number => '5105105105105100',
+          :expiration_month => '12',
+          :expiration_year => '2020',
+          :cvv => '123'
+      )
+
+      # create order
+      @order = @merchant.create_order
+
+      # set amount for debit
+      @amount = 10000
+
+      # debit into the order
+      debit = @order.debit_from(
+          :source => @card,
+          :amount => @amount
+      )
+
+      # credit the account
+      account_credit = @merchant.payable_account.credit(
+          :amount => @amount,
+          :order => @order
+      )
+    end
+
+    it 'reduces the account balance to zero' do
+      # settle the account
+      settlement = @merchant.payable_account.settle(
+          :funding_instrument => @bank_account,
+          :appears_on_statement_as => "Settlement Oct",
+          :description => "Settlement for payouts from October"
+      )
+
+      settlement.amount.should eq @amount
+      settlement.appears_on_statement_as.should eq "BAL*Settlement Oct"
+      settlement.description.should eq "Settlement for payouts from October"
+      @merchant.payable_account.balance.should eq 0
+    end
+  end
+
+  describe 'reversing a settlement' do
+    before do
+      # create seller
+      @merchant = Balanced::Customer.new(
+          :name => 'Henry Ford',
+          :dob_month => 7,
+          :dob_year => 1963,
+          :address => {
+              :postal_code => '48120'
+          }
+      ).save
+      @bank_account = @merchant.bank_accounts.create(
+          :name => 'William Henry Cavendish III',
+          :routing_number => '321174851',
+          :account_number => '0987654321',
+          :type => 'checking'
+      )
+      @bank_account.associate_to_customer(@merchant)
+
+      # create buyer
+      buyer = Balanced::Customer.new(
+          :name => 'John Buyer'
+      ).save
+      @card = buyer.cards.create(
+          :number => '5105105105105100',
+          :expiration_month => '12',
+          :expiration_year => '2020',
+          :cvv => '123'
+      )
+
+      # create order
+      @order = @merchant.create_order
+
+      # set amount for debit
+      @amount = 10000
+
+      # debit into the order
+      @order.debit_from(
+          :source => @card,
+          :amount => @amount
+      )
+
+      # credit the account
+      @account_credit = @merchant.payable_account.credit(
+          :amount => @amount,
+          :order => @order
+      )
+
+      # settle the account
+      @settlement = @merchant.payable_account.settle(
+          :funding_instrument => @bank_account.href,
+          :appears_on_statement_as => "Settlement Oct",
+          :description => "Settlement for payouts from October"
+      )
+    end
+
+    it 'credit should be reversible when account has pending balance' do
+      order_two = @merchant.create_order
+      order_two.debit_from(
+          :source => @card,
+          :amount => @amount
+      )
+
+      credit = @merchant.payable_account.credit(
+          :amount => @amount,
+          :order => order_two
+      )
+      @merchant.payable_account.balance.should eq @amount
+
+      credit.reverse(:amount => @amount)
+
+      #@payable_account.reload
+      @merchant.payable_account.balance.should eq 0
+
+    end
+  end
+
+  describe 'settling an account with an negative balance' do
+    before do
+
+      # create seller
+      @merchant = Balanced::Customer.new(
+          :name => 'Henry Ford',
+          :dob_month => 7,
+          :dob_year => 1963,
+          :address => {
+              :postal_code => '48120'
+          }
+      ).save
+      @bank_account = @merchant.bank_accounts.create(
+          :name => 'William Henry Cavendish III',
+          :routing_number => '321174851',
+          :account_number => '0987654321',
+          :type => 'checking'
+      )
+      @bank_account.associate_to_customer(@merchant)
+
+      # create buyer
+      buyer = Balanced::Customer.new(
+          :name => 'John Buyer'
+      ).save
+      @card = buyer.cards.create(
+          :number => '5105105105105100',
+          :expiration_month => '12',
+          :expiration_year => '2020',
+          :cvv => '123'
+      )
+
+      # create order
+      @order = @merchant.create_order
+
+      # set amount for debit
+      @amount = 10000
+
+      # debit into the order
+      @order.debit_from(
+          :source => @card,
+          :amount => @amount
+      )
+
+      # credit the account
+      @account_credit = @merchant.payable_account.credit(
+          :amount => @amount,
+          :order => @order
+      )
+
+      # settle the account
+      @settlement = @merchant.payable_account.settle(
+          :funding_instrument => @bank_account,
+          :appears_on_statement_as => "BAL*Settlement Oct",
+          :description => "Settlement for payouts from October"
+      )
+    end
+
+    it 'should create reversal and refund' do
+      @account_credit.reverse(:amount => @amount)
+
+      @merchant.payable_account.reload
+      @merchant.payable_account.balance.should eq -@amount
+
+      @settlement = @merchant.payable_account.settle(
+          :funding_instrument => @bank_account,
+          :appears_on_statement_as => "Reverse Settlement Oct",
+          :description => "Settlement for payouts from October"
+      )
+
+      @merchant.payable_account.balance.should eq 0
+    end
+  end
+end