fidor_schema 0.8.0 → 0.10.0

data/schema/v1.0/customer.json

@@ -2,27 +2,51 @@
   "$schema"     : "http://json-schema.org/draft-04/schema#",
   "type"        : "object",
   "title"       : "customer",
-  "description" : "",
-  "required"    : ["email", "first_name", "last_name", "gender", "title", "nick"],
+  "description" : "A customer object",
+  "required"    : [
+    "email", "password", "adr_mobile"
+    ],
   "properties"  : {
     "id" : {
       "$ref" : "./base_types/base_types.json#definitions/id"
     },
     "email" : {
-      "$ref"     : "./base_types/base_types.json#definitions/email",
-      "readOnly" : true
+      "$ref"     : "./base_types/base_types.json#definitions/email"
     },
     "first_name" : {
       "description" : "The given name of the customer",
       "type"        : "string",
-      "maxLength"   : 30,
-      "readOnly"    : true
+      "maxLength"   : 30
+    },
+    "additional_first_name" : {
+      "description" : "The additional given name of the customer",
+      "type"        : "string",
+      "maxLength"   : 30
     },
     "last_name" : {
       "description" : "The family name of the customer",
       "type"        : "string",
-      "maxLength"   : 30,
-      "readOnly"    : true
+      "maxLength"   : 30
+    },
+    "maiden_name" : {
+      "description" : "Name at birth, maiden name.",
+      "type"        : "string",
+      "maxLength"   : 30
+    },
+    "password"   : {
+      "description" : "Password for accessing your account later. You can use lower and upper case letters, digits and special characters",
+      "type"        : ["string", "null"],
+      "minLength"   : 6,
+      "maxLength"   : 128,
+      "pattern"     : "^[0-9a-zA-Z!\"#$%&'()*+,-=./:;?@\\[\\]<>^_`{|}~]+$"
+    },
+    "legal" : {
+      "description" : "Legal requirements that have to be accepted",
+      "type"        : "array",
+      "items"       : {
+        "type"       : "object",
+        "$ref" : "./legal.json#"
+      }
     },
     "gender" : {
       "description" : "The gender of the customer",
@@ -30,87 +54,93 @@
         "m",
         "f"
       ],
-      "type"     : "string",
-      "readOnly" : true
+      "type"     : "string"
     },
     "title" : {
-      "description" : "Salutation e.g Mr. or Ms./Mrs.",
-      "type"        : "string",
-      "maxLength"   : 30,
-      "readOnly"    : true
+      "description" : "Salutation: 1 - Mr., 2 - Ms., 3 - Mr. Dr., 4 - Ms. Dr.",
+      "enum"        : [
+        1,
+        2,
+        3,
+        4
+      ],
+      "type"     : "integer"
     },
     "nick" : {
       "description" : "Nickname used in community.",
       "type"        : "string",
       "maxLength"   : 40,
-      "minLength"   : 2,
-      "readOnly"    : true
+      "minLength"   : 2
     },
