Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.18 KB

terminal-checkout-query-filter.md

File metadata and controls

28 lines (20 loc) · 1.18 KB

Terminal Checkout Query Filter

Structure

TerminalCheckoutQueryFilter

Fields

Name Type Tags Description Getter
DeviceId String Optional The TerminalCheckout objects associated with a specific device. If no device is specified, then all
TerminalCheckout objects for the merchant are displayed.
String getDeviceId()
CreatedAt TimeRange Optional Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled.
TimeRange getCreatedAt()
Status String Optional Filtered results with the desired status of the TerminalCheckout.
Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED
String getStatus()

Example (as JSON)

{
  "device_id": "device_id4",
  "created_at": {
    "start_at": "start_at4",
    "end_at": "end_at8"
  },
  "status": "status0"
}