{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-statement-reserve-response-schema.json",
  "title": "StatementReserveResponse",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-reporting-api-openapi.yml#/components/schemas/StatementReserveResponse",
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href=\"/docs/api-conventions#platform-api-response-codes\" target=\"_blank\">Platform API Response Codes</a> for the entire list of return codes.",
      "format": "int32",
      "readOnly": true
    },
    "message": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.",
      "readOnly": true
    },
    "totalPages": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length N<br><strong>Description: </strong>Total number of pages. ",
      "format": "int32",
      "readOnly": true
    },
    "totalRecords": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length, up to 3 N<br><strong>Description: </strong>Total number of records up to a maximum of 100.",
      "format": "int32",
      "readOnly": true
    },
    "data": {
      "description": "An array of the resource object.",
      "readOnly": true,
      "$ref": "#/$defs/StatementReserveData"
    }
  },
  "$defs": {
    "StatementReserveData": {
      "type": "object",
      "properties": {
        "rec_id_linked": {
          "type": "integer",
          "description": "For INTERNAL USE ONLY.",
          "format": "int64"
        },
        "merchant_id": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 16 N<br><strong>Description: </strong>The unique ID assigned to a merchant.",
          "format": "int64"
        },
        "billing_month": {
          "type": "string",
          "description": "Identifies the date funds are posted to the depository account for either settled transactions, net of reserve, or adjustments for release of reserves (in YYYY-MM-DD HH:MM:ss format)."
        },
        "batch_date": {
          "type": "string",
          "description": "Identifies the date funds are posted to the depository account for either settled transactions, net of reserve, or adjustments for release of reserves (in YYYY-MM-DD HH:MM:ss format).",
          "format": "date-time"
        },
        "amt_reserve": {
          "type": "number",
          "description": "The total USD amount deducted from settled transactions prior to funding. This amount is calculated by applying an agreed-upon percentage to the sales volume in a batch.",
          "format": "double"
        },
        "amt_released_reserve": {
          "type": "number",
          "description": "The total USD amount released as an adjustment to the depository account.",
          "format": "double"
        },
        "amt_reserve_balance": {
          "type": "number",
          "description": "The total amount of reserve held as of the ACH post date.",
          "format": "double"
        }
      }
    }
  }
}