Qualpay · Schema

PGApiBatchCloseRequest

PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization

Properties

Name Type Description
merchant_id integer Format: Variable length, up to 12 N
Description: Unique identifier in our system.
developer_id string Format: Variable length, up to 32 AN
Description: Use to indicate which company developed the integration or the name of the payment solution that is connected to
echo_fields string Format: Variable length
Description: This field contains a JSON array of field data that will be echoed back in the response message.
loc_id string Format: Variable length, up to 4 N
Description: When a merchant has more than one location using the same currency, this value is used to specify the location for
profile_id string Format: Fixed length, 20 N
Description: Explicitly identifies which Payment Gateway profile should be used for the request.
report_data string Format: Variable length
Description: This field contains a JSON array of field data that will be included with the transaction data reported in Merchant Manager.
session_id string INTERNAL USE ONLY.
tran_currency integer Format: Fixed length, 3 N
Default: 840
Description: The ISO numeric currency code for the transaction. This must be a currency code associated
user_id integer INTERNAL USE ONLY.
vendor_id integer Format: Fixed length, 10 N
Description: Identifies the vendor to which this request applies.
Conditional Requirement: This field is required f
View JSON Schema on GitHub

JSON Schema

qualpay-pgapi-batch-close-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-pgapi-batch-close-request-schema.json",
  "title": "PGApiBatchCloseRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-payment-gateway-api-openapi.yml#/components/schemas/PGApiBatchCloseRequest",
  "type": "object",
  "required": [
    "merchant_id"
  ],
  "properties": {
    "merchant_id": {
      "type": "integer",
      "format": "int64",
      "description": "<strong>Format: </strong>Variable length, up to 12 N<br><strong>Description: </strong>Unique identifier in our system."
    },
    "developer_id": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Use to indicate which company developed the integration or the name of the payment solution that is connected to us. Suggested usage is `softwareABCv1.0` or `companyXYZv2.0`."
    },
    "echo_fields": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>This field contains a JSON array of field data that will be echoed back in the response message."
    },
    "loc_id": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 4 N<br><strong>Description: </strong>When a merchant has more than one location using the same currency, this value is used to specify the location for this request."
    },
    "profile_id": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 20 N<br><strong>Description: </strong>Explicitly identifies which Payment Gateway profile should be used for the request."
    },
    "report_data": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>This field contains a JSON array of field data that will be included with the transaction data reported in Merchant Manager."
    },
    "session_id": {
      "type": "string",
      "description": "INTERNAL USE ONLY."
    },
    "tran_currency": {
      "type": "integer",
      "format": "int32",
      "description": "<strong>Format: </strong>Fixed length, 3 N<br><strong>Default: </strong>840<br><strong> Description: </strong>The ISO numeric currency code for the transaction. This must be a currency code associated with one of your payment profiles; contact Qualpay to add currencies. Refer to <a href=\"/docs/references#currency-codes\" target=\"_blank\">Currency Codes</a> for a list of currency codes."
    },
    "user_id": {
      "type": "integer",
      "format": "int64",
      "description": "INTERNAL USE ONLY."
    },
    "vendor_id": {
      "type": "integer",
      "format": "int64",
      "description": "<strong>Format: </strong>Fixed length, 10 N<br><strong>Description: </strong>Identifies the vendor to which this request applies. <br><strong>Conditional Requirement: </strong>This field is required for Qualpay partner accounts."
    }
  }
}

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-pgapi-batch-close-request"
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.