Export Checks
Request URL
POST /check/export-list
Description
This endpoint will export a .csv list of requested paper checks that match the desired search criteria. Search criteria may be a date range, a cFiCheckId, a reference ID, a status value, or a combination of criteria. You may also specify a maximum number of records to return using the numberOfRecords
property (up to 100000) and you may specify a number of records to skip using the skipRecords
property. Combine the numberOfRecords
property with the skipRecords
property to make exporting paper check 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.
If no properties are included, an unfiltered check print request list will be exported (up to a maximum of 100000).
Schema
Property table for check/export-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, "$id": "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, "$id": "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, "$id": "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, "$id": "common-numberOfRecords" } |
skipRecords | The number of records to skip when returning results | No | { "type": "integer", "minimum": 0, "nullable": true, "$id": "common-skipRecords" } |
Request Body
{
"dateCreateFrom": "2024-10-15T00:00:00.001Z",
"dateCreateTo": "2024-10-16T23:59:59.999Z",
"status": "Cancelled",
"numberOfRecords": 1000,
"skipRecords": 0
}
Snippet Examples
javascript
const axios = require('axios');
const data = {
"dateCreateFrom": "2024-10-15T00:00:00.001Z",
"dateCreateTo": "2024-10-16T23:59:59.999Z",
"status": "Cancelled",
"numberOfRecords": 1000,
"skipRecords": 0
};
const config = {
method: 'POST',
url: '${CONNECTFI_BASE_URL}/check/export-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/export-list" --data "{ \"dateCreateFrom\":\"2024-10-15T00:00:00.001Z\", \"dateCreateTo\":\"2024-10-16T23:59:59.999Z\", \"status\":\"Cancelled\", \"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/EXPORT-LIST SUCCESS EXAMPLE
HEADERS
Header | Value |
---|---|
Content-Type | application/json |
x-connectfi-token | A long random string token received from /auth/get-token request |
REQUEST BODY
{
"dateCreateFrom": "2024-10-15T00:00:00.001Z",
"dateCreateTo": "2024-10-16T23:59:59.999Z",
"status": "Cancelled",
"numberOfRecords": 1000,
"skipRecords": 0
}
RESPONSE BODY
CHECK ID,TRANSACTION ID,PLATFORM ID,SERIAL,MERCHANT ID,REFERENCE #,INIT VOID,STATUS,CREATED DATE,ACCOUNT,AMOUNT,CURRENCY,RETURN ADDRESS,PAYER NAME,PAYER ADDRESS,PAYEE NAME,PAYEE ADDRESS,ATTACHMENTS,PLATFORM NUMBER,CHECK LAYOUT,ENVELOPE,INSERT,DELIVERY OPTION,SENT DATE,VOID STATUS,VOID REASON,VOID SENT DATE,VOID INITIATED DATE,CANCELLED DATE,BO STATUS,BO STATUS DATE,BO DATE PRINTED,BO TRACKING,IMPORT DATE,IMPORT FILE NAME,PACKAGE FILE NAME
chk_4Ul0ASII1DQsF8z96uGkG6,chk_4Ul0ASII1DQsF8z96uGkG6,CLIENTID,266,10000000123456,extChkRef358,false,Cancelled,2024-10-16T12:10:27.302Z,10000000123456,11.13,USD,"Platform Name, ATTN: Employee, 100 Unicorn St, San Francisco, CA 94103",Jim Payer,"3700 Loon Rd, Minneapolis, MN, 12345-1234",Xcel Energy,"414 Nicollet Mall, Minneapolis, MN, 12345",,+1 (555) 666-7777,Default,Default,Null,USPS_FirstClass,,,Lost the check,,,2024-10-16T12:10:28.083Z,,,,,,,
chk_3qE9uFz8aLe17syI7LFlNo,chk_3qE9uFz8aLe17syI7LFlNo,CLIENTID,265,10000000123456,extChkRef152,false,Cancelled,2024-10-15T12:10:16.962Z,10000000123456,11.13,USD,"Platform Name, ATTN: Employee, 100 Unicorn St, San Francisco, CA 94103",Jim Payer,"3700 Loon Rd, Minneapolis, MN, 12345-1234",Xcel Energy,"414 Nicollet Mall, Minneapolis, MN, 12345",,+1 (555) 666-7777,Default,Default,Null,USPS_FirstClass,,,Lost the check,,,2024-10-15T12:10:17.681Z,,,,,,,