Retrieves the list of checks

post

https://devapi.qolopay.com/api/{version}/Check/getchecks

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

required

Body Params

Check Search DTO

limit

int32

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

start_index

int32

Index used for pagination of the result.

program_guid

uuid | null

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

person_guid

uuid | null

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

account_guid

uuid | null

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

date_from

date-time | null

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

date-time | null

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

enum

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

check_number

string | null

Retrieve details of a specific check.

checks

array of objects | null

list of checks.

checks

Responses

500

Server Error

200Returns the checks

400Bad request

401Unauthorized

404Check not found