Skip to main content
GET
/
checks
Retrieve all checks
curl --request GET \
  --url https://test.onlinecheckwriter.com/api/v3/checks \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "meta": {
      "total": 123,
      "currentPage": 123,
      "perPage": 123
    },
    "checks": [
      {
        "checkId": "<string>",
        "serialNumber": "<string>",
        "amount": 123,
        "amountInWord": "<string>",
        "date": "2023-12-25",
        "status": 123,
        "memo": "<string>",
        "accountNumber": "<string>",
        "invoiceNumber": "<string>",
        "referenceId": "<string>",
        "bankAccount": {
          "bankAccountId": "<string>",
          "name": "<string>"
        },
        "payee": {
          "payeeId": "<string>",
          "name": "<string>"
        },
        "checkStatus": {
          "status": 123,
          "description": "<string>"
        },
        "checkStatements": [
          {
            "status": "<string>",
            "date": "2023-12-25",
            "time": "<string>"
          }
        ]
      }
    ]
  }
}

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