fidor_schema 0.1.18

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d20bce8312da6521a63aa2702dbe8422a20d2ce1
+  data.tar.gz: 3b140e2370a078335051e76edf9bdd947d96df4b
+SHA512:
+  metadata.gz: 34011c7dc15704691350254dcff74eb7a9f9d15ad2a26c15b86aceba812a4f28468116d093aefa1ddd3eaad5907f5fc262526fb4b3ca33bed283c37cedcea662
+  data.tar.gz: c66566de7bd062112314300b4b4c51ddbbea51cacd95797523bd02543fb8f5873bcfb0bb4a71662660c51c31c53243b059225bd0ded7846f53c90c283154231b

data/.gitignore

@@ -0,0 +1,8 @@
+coverage/*
+rdoc/*
+pkg/*
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+*.swp
+.idea

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+= Changelog Fidor API Schema
+
+A more detailed view of the changes can be found in the [commit messages](https://github.com/fidor/fidor_schema/commits/)
+
+2014-10
+
+  * initial public release - ALPHA

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+# Fidor API Schema
+
+The Fidor API is described with [JSON Schema](http://json-schema.org), which serves
+as a public contract about available API resources and object internals.
+
+This gem(besides the schema) provides a single utility method: the path to the
+json files.
+
+    gem install fidor_schema
+    
+    require 'fidor_schema'
+    Fidor::Schema.path
+
+Other languages can take advantage of the raw json files.
+
+## Test
+
+Install required gems with bundler and go for it:
+
+    bundle install
+    rake spec
+
+## Field types & formats
+
+All strings MUST be UTF-8 encoded. Date & date-time values are ISO8601
+
+Copyright (c) 2014 Fidor AG

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new
+task :default => :spec

data/fidor_schema.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fidor_schema_version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'fidor_schema'
+  spec.version = Fidor::Schema::VERSION
+  spec.authors = ['Georg Leciejewski']
+  spec.email = 'dev@fidor.de'
+  spec.summary = 'Fidor API - JSON Schema'
+  spec.description = %q{Fidor API description. Using JSON Schema to describe the available objects, their fields and resource links.}
+  spec.homepage = 'https://www.fidor.de'
+  spec.license = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject{|i| i[/^docs\//] }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'json_schema_tools', '>=0.2.6'
+  spec.add_development_dependency 'activemodel' # required by above
+  spec.add_development_dependency 'rake'
+
+end

data/lib/fidor/schema.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Fidor
+  class Schema
+    # Get the path to schema files delivered by this gem. 
+    # @example
+    # 	Fidor::Schema.path   # => /home/me/gems/.../fidor_schema/schema
+    #
+    # @param [String] version folder name to use
+    def self.path(version='v1.0')
+      File.expand_path( File.join('../../schema', version), File.dirname(__FILE__))
+    end
+  end
+end

data/lib/fidor_schema.rb

@@ -0,0 +1,2 @@
+require 'fidor/schema'
+require 'fidor_schema_version'

data/lib/fidor_schema_version.rb

@@ -0,0 +1,5 @@
+module Fidor
+  class Schema
+    VERSION='0.1.18'
+  end
+end

data/schema/v1.0/account.json

@@ -0,0 +1,118 @@
+{
+  "type"        : "object",
+  "title"       : "Account",
+  "name"        : "account",
+  "description" : "A fidor bank account.",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "account_number" : {
+      "description" : "The bank account number.",
+      "type"        : "string",
+      "maxLength"   : 10,
+      "readonly"    : true
+    },
+    "iban" : {
+      "$ref"     : "./base_types/base_types.json#definitions/iban",
+      "readonly" : true
+    },
+    "balance" : {
+      "description" : "Account balance",
+      "type"        : "number",
+      "readonly"    : true
+    },
+    "balance_available" : {
+      "description" : "Available account balance.",
+      "type"        : "number",
+      "readonly"    : true
+    },
+    "overdraft" : {
+      "description" : "Available account overdraft",
+      "type"        : "number",
+      "readonly"    : true
+    },
+    "preauth_amount" : {
+      "description" : "Amount available for pre-authorization.",
+      "type"        : "number",
+      "readonly"    : true
+    },
+    "cash_flow_per_year" : {
+      "description" : "Amount available for yearly cash flow. This is the limit of funds an account holder has at their disposal without fulfilling Germany KYC requirements.",
+      "type"        : "number",
+      "readonly"    : true
+    },
+    "is_debit_note_enabled" : {
+      "description" : "Whether this account is authorized to initiate direct debit transactions.",
+      "type"        : "boolean",
+      "default"     : false,
+      "readonly"    : true
+    },
+    "is_trusted" : {
+      "description" : "Indicates if this is an escrow account",
+      "type"        : "boolean",
+      "default"     : false,
+      "readonly"    : true
+    },
+    "is_locked" : {
+      "description" : "Indicates whether the account is locked",
+      "type"        : "boolean",
+      "readonly"    : true
+    },
+    "currency" : {
+      "$ref"     : "./base_types/base_types.json#definitions/currency",
+      "readonly" : true
+    },
+    "customers" : {
+      "description" : "The owners of the account",
+      "type"        : "array",
+      "items"       : {
+        "type"       : "object",
+        "properties" : {
+          "$ref" : "./customer.json#properties"
+        }
+      },
+      "readonly" : true
+    },
+    "created_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/created_at"
+    },
+    "updated_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/updated_at"
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "accounts/{id}"
+    },
+    {
+      "rel"  : "instances",
+      "href" : "accounts"
+    },
+    {
+      "rel"  : "transactions",
+      "href" : "accounts/{id}/transactions"
+    },
+    {
+      "rel"  : "internal_transfers",
+      "href" : "accounts/{id}/internal_transfers"
+    },
+    {
+      "rel"  : "sepa_credit_transfers",
+      "href" : "accounts/{id}/sepa_credit_transfers"
+    },
+    {
+      "rel"  : "sepa_direct_debits",
+      "href" : "accounts/{id}/sepa_direct_debits"
+    },
+    {
+      "rel"  : "batch_transfers",
+      "href" : "accounts/{id}/batch_transfers"
+    },
+    {
+      "rel"  : "batch_direct_debit",
+      "href" : "accounts/{id}/batch_direct_debits"
+    }
+  ]
+}

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

@@ -0,0 +1,124 @@
+{
+  "definitions" : {
+    "id" : {
+      "description" : "Unique identifier of the object",
+      "identity"    : true,
+      "readonly"    : true,
+      "type"        : "integer"
+    },
+    "account_id" : {
+      "description" : "Fidor account the transaction belongs to.",
+      "type"        : "string",
+      "pattern"     : "\\d{8}"
+    },
+    "user_id" : {
+      "description" : "Identifies the user who created this object",
+      "readonly"    : true,
+      "type"        : "string",
+      "pattern"     : "\\d{8}"
+    },
+    "transaction_id" : {
+      "description" : "Identifies a reference to a corresponding transaction",
+      "readonly"    : true,
+      "type"        : "integer"
+    },
+    "phone" : {
+      "description" : "A phone or fax number, formatted with country code: +49 123 1233213",
+      "type"        : "string",
+      "pattern"     : "\\+[ 0-9]*"
+    },
+    "email" : {
+      "description" : "Email address",
+      "type"        : "string",
+      "format"      : "email",
+      "maxLength"   : 100
+    },
+    "twitter" : {
+      "description" : "Twitter username",
+      "type"        : "string",
+      "pattern"     : "^@(\\w){1,15}$"
+    },
+    "created_at" : {
+      "description" : "Creation date-time, never changes.",
+      "format"      : "date-time",
+      "type"        : "string",
+      "readonly"    : true
+    },
+    "updated_at" : {
+      "description" : "Last update date-time.",
+      "format"      : "date-time",
+      "type"        : "string",
+      "readonly"    : true
+    },
+    "external_uid" : {
+      "description" : "Unique ID of the creator of the transaction. In case a uid is reused for a transaction, it is not executed, this mechanism can be used to prevent double bookings in case of network failure or similar event where transaction status is unknown",
+      "type"        : "string",
+      "required"    : true
+    },
+    "iban" : {
+      "description" : "IBAN",
+      "checksum"    : "Checksum is calculated as described in ISO 13616-1, 2 digits MOD97 inserted after the country code",
+      "type"        : "string",
+      "maxLength"   : 34,
+      "pattern"     : "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$"
+    },
+    "bic" : {
+      "description" : "BIC / Swift code of bank",
+      "type"        : "string",
+      "pattern"     : "^([A-Z0-9]{8}|[A-Z0-9]{8})$",
+      "maxLength"   : 11
+    },
+    "eref" : {
+      "description" : "End-to-end reference.",
+      "type"        : "string",
+      "maxLength"   : 255
+    },
+    "country" : {
+      "description" : "Country code as defined in ISO3166 alpha2. e.g DE, GB",
+      "type"        : "string",
+      "minLength"   : 2,
+      "maxLength"   : 2
+    },
+    "currency" : {
+      "description" : "Account currency. ISO 4217 alpha-3 - 3 letter upcase e.g EUR",
+      "type"        : "string",
+      "maxLength"   : 3,
+      "minLength"   : 3,
+      "default"     : "EUR"
+    },
+    "subject" : {
+      "description" : "Transfer subject (reference)",
+      "type"        : "string",
+      "pattern"     : "^[A-Za-z0-9_\\.\\, &\\-\\/\\+\\*\\$\\%@üöäÜÖÄ߀]*$"
+    },
+    "amount" : {
+      "description" : "The transferred amount in account currency, two decimal places. Must be greater than 0 e.g. > 0",
+      "type"        : "number",
+      "exclusiveMinimum" : true,
+      "minimum" : 0
+    },
+    "transaction_type" : {
+      "description" : "Type of the transaction",
+      "enum"        : [
+        "payin_giropay",
+        "payin_paymentnetwork",
+        "payin_credit_note",
+        "payin_debit_note_eze",
+        "payin_debit_note_aba",
+        "payin_credit_note_sepa",
+        "payin_debit_note_sepa_core",
+        "payin_debit_note_sepa_b2b",
+        "payin_fidorpay",
+        "payout_ogone",
+        "payout_paymentnetwork",
+        "payout_credit_note",
+        "payout_debit_note_eze",
+        "payout_credit_note_sepa",
+        "payout_fidorpay",
+        "payout_creditcard",
+        "payout_fee"
+      ],
+      "type" : "string"
+    }
+  }
+}

data/schema/v1.0/batch_direct_debit.json

@@ -0,0 +1,140 @@
+{
+  "type"        : "object",
+  "title"       : "Batch Direct Debit",
+  "name"        : "batch_direct_debit",
+  "description" : "A direct debit batch contains multiple direct debits which are processed asynchronously.",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "external_uid" : {
+      "$ref" : "./base_types/base_types.json#definitions/external_uid"
+    },
+    "account_id" : {
+      "$ref"     : "./base_types/base_types.json#definitions/account_id",
+      "required" : true
+    },
+    "user_id" : {
+      "$ref" : "./base_types/base_types.json#definitions/user_id"
+    },
+    "sepa_direct_debits" : {
+      "description" : "The direct_debits to process.",
+      "type"        : "array",
+      "required"    : false,
+      "items"       : {
+        "type"       : "object",
+        "properties" : {
+          "$ref" : "./sepa_direct_debit.json#properties"
+        }
+      }
+    },
+    "sepa_direct_debit_ids" : {
+      "description" : "ids of successfully executed direct debit transactions",
+      "type"        : "array",
+      "items"       : {
+        "$ref" : "./base_types/base_types.json#definitions/id"
+      }
+    },
+    "sepa_direct_debit_errors" : {
+      "description" : "contains a list of errors encountered in nested debits contained in this batch. Debits are identified by external_uid",
+      "type"        : "array",
+      "items"       : {
+        "type"       : "object",
+        "properties" : {
+          "external_uid" : {
+            "type" : "string"
+          },
+          "error" : {
+            "type"       : "object",
+            "properties" : {
+              "$ref" : "./error.json#properties"
+            }
+          }
+        }
+      }
+    },
+    "number_of_debits" : {
+      "description" : "count of debits transactions received in this batch",
+      "readonly"    : true,
+      "type"        : "integer"
+    },
+    "state" : {
+      "description" : "State of the batch operation. received: We received the batch | processing: Batch is currently being processed | failure: An error occurred during execution in at least one of the transfers. In this case you should check the transfers. | success: batch successfully processed",
+      "enum"        : [
+        "received",
+        "processing",
+        "success",
+        "failure"
+      ],
+      "readonly" : true,
+      "type"     : "string"
+    },
+    "success_url" : {
+      "description" : "Url receiving a POST with the batch object after processing is finished.",
+      "type"        : "string",
+      "format"      : "uri"
+    },
+    "created_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/created_at"
+    },
+    "updated_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/updated_at"
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "batch_direct_debits/{id}"
+    },
+    {
+      "rel"        : "instances",
+      "href"       : "batch_direct_debits",
+      "properties" : {
+        "filter[created_at_from]" : {
+          "title"  : "Creation date filter from >= date",
+          "format" : "date",
+          "type"   : "string"
+        },
+        "filter[created_at_to]" : {
+          "title"  : "Creation date filter to <= date",
+          "format" : "date",
+          "type"   : "string"
+        },
+        "filter[states]" : {
+          "title" : "Filter by single or multiple csv delimited states",
+          "enum"  : [
+            "received",
+            "processing",
+            "success",
+            "failure"
+          ],
+          "type" : "string"
+        },
+        "page" : {
+          "title"       : "Page",
+          "description" : "In paginated results set the page to look for",
+          "type"        : "number"
+        },
+        "per_page" : {
+          "title"       : "Per page",
+          "description" : "Results per page. Default is 10, max is 100",
+          "type"        : "number"
+        },
+        "sort" : {
+          "title" : "Sort",
+          "enum"  : [
+            "ASC",
+            "DESC"
+          ],
+          "description" : "Sort the results in ASC or DESC",
+          "type"        : "string"
+        }
+      }
+    },
+    {
+      "rel"    : "create",
+      "href"   : "batch_direct_debits",
+      "method" : "POST"
+    }
+  ]
+}

data/schema/v1.0/batch_transfer.json

@@ -0,0 +1,179 @@
+{
+  "type"        : "object",
+  "title"       : "Batch Transfer",
+  "name"        : "batch_transfer",
+  "description" : "A transfer batch contains multiple transfers which are processed asynchronously.",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "external_uid" : {
+      "$ref" : "./base_types/base_types.json#definitions/external_uid"
+    },
+    "account_id" : {
+      "$ref"     : "./base_types/base_types.json#definitions/account_id",
+      "required" : true
+    },
+    "user_id" : {
+      "$ref" : "./base_types/base_types.json#definitions/user_id"
+    },
+    "sepa_credit_transfers" : {
+      "description" : "SEPA credit transfers to process",
+      "type"        : "array",
+      "items"       : {
+        "type"       : "object",
+        "properties" : {
+          "$ref" : "./sepa_credit_transfer.json#properties"
+        }
+      }
+    },
+    "internal_transfers" : {
+      "description" : "Interal transfers to process",
+      "type"        : "array",
+      "items"       : {
+        "type"       : "object",
+        "properties" : {
+          "$ref" : "./internal_transfer.json#properties"
+        }
+      }
+    },
+    "sepa_credit_transfer_ids" : {
+      "description" : "ids of successfully executed SEPA credit transfers",
+      "type"        : "array",
+      "items"       : {
+        "$ref" : "./base_types/base_types.json#definitions/id"
+      }
+    },
+    "internal_transfer_ids" : {
+      "description" : "ids of successfully executed internal transfers",
+      "type"        : "array",
+      "items"       : {
+        "$ref" : "./base_types/base_types.json#definitions/id"
+      }
+    },
+    "sepa_credit_transfer_errors" : {
+      "description" : "contains a list of errors encountered in nested debits contained in this batch. Transfers are identified by external_uid contained in the original transfer json",
+      "type"        : "array",
+      "items"       : {
+        "type"       : "object",
+        "properties" : {
+          "external_uid" : {
+            "type" : "string"
+          },
+          "error" : {
+            "type"       : "object",
+            "properties" : {
+              "$ref" : "./error.json#properties"
+            }
+          }
+        }
+      }
+    },
+    "internal_transfer_errors" : {
+      "description" : "contains a list of errors encountered in nested debits contained in this batch. Transfers are identified by external_uid contained in the original transfer json",
+      "type"        : "array",
+      "items"       : {
+        "type"       : "object",
+        "properties" : {
+          "external_uid" : {
+            "type" : "string"
+          },
+          "error" : {
+            "type"       : "object",
+            "properties" : {
+              "$ref" : "./error.json#properties"
+            }
+          }
+        }
+      }
+    },
+    "number_of_transfers" : {
+      "description" : "count of transfers (internal and sepa) transactions received in this batch",
+      "readonly"    : true,
+      "type"        : "integer"
+    },
+    "state" : {
+      "description" : "State of the batch operation. received: We received the batch | processing: Batch is currently being processed | failure: An error occurred during execution of the batch. In this case you should check the transfers. | success: Batch execution has been completed.",
+      "enum"        : [
+        "received",
+        "processing",
+        "success",
+        "failure"
+      ],
+      "readonly" : true,
+      "type"     : "string"
+    },
+    "success_url" : {
+      "description" : "Url receiving a POST with the batch object after processing is finished.",
+      "type"        : "string",
+      "format"      : "uri"
+    },
+    "created_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/created_at"
+    },
+    "updated_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/updated_at"
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "batch_transfers/{id}"
+    },
+    {
+      "rel"        : "instances",
+      "href"       : "batch_transfers",
+      "properties" : {
+        "filter[account_ids]" : {
+          "title"  : "Find transfers belonging to the given account ids. Single id or multiple ids comma-separated.",
+          "format" : "date",
+          "type"   : "string"
+        },
+        "filter[created_at_from]" : {
+          "title"  : "Creation date filter from >= date",
+          "format" : "date",
+          "type"   : "string"
+        },
+        "filter[created_at_to]" : {
+          "title"  : "Creation date filter to <= date",
+          "format" : "date",
+          "type"   : "string"
+        },
+        "filter[states]" : {
+          "title" : "Filter by single or multiple csv delimited states",
+          "enum"  : [
+            "received",
+            "processing",
+            "success",
+            "failure"
+          ],
+          "type" : "string"
+        },
+        "page" : {
+          "title"       : "Page",
+          "description" : "In paginated results set the page to look for",
+          "type"        : "number"
+        },
+        "per_page" : {
+          "title"       : "Per page",
+          "description" : "Results per page. Default is 10, max is 100",
+          "type"        : "number"
+        },
+        "sort" : {
+          "title" : "Sort",
+          "enum"  : [
+            "ASC",
+            "DESC"
+          ],
+          "description" : "Sort the results in ASC or DESC",
+          "type"        : "string"
+        }
+      }
+    },
+    {
+      "rel"    : "create",
+      "href"   : "batch_transfers",
+      "method" : "POST"
+    }
+  ]
+}