List Checks
Request URL
POST /check/list
Description
This endpoint will list checks that match the desired search criteria. Search criteria may be a specific cFiCheckId, an array of cFiCheckIds, an external reference ID, a date range, a check status value, a void status value, or a combination of criteria. You may also specify a maximum number of records to return using the numberOfRecords property (up to 1000) and you may specify a number of records to skip using the skipRecords property. Combine the numberOfRecords property with the skipRecords property to make displaying transaction lists in batches easy. For example, if you want to list checks in batches of 150, you can set numberOfRecords to 150 and skipRecords to 0 in the first request. Then, increase skipRecords by 150 in each subsequent request to return the next batch and so on.
When making a request, if the number of checks matching the criteria is greater than the numberOfRecords maximum requested, the response body will indicate that there are additional checks ("more": true).
If no properties are included, an unfiltered check list will be returned (up to a maximum of 1000).
Schema
Property table for check/list
| Property | Description | Required | Schema |
|---|---|---|---|
| cFiCheckId | Check ID from the connectFi system obtained when the check was initialized | No | { "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "nullable": true, "description": "common-idNullable" } |
| cFiCheckIds | An array of check IDs from the connectFi system | No | array of { "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "nullable": true, "description": "common-idNullable" } |
| reference | An external alphanumeric reference ID for the entity in your system | No | { "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "nullable": true, "description": "common-idNullable" } |
| dateCreateFrom | A beginning date in ISO Date format | No | { "type": "string", "format": "dateISO", "nullable": true } |
| dateCreateTo | An ending date in ISO Date format | No | { "type": "string", "format": "dateISO", "nullable": true } |
| status | status | No | { "type": "string", "nullable": true, "enum": [ "Processing", "Sent", "Complete", "Cancelled", "Declined", "InBank", "Unknown" ] } |
| voidStatus | The void status | No | { "type": "string", "nullable": true, "enum": [ "Processing", "Sent", "Complete" ] } |
| numberOfRecords | The maximum number of desired records to return | No | { "type": "integer", "minimum": 1, "nullable": true, "description": "common-numberOfRecords" } |
| skipRecords | The number of records to skip when returning results | No | { "type": "integer", "minimum": 0, "nullable": true, "description": "common-skipRecords" } |
Request Body
{
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2999-12-15T23:59:59.999Z",
"status": "Sent",
"numberOfRecords": 1000,
"skipRecords": 0
}
Snippet Examples
javascript
const axios = require('axios');
const data = {
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2999-12-15T23:59:59.999Z",
"status": "Sent",
"numberOfRecords": 1000,
"skipRecords": 0
};
const config = {
method: 'POST',
url: '${CONNECTFI_BASE_URL}/check/list',
headers: {
'Content-Type': "application/json",
'x-connectfi-token': "A long random string token received from /auth/get-token request"
},
data
};
let result;
try {
result = await axios.request(config);
if (result.status === 200) {
console.log(JSON.stringify(result.data));
}
} catch (err) {
console.log({
errCode: err.code,
responseStatus: err.response && err.response.status,
data: err.response && JSON.stringify(err.response.data)
});
}
cURL
curl --location "CONNECTFI_BASE_URL/check/list" --data "{ \"dateCreateFrom\":\"2023-01-15T00:00:00.001Z\", \"dateCreateTo\":\"2999-12-15T23:59:59.999Z\", \"status\":\"Sent\", \"numberOfRecords\":1000, \"skipRecords\":0}" --header "Content-Type: application/json" --header "x-connectfi-token: A long random string token received from /auth/get-token request"
Successful Response Examples
200 CHECK/LIST SUCCESSFUL RESPONSE USING DATE RANGE AND NUMBEROFRECORDS
HEADERS
| Header | Value |
|---|---|
| Content-Type | application/json |
| x-connectfi-token | A long random string token received from /auth/get-token request |
REQUEST BODY
{
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2999-12-15T23:59:59.999Z",
"numberOfRecords": 2
}
RESPONSE BODY
{
"code": "0",
"data": {
"total": {
"skipRecords": 0,
"numberOfRecords": 2,
"more": true
},
"items": [
{
"cFiCheckId": "chk_5f2pO0aq0I5D0HV440yms2",
"reference": "extChkRef00000006",
"serial": "92",
"cFiCheckStatus": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-11-09T14:17:11.153Z"
},
{
"cFiCheckId": "chk_10Yr0skuZ8NUX1wPG06MNA",
"reference": "extChkRef702",
"serial": "90",
"cFiCheckStatus": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-11-02T11:22:38.822Z"
}
]
},
"requestId": "8c29d7d0950d11eea89d7100487c0512"
}
200 CHECK/LIST SUCCESSFUL RESPONSE USING MULTIPLE CRITERIA
HEADERS
| Header | Value |
|---|---|
| Content-Type | application/json |
| x-connectfi-token | A long random string token received from /auth/get-token request |
REQUEST BODY
{
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2999-12-15T23:59:59.999Z",
"status": "Sent",
"numberOfRecords": 1000,
"skipRecords": 0
}
RESPONSE BODY
{
"code": "0",
"data": {
"total": {
"skipRecords": 0,
"numberOfRecords": 3,
"more": false
},
"items": [
{
"cFiCheckId": "chk_3cjSsIGwCA0kLgiK2Sent2",
"reference": "extChkRefSent2",
"serial": "66",
"cFiCheckStatus": "Sent",
"cFiVoidStatus": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLgiK2Sent1",
"reference": "extChkRefSent1",
"serial": "65",
"cFiCheckStatus": "Sent",
"cFiVoidStatus": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLgiK2Sent3",
"reference": "extChkRefSent3",
"serial": "67",
"cFiCheckStatus": "Sent",
"cFiVoidStatus": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
}
]
},
"requestId": "abdc2cb0797211eeb5658f28ab5fe311"
}
200 CHECK/LIST SUCCESSFUL RESPONSE USING STATUS
HEADERS
| Header | Value |
|---|---|
| Content-Type | application/json |
| x-connectfi-token | A long random string token received from /auth/get-token request |
REQUEST BODY
RESPONSE BODY
{
"code": "0",
"data": {
"total": {
"skipRecords": 0,
"numberOfRecords": 3,
"more": false
},
"items": [
{
"cFiCheckId": "chk_3cjSsIGwCA0kLComplete3",
"reference": "extChkRefComplete3",
"serial": "73",
"cFiCheckStatus": "Complete",
"boStatus": "Printed",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLComplete1",
"reference": "extChkRefComplete1",
"serial": "71",
"cFiCheckStatus": "Complete",
"cFiVoidStatus": "Processing",
"boStatus": "Printed",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLComplete2",
"reference": "extChkRefComplete2",
"serial": "72",
"cFiCheckStatus": "Complete",
"cFiVoidStatus": "Processing",
"boStatus": "Printed",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
}
]
},
"requestId": "a7573d90950d11eea89d7100487c0512"
}
200 CHECK/LIST SUCCESSFUL RESPONSE USING VOIDSTATUS
HEADERS
| Header | Value |
|---|---|
| Content-Type | application/json |
| x-connectfi-token | A long random string token received from /auth/get-token request |
REQUEST BODY
RESPONSE BODY
{
"code": "0",
"data": {
"total": {
"skipRecords": 0,
"numberOfRecords": 7,
"more": false
},
"items": [
{
"cFiCheckId": "chk_3cjSsIGwCA0kLgiK2Sent2",
"reference": "extChkRefSent2",
"serial": "66",
"cFiCheckStatus": "Sent",
"cFiVoidStatus": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLgiK2Sent1",
"reference": "extChkRefSent1",
"serial": "65",
"cFiCheckStatus": "Sent",
"cFiVoidStatus": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLgiK2Sent3",
"reference": "extChkRefSent3",
"serial": "67",
"cFiCheckStatus": "Sent",
"cFiVoidStatus": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLgiInBank2",
"reference": "extChkRefInBank2",
"serial": "69",
"cFiCheckStatus": "InBank",
"cFiVoidStatus": "Processing",
"boStatus": "Received",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLComplete1",
"reference": "extChkRefComplete1",
"serial": "71",
"cFiCheckStatus": "Complete",
"cFiVoidStatus": "Processing",
"boStatus": "Printed",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLgiInBank1",
"reference": "extChkRefInBank1",
"serial": "68",
"cFiCheckStatus": "InBank",
"cFiVoidStatus": "Processing",
"boStatus": "Received",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
},
{
"cFiCheckId": "chk_3cjSsIGwCA0kLComplete2",
"reference": "extChkRefComplete2",
"serial": "72",
"cFiCheckStatus": "Complete",
"cFiVoidStatus": "Processing",
"boStatus": "Printed",
"amount": 1.01,
"currency": "USD",
"dtsCreatedAt": "2023-09-14T13:20:01.848Z"
}
]
},
"requestId": "c5fbc8b0950d11eea89d7100487c0512"
}
200 CHECK/LIST SUCCESSFUL RESPONSE NO CHECKS FOUND THAT MATCH CRITERIA
HEADERS
| Header | Value |
|---|---|
| Content-Type | application/json |
| x-connectfi-token | A long random string token received from /auth/get-token request |
REQUEST BODY
{
"dateCreateFrom": "2023-01-15T00:00:00.001Z",
"dateCreateTo": "2999-12-15T23:59:59.999Z",
"status": "Sent",
"voidStatus": "Sent",
"numberOfRecords": 1000,
"skipRecords": 0
}
RESPONSE BODY