Documentation for a newer release is available. View Latest

Json Schema for ValidateDirectDebitSchemeRulesResponse

Json Schema:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Validate Direct Debit Scheme Rules Response",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "responseId" : {
      "type" : "string"
    },
    "requestId" : {
      "type" : "string"
    },
    "processingContext" : {
      "$ref" : "#/definitions/ProcessingContext"
    },
    "version" : {
      "$ref" : "#/definitions/Version"
    },
    "createdAt" : { },
    "payload" : {
      "$ref" : "#/definitions/Payload(ResponseWrapper)"
    },
    "status" : {
      "type" : "string",
      "enum" : [ "SUCCESS", "REJECT", "FAILURE", "PENDING" ]
    },
    "schemeName" : {
      "type" : "string"
    },
    "customBusinessData" : {
      "$ref" : "#/definitions/SupportingContext"
    },
    "schemeFormatMessage" : {
      "type" : "string"
    }
  },
  "definitions" : {
    "ProcessingContext" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "associationId" : {
          "type" : "string"
        },
        "checkpoint" : {
          "type" : "string"
        },
        "unitOfWorkId" : {
          "type" : "string"
        },
        "clientRequestId" : {
          "type" : "string"
        },
        "processingEntity" : {
          "type" : "string"
        }
      }
    },
    "Version" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "major" : {
          "type" : "integer"
        },
        "minor" : {
          "type" : "integer"
        },
        "patch" : {
          "type" : "integer"
        }
      }
    },
    "Payload(ResponseWrapper)" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "content" : {
          "$ref" : "#/definitions/ResponseWrapper"
        },
        "version" : {
          "$ref" : "#/definitions/Version"
        }
      }
    },
    "ResponseWrapper" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "orgnlGrpInfAndSts" : {
          "$ref" : "#/definitions/OrgnlGrpInfAndSts"
        },
        "txInfAndSts" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/TxInfAndSts"
          }
        }
      }
    },
    "OrgnlGrpInfAndSts" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "grpSts" : {
          "type" : "string",
          "enum" : [ "ACTC", "RJCT", "PART" ]
        },
        "stsRsnInf" : {
          "$ref" : "#/definitions/StsRsnInf"
        }
      }
    },
    "StsRsnInf" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "rsn" : {
          "$ref" : "#/definitions/Rsn"
        }
      }
    },
    "Rsn" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "cd" : {
          "type" : "string"
        },
        "prtry" : {
          "type" : "string"
        },
        "addtlInf" : {
          "type" : "string"
        }
      }
    },
    "TxInfAndSts" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "orgnlTxId" : {
          "type" : "string"
        },
        "txSts" : {
          "type" : "string",
          "enum" : [ "ACTC", "RJCT", "PART" ]
        },
        "stsRsnInf" : {
          "$ref" : "#/definitions/StsRsnInf_1"
        }
      }
    },
    "StsRsnInf_1" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "rsn" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/Rsn"
          }
        }
      }
    },
    "SupportingContext" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "headers" : {
          "$ref" : "#/definitions/SupportingHeader"
        },
        "metaData" : {
          "$ref" : "#/definitions/SupportingMetaData"
        }
      }
    },
    "SupportingHeader" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "values" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "string"
          }
        }
      }
    },
    "SupportingMetaData" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "values" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "string"
          }
        }
      }
    }
  }
}