Skip to main content
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": "<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.

Path Parameters

​
checkId
string
required

The unique ID of the check to retrieve.

Response

Successful response with the details of the check.

​
success
boolean
Example:

true

​
data
object