{
  "$schema"     : "http://json-schema.org/draft-04/schema#",
  "type"        : "object",
  "title"       : "sepa_mandate",
  "description" : "A mandate object authorizing debits from an account.",
  "required"    : ["external_uid", "customer_id", "mandate_reference", "remote_title", "remote_name", "remote_email",
                   "remote_address_line1", "remote_address_line2", "remote_country", "remote_iban",
                   "signature_date", "creditor_identity_id"],
  "properties"  : {
    "id" : {
      "$ref" : "./base_types/base_types.json#definitions/id"
    },
    "external_uid" : {
      "$ref"     : "./base_types/base_types.json#definitions/external_uid"
    },
    "customer_id" : {
      "description" : "Customer for which this mandate is valid.",
      "type"        : "string"
    },
    "creditor_identity_id" : {
      "description" : "The identifier of the creditor, who created the sepa mandate",
      "type" : "string"
    },
    "mandate_reference" : {
      "description" : "Unique reference of the mandate.",
      "type"        : "string",
      "maxLength"   : 35
    },
    "sequence" : {
      "description" : "Recurring or One-Time",
      "type"        : "string",
      "default"     : "RCUR",
      "enum"        : [
        "RCUR",
        "OOFF"
      ]
    },
    "cor1_option" : {
      "description" : "COR-1 option",
      "type"        : "string",
      "default"     : "1",
      "enum"        : [
        "0",
        "1"
      ]
    },
    "remote_title" : {
      "description" : "Title of the debtor e.g Dr. Prof.",
      "type"        : "string",
      "maxLength"   : 35
    },
    "remote_name" : {
      "description" : "Full name of debtor",
      "type"        : "string",
      "maxLength"   : 70
    },
    "remote_email" : {
      "description" : "Debtor's email",
      "type"        : "string",
      "maxLength"   : 70
    },
    "remote_address_line1" : {
      "description" : "Address street.",
      "type"        : "string",
      "maxLength"   : 35
    },
    "remote_address_line2" : {
      "description" : "ZIP and City",
      "type"        : "string",
      "maxLength"   : 70
    },
    "remote_country" : {
      "description" : "2 digit country code, ISO 3166",
      "type"        : "string",
      "maxLength"   : 2
    },
    "remote_iban" : {
      "$ref"     : "./base_types/base_types.json#definitions/iban"
    },
    "remote_bic" : {
      "description" : "BIC / Swift code of bank",
      "type"        : ["string", "null"],
      "pattern"     : "^[A-Z0-9]{8,11}$",
      "maxLength"   : 11
    },
    "remote_ultimate_name" : {
      "description" : "Ultimate name",
      "type"        : "string",
      "maxLength"   : 70
    },
    "remote_signature_location" : {
      "description" : "Location where debtor signed the mandate.",
      "type"        : "string",
      "maxLength"   : 70
    },
    "signature_date" : {
      "description" : "Date the mandate was signed of by the debtor.",
      "format"      : "date-time",
      "type"        : "string"
    },
    "valid_from_date" : {
      "description" : "Date the mandate started to be valid.",
      "format"      : "date-time",
      "type"        : "string"
    },
    "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" : "sepa_mandates/{id}"
    },
    {
      "rel"        : "instances",
      "href"       : "sepa_mandates",
      "properties" : {
        "filter[mandate_references]" : {
          "title"       : "Search",
          "description" : "Search by mandate reference, add multiple comma separated",
          "type"        : "string"
        },
        "filter[remote_ibans]" : {
          "title"       : "Search",
          "description" : "Search by remote iban, add multiple comma separated",
          "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"
        }
      }
    },
    {
      "rel"    : "create",
      "href"   : "sepa_mandates",
      "method" : "POST"
    }
  ]
}