Qualpay · Schema

StatementSettlementResponse

PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization

Properties

Name Type Description
code integer Format: Fixed length, 1 N
Description: Response code from the API. `0` indicates success. Refer to
message string Format: Variable length AN
Description: A short description of the API response code.
totalPages integer Format: Variable length N
Description: Total number of pages.
totalRecords integer Format: Variable length, up to 3 N
Description: Total number of records up to a maximum of 100.
data object An array of the resource object.
View JSON Schema on GitHub

JSON Schema

qualpay-statement-settlement-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-statement-settlement-response-schema.json",
  "title": "StatementSettlementResponse",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-reporting-api-openapi.yml#/components/schemas/StatementSettlementResponse",
  "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/StatementSettlementData"
    }
  },
  "$defs": {
    "StatementSettlementData": {
      "type": "object",
      "properties": {
        "rec_id_linked": {
          "type": "integer",
          "description": "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": "Billing month of the statement in YYYY-MM-DD format."
        },
        "batch_date": {
          "type": "string",
          "description": "The date the batch was settled to us in YYYY-MM-DD format.",
          "format": "date-time"
        },
        "reference_number": {
          "type": "integer",
          "description": "An 11-digit number generated by the product initiating the transaction. The number is available when the transaction is settled and is a unique number that both the acquirer and the issuer can use to identify a transaction. This reference is used as the deposit reference number.",
          "format": "int64"
        },
        "cnt_purch": {
          "type": "number",
          "description": "The total funded count of transactions in a settled batch.",
          "format": "double"
        },
        "amt_purch": {
          "type": "number",
          "description": "The total funded value of each transaction in a settled batch.",
          "format": "double"
        },
        "amt_return": {
          "type": "number",
          "description": "The total amount of refund or credit transactions in a batch.",
          "format": "double"
        },
        "discount_paid": {
          "type": "number",
          "description": "The amount deducted from a settled batch prior to merchant funding. The discount paid amount represents fees that apply to accounts set up for net settlement. The fees are the discount percentage applied to each payment transaction, and they vary based on the type of payment and the type of the transaction.",
          "format": "double"
        },
        "amt_net": {
          "type": "number",
          "description": "The net amount funded to a deposit account.",
          "format": "double"
        },
        "source_id": {
          "type": "integer",
          "description": "INTERNAL USE ONLY.",
          "format": "int64"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/qualpay-statement-settlement-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.