Qualpay · Schema

DisputeResponse

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 array An array of the resource object.
View JSON Schema on GitHub

JSON Schema

qualpay-dispute-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-dispute-response-schema.json",
  "title": "DisputeResponse",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-disputes-v0-5-api-openapi.yml#/components/schemas/DisputeResponse",
  "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": {
      "type": "array",
      "description": "An array of the resource object.",
      "readOnly": true,
      "items": {
        "$ref": "#/$defs/DataDispute"
      }
    }
  },
  "$defs": {
    "DataDispute": {
      "type": "object",
      "properties": {
        "rec_id": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 18 N<br><strong>Description: </strong>Control number - The control number for the dispute, a unique number associated with each dispute case received.",
          "format": "int64",
          "readOnly": true
        },
        "data_type": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Description: </strong>Dispute type - The type of dispute. See <a href=\"/docs/dispute-conventions#dispute-types\" target=\"_blank\">Dispute Types</a> for more information.",
          "readOnly": true
        },
        "merchant_id": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 16 N<br><strong>Description: </strong>Merchant ID (MID) - The ID assigned to the merchant account.",
          "format": "int64",
          "readOnly": true
        },
        "incoming_date": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>Incoming date - The date the card issuer initiated the dispute.",
          "readOnly": true
        },
        "dba_name": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 25 AN<br><strong>Description: </strong>DBA name - The 'Doing Business As' name of the merchant.",
          "readOnly": true
        },
        "batch_id": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>Batch ID - The unique number assigned to this batch.",
          "format": "int64",
          "readOnly": true
        },
        "card_number": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 16 AN<br><strong>Description: </strong>Card number - The masked number of the card associated with the dispute, formatted as 123456xxxxxx1234.",
          "readOnly": true
        },
        "card_type": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 2 AN<br><strong>Description: </strong>Card type - The card brand of this dispute.",
          "readOnly": true,
          "enum": [
            "VS",
            "MC",
            "DS",
            "AM"
          ]
        },
        "tran_date": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>Transaction date - The date the original transaction was authorized.",
          "readOnly": true
        },
        "amt_tran": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 12,2 N<br><strong>Description: </strong>Transaction amount - The amount of the original settled transaction in USD.",
          "readOnly": true
        },
        "amt_dispute": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 12,2 N<br><strong>Description: </strong>Disputed amount - The amount being disputed. This is equal to or less than the original transaction amount (`amt_tran`).",
          "readOnly": true
        },
        "tran_currency": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 3 AN<br><strong>Description: </strong>The ISO numeric currency code of the dispute. This must be a currency code associated with one of your payment profiles; contact Qualpay to add currencies. See <a href=\"/docs/references#currency-codes\" target=\"_blank\">Currency Codes</a> for a list of currency codes.",
          "readOnly": true
        },
        "purchase_id": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 25 AN<br><strong>Description: </strong>Purchase identifier - The invoice or purchase number generated by the merchant. This number may be visible to the cardholder, depending on card issuer.",
          "readOnly": true
        },
        "merch_ref_num": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Merchant reference number - A tracking number generated by the merchant for the merchant's reference. We store this number and do not pass it to the card issuer.",
          "readOnly": true
        },
        "pg_id": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>Payment Gateway ID - If the transaction originated through Virtual Terminal or the Payment Gateway API, this is the transaction’s ID returned in the gateway response.",
          "readOnly": true
        },
        "auth_code": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 6 AN<br><strong>Description: </strong>Authorization code - The code provided by the card issuer when the card was approved.",
          "readOnly": true
        },
        "reason_code": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 8 AN<br><strong>Description: </strong>Reason code - The code providing the reason for the dispute. See <a href=\"/docs/dispute-conventions\" target=\"_blank\">Dispute Conventions</a> for more information.",
          "readOnly": true
        },
        "rec_id_linked": {
          "type": "string",
          "description": "INTERNAL USE ONLY.",
          "readOnly": true
        },
        "auth_avs_result": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Description: </strong>AVS payment result code - The Address Verification Service result code of the original transaction. See <a href=\"/docs/api-conventions#payment-result-codes-for-avs\" target=\"_blank\">Payment Result Codes for AVS</a> for more information.",
          "readOnly": true
        },
        "auth_cvv2_result": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Description: </strong>CVV2 payment result code - The Card Verification Value 2 (CVV2) result code of the original transaction. See <a href=\"/docs/api-conventions#payment-result-codes-for-cvv2\" target=\"_blank\">Payment Result Codes for CVV2</a> for more information.",
          "readOnly": true
        },
        "card_number_original": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>Original card number - The masked card number of the original captured transactions, formatted as 123456xxxxxx1234. <br><br>In some rare cases a dispute may be issued on a different card from the original. This can occur when, for example, the card was reissued between the original transaction date and the dispute date.",
          "readOnly": true
        },
        "date_status_change": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>Dispute status date - The date the dispute's status most recently changed.",
          "readOnly": true
        }
      }
    }
  }
}

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-dispute-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.