Skip to content

List Packages

Request URL

POST /transfer-to/ach/list-package

Description

A package is a NACHA formatted batch file prepared by connectFi containing ACH transaction requests. This endpoint will list packages that match the desired search criteria. Search criteria may be a specific cFiPackageId(s), a fileExport name, a date range, 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 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 paginated package lists easy. For example, if you want to list packages in groups 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 group and so on.

When making a request, if the number of packages matching the criteria is greater than the numberOfRecords maximum requested, the response body will indicate that there are additional packages ("more": true).

If no properties are included, an unfiltered package list will be returned (up to a maximum of 1000).

Schema

Property table for transfer-to/ach/list-package

Property Description Required Schema
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
}
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"
}
status Status No {
  "type": "string",
  "nullable": true,
  "enum": [ "Initiated", "Packed", "Sent",
"NotSent", "Complete", "Declined" ]
}
cFiPackageId cFiPackageId No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "$id": "common-id"
}
cFiPackageIds cFiPackageIds No array of {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "$id": "common-id"
}
fileExport fileExport No {
  "type": "string",
  "pattern": "^((?![<>]).)*$",
  "minLength": 0,
  "maxLength": 500,
  "nullable": true,
  "$id": "common-commonStr500"
}

Request Body

{
  "dateCreateFrom": "2023-01-15T00:00:00.001Z",
  "dateCreateTo": "2999-12-15T23:59:59.999Z",
  "cFiPackageIds": [],
  "status":"Packed",
  "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",
  "cFiPackageIds": [],
  "status":"Packed",
  "numberOfRecords": 1000,
  "skipRecords": 0
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/transfer-to/ach/list-package',
  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/transfer-to/ach/list-package" --data "{  \"dateCreateFrom\":\"2023-01-15T00:00:00.001Z\", \"dateCreateTo\":\"2999-12-15T23:59:59.999Z\", \"cFiPackageIds\":[], \"status\":\"Packed\", \"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 SUCCESSFUL RESPONSE

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-11-15T23:59:59.999Z",
  "cFiPackageIds": [],
  "status":"Sent",
  "numberOfRecords": 1000,
  "skipRecords": 0
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "total": {
            "skipRecords": 0,
            "numberOfRecords": 1,
            "more": false
        },
        "items": [
            {
                "id": "cpkg_4cbMu8ZjPi1V8YDQGBJkYq",
                "status": "Sent",
                "cFiAggregatorId": "CLIENTID",
                "referenceCode": "24111348",
                "fileExport": "2024_11_13_0.achtest",
                "achAttributes": {
                    "enabled": true,
                    "clientCode": "CLIENTID",
                    "immediateDestination": "081000045",
                    "immediateOrigin": "084106768",
                    "immediateDestinationName": "FEDERAL RESERVE BANK",
                    "immediateOriginName": "EVOLVE BANK & TRUST",
                    "companyName": "CLIENTID",
                    "companyIdentification": "yuEAY8eEwGafmufciZBrEQ",
                    "startFileNumber": 0,
                    "productiveEnable": false,
                    "extraEmail": "test@testemail.com"
                },
                "statusChangeHistory": [
                    {
                        "initiatorType": "process",
                        "status": "Initiated",
                        "_id": "6734af24474a322e85a38d1d",
                        "dtsCreatedAt": "2024-11-13T13:52:36.596Z",
                        "dtsUpdatedAt": "2024-11-13T13:52:36.596Z"
                    },
                    {
                        "initiatorType": "process",
                        "status": "Packed",
                        "_id": "6734af24474a322e85a38d28",
                        "dtsCreatedAt": "2024-11-13T13:52:36.806Z",
                        "dtsUpdatedAt": "2024-11-13T13:52:36.806Z"
                    },
                    {
                        "initiatorType": "process",
                        "status": "Sent",
                        "_id": "6734b003e34fa85116046292",
                        "dtsCreatedAt": "2024-11-13T13:56:19.687Z",
                        "dtsUpdatedAt": "2024-11-13T13:56:19.687Z"
                    }
                ],
                "dtsCreatedAt": "2024-11-13T13:52:36.603Z",
                "dtsUpdatedAt": "2024-11-13T13:56:19.687Z",
                "count": 2,
                "dtsSent": "2024-11-13T13:56:19.684Z"
            }
        ]
    },
    "requestId": "c014fee0a1c711efa1c705d40488b012"
}

200 SUCCESSFUL RESPONSE - NO TRANSACTIONS MEET SEARCH 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": "2024-10-15T00:00:00.001Z",
  "dateCreateTo": "2024-11-15T23:59:59.999Z",
  "cFiPackageIds": [],
  "status":"Packed",
  "numberOfRecords": 1000,
  "skipRecords": 0
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "total": {
            "skipRecords": 0,
            "numberOfRecords": 0,
            "more": false
        },
        "items": []
    },
    "requestId": "0b10b470a1c811efa1c705d40488b012"
}