-    "maiden_name" : {
-      "description" : "Name at birth, maiden name.",
-      "type"        : "string",
-      "maxLength"   : 30,
-      "readOnly"    : true
+    "occupation"  : {
+      "description" : "Customer's current occupation: 1 - employee, 2 - executive, 3 - self-employed, 4 - freelancer, 5 - student, 6 - trainee, 7 - retired, 8 - privatier, 9 - unemployed",
+      "enum"        : [
+        1,
+        2,
+        3,
+        4,
+        5,
+        6,
+        7,
+        8,
+        9
+      ],
+      "type"     : "integer"
     },
     "adr_street" : {
       "description" : "Address street",
       "type"        : "string",
-      "maxLength"   : 100,
-      "readOnly"    : true
+      "maxLength"   : 100
     },
     "adr_street_number" : {
       "description" : "Address street number",
       "type"        : "string",
-      "maxLength"   : 10,
-      "readOnly"    : true
+      "maxLength"   : 10
     },
     "adr_post_code" : {
       "description" : "Address post code",
       "type"        : "string",
-      "maxLength"   : 10,
-      "readOnly"    : true
+      "maxLength"   : 10
     },
     "adr_city" : {
       "description" : "Address City",
       "type"        : "string",
-      "maxLength"   : 100,
-      "readOnly"    : true
+      "maxLength"   : 100
     },
     "adr_country" : {
       "description" : "Address Country",
       "type"        : "string",
-      "maxLength"   : 100,
-      "readOnly"    : true
+      "maxLength"   : 100
     },
     "adr_phone" : {
       "description" : "Phone home",
       "type"        : "string",
-      "maxLength"   : 30,
-      "readOnly"    : true
+      "maxLength"   : 30
     },
     "adr_mobile" : {
       "description" : "Phone mobile",
       "type"        : "string",
-      "maxLength"   : 30,
-      "readOnly"    : true
+      "maxLength"   : 30
     },
     "adr_fax" : {
       "description" : "Phone fax",
       "type"        : "string",
-      "maxLength"   : 30,
-      "readOnly"    : true
+      "maxLength"   : 30
     },
     "adr_businessphone" : {
       "description" : "Phone business",
       "type"        : "string",
-      "maxLength"   : 30,
-      "readOnly"    : true
+      "maxLength"   : 30
     },
     "birthday" : {
       "description" : "Date of birth",
       "type"        : "string",
-      "format"      : "date-time",
-      "readOnly"    : true
+      "format"      : "date-time"
+    },
+    "birthplace" : {
+      "description" : "Place of birth",
+      "type"        : "string",
+      "maxLength"   : 100
     },
     "is_verified" : {
       "description" : "Indicates whether KYC has been performed.",
@@ -118,8 +148,7 @@
       "readOnly"    : true
     },
     "nationality" : {
-      "$ref"     : "./base_types/base_types.json#definitions/country",
-      "readOnly" : true
+      "$ref"     : "./base_types/base_types.json#definitions/country"
     },
     "marital_status" : {
       "description" : "1: single, 2: married, 3: widowed, 4: divorced, 5: seperated, 6: de facto",
@@ -131,8 +160,7 @@
         5,
         6
       ],
-      "type"     : "integer",
-      "readOnly" : true
+      "type"     : "integer"
     },
     "religion" : {
       "description" : "Denomination for tax reasons. 0: no information, 1: no denomination, 2: Protestant, 3: Roman-Catholic, 4-18: Other denominations",
@@ -156,24 +184,28 @@
         17,
         18
       ],
-      "type"     : "integer",
-      "readOnly" : true
+      "type"     : "integer"
     },
     "id_card_registration_city" : {
       "description" : "City where the id card is registered.",
-      "type"        : "string",
-      "readOnly"    : true
+      "type"        : ["string", "null"]
     },
     "id_card_number" : {
       "description" : "ID card number",
-      "type"        : "string",
-      "readOnly"    : true
+      "type"        : ["string", "null"]
     },
     "id_card_valid_until" : {
       "description" : "Expiration date of id card",
       "format"      : "date-time",
-      "type"        : "string",
-      "readOnly"    : true
+      "type"        : ["string", "null"]
+    },
+    "newsletter"    : {
+      "description" : "Indicates whether customer has agreed to receiving newsletter or not",
+      "type"        : "boolean"
+    },
+    "affiliate_uid" : {
+      "description" : "Indicates the attachment of the customer to a certain affiliate",
+      "type"     : ["string", "null"]
     },
     "created_at" : {
       "$ref" : "./base_types/base_types.json#definitions/created_at"
@@ -194,6 +226,22 @@
     {
       "rel"  : "accounts",
       "href" : "customers/{id}/accounts"
+    },
+    {
+      "rel"  : "confirmations",
+      "href" : "customers/{id}/confirmations"
+    },
+    {
+      "rel"         : "create",
+      "href"        : "customers",
+      "method"      : "POST",
+      "description" : "Creates a customer"
+    },
+    {
+      "rel"         : "update",
+      "href"        : "customers/{id}",
+      "method"      : "PUT",
+      "description" : "Updates customer data"
     }
   ]
 }

data/schema/v1.0/emergency_loan.json

@@ -0,0 +1,10 @@
+{
+  "type"        : "object",
+  "title"       : "Emergency Loan",
+  "name"        : "emergency_loan",
+  "description" : "",
+  "properties"  : {
+
+  },
+  "links" : []
+}

data/schema/v1.0/internal_transfer.json

