On This Page
REST API

status

For requests, the status of the terminal.
For responses, the status of the plan or subscription.
Valid values for requests:
  • Active
  • Inactive
To set the status field as
Active
, you must set the
paymentProcessor
,
terminalId
, and
serialNumber
 fields. For terminals that have an
Active
 status, the
statusChangeReason
 field is set to
In Production
.
Valid values for responses:
  • ACTIVE
  • CANCELLED
  • DELINQUENT
  • EXPIRED
  • PENDING
  • SUSPENDED

Specifications

  • Data Type:
     Enum of string
  • Data Length:
     Pre-defined values

Mapping Information

  • REST API Field:
    status
  • SCMP API Field:
     No corresponding field.
  • Simple Order API Field:
     No corresponding field.