Retrieves the list of checks

Retrieves the list of checks that have been issued and their details. The checks can be retrieved based on a date range, account guid, person guid, check number, or status.

Request
Security:
path Parameters
version
required
string
Request Body schema: application/json
limit
integer <int32>

Limit number of checks to retrieve (Will be defaulted to 100 if none specified)

start_index
integer <int32>

Index used for pagination of the result.

program_guid
string or null <uuid>

Unique Program identifier on Qolo Platform. Retrieve all the checks issued for this program.

person_guid
string or null <uuid>

Unique Person identifier on Qolo Platform. Retrieve all the checks issued for this person.

account_guid
string or null <uuid>

Unique Account identifier on Qolo Platform. Retrieve all the checks issued under this account.

date_from
string or null <date-time>

Date to search from in the format yyyy-MM-dd HH:mm:ss. Please use the format yyyy-MM-dd 00:00:00 to fetch data from start of the day.

date_to
string or null <date-time>

Date to search till in the format yyyy-MM-dd HH:mm:ss. Please use the format yyyy-MM-dd 23:59:59 to fetch data to end of the day.

check_status
string (CheckStatusType)

Different statuses of a check Description attribute reflects the actual value in database

Enum: "NOTISSUED" "ISSUED" "CLEARED" "DISPUTED" "STOPPED" "EXPIRED" "CANCELLED" "REVERSED" "DROP" "VOID"
check_number
string or null

Retrieve details of a specific check.

Array of objects or null (CheckDTO)

list of checks.

Responses
200

Returns the checks

400

Bad request

401

Unauthorized

404

Check not found

500

Server Error

post/api/{version}/Check/getchecks
Request samples
application/json
{
  • "limit": 0,
  • "start_index": 0,
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "date_from": "2019-08-24T14:15:22Z",
  • "date_to": "2019-08-24T14:15:22Z",
  • "check_status": "NOTISSUED",
  • "check_number": "string",
  • "checks": [
    • {
      • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
      • "reverse_txn_guid": "1c5ffe75-1896-4946-ad70-748a1803a4ef",
      • "routing_number": "string",
      • "account_number": "string",
      • "check_number": "string",
      • "date_issued": "2019-08-24T14:15:22Z",
      • "check_amount": 0,
      • "payee_name": "string",
      • "payee_address": "string",
      • "check_status": "string",
      • "memo": "string",
      • "date_updated": "2019-08-24T14:15:22Z",
      • "user_updated": "string"
      }
    ]
}
Response samples
application/json
{
  • "count": 0,
  • "start_index": 0,
  • "end_index": 0,
  • "has_more": true,
  • "data": [
    • {
      • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
      • "reverse_txn_guid": "1c5ffe75-1896-4946-ad70-748a1803a4ef",
      • "routing_number": "string",
      • "account_number": "string",
      • "check_number": "string",
      • "date_issued": "2019-08-24T14:15:22Z",
      • "check_amount": 0,
      • "payee_name": "string",
      • "payee_address": "string",
      • "check_status": "string",
      • "memo": "string",
      • "date_updated": "2019-08-24T14:15:22Z",
      • "user_updated": "string"
      }
    ],
  • "check_statuses": [
    • "string"
    ]
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.