fidor_schema 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7bb17909b66fdb0dd6d0c78c63db843a7fea592
-  data.tar.gz: c71536d24b0d0db3025fae8fcdcba77261ed0303
+  metadata.gz: 4dc5099e6308916a078cd74e1e7a8912bc23be31
+  data.tar.gz: ccb1d0e215ddb06ff92f4f67636439b25a2f4db6
 SHA512:
-  metadata.gz: 35ac0325b0491a3014828c397952a2e48b6db26d38364af801d6728f541a2851e494af1edf3df1660203b4607c0332a4135221a4a60efea4e5f946b1199992aa
-  data.tar.gz: a4d0a4ebd4ba7a861403261a03df2a7ed20dc358434acbc9892b7363110bc28d21ec2842fc0125687b53cee6142fa2aff1651783811887697d44486e37c541a9
+  metadata.gz: 9fa70a26d0950850772a127b3cbdc9c8067c269007afe09eba86d5658493984d8453dc8f92fb719260233cba04d6c07bba2ace8a16bd83ef0801989a9b22af1f
+  data.tar.gz: 30cbb0cd681e1c984d6ed123872070147786df4a86720d3055175f10aa32dcfd57521e3b73b60c10c939835780a832b61f5a8cefe2379ad074faa02212da64ff

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order rand

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+branches:
+  only:
+    - master
+
+rvm:
+  - 1.9.3
+  - 2.1
+  - 2.2
+
+cache: bundler
+
+script: bundle exec rspec

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 A more detailed view of the changes can be found in the [commit messages](https://github.com/fidor/fidor_schema/commits/)
 
+##2015-06
+
+* add transfer_approval resource
+* add mobile topup transaction details
+* add global money transfer(gmt) transaction details
+* add sepa_credit_transfer.fee_amount
+* add BIC to account
+* change creditor_identifier to creditor_identity_id for sepa_direct_debit
+
+##2015-05
+* add transaction_type_details for bonus transactions
+* enhance internal_transfer_details with more fields
+
 ##2015-04
 * Transaction update transaction types
 

data/lib/fidor_schema_version.rb

@@ -1,5 +1,5 @@
 module Fidor
   class Schema
-    VERSION='0.7.0'
+    VERSION='0.8.0'
   end
 end

data/schema/v1.0/account.json

@@ -17,6 +17,10 @@
       "$ref"     : "./base_types/base_types.json#definitions/iban",
       "readOnly" : true
     },
+    "bic" : {
+      "$ref"     : "./base_types/base_types.json#definitions/bic",
+      "readOnly" : true
+    },
     "balance" : {
       "description" : "Account balance",
       "type"        : "integer",

data/schema/v1.0/base_types/base_types.json

@@ -21,6 +21,41 @@
       "readOnly"    : true,
       "type"        : "string"
     },
+    "transaction_type" : {
+      "description" : "Type of the transaction",
+      "enum"        : [
+        "bonus",
+        "credit_interest",
+        "creditcard_annual_fee",
+        "creditcard_atm_fee",
+        "creditcard_foreign_exchange_fee",
+        "creditcard_notification_fee",
+        "creditcard_order_cancellation",
+        "creditcard_order_fee",
+        "creditcard_order_withdrawal_fee",
+        "creditcard_payin",
+        "creditcard_payout",
+        "creditcard_preauth",
+        "creditcard_release",
+        "debit_interest",
+        "emoney_payin",
+        "fee",
+        "fidor_payin",
+        "fidor_payout",
+        "gmt_fee",
+        "gmt_refund",
+        "gmt_payout",
+        "payout",
+        "prepaid_mobile_topup",
+        "sepa_authorization",
+        "sepa_b2b_direct_debit",
+        "sepa_core_direct_debit",
+        "sepa_payin",
+        "unknown"
+      ],
+      "type" : "string",
+      "maxLength"   : 255
+    },
     "phone" : {
       "description" : "A phone or fax number, formatted with country code: +49 123 1233213",
       "type"        : "string",
@@ -80,7 +115,7 @@
     "currency" : {
       "description" : "Currency of Account or Amount. ISO 4217 alpha-3 - 3 letter upcase e.g EUR",
       "type"        : "string",
-      "enum"        : ["EUR"],
+      "enum"        : ["EUR", "GBP"],
       "default"     : "EUR"
     },
     "subject" : {
@@ -93,24 +128,10 @@
       "type"             : "integer",
       "minimum"          : 1
     },
-    "transaction_type" : {
-      "description" : "Type of the transaction",
-      "enum"        : [
-        "payout",
-        "creditcard_payout",
-        "creditcard_authorization",
-        "creditcard_cancellation",
-        "fee",
-        "sepa_payin",
-        "sepa_core_direct_debit",
-        "sepa_b2b_direct_debit",
-        "fidor_payin",
-        "fidor_payout",
-        "sepa_authorization",
-        "emoney_payin",
-        "gmt_payout"
-      ],
-      "type" : "string"
+    "fee" : {
+      "description"      : "A fee amount in account currency, in minor units, e.g. 1EUR is represented as 100.",
+      "type"             : "integer",
+      "minimum"          : 0
     }
   }
 }

