Skip to content

Query Transactions

Request URL

POST /transfer-to/combo/query

Description

The status of up to 20 transactions may be requested at a time. The requested transactions are identified either by an array of cFiTransactionId objects (each of which consist of the transferType and the "cFiTransactionId") or by an array of reference objects (each of which consist of the transferType and the external system "reference"). The array that you include may not be an empty array.

The system will return only the transactions it could locate. Unknown IDs will be ignored and if no IDs are recognized, an empty array is returned with success code "0".

If the same ID is requested multiple times in the "сFiTransactionIds" or "references" array, the response will only return one object in the data array corresponding to that ID, regardless of how many times it was listed in the request array.

If more than 20 elements are listed in the request array (either "сFiTransactionIds" array or the "references" array), an error will be thrown even if the IDs are not unique. For example, if the cFiTransactionId "CLIENTID_6UkLq66HEN6IMj4fNl6hgM" is listed 21 times in the request array, the request will fail even though technically only one unique ID was requested.

Either "cFiTransactionIds": [...] should be used or "references": [...], but not both. You cannot combine both types of IDs into a single request.

Schema

Property table for schema 1 for transfer-to/combo/query

Property Description Required Schema
cFiTransactionIds Array of transaction IDs from the connectFi system obtained when each transaction was initialized Yes array of cFiTransactionIds item objects

Property table for schema 2 for transfer-to/combo/query

Property Description Required Schema
references An array of external references Yes array of references item objects

Property table for references array item object

Property Description Required Schema
transferType transferType Yes {
  "type": "string",
  "enum": [ "ach", "push", "pull", "wire" ]
}
reference An external alphanumeric reference ID for the entity in your system Yes {
  "type": "string",
  "pattern": "^[0-9a-zA-Z]+$",
  "minLength": 1,
  "maxLength": 32,
  "$id": "common-reference"
}

Property table for cFiTransactionIds array item object

Property Description Required Schema
transferType transferType Yes {
  "type": "string",
  "enum": [ "ach", "push", "pull", "wire" ]
}
cFiTransactionId The transaction ID in the connectFi system Yes {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "$id": "common-id"
}

Request Body

