<- Terminal API

Terminal API

Search terminal checkouts

POST

 /v2/terminals/checkouts/search

Returns a filtered list of Terminal checkout requests created by the application making the request.

Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned. Terminal checkout requests are available for 30 days.

Permissions:PAYMENTS_READ

Guide

Search for Terminal checkout requests

Try in API Explorer
Link to section

Request body

Example code

Link to section

query

Queries Terminal checkouts based on given conditions and the sort order. Leaving these unset returns all checkouts with the default sort order.

Link to section

cursor

string

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

Link to section

limit

integer(32-bit)

Limits the number of results returned for a single request.

Min
1
Max
100
Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

checkouts

The requested search result of TerminalCheckout objects.

Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

See Pagination for more information.