Bulk credits sweep account

features/accounts.feature

@@ -0,0 +1,36 @@
+Feature: Accounts
+  Accounts are a way to have a store of some kind of value.
+
+  Scenario: List accounts
+    Given I have created a customer
+    When I GET to /accounts
+    Then I should get a 200 OK status code
+    And the response is valid according to the "accounts" schema
+
+  Scenario: Retrieving accounts for a customer
+    Given I have created a customer
+    When I GET to /customers/:customer_id/accounts
+    Then I should get a 200 OK status code
+    And the response is valid according to the "accounts" schema
+    And the fields on these credits match:
+      """
+      {
+        "links": {
+          "customer": ":customer_id"
+        }
+      }
+      """
+
+  Scenario: Credit a customer deposit account
+    Given I have an order with a debit
+    When I POST to /accounts/:customer_deposit_account_id/credits
+    """
+    {
+      "credits": [{
+        "amount": 234,
+        "order": "/orders/:order_id"
+      }]
+    }
+    """
+    Then I should get a 201 Created status code
+    And the response is valid according to the "credits" schema

features/credits.feature

@@ -124,3 +124,50 @@ Feature: Credits
        "category_code": "no-funding-destination"
       }
     """
+
+
+  Scenario: Bulk credit to a customer deposit account
+    Given I have a merchant with 2 orders with debits
+    When I POST to /accounts/:customer_deposit_account_id/credits with the body:
+    """
+      {
+        "credits": [{
+          "amount": 1000,
+          "order": "/orders/:order_id_1",
+          "appears_on_statement_as": "Payout group A"
+        }]
+      }
+    """
+    Then I should get a 201 Created status code
+    And the response is valid according to the "credits" schema
+
+    When I make a GET request to /accounts/:customer_deposit_account_id
+    Then I should get a 200 OK status code
+    And the fields on this error match:
+    """
+      {
+       "balance": 1000
+      }
+    """
+
+    When I POST to /accounts/:customer_deposit_account_id/credits with the body:
+    """
+      {
+        "credits": [{
+          "amount": 1000,
+          "order": "/orders/:order_id_2",
+          "appears_on_statement_as": "Payout group B"
+        }]
+      }
+    """
+    Then I should get a 201 Created status code
+    And the response is valid according to the "credits" schema
+
+    When I make a GET request to /accounts/:customer_deposit_account_id/credits
+    Then I should get a 200 OK status code
+    And the fields on this error match:
+    """
+      {
+       "balance": 2000
+      }
+    """

features/settlements.feature

@@ -0,0 +1,108 @@
+@focus
+Feature: Settlements
+  Settlement is the action of moving money out of an Account to a
+  bank account.
+
+  Scenario: Create a settlement
+    Given I have an Account with sufficient funds
+    And I have tokenized a bank account
+    When I POST to /accounts/:customer_deposit_account_id/settlements with the body:
+      """
+      {
+        "settlements": [{
+          "destination": "/bank_accounts/:bank_account_id",
+          "appears_on_statement_as": "Settlement Oct",
+          "description": "Settlement for payouts from October"
+        }]
+      }
+      """
+    Then I should get a 201 Created status code
+    And the response is valid according to the "settlements" schema
+    And the fields on this settlement match:
+      """
+      {
+        "amount": "10000",
+        "appears_on_statement_as": "BAL*Settlement Oct",
+        "description": "Settlement for payouts from October",
+        "links": {
+          "destination": ":bank_account_id"
+        }
+      }
+      """
+
+  Scenario: List settlements
+    Given I have 2 settlements
+    When I GET to /settlements
+    Then I should get a 200 OK status code
+    And the response is valid according to the "settlements" schema
+
+  Scenario: Retrieving settlements for a bank account
+    Given I have a bank account with a settlement
+    When I GET to /bank_accounts/:bank_account_id/settlements
+    Then I should get a 200 OK status code
+    And the response is valid according to the "settlements" schema
+    And the fields on these settlements match:
+      """
+      {
+        "links": {
+          "destination": ":bank_account_id"
+        }
+      }
+      """
+
+  Scenario: Updating a settlement description
+    Given I have a bank account with a settlement
+    When I PUT to /settlements/:settlement_id with the body:
+      """
+      {
+        "description": "A new settlement description"
+      }
+      """
+    Then I should get a 200 OK status code
+    And the response is valid according to the "settlements" schema
+    And the fields on this settlement match:
+      """
+      {
+        "description": "A new settlement description"
+      }
+      """
+
+  Scenario: Updating a settlement meta
+    Given I have a bank account with a settlement
+    When I PUT to /settlements/:settlement_id with the body:
+      """
+      {
+        "meta": {
+          "reference_number": "546512"
+        }
+      }
+      """
+    Then I should get a 200 OK status code
+    And the response is valid according to the "settlements" schema
+    And the fields on this settlement match:
+      """
+      {
+        "meta": {
+          "reference_number": "546512"
+        }
+      }
+      """
+
+  Scenario: Creating a settlement without a funding destination leads to failure
+    When I POST to /settlements with the body:
+    """
+      {
+        "settlements": [{
+          "description": "Will this credit work? Nobody knows"
+        }]
+      }
+    """
+    Then I should get a 409 status code
+    And the response is valid according to the "errors" schema
+    And the fields on this error match:
+    """
+      {
+       "category_code": "no-funding-destination"
+      }
+    """
+

features/step_definitions/account.rb

@@ -0,0 +1,8 @@
+Given(/^I have an Account with sufficient funds$/) do
+  step 'I have an order with a debit'
+  @client.post("/accounts/#{@customer_deposit_account_id}/credits", {
+                 amount: 10000,
+                 order: @order_id
+               })
+  @client.add_hydrate :credit_id, @client['id']
+end

features/step_definitions/customers.rb

@@ -11,7 +11,13 @@
   )
   @customer_id = @client['id']
   @client.add_hydrate :customer_id, @customer_id
-
+  # get the deposit account
+  @client['accounts'].each do |acct|
+    if acct['type'] == 'deposit'
+      @client.add_hydrate :customer_deposit_account_id, acct['id']
+      break
+    end
+  end
   @customer_url = @client['customers']['href']
 
   # tokenize a card for them

features/step_definitions/orders.rb

@@ -55,4 +55,24 @@
       order: @order_id
   })
   @client.add_hydrate :card_hold_id, @client['id']
+end
+
+
+Given(/^I have a merchant with (\d) orders with debits$/) do |num|
+  step 'I have created a customer'
+  @client.post('/customers', {})
+  @merchant_id = @client['id']
+  @client.add_hydrate :merchant_id, @merchant_id
+  step 'I have tokenized a bank account and associated with the merchant'
+  num.to_i.times do |i|
+    @client.post("/customers/#{@merchant_id}/orders", {})
+    order_id = @client['id']
+    @client.add_hydrate :order_id, order_id
+    @client.post("/cards/#{@card_id}/debits", {
+                   amount: 12345,
+                   order: order_id
+                 })
+    @client.add_hydrate :debit_id, @merchant_id
+    instance_variable_set("@order_id_#{i + 1}", order_id)
+  end
 end

features/step_definitions/settlements.rb

@@ -0,0 +1,14 @@
+Given(/^I have a bank account with a settlement$/) do
+  step 'I have an order with a debit'
+  step 'I have created a customer'
+  @client.post("/accounts/#{@customer_deposit_account_id}/credits", {
+                 amount: 1234,
+                 order: :order_id
+               })
+  @settlement_id = @client['settlements']['id']
+  @client.add_hydrate :settlement_id, @settlement_id
+end
+
+Given(/^I have (\d) settlements$/) do
+  num.to_i.times { step 'I have a bank account with a settlement' }
+end

fixtures/_models/account.json

@@ -0,0 +1,69 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "The redeemable balance of a customer is represented as a financial instrument just like a Card or Bank Account.",
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "pattern": "AT[a-zA-Z0-9]{16,32}"
+        },
+        "href": {
+            "type": "string",
+            "format": "uri"
+        },
+        "created_at": {
+            "type": "string",
+            "format": "date-time"
+        },
+        "updated_at": {
+            "type": "string",
+            "format": "date-time"
+        },
+        "balance": {
+            "type": "integer",
+            "minimum": 0
+        },
+        "currency": {
+            "type": "string",
+            "enum": [
+                "USD"
+            ]
+        },
+        "can_debit": {
+            "description": "Flag indicating whether this account can be debited (true) or not (false).",
+            "type": "boolean"
+        },
+        "can_credit": {
+            "description": "Flag indicating whether this account instrument can be credited (true) or not (false).",
+            "type": "boolean"
+        },
+        "meta": {
+            "type": "object"
+        },
+        "links": {
+            "type": "object",
+            "properties": {
+                "customer": {
+                    "type": "string",
+                    "pattern": "CU[a-zA-Z0-9]{16,32}"
+                }
+            },
+            "additionalProperties": false,
+            "required": [
+                "customer"
+            ]
+        }
+    },
+    "required": [
+        "id",
+        "href",
+        "created_at",
+        "updated_at",
+        "balance",
+        "currency",
+        "can_credit",
+        "can_debit",
+        "meta",
+        "links"
+    ]
+}

fixtures/_models/bank_account.json

@@ -84,6 +84,14 @@
                         "string"
                     ],
                     "pattern": "BZ[a-zA-Z0-9]{16,32}"
+                },
+                "sweep_account": {
+                    "description": "A funding instrument representing a sweep account used for bulk credits",
+                    "type": [
+                        "null",
+                        "string"
+                    ],
+                    "pattern": "(AT)[a-zA-Z0-9]{16,32}"
                 }
             },
             "required": [

fixtures/_models/credit.json

@@ -76,7 +76,7 @@
                 "destination": {
                     "description": "The funding destination for this credit",
                     "type": "string",
-                    "pattern": "(CC|BA)[a-zA-Z0-9]{16,32}"
+                    "pattern": "(CC|BA|AT)[a-zA-Z0-9]{16,32}"
                 },
                 "order": {
                     "description": "The order this credit is associated with",

fixtures/_models/reversal.json

@@ -68,7 +68,7 @@
                     "pattern": "CR[a-zA-Z0-9]{16,32}"
                 },
                 "order": {
-                    "description": "The order this credit is assocaited with",
+                    "description": "The order this credit is associated with",
                     "type": [
                         "null",
                         "string"