Get Package
Request URL
GET /transfer-to/ach/package/:id
Description
A package is a NACHA formatted batch file prepared by connectFi containing ACH transaction requests. This endpoint will get the details for the package specified in the "id" path parameter, if a match exists.
Snippet Examples
javascript
const axios = require('axios');
const config = {
method: 'GET',
url: '${CONNECTFI_BASE_URL}/transfer-to/ach/package/:id',
headers: {
'x-connectfi-token': "A long random string token received from /auth/get-token request"
},
};
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/package/:id" --header "x-connectfi-token: A long random string token received from /auth/get-token request"
Successful Response Examples
200 SUCCESSFUL RESPONSE
HEADERS
Header | Value |
---|---|
x-connectfi-token | A long random string token received from /auth/get-token request |
PARAMETERS
Parameter | Description | Value |
---|---|---|
id | cpkg_4cbMu8ZjPi1V8YDQGBJkYq |
REQUEST BODY
RESPONSE BODY
{
"code": "0",
"data": {
"_id": "6734af24474a322e85a38d1c",
"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",
"dtsCreatedAt": "2024-11-13T13:52:36.596Z",
"dtsUpdatedAt": "2024-11-13T13:52:36.596Z"
},
{
"initiatorType": "process",
"status": "Packed",
"dtsCreatedAt": "2024-11-13T13:52:36.806Z",
"dtsUpdatedAt": "2024-11-13T13:52:36.806Z"
},
{
"initiatorType": "process",
"status": "Sent",
"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",
"__v": 0,
"count": 2,
"dtsSent": "2024-11-13T13:56:19.684Z"
},
"requestId": "d1ec2520a1c811efa1c705d40488b012"
}