@@ -133,6 +133,25 @@
       "rel"    : "create",
       "href"   : "internal_transfers",
       "method" : "POST"
+    },
+    {
+      "rel"  : "mtan",
+      "href" : "internal_transfers/{id}/mtan",
+      "method" : "GET"
+    },
+    {
+      "rel"  : "mtan",
+      "href" : "internal_transfers/{id}/mtan",
+      "title" : "Confirm the transfer with the mtan send to the user",
+      "method" : "PUT",
+      "properties" : {
+        "mtan" : {
+          "title"  : "The mtan received by the user",
+          "required"   : true,
+          "type"   : "string"
+        }
+      }
+
     }
   ]
 }

data/schema/v1.0/legal.json

@@ -0,0 +1,36 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "legal",
+  "description" : "Set of legal requirements a user has to accept",
+  "properties"  : {
+    "own_interest"  : {
+      "description" : "Indicates whether customer acts in his own interest",
+      "enum"        : [ true ],
+      "type"        : "boolean",
+      "default"     : false
+    },
+    "tos" : {
+      "description" : "Indicates whether customer has agreed to terms of service or not",
+      "enum"        : [ true ],
+      "type"        : "boolean",
+      "default"     : false
+    },
+    "privacy_policy" : {
+      "description" : "Indicates whether customer has agreed to privacy policy or not",
+      "enum"        : [ true ],
+      "type"        : "boolean",
+      "default"     : false
+    },
+    "us_citizen" : {
+      "description" : "Indicates whether the customer is a US citizen or not",
+      "type"        : "boolean",
+      "default"     : false
+    },
+    "us_tax_payer" : {
+      "description" : "Indicates whether the customer has to pay taxes in the US",
+      "type"        : "boolean",
+      "default"     : false
+    }
+  }
+}

data/schema/v1.0/overdraft.json

@@ -8,9 +8,7 @@
       "$ref" : "./base_types/base_types.json#definitions/id"
     },
     "account_id" : {
-      "description" : "The external account id.",
-      "type"        : "string",
-      "maxLength"   : 8,
+      "$ref" : "./base_types/base_types.json#definitions/account_id",
       "readOnly"    : true
     },
     "line" : {
@@ -24,7 +22,7 @@
       "readOnly"    : true
     },
     "active" : {
-      "description" : "",
+      "description" : "Indicates whether the overdraft is an active one or not",
       "type"        : "boolean",
       "readOnly"    : true
     },
@@ -43,6 +41,10 @@
     {
       "rel"  : "self",
       "href" : "overdrafts/{id}"
+    },
+    {
+      "rel"   : "instances",
+      "href"  : "overdrafts"
     }
   ]
 }

data/schema/v1.0/preauth.json

@@ -0,0 +1,131 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "preauth",
+  "description" : "A preauth is created when you, for example, send money to a not existing fidor account or use a mastercard",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "account_id" : {
+      "$ref"     : "./base_types/base_types.json#definitions/account_id",
+      "readOnly" : true
+    },
+    "amount"      : {
+      "description" : "Preauthorized amount of money",
+      "$ref"        : "./base_types/base_types.json#definitions/amount",
+      "readOnly"    : true
+    },
+    "currency" : {
+      "$ref"     : "./base_types/base_types.json#definitions/currency",
+      "readOnly" : true
+    },
+    "preauth_type" : {
+      "$ref"       : "./base_types/base_types.json#definitions/preauth_type",
+      "readOnly"   : true
+    },
+    "preauth_type_details" : {
+      "description" : "Details specific to this preauth type are collected here.",
+      "readOnly"    : true,
+      "type"        : "object",
+      "oneOf"       : [
+        {
+          "title": "credit_card_details",
+          "$ref" : "./preauth_type_details/credit_card_details.json#"
+        },
+        {
+          "title": "internal_transfer_details",
+          "$ref" : "./preauth_type_details/internal_transfer_details.json#"
+        },
+        {
+          "title": "capital_bond_details",
+          "$ref" : "./preauth_type_details/capital_bond_details.json#"
+        },
+        {
+          "title": "currency_order_details",
+          "$ref" : "./preauth_type_details/currency_order_details.json#"
+        },
+        {
+          "title": "gmt_details",
+          "$ref" : "./preauth_type_details/gmt_details.json#"
+        },
+        {
+          "title": "ripple_details",
+          "$ref" : "./preauth_type_details/ripple_details.json#"
+        }
+      ]
+    },
+    "expires_at" : {
+      "description" : "Date of the preauthorization expiration. ISO 8601 Date-Time",
+      "format"      : "date-time",
+      "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"
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "preauths/{id}"
+    },
+    {
+      "rel"        : "instances",
+      "href"       : "preauths",
+      "properties" : {
+        "filter[account_ids]" : {
+          "title"  : "Find preauths belonging to the given account ids. Single id or multiple ids comma-separated.",
+          "format" : "integer",
+          "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[expiration_date_from]" : {
+          "title"  : "Date filter from >= date. ISO 8601 Date",
+          "format" : "date-time",
+          "type"   : "string"
+        },
+        "filter[expiration_date_to]" : {
+          "title"  : "Date filter to <= date. ISO 8601 Date",
+          "format" : "date-time",
+          "type"   : "string"
+        },
+        "filter[preauth_types]" : {
+          "$ref"  : "./base_types/base_types.json#definitions/preauth_type",
+          "title" : "By preauth types"
+        },
+        "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"
+        }
+      }
+    }
+  ]
+}

