GET
/
checks
curl --request GET \
  --url https://test.onlinecheckwriter.com/api/v3/checks \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "meta": {
      "total": 21325,
      "currentPage": 1,
      "perPage": 10
    },
    "checks": [
      {
        "checkId": "kWx8eP3l60GK2Xz",
        "serialNumber": "2",
        "amount": 12,
        "amountInWord": "twelve",
        "date": "2024-11-18",
        "status": 0,
        "memo": null,
        "accountNumber": null,
        "invoiceNumber": null,
        "referenceId": null,
        "bankAccount": {
          "bankAccountId": "6gYVewBOP7Gdx7b",
          "name": "test"
        },
        "payee": {
          "payeeId": "1ZoVelyDaQj8pwb",
          "name": "test new"
        },
        "checkStatus": {
          "status": 0,
          "description": "New"
        },
        "checkStatements": [
          {
            "status": "created",
            "date": "2024-11-18",
            "time": "04:15 pm"
          }
        ]
      },
      {
        "checkId": "zRNXG0J7PljLxyB",
        "serialNumber": "345354353855",
        "amount": 12,
        "amountInWord": "twelve",
        "date": "2024-11-16",
        "status": 0,
        "memo": null,
        "accountNumber": null,
        "invoiceNumber": null,
        "referenceId": null,
        "bankAccount": {
          "bankAccountId": "xZqXGK2y0b4RzVv",
          "name": "werwer"
        },
        "payee": {
          "payeeId": "pzo54xE7BaGaXmL",
          "name": "Test Name 2"
        },
        "checkStatus": {
          "status": 0,
          "description": "New"
        },
        "checkStatements": [
          {
            "status": "created",
            "date": "2024-11-16",
            "time": "11:19 am"
          }
        ]
      }
    ]
  }
}

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

200
application/json
Successful response with a list of checks.
​
success
boolean
Example:

true

​
data
object