data/schema/v1.0/base_types/lists.json

@@ -0,0 +1,31 @@
+{
+  "type"        : "object",
+  "title"       : "List",
+  "name"        : "list",
+  "description" : "A paginated list of objects",
+  "properties"  : {
+    "data" : {
+      "description"  : "The requested objects",
+      "type"  : "array"
+    },
+    "collection" : {
+      "type"        : "object",
+      "name"        : "collection",
+      "description" : "Pagination information for a list of returned object (not standalone)",
+      "properties"  : {
+        "current_page" : {
+          "type" : "integer"
+        },
+        "per_page" : {
+          "type" : "integer"
+        },
+        "total_entries" : {
+          "type" : "integer"
+        },
+        "total_pages" : {
+          "type" : "integer"
+        }
+      }
+    }
+  }
+}

data/schema/v1.0/batch_transfer.json

@@ -119,7 +119,6 @@
       "properties" : {
         "filter[account_ids]" : {
           "title"  : "Find transfers belonging to the given account ids. Single id or multiple ids comma-separated.",
-          "format" : "date-time",
           "type"   : "string"
         },
         "filter[created_at_from]" : {

data/schema/v1.0/creditor_identity.json

@@ -2,7 +2,7 @@
   "$schema"     : "http://json-schema.org/draft-04/schema#",
   "type"        : "object",
   "title"       : "creditor_identity",
-  "description" : "Information about creditor identity. You have to provide the credidor identity you want to create a sepa mandate with",
+  "description" : "Information about creditor identity. You have to provide the creditor identity you want to create a sepa mandate with",
   "properties"  : {
     "id" : {
       "$ref" : "./base_types/base_types.json#definitions/id"
@@ -30,7 +30,6 @@
       "properties" : {
         "filter[account_ids]" : {
           "title"  : "Find creditor identities belonging to the given account ids. Single id or multiple ids comma-separated.",
-          "format" : "date",
           "type"   : "string"
         },
         "page" : {

data/schema/v1.0/customer.json

@@ -112,11 +112,6 @@
       "format"      : "date-time",
       "readOnly"    : true
     },
-    "creditor_identifier" : {
-      "description" : "Creditor Identifier ID set if the customer wants to create direct debits.",
-      "type"        : "string",
-      "readOnly"    : true
-    },
     "is_verified" : {
       "description" : "Indicates whether KYC has been performed.",
       "type"        : "boolean",

data/schema/v1.0/internal_transfer.json

@@ -82,7 +82,6 @@
       "properties" : {
         "filter[account_ids]" : {
           "title"  : "Find internal transfers belonging to the given account ids. Single id or multiple ids comma-separated.",
-          "format" : "date-time",
           "type"   : "string"
         },
         "filter[created_at_from]" : {

data/schema/v1.0/overdraft.json

@@ -0,0 +1,48 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "overdraft",
+  "description" : "This feature allows customers that are considered trustworthy to use more money than they actually have, based on some criteria",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "account_id" : {
+      "description" : "The external account id.",
+      "type"        : "string",
+      "maxLength"   : 8,
+      "readOnly"    : true
+    },
+    "line" : {
+      "description" : "Overdraft line",
+      "type"        : "integer",
+      "readOnly"    : true
+    },
+    "interest_rate" : {
+      "description" : "Interest based on the balance of the account",
+      "type"        : "number",
+      "readOnly"    : true
+    },
+    "active" : {
+      "description" : "",
+      "type"        : "boolean",
+      "readOnly"    : true
+    },
+    "created_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/created_at"
+    },
+    "updated_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/updated_at"
+    },
+    "currency" : {
+      "$ref"     : "./base_types/base_types.json#definitions/currency",
+      "readOnly" : true
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "overdrafts/{id}"
+    }
+  ]
+}

data/schema/v1.0/sepa_credit_transfer.json

@@ -31,6 +31,10 @@
       "$ref"     : "./base_types/base_types.json#definitions/currency",
       "readOnly" : true
     },
+    "fee_amount" : {
+      "$ref"     : "./base_types/base_types.json#definitions/fee",
+      "readOnly" : true
+    },
     "remote_name" : {
       "description" : "Receiving account holder name",
       "type"        : "string",
@@ -72,7 +76,6 @@
       "properties" : {
         "filter[account_ids]" : {
           "description"  : "Find transfers belonging to the given account ids. Single id or multiple ids comma-separated.",
-          "format" : "date-time",
           "type"   : "string"
         },
         "filter[created_at_from]" : {

data/schema/v1.0/sepa_direct_debit.json

@@ -21,8 +21,8 @@
       "description" : "The sepa mandate used by the debit",
       "type"        : "string"
     },
-    "creditor_identifier" : {
-      "description" : "Creditor Identifier",
+    "creditor_identity_id" : {
+      "description" : "Unique identifier of the creditor sepa mandate has been created with",
       "type"        : "string",
       "readOnly"    : true
     },
@@ -74,7 +74,6 @@
       "properties" : {
         "filter[account_ids]" : {
           "title"  : "Find direct debits belonging to the given account ids. Single id or multiple ids comma-separated.",
-          "format" : "date-time",
           "type"   : "string"
         },
         "filter[created_at_from]" : {

data/schema/v1.0/transaction.json

@@ -21,20 +21,32 @@
       "type"        : "object",
       "oneOf"       : [
         {
-          "title"      : "credit_card_details",
+          "title": "credit_card_details",
           "$ref" : "./transaction_type_details/credit_card_details.json#"
         },
         {
-          "title"      : "internal_transfer_details",
+          "title": "internal_transfer_details",
           "$ref" : "./transaction_type_details/internal_transfer_details.json#"
         },
         {
-          "title"      : "sepa_credit_transfer_details",
+          "title": "sepa_credit_transfer_details",
           "$ref" : "./transaction_type_details/sepa_credit_transfer_details.json#"
         },
         {
-          "title"      : "sepa_direct_debit_details",
+          "title": "sepa_direct_debit_details",
           "$ref" : "./transaction_type_details/sepa_direct_debit_details.json#"
+        },
+        {
+          "title": "gmt_details",
+          "$ref" : "./transaction_type_details/gmt_details.json#"
+        },
+        {
+          "title": "bonus_details",
+          "$ref" : "./transaction_type_details/bonus_details.json#"
+        },
+        {
+          "title": "mobile_topup_details",
+          "$ref" : "./transaction_type_details/mobile_topup_details.json#"
         }
       ]
     },
@@ -114,6 +126,16 @@
           "format" : "date-time",
           "type"   : "string"
         },
+        "filter[value_date_from]" : {
+          "title"  : "Date filter from >= date. ISO 8601 Date",
+          "format" : "date-time",
+          "type"   : "string"
+        },
+        "filter[value_date_to]" : {
+          "title"  : "Date filter to <= date. ISO 8601 Date",
+          "format" : "date-time",
+          "type"   : "string"
+        },
         "filter[transaction_types]" : {
           "$ref"  : "./base_types/base_types.json#definitions/transaction_type",
           "title" : "By transaction types"

data/schema/v1.0/transaction_type_details/bonus_details.json

@@ -0,0 +1,33 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "bonus_details",
+  "description" : "Information about bonus available in a bonus transaction",
+  "properties"  : {
+    "affiliate_id" : {
+      "description" : "An affiliate identifier",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "affiliate_name" : {
+      "description" : "Name of the affiliate",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "affiliate_transaction_type_id" : {
+      "description" : "Identifier of the transaction type",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "affiliate_transaction_type_name" : {
+      "description" : "The name of the transaction type",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "affiliate_transaction_type_category" : {
+      "description" : "The category of the transaction type, e.g. Community, Banking, Bonusprogramm",
+      "type"        : "string",
+      "readOnly"    : true
+    }
+  }
+}

data/schema/v1.0/transaction_type_details/credit_card_details.json

@@ -27,6 +27,12 @@
       "type"        : "string",
       "maxLength"   : 255,
       "readOnly"    : true
+    },
+    "cc_sequence" : {
+      "description" : "The CC sequence is the same for all related transactions",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readOnly"    : true
     }
   }
 }

data/schema/v1.0/transaction_type_details/gmt_details.json

@@ -0,0 +1,31 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "gmt_details",
+  "description" : "Information about details of the global money transfer transaction",
+  "properties"  : {
+    "destination_country" : {
+      "$ref"        : "../base_types/base_types.json#definitions/country",
+      "readOnly"    : true
+    },
+    "destination_currency" : {
+      "$ref"        : "../base_types/base_types.json#definitions/currency",
+      "readOnly"    : true
+    },
+    "amount_in_destination_currency" : {
+      "description" : "Amount transferred in the destination currency",
+      "$ref"        : "../base_types/base_types.json#definitions/amount",
+      "readOnly"    : true
+    },
+    "exchange_rate" : {
+      "description" : "Exchange rate valid at the time the transfer has been performed",
+      "type"        : "number",
+      "readOnly"    : true
+    },
+    "fee_transaction_id" : {
+      "description" : "A unique identifier of the fee transaction that belongs to the gmt transaction",
+      "type"        : "string",
+      "readOnly"    : true
+    }
+  }
+}

data/schema/v1.0/transaction_type_details/internal_transfer_details.json

@@ -12,6 +12,31 @@
       "description" : "Id of transfer if transaction was created by a transfer. Refunded transactions have no id",
       "readOnly"    : true,
       "type"        : "string"
+    },
+    "remote_bic" : {
+      "description" : "BIC of the transaction's sender",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_iban" : {
+      "description" : "IBAN of the transaction's sender",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_name" : {
+      "description" : "Full name of the transaction's sender",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_nick" : {
+      "description" : "Community nickname of the transaction's sender",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_subject" : {
+      "description" : "Subject of the transaction",
+      "readOnly"    : true,
+      "type"        : "string"
     }
   }
 }

data/schema/v1.0/transaction_type_details/mobile_topup_details.json

@@ -0,0 +1,23 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "mobile_topup_details",
+  "description" : "Information about mobile topup",
+  "properties"  : {
+    "provider" : {
+      "description" : "The name of the mobile network operator",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "phone_number" : {
+      "description" : "Mobile phone number user for topup",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "topup_subject" : {
+      "description" : "Subject of the mobile topup",
+      "type"        : "string",
+      "readOnly"    : true
+    }
+  }
+}

data/schema/v1.0/transfer_approval.json

@@ -0,0 +1,120 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "transfer_approval",
+  "description" : "A transfer approval is created each time when transfer is being initiated from an escrow (trust) account",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "transfer_id" : {
+      "description" : "The unique identifier of the tranfer, once it has been approved",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "transfer_type" : {
+      "description" : "The type of the transfer",
+      "type"        : "integer",
+      "readOnly"    : true
+    },
+    "state" : {
+      "description" : "State of the transfer approval. pending: We received you approval request | approved: Your transfer has been approved | rejected: Your transfer has been rejected | uninitiated: Transfer couldn't not be created | invalid : Something went wrong",
+      "enum"  : [
+        "pending",
+        "approved",
+        "rejected",
+        "uninitiated",
+        "invalid"
+      ],
+      "type" : "string",
+      "readOnly" : true
+    },
+    "created_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/created_at"
+    },
+    "updated_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/updated_at"
+    },
+    "approved_at" : {
+      "description" : "Approval date-time, never changes. ISO 8601 Date-Time",
+      "format"      : "date-time",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "rejected_at" : {
+      "description" : "Rejection update date-time. ISO 8601 Date-Time",
+      "format"      : "date-time",
+      "type"        : "string",
+      "readOnly"    : true
+    },
+    "transfer_details" : {
+      "type": "object",
+      "oneOf": [
+        {
+          "title" : "internal_transfer",
+          "$ref": "./internal_transfer.json" 
+        },
+        { 
+          "title" : "sepa_credit_transfer",
+          "$ref": "./sepa_credit_transfer.json" 
+        }
+      ]
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "transfer_approvals/{id}"
+    },
+    {
+      "rel"        : "instances",
+      "href"       : "transfer_approvals",
+      "properties" : {
+        "filter[transfer_ids]" : {
+          "title"  : "Find transfer approvals belonging to the given transfer ids. Single id or multiple ids comma-separated.",
+          "type"   : "string"
+        },
+        "filter[created_at_from]" : {
+          "title"  : "Creation date filter from >= date",
+          "format" : "date-time",
+          "type"   : "string"
+        },
+        "filter[created_at_to]" : {
+          "title"  : "Creation date filter to <= date",
+          "format" : "date-time",
+          "type"   : "string"
+        },
+        "filter[states]" : {
+          "title" : "Filter by single or multiple csv delimited states",
+          "enum"  : [
+            "pending",
+            "approved",
+            "rejected",
+            "uninitiated",
+            "invalid"
+          ],
+          "type" : "string"
+        },
+        "page" : {
+          "title"       : "Page",
+          "description" : "In paginated results set the page to look for",
+          "type"        : "integer"
+        },
+        "per_page" : {
+          "title"       : "Per page",
+          "description" : "Results per page. Default is 10, max is 100",
+          "type"        : "integer"
+        },
+        "sort" : {
+          "title" : "Sort",
+          "enum"  : [
+            "ASC",
+            "DESC"
+          ],
+          "description" : "Sort the results in ASC or DESC",
+          "type"        : "string"
+        }
+      }
+    }
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fidor_schema
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +145,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -161,21 +163,27 @@ files:
 - lib/validator/schema.json
 - schema/v1.0/account.json
 - schema/v1.0/base_types/base_types.json
+- schema/v1.0/base_types/lists.json
 - schema/v1.0/batch_direct_debit.json
 - schema/v1.0/batch_transfer.json
 - schema/v1.0/creditor_identity.json
 - schema/v1.0/customer.json
 - schema/v1.0/error.json
 - schema/v1.0/internal_transfer.json
+- schema/v1.0/overdraft.json
 - schema/v1.0/rate_limit.json
 - schema/v1.0/sepa_credit_transfer.json
 - schema/v1.0/sepa_direct_debit.json
 - schema/v1.0/sepa_mandate.json
 - schema/v1.0/transaction.json
+- schema/v1.0/transaction_type_details/bonus_details.json
 - schema/v1.0/transaction_type_details/credit_card_details.json
+- schema/v1.0/transaction_type_details/gmt_details.json
 - schema/v1.0/transaction_type_details/internal_transfer_details.json
+- schema/v1.0/transaction_type_details/mobile_topup_details.json
 - schema/v1.0/transaction_type_details/sepa_credit_transfer_details.json
 - schema/v1.0/transaction_type_details/sepa_direct_debit_details.json
+- schema/v1.0/transfer_approval.json
 - schema/v1.0/user.json
 - spec/fidor_schema_spec.rb
 - spec/spec_helper.rb