data/schema/v1.0/preauth_type_details/capital_bond_details.json

@@ -0,0 +1,8 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "capital_bond_details",
+  "description" : "Capital bond related preauthorization details",
+  "properties"  : {
+  }
+}

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

@@ -0,0 +1,50 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "credit_card_details",
+  "description" : "Credit card related preauthorization details",
+  "properties"  : {
+    "cc_merchant_name" : {
+      "description" : "CreditCard merchant initiating the transaction",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readOnly"    : true
+    },
+    "cc_merchant_category" : {
+      "description" : "Category given by the merchant",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readOnly"    : true
+    },
+    "cc_type" : {
+      "description" : "CreditCard type",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readOnly"    : true
+    },
+    "cc_category" : {
+      "description" : "CreditCard category",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readOnly"    : true
+    },
+    "cc_sequence" : {
+      "description" : "CreditCard sequence identifier, identical for all related transactions",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readOnly"    : true
+    },
+    "pos_code"  : {
+      "description" : "Code for point of service where card was used",
+      "type"        : "string",
+      "maxLength"   : 3,
+      "readOnly"    : true
+    },
+    "financial_network_code"  : {
+      "description" : "",
+      "type"        : "string",
+      "maxLength"   : 5,
+      "readOnly"    : true
+    }
+  }
+}

data/schema/v1.0/preauth_type_details/currency_order_details.json

@@ -0,0 +1,8 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "capital_bond_details",
+  "description" : "Currency order related preauthorization details",
+  "properties"  : {
+  }
+}

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

@@ -0,0 +1,31 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "gmt_details",
+  "description" : "Global money transfer related preauthorization details",
+  "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/preauth_type_details/internal_transfer_details.json

@@ -0,0 +1,42 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "internal_transfer_details",
+  "description" : "Fidor internal transfer related preauthorization details",
+  "properties"  : {
+    "remote_account_id" : {
+      "$ref"     : "../base_types/base_types.json#definitions/account_id",
+      "readOnly" : true
+    },
+    "internal_transfer_id" : {
+      "description" : "Id of transfer if transaction/preauth was created by a transfer. Refunded transactions have no id",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_bic" : {
+      "description" : "BIC of the transfer sender",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_iban" : {
+      "description" : "IBAN of the transfer sender",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_name" : {
+      "description" : "Full name of the transfer sender",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_nick" : {
+      "description" : "Community nickname of the transfer sender",
+      "readOnly"    : true,
+      "type"        : "string"
+    },
+    "remote_subject" : {
+      "description" : "Subject of the transaction",
+      "readOnly"    : true,
+      "type"        : "string"
+    }
+  }
+}

data/schema/v1.0/preauth_type_details/ripple_details.json

@@ -0,0 +1,8 @@
+{
+  "$schema"     : "http://json-schema.org/draft-04/schema#",
+  "type"        : "object",
+  "title"       : "ripple_details",
+  "description" : "Ripple transfer related preauthorization details",
+  "properties"  : {
+  }
+}