Update Terminal

​

Update a terminal configuration. Supports updating name, description, MID, TID, var_sheet (processor-specific settings), and batch_schedule (automated batch close/open scheduling).

Batch Schedule: Set batch_schedule to configure Koard-managed batch scheduling for TSYS, Elavon, or Worldpay terminals. Set to null to remove and revert to manual management. Omit the field entirely to leave the existing schedule unchanged.

Path Parameters
  • terminal_id
    Type: string · Terminal Id
    required
Headers
  • Accept
    enum
    const:  
    application/json
    required

    Response format. Must be application/json.

    values
    • application/json
  • Content-Type
    enum
    const:  
    application/json
    required

    Request payload format. Must be application/json when a body is sent.

    values
    • application/json
Body·TerminalConfigUpdateV2
required
application/json
  • batch_schedule
    Type: object | null · Batch Schedule

    Automated batch close/open schedule. Set to configure Koard-managed batch scheduling. Set to null to remove and revert to manual management. Omit to leave unchanged. Only supported for TSYS, Elavon, and Worldpay terminals.

  • description
    Type: string | null · Description
  • mid
    Type: string | null · Mid

    Merchant ID

  • name
    Type: string | null · Name
  • tid
    Type: string | null · Tid

    Terminal ID

  • var_sheet
    Type: object | null · Var Sheet

    Processor-specific configuration (e.g., TSYS VAR sheet data)

Responses
  • application/json
  • 400

    Bad Request. Returned when batch_schedule is set for an unsupported processor (only TSYS, Elavon, Worldpay supported) or when is_active is true but no schedule entries are provided.

  • application/json
Request Example for put/v2/terminals/{terminal_id}
curl 'https://api.uat.koard.com/v2/terminals/{terminal_id}' \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Front Counter POS"
}'

{
  "terminal_id": "term-abc123",
  "name": "Front Counter POS",
  "mid": "886000001130",
  "tid": "00000001",
  "processor_config_id": "cfg-tsys-001",
  "status": "active",
  "account_id": "acct-xyz789",
  "location_id": "loc-456",
  "var_sheet": {
    "applicationId": "B001",
    "merchantNumber": "886000001130"
  },
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-03-03T18:00:00Z"
}

Successful Response