{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-aus-hold-request-schema.json",
  "title": "AusHoldRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-account-updater-api-openapi.yml#/components/schemas/AusHoldRequest",
  "type": "object",
  "properties": {
    "card_id": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>The card ID to be put on an Account Updater harvest hold. If both `card_id` and `customer_id` are included in the request, the system ignores `customer_id` and puts only the specified `card_id` on hold.<br><strong>Conditional Requirement: </strong>Either `card_id` or `customer_id` is required."
    },
    "customer_id": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Unique ID established by the merchant to identify a customer. When this field is included in the request, all card IDs belonging to this customer are put on Account Updater harvest hold. If both `card_id` and `customer_id` are included in the request, the system ignores `customer_id` and puts only the specified `card_id` on hold.<br><strong>Conditional Requirement: </strong>Either `card_id` or `customer_id` is required."
    },
    "merchant_id": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.<br><strong>Conditional Requirement: </strong>Required if this request is on behalf of another merchant.",
      "format": "int64"
    }
  }
}