GET
/
checks
/
{checkId}
Retrieve a check
curl --request GET \
  --url https://test.onlinecheckwriter.com/api/v3/checks/{checkId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "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": "Demo Bank"
    },
    "payee": {
      "payeeId": "1ZoVelyDaQj8pwb",
      "name": "John Doe"
    },
    "checkStatus": {
      "status": 0,
      "description": "New"
    },
    "checkStatements": [
      {
        "status": "created",
        "date": "2024-11-18",
        "time": "04:15 pm"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
checkId
string
required

The unique ID of the check to retrieve.

Response

200
application/json

Successful response with the details of the check.

The response is of type object.