Search terminal actions

Beta

- POST /v2/terminals/actions/search

Retrieves a filtered list of Terminal action requests created by the account making the request.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Body

cursor

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See Pagination for more information.

string

limit

Limit the number of results returned for a single request.

Min 1 Max 100

integer

query

Queries terminal actions based on given conditions and sort order. Leaving this unset will return all actions with the default sort order.

TerminalActionQuery

filter

Options for filtering returned TerminalActions

TerminalActionQueryFilter

created_at

Time range for the beginning of the reporting period. Inclusive. Default value: The current time minus one day. Note that TerminalActions are available for 30 days after creation.

TimeRange

device_id

TerminalActions associated with a specific device. If no device is specified then all TerminalActions for the merchant will be displayed.

string

status

Filter results with the desired status of the TerminalAction Options: PENDING, IN_PROGRESS, CANCEL_REQUESTED, CANCELED, COMPLETED

string

type

Filter results with the requested ActionType.

string

Select type

QR_CODE The action represents a request to display a QR code. Details are contained in the qr_code_options object.
PING The action represents a request to check if the specific device is online or currently active with the merchant in question. Does not require an action options value.
SAVE_CARD Represents a request to save a card for future card-on-file use. Details are contained in the save_card_options object.
SIGNATURE The action represents a request to capture a buyer's signature. Details are contained in the signature_options object.
CONFIRMATION The action represents a request to collect a buyer's confirmation decision to the displayed terms. Details are contained in the confirmation_options object.
RECEIPT The action represents a request to display the receipt screen options. Details are contained in the receipt_options object.
DATA_COLLECTION The action represents a request to collect a buyer's text data. Details are contained in the data_collection_options object.
SELECT The action represents a request to allow the buyer to select from provided options. Details are contained in the select_options object.

sort

Option for sorting returned TerminalAction objects.

TerminalActionQuerySort

You are viewing an old version of the API

All Versions

Request

cURL

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums