Export Wires
Request URL
POST /transfer-to/wire/export-list
Description
This endpoint will export a .csv list of wire transfers that match the desired search criteria. Search criteria may be 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 exporting wire transfer lists in batches easy. For example, if you want to list wire transfers 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 wire transfer list will be exported (up to a maximum of 100000).
Schema
Property table for transfer-to/wire/export-list
Property | Description | Required | Schema |
---|---|---|---|
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" } |
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", "nullable": true, "format": "dateISO" } |
dateCreateTo | An ending date in ISO Date format | No | { "type": "string", "nullable": true, "format": "dateISO" } |
status | Status | No | { "type": "string", "nullable": true, "enum": [ "Sent", "Initiated", "Complete", "Declined", "Cancelled", "Unknown" ] } |
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": "2023-02-01T14:27:33.684Z",
"dateCreateTo": "2029-05-13T14:27:33.684Z",
"status": "Complete",
"numberOfRecords": 1000,
"skipRecords": 0
}
Snippet Examples
javascript
const axios = require('axios');
const data = {
"dateCreateFrom": "2023-02-01T14:27:33.684Z",
"dateCreateTo": "2029-05-13T14:27:33.684Z",
"status": "Complete",
"numberOfRecords": 1000,
"skipRecords": 0
}
;
const config = {
method: 'POST',
url: '${CONNECTFI_BASE_URL}/transfer-to/wire/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/wire/export-list" --data "{\"dateCreateFrom\":\"2023-02-01T14:27:33.684Z\",\"dateCreateTo\":\"2029-05-13T14:27:33.684Z\", \"status\":\"Complete\", \"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 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-02-01T14:27:33.684Z",
"dateCreateTo": "2029-05-13T14:27:33.684Z",
"status": "Complete",
"numberOfRecords": 1000,
"skipRecords": 0
}
RESPONSE BODY
TRANSACTION ID,PLATFORM ID,MERCHANT ID,ACCOUNT TOKEN,CFIREFERENCEID,REFERENCE ID,RECEIPT ID,BANK NAME,BANK ABA NUMBER,ACCOUNT NUMBER,NAME,AMOUNT,CURRENCY,ADDRESS,NARRATIVE,MEMOS,STATUS,ERROR CODE,ERROR SUBCODE,ERROR MESSAGE,CREATED DATE
CLIENTID_5sjDl6ZbNRKFC6FDE0ETq8,CLIENTID,1000005,W8EItBOjeYuItDSB9mYsY8ePKbdRDdVB,000000100001114,b34895a06d2911ef834156da8a867868,JW2QGEHYI0,Unicorn Bank,122244184,1234567890123456,John O'Smith-Doe,1.01,USD,[object Object],Test wire,"For test invoice,Test memo,000000100001114",Sent,,,,2024-09-07T14:58:54.089Z
CLIENTID_5nPbR0VZFWzXK3uyEsb1hC,CLIENTID,1000005,W8EItBOjeYuItDSB9mYsY8ePKbdRDdVB,000000100001113,b0e6fef06d2911efbfda56da8a867868,JW2QGEHYI0,Unicorn Bank,122244184,1234567890123456,John O'Smith-Doe,1.01,USD,[object Object],Test wire,"For test invoice,Test memo,000000100001113",Sent,,,,2024-09-07T14:58:50.095Z