Skip to content

Export Transactions

Request URL

POST /transfer-to/ach/export-list

Description

This endpoint will export a list of transactions that match the desired search criteria as a .csv file. Search criteria may be a specific cFiTransactionId or reference ID, a cFiPackageId, a clientCode, 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 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 displaying transaction lists in batches easy. For example, if you want to list transactions 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 transactions matching the criteria is greater than the numberOfRecords maximum requested, the response body will indicate that there are additional transactions ("more": true).

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

Schema

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

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"
}
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"
}
cFiTransactionId The transaction ID in the connectFi system No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "nullable": true,
  "$id": "common-idNullable"
}
cFiTransactionIds Array of transaction IDs from the connectFi system obtained when each transaction was initialized No array of {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "nullable": true,
  "$id": "common-idNullable"
}
cFiPackageId cFiPackageId No {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "nullable": true,
  "$id": "common-idNullable"
}
status Status No {
  "type": "string",
  "nullable": true,
  "enum": [ "Initiated", "Sent", "Complete",
"Settled", "Returned", "Declined" ]
}
clientCode The clientCode in connectFi that corresponds to the desired ACH configurations for companyName and companyId. If not included, the default ACH solution configuration for this client will be used. Contact support to update ACH configurations. Example - If clientCode: "name1" is configured to use ACH { companyName: "COABC", companyId: "123abc456def789" } and clientCode: "name2" is configured to use ACH { companyName: "COABD", companyId: "123abc456def780" }, then including the clientCode parameter will specify which configuration to use. If not included, the default "name1" configuration would be used in this example. No {
  "type": "string",
  "pattern": "^((?![<>]).)*$",
  "minLength": 0,
  "maxLength": 100,
  "nullable": true,
  "$id": "common-commonStr100"
}

Request Body

{
  "dateCreateFrom": "2024-09-15T00:00:00.001Z",
  "dateCreateTo": "2024-10-25T23:59:59.999Z",
  "cFiTransactionIds": [],
  "numberOfRecords": 1000,
  "skipRecords": 0
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
  "dateCreateFrom": "2024-09-15T00:00:00.001Z",
  "dateCreateTo": "2024-10-25T23:59:59.999Z",
  "cFiTransactionIds": [],
  "numberOfRecords": 1000,
  "skipRecords": 0
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/transfer-to/ach/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/transfer-to/ach/export-list" --data "{  \"dateCreateFrom\":\"2024-09-15T00:00:00.001Z\", \"dateCreateTo\":\"2024-10-25T23:59:59.999Z\", \"cFiTransactionIds\":[], \"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-09-15T00:00:00.001Z",
  "dateCreateTo": "2024-11-25T23:59:59.999Z",
  "cFiTransactionIds": [],
  "numberOfRecords": 1000,
  "skipRecords": 0
}

RESPONSE BODY

TRANSACTION ID,PLATFORM ID,REF CODE,CREATION DATE,ORIGIN,TRACE ACH #,CLIENT CODE,COMPANY IDENTIFICATION,ENTRY DATE(1-CSV),COMPANY NAME(2-CSV),CLASS CODE(3-CSV),ENTRY DESCRIPTION(4-CSV),DISCRETIONARY DATA(5-CSV),INDIVIDUAL NAME(6-CSV),ROUTING(7-CSV),ACCOUNT(8-CSV),ACC TYPE(9-CSV),TRXN TYPE(10-CSV),AMOUNT(11-CSV),CHECK SERIAL #(12-CSV),CITY(13-CSV),STATE(14-CSV),IDENTIFICATION #(15-CSV),PRENOTE(16-CSV),ORIGINAL TRACE #,ACH DATE,IMPORT TRACE DATE,STATUS
CLIENTID_jk8KNromFPKZeAScTvRrY,CLIENTID,extTrnAch267,2024-11-13T13:49:01.943Z,External,,CLIENTID,,2024-11-13,,POP,PAYMENT,Trading,John Smith,103112617,123456789,Checking,Debit,10,123456789,CHAR,NC,,,,,,Initiated
CLIENTID_730F1dquQjEha0VIvyPMxH,CLIENTID,extTrnAch265,2024-09-24T12:17:02.235Z,External,084106760000007,CLIENTID,yuEAY8eEwGafmufciZBrEQ,2024-09-24,CLIENTID,ARC,PAYMENT,Trading,John Smith,103112617,123456789,Checking,Debit,10,1234567890123,,,,,,,,Sent

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-10-25T23:59:59.999Z",
  "cFiTransactionIds": [],
  "numberOfRecords": 1000,
  "skipRecords": 0
}

RESPONSE BODY

TRANSACTION ID,PLATFORM ID,REF CODE,CREATION DATE,ORIGIN,TRACE ACH #,CLIENT CODE,COMPANY IDENTIFICATION,ENTRY DATE(1-CSV),COMPANY NAME(2-CSV),CLASS CODE(3-CSV),ENTRY DESCRIPTION(4-CSV),DISCRETIONARY DATA(5-CSV),INDIVIDUAL NAME(6-CSV),ROUTING(7-CSV),ACCOUNT(8-CSV),ACC TYPE(9-CSV),TRXN TYPE(10-CSV),AMOUNT(11-CSV),CHECK SERIAL #(12-CSV),CITY(13-CSV),STATE(14-CSV),IDENTIFICATION #(15-CSV),PRENOTE(16-CSV),ORIGINAL TRACE #,ACH DATE,IMPORT TRACE DATE,STATUS