{
  "$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."
    }
  }
}