OBVRPFundsConfirmationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/barclays/main/json-schema/barclays-obvrpfunds-confirmation-request-schema.json",
  "title": "OBVRPFundsConfirmationRequest",
  "description": "The OBVRPFundsConfirmationRequest object must be used to request funds availability for a specific amount in the Debtor Account included in the VRP consents.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/barclays-domestic-vrp-consents-api-openapi.yml#/components/schemas/OBVRPFundsConfirmationRequest",
  "type": "object",
  "additionalProperties": false,
  "deprecated": false,
  "properties": {
    "Data": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "ConsentId": {
          "type": "string",
          "description": "Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource.",
          "maxLength": 25,
          "minLength": 1,
          "pattern": "^BARCLAYS-S-\\d{14}$"
        },
        "Reference": {
          "type": "string",
          "description": "Unique reference, as assigned by the PISP, to unambiguously refer to the request related to the payment transaction. This must be the same value as the `Reference` field in the consent.",
          "maxLength": 35,
          "minLength": 1,
          "pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_,&@#\\/;&+]{1,35})$"
        },
        "InstructedAmount": {
          "$ref": "#/$defs/OBActiveOrHistoricCurrencyAndAmount"
        }
      },
      "required": [
        "ConsentId",
        "InstructedAmount"
      ]
    }
  },
  "required": [
    "Data"
  ],
  "nullable": false,
  "$defs": {
    "ActiveOrHistoricCurrencyCode": {
      "type": "string",
      "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
      "maxLength": 3,
      "minLength": 3,
      "pattern": "^[A-Z]{3,3}$"
    },
    "OBActiveCurrencyAndAmount_SimpleType": {
      "type": "string",
      "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.",
      "maxLength": 19,
      "minLength": 3,
      "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$"
    },
    "OBActiveOrHistoricCurrencyAndAmount": {
      "type": "object",
      "additionalProperties": false,
      "deprecated": false,
      "properties": {
        "Amount": {
          "$ref": "#/$defs/OBActiveCurrencyAndAmount_SimpleType"
        },
        "Currency": {
          "$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
        }
      },
      "required": [
        "Amount",
        "Currency"
      ],
      "nullable": false
    }
  }
}