Skip to main content
GET
Retrieve all checks

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

perPage
integer
default:10

Number of records to retrieve in the response. Defaults to 10.

page
integer
default:1

For navigating through pages. Defaults to the first page.

term
string

Filter records using any keywords.

status
string

Filter records by check status. Allowed values: new, void, mailed, refunded, emailed, eprinted, printed.

referenceId
string

Filter records by a unique reference ID.

Response

Successful response with a list of checks.

success
boolean
Example:

true

data
object