payment-request-schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PaymentRequest",
  "type": "object",
  "properties": {
    "payment-id": {
      "type": "string",
      "maxLength": 36,
      "description": "Unique identifier for the payment.",
      "minLength": 1,
      "examples": [
        "8D8AC610-566D-4EF0-9C22-186B2A5ED793"
      ]
    },
    "instructed-amount": {
      "type": "string",
      "minLength": 1,
      "maxLength": 8,
      "description": "The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot..",
      "examples": [
        "1595",
        "14.22",
        "34.5"
      ]
    },
    "purpose": {
      "type": "string",
      "description": "Purpose of the payment.",
      "maxLength": 140,
      "examples": [
        "Shopping at Merchant A"
      ]
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 Alpha 3 currency code.",
      "pattern": "^[A-Z]{3}$",
      "minLength": 3,
      "maxLength": 3,
      "examples": [
        "EUR",
        "NOK"
      ]
    },
    "creditor-name": {
      "type": "string",
      "description": "Name of the creditor.",
      "maxLength": 140,
      "examples": [
        "Merchant A"
      ]
    },
    "creditor-account": {
      "type": "object",
      "properties": {
        "iban": {
          "type": "string",
          "description": "IBAN of the account. This is required when no BBAN is provided.",
          "pattern": "^([A-Z]{2}[ '+'\\'+'-]?[0-9]{2})(?=(?:[ '+'\\'+'-]?[A-Z0-9]){9,30}$)((?:[ '+'\\'+'-]?[A-Z0-9]{3,5}){2,7})([ '+'\\'+'-]?[A-Z0-9]{1,3})?$",
          "maxLength": 34,
          "examples": [
            "DE75512108001245126199"
          ]
        },
        "bic": {
          "type": "string",
          "description": "The BIC associated to the account.",
          "pattern": "^[A-Z]{4}[-]{0,1}[A-Z]{2}[-]{0,1}[A-Z0-9]{2}[-]{0,1}[0-9]{3}$",
          "maxLength": 11,
          "examples": [
            "SOGEDEFFXXX"
          ]
        },
        "bban": {
          "type": "string",
          "description": "BBAN of the account. Used for payment accounts without IBAN.",
          "pattern": "^[A-Z0-9]+$",
          "maxLength": 30
        }
      },
      "required": ["iban"]
    },
    "start-date": {
      "type": "string",
      "format": "date",
      "description": "Start of a recurring payment.",
      "examples": [
        "2018-11-13"
      ]
    },
    "end-date": {
      "type": "string",
      "format": "date",
      "description": "End of a recurring payment.",
      "examples": [
        "2018-11-13"
      ]
    },
    "frequency": {
      "type": "string",
      "description": "End of a recurring payment indicated as EventFrequency7Code of ISO 20022",
      "enum": ["Daily", "Weekly", "EveryTwoWeeks", "Monthly","EveryTwoMonths", "Quarterly", "SemiAnnual", "Annual", "MonthlyVariable"],
      "examples": [
        "Daily"
      ]
    },
    "execution-day": {
      "type": "integer",
      "minimum": 1,
      "maximum": 31,
      "description": "Day of execution.",
      "examples": [
        12
      ]
    },
    "execution-month": {
      "type": "integer",
      "minimum": 1,
      "maximum": 12,
      "description": "Month of execution.",
      "examples": [
        3
      ]
    }
  },
  "additionalProperties": false,
  "required": ["payment-id", "instructed-amount", "purpose", "currency", "creditor-name"]
}