{
    "cFiTransactionIds": [
      {"transferType": "pull", "cFiTransactionId": "CLIENTID_5sgMbmRj2HzTUx5jOFccnw"},
      {"transferType": "push", "cFiTransactionId": "CLIENTID_7cLPRxUEe1PcERTfArLwHM"},
      {"transferType": "wire", "cFiTransactionId": "CLIENTID_6GjbDZwkm3SieyS4IpQP7A"},
      {"transferType": "pull", "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy"},
      {"transferType": "push", "cFiTransactionId": "CLIENTID_01m6InYtVfqMPb9HS3wxVg"},
      {"transferType": "wire", "cFiTransactionId": "CLIENTID_LO7PHImGsvvR46Z7E1hwS"},
      {"transferType": "ach",
        "cFiTransactionId": "CLIENTID_16miQKjs2NjZVzrf8ouBQm"}
    ]
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "cFiTransactionIds": [
      {"transferType": "pull", "cFiTransactionId": "CLIENTID_5sgMbmRj2HzTUx5jOFccnw"},
      {"transferType": "push", "cFiTransactionId": "CLIENTID_7cLPRxUEe1PcERTfArLwHM"},
      {"transferType": "wire", "cFiTransactionId": "CLIENTID_6GjbDZwkm3SieyS4IpQP7A"},
      {"transferType": "pull", "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy"},
      {"transferType": "push", "cFiTransactionId": "CLIENTID_01m6InYtVfqMPb9HS3wxVg"},
      {"transferType": "wire", "cFiTransactionId": "CLIENTID_LO7PHImGsvvR46Z7E1hwS"},
      {"transferType": "ach",
        "cFiTransactionId": "CLIENTID_16miQKjs2NjZVzrf8ouBQm"}
    ]
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/transfer-to/combo/query',
  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/combo/query" --data "{    \"cFiTransactionIds\":[      {\"transferType\":\"pull\",\"cFiTransactionId\":\"CLIENTID_5sgMbmRj2HzTUx5jOFccnw\"},     {\"transferType\":\"push\",\"cFiTransactionId\":\"CLIENTID_7cLPRxUEe1PcERTfArLwHM\"},     {\"transferType\":\"wire\",\"cFiTransactionId\":\"CLIENTID_6GjbDZwkm3SieyS4IpQP7A\"},     {\"transferType\":\"pull\",\"cFiTransactionId\":\"CLIENTID_600u0FY9DNdRihmYe7icMy\"},     {\"transferType\":\"push\",\"cFiTransactionId\":\"CLIENTID_01m6InYtVfqMPb9HS3wxVg\"},     {\"transferType\":\"wire\",\"cFiTransactionId\":\"CLIENTID_LO7PHImGsvvR46Z7E1hwS\"},     {\"transferType\":\"ach\",       \"cFiTransactionId\":\"CLIENTID_16miQKjs2NjZVzrf8ouBQm\"}    ]}" --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 CFITRANSACTIONIDS

HEADERS

Header Value
Content-Type application/json
x-connectfi-token A long random string token received from /auth/get-token request

REQUEST BODY

{
    "cFiTransactionIds": [
      {"transferType": "pull", "cFiTransactionId": "CLIENTID_5sgMbmRj2HzTUx5jOFccnw"},
      {"transferType": "push", "cFiTransactionId": "CLIENTID_7cLPRxUEe1PcERTfArLwHM"},
      {"transferType": "wire", "cFiTransactionId": "CLIENTID_6GjbDZwkm3SieyS4IpQP7A"},
      {"transferType": "pull", "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy"},
      {"transferType": "push", "cFiTransactionId": "CLIENTID_01m6InYtVfqMPb9HS3wxVg"},
      {"transferType": "wire", "cFiTransactionId": "CLIENTID_LO7PHImGsvvR46Z7E1hwS"},
      {"transferType": "ach",
        "cFiTransactionId": "CLIENTID_16miQKjs2NjZVzrf8ouBQm"}
    ]
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "ach": [
            {
                "cFiTransactionId": "CLIENTID_16miQKjs2NjZVzrf8ouBQm",
                "reference": "extTrnAch200",
                "cFiAggregatorId": "CLIENTID",
                "status": "Sent",
                "dtsCreatedAt": "2023-10-24T12:52:08.504Z",
                "dtsSent": "2023-10-24T19:58:09.608Z",
                "effectiveEntryDate": "2023-10-24",
                "individualName": "John Smith",
                "routingNumber": "053207766",
                "amount": 3.15,
                "currency": "USD",
                "DFIAccountNumber": "123456789"
            }
        ],
        "card": [
            {
                "reference": "externalPshTrnId0401",
                "cFiTransactionId": "CLIENTID_01m6InYtVfqMPb9HS3wxVg",
                "dtsCreated": "2023-10-24T12:51:08.917Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            },
            {
                "reference": "exrnlPllTnId25901",
                "cFiTransactionId": "CLIENTID_5sgMbmRj2HzTUx5jOFccnw",
                "dtsCreated": "2023-10-24T12:48:58.974Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            },
            {
                "reference": "exrnlPllTnId25902",
                "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy",
                "dtsCreated": "2023-10-24T12:49:28.970Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            },
            {
                "reference": "externalPshTrnId0400",
                "cFiTransactionId": "CLIENTID_7cLPRxUEe1PcERTfArLwHM",
                "dtsCreated": "2023-10-24T12:50:35.443Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            }
        ],
        "wire": [
            {
                "status": "Initiated",
                "amount": 1.01,
                "currency": "USD",
                "reference": "externalTrnId1361",
                "cFiTransactionId": "CLIENTID_6GjbDZwkm3SieyS4IpQP7A",
                "transactionReceiptId": "JW2QGEHYI0",
                "dtsCreatedAt": "2023-10-24T12:42:57.090Z"
            },
            {
                "status": "Initiated",
                "amount": 1.01,
                "currency": "USD",
                "reference": "externalTrnId1362",
                "cFiTransactionId": "CLIENTID_LO7PHImGsvvR46Z7E1hwS",
                "transactionReceiptId": "JW2QGEHYI0",
                "dtsCreatedAt": "2023-10-24T12:44:40.742Z"
            }
        ]
    },
    "requestId": "f9baa42079a411eeb5658f28ab5fe311"
}

200 SUCCESSFUL RESPONSE USING REFERENCES

HEADERS

Header Value
Content-Type application/json
x-connectfi-token A long random string token received from /auth/get-token request

REQUEST BODY

{
    "references": [
      {"transferType": "pull", "reference": "exrnlPllTnId25901"},
      {"transferType": "push", "reference": "externalPshTrnId0400"},
      {"transferType": "wire", "reference": "externalTrnId1361"},
      {"transferType": "pull", "reference": "exrnlPllTnId25902"},
      {"transferType": "push", "reference": "externalPshTrnId0401"},
      {"transferType": "wire", "reference": "externalTrnId1362"},
      {"transferType": "ach", "reference": "extTrnAch200"}
    ]
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "ach": [
            {
                "cFiTransactionId": "CLIENTID_16miQKjs2NjZVzrf8ouBQm",
                "reference": "extTrnAch200",
                "cFiAggregatorId": "CLIENTID",
                "status": "Sent",
                "dtsCreatedAt": "2023-10-24T12:52:08.504Z",
                "dtsSent": "2023-10-24T19:58:09.608Z",
                "effectiveEntryDate": "2023-10-24",
                "individualName": "John Smith",
                "routingNumber": "053207766",
                "amount": 3.15,
                "currency": "USD",
                "DFIAccountNumber": "123456789"
            }
        ],
        "card": [
            {
                "reference": "exrnlPllTnId25901",
                "cFiTransactionId": "CLIENTID_5sgMbmRj2HzTUx5jOFccnw",
                "dtsCreated": "2023-10-24T12:48:58.974Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            },
            {
                "reference": "exrnlPllTnId25902",
                "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy",
                "dtsCreated": "2023-10-24T12:49:28.970Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            },
            {
                "reference": "externalPshTrnId0400",
                "cFiTransactionId": "CLIENTID_7cLPRxUEe1PcERTfArLwHM",
                "dtsCreated": "2023-10-24T12:50:35.443Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            },
            {
                "reference": "externalPshTrnId0401",
                "cFiTransactionId": "CLIENTID_01m6InYtVfqMPb9HS3wxVg",
                "dtsCreated": "2023-10-24T12:51:08.917Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            }
        ],
        "wire": [
            {
                "status": "Initiated",
                "amount": 1.01,
                "currency": "USD",
                "reference": "externalTrnId1361",
                "cFiTransactionId": "CLIENTID_6GjbDZwkm3SieyS4IpQP7A",
                "transactionReceiptId": "JW2QGEHYI0",
                "dtsCreatedAt": "2023-10-24T12:42:57.090Z"
            },
            {
                "status": "Initiated",
                "amount": 1.01,
                "currency": "USD",
                "reference": "externalTrnId1362",
                "cFiTransactionId": "CLIENTID_LO7PHImGsvvR46Z7E1hwS",
                "transactionReceiptId": "JW2QGEHYI0",
                "dtsCreatedAt": "2023-10-24T12:44:40.742Z"
            }
        ]
    },
    "requestId": "71a30d6079a511eeb5658f28ab5fe311"
}

200 SUCCESSFUL RESPONSE UNKNOWNID IS IGNORED

HEADERS

Header Value
Content-Type application/json
x-connectfi-token A long random string token received from /auth/get-token request

REQUEST BODY

{
    "cFiTransactionIds": [
      {"transferType": "pull", "cFiTransactionId": "unknownId"},
      {"transferType": "push", "cFiTransactionId": "CLIENTID_7cLPRxUEe1PcERTfArLwHM"},
      {"transferType": "wire", "cFiTransactionId": "CLIENTID_6GjbDZwkm3SieyS4IpQP7A"},
      {"transferType": "pull", "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy"},
      {"transferType": "push", "cFiTransactionId": "CLIENTID_01m6InYtVfqMPb9HS3wxVg"},
      {"transferType": "wire", "cFiTransactionId": "CLIENTID_LO7PHImGsvvR46Z7E1hwS"},
      {"transferType": "ach",
        "cFiTransactionId": "CLIENTID_16miQKjs2NjZVzrf8ouBQm"}
    ]
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "ach": [
            {
                "cFiTransactionId": "CLIENTID_16miQKjs2NjZVzrf8ouBQm",
                "reference": "extTrnAch200",
                "cFiAggregatorId": "CLIENTID",
                "status": "Sent",
                "dtsCreatedAt": "2023-10-24T12:52:08.504Z",
                "dtsSent": "2023-10-24T19:58:09.608Z",
                "effectiveEntryDate": "2023-10-24",
                "individualName": "John Smith",
                "routingNumber": "053207766",
                "amount": 3.15,
                "currency": "USD",
                "DFIAccountNumber": "123456789"
            }
        ],
        "card": [
            {
                "reference": "externalPshTrnId0401",
                "cFiTransactionId": "CLIENTID_01m6InYtVfqMPb9HS3wxVg",
                "dtsCreated": "2023-10-24T12:51:08.917Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            },
            {
                "reference": "exrnlPllTnId25902",
                "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy",
                "dtsCreated": "2023-10-24T12:49:28.970Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            },
            {
                "reference": "externalPshTrnId0400",
                "cFiTransactionId": "CLIENTID_7cLPRxUEe1PcERTfArLwHM",
                "dtsCreated": "2023-10-24T12:50:35.443Z",
                "status": "Complete",
                "network": "Visa",
                "networkRC": "00"
            }
        ],
        "wire": [
            {
                "status": "Initiated",
                "amount": 1.01,
                "currency": "USD",
                "reference": "externalTrnId1361",
                "cFiTransactionId": "CLIENTID_6GjbDZwkm3SieyS4IpQP7A",
                "transactionReceiptId": "JW2QGEHYI0",
                "dtsCreatedAt": "2023-10-24T12:42:57.090Z"
            },
            {
                "status": "Initiated",
                "amount": 1.01,
                "currency": "USD",
                "reference": "externalTrnId1362",
                "cFiTransactionId": "CLIENTID_LO7PHImGsvvR46Z7E1hwS",
                "transactionReceiptId": "JW2QGEHYI0",
                "dtsCreatedAt": "2023-10-24T12:44:40.742Z"
            }
        ]
    },
    "requestId": "3c846b6079a511eeb5658f28ab5fe311"
}