Skip to content

List Transactions

Request URL

POST /acquiring/list

Description

This endpoint will list transactions 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 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 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 1000).

Schema

Property table for acquiring/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
}
status Status No {
  "type": "string",
  "nullable": true,
  "enum": [ "Unknown", "Manual", "Initiated",
"Complete", "Declined" ]
}
reversalStatus reversalStatus No {
  "type": "string",
  "nullable": true,
  "enum": [ "Unknown", "Reversal", "Reversed" ]
}
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"
}
type type No {
  "type": "string",
  "enum": [ "push", "pull" ],
  "nullable": true
}

Request Body

{
  "dateCreateFrom": "2023-04-01T18:57:25.957Z",
  "dateCreateTo": "2024-05-10T18:57:25.957Z",
  "status": "Complete",
  "numberOfRecords": 1000,
  "skipRecords": 0
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
  "dateCreateFrom": "2023-04-01T18:57:25.957Z",
  "dateCreateTo": "2024-05-10T18:57:25.957Z",
  "status": "Complete",
  "numberOfRecords": 1000,
  "skipRecords": 0
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/acquiring/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/acquiring/list" --data "{  \"dateCreateFrom\":\"2023-04-01T18:57:25.957Z\", \"dateCreateTo\":\"2024-05-10T18:57:25.957Z\", \"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 DATE RANGE AND NUMBEROFRECORDS

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-04-01T18:57:25.957Z",
  "dateCreateTo": "2024-05-10T18:57:25.957Z",
  "numberOfRecords": 2
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "total": {
            "skipRecords": 0,
            "numberOfRecords": 2,
            "more": true
        },
        "items": [
            {
                "reference": "exrnl2TnId25856117",
                "cFiTransactionId": "CLIENTID_1LOvLXGjG5mPc7FAAuED3t",
                "dtsCreated": "2023-11-24T18:28:13.301Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "httpStatus": 400,
                    "status": 400
                },
                "amount": 100,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25856116",
                "cFiTransactionId": "CLIENTID_4TTReb7QhZarVyknI8ktt",
                "dtsCreated": "2023-11-24T18:26:40.021Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 422,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E5662"
                    },
                    "message": "Transaction Limit",
                    "httpStatus": 422,
                    "status": 400
                },
                "amount": 100.01,
                "currency": "USD"
            }
        ]
    },
    "requestId": "e26484b094f911eea89d7100487c0512"
}

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-04-01T18:57:25.957Z",
  "dateCreateTo": "2024-05-10T18:57:25.957Z",
  "status": "Complete",
  "numberOfRecords": 1000,
  "skipRecords": 0
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "total": {
            "skipRecords": 0,
            "numberOfRecords": 14,
            "more": false
        },
        "items": [
            {
                "reference": "exrnl2TnId2602",
                "cFiTransactionId": "CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK",
                "dtsCreated": "2023-11-02T10:52:56.052Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId2600",
                "cFiTransactionId": "CLIENTID_6C1dj5cgIHVRAZBRFKJ5ES",
                "dtsCreated": "2023-11-02T10:37:40.910Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25900",
                "cFiTransactionId": "CLIENTID_cG8htnpomsWdn4tkc8TsK",
                "dtsCreated": "2023-10-24T13:27:06.468Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25902",
                "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy",
                "dtsCreated": "2023-10-24T12:49:28.970Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25901",
                "cFiTransactionId": "CLIENTID_5sgMbmRj2HzTUx5jOFccnw",
                "dtsCreated": "2023-10-24T12:48:58.974Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "externalPshTrnId03651",
                "cFiTransactionId": "CLIENTID_41cwhp7RusD7RKfc56fJHI",
                "dtsCreated": "2023-10-04T19:59:24.242Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId258562",
                "cFiTransactionId": "CLIENTID_4Xy82bSvTSWfj8MXUcnYGK",
                "dtsCreated": "2023-10-03T19:47:08.283Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId258561",
                "cFiTransactionId": "CLIENTID_2W8xYRgEXEpJkMt7rH42Ua",
                "dtsCreated": "2023-10-03T19:38:07.282Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25873",
                "cFiTransactionId": "CLIENTID_7njuVztzKhOlxD6Wx9mDGa",
                "dtsCreated": "2023-10-02T14:49:53.734Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25872",
                "cFiTransactionId": "CLIENTID_5wkL4XikWRnezWVpS3SxJE",
                "dtsCreated": "2023-10-02T14:41:02.016Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25857",
                "cFiTransactionId": "CLIENTID_7xhWskTDmqIHoftgltrPyO",
                "dtsCreated": "2023-09-29T15:15:04.566Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25856",
                "cFiTransactionId": "CLIENTID_2mqM1MGGCOvxpCliULF89s",
                "dtsCreated": "2023-09-29T14:48:50.807Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25871",
                "cFiTransactionId": "CLIENTID_25T7qk8vVrXi6lPLUtbbWy",
                "dtsCreated": "2023-09-27T19:51:37.268Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "externalCardId52",
                "cFiTransactionId": "CLIENTID_63SrPuoPcgi8EbxVcjwvK2",
                "dtsCreated": "2023-09-18T18:18:33.948Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 10.01,
                "currency": "USD"
            }
        ]
    },
    "requestId": "ca8b6300796e11eeb5658f28ab5fe311"
}

200 SUCCESSFUL RESPONSE USING REVERSALSTATUS AND NUMBEROFRECORDS

HEADERS

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

REQUEST BODY

{
  "reversalStatus": "Reversed",
  "numberOfRecords": 2
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "total": {
            "skipRecords": 0,
            "numberOfRecords": 2,
            "more": true
        },
        "items": [
            {
                "reference": "exrnl2TnId25856114",
                "cFiTransactionId": "CLIENTID_6Wdb0YQloJJs67kF5wMA5I",
                "dtsCreated": "2023-11-15T21:28:17.009Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 1.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25877",
                "cFiTransactionId": "CLIENTID_4rbhvn8ehUFqyGjzkaxmme",
                "dtsCreated": "2023-11-15T12:14:47.922Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 5.01,
                "currency": "USD"
            }
        ]
    },
    "requestId": "b39b96f094f911eea89d7100487c0512"
}

200 SUCCESSFUL RESPONSE UNFILTERED LIST OF TRANSACTIONS FOR LOGGED IN AGGREGATOR

HEADERS

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

REQUEST BODY

{

}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "total": {
            "skipRecords": 0,
            "numberOfRecords": 25,
            "more": false
        },
        "items": [
            {
                "reference": "exrnl2TnId2602",
                "cFiTransactionId": "CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK",
                "dtsCreated": "2023-11-02T10:52:56.052Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId2600",
                "cFiTransactionId": "CLIENTID_6C1dj5cgIHVRAZBRFKJ5ES",
                "dtsCreated": "2023-11-02T10:37:40.910Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25900",
                "cFiTransactionId": "CLIENTID_cG8htnpomsWdn4tkc8TsK",
                "dtsCreated": "2023-10-24T13:27:06.468Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25902",
                "cFiTransactionId": "CLIENTID_600u0FY9DNdRihmYe7icMy",
                "dtsCreated": "2023-10-24T12:49:28.970Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25901",
                "cFiTransactionId": "CLIENTID_5sgMbmRj2HzTUx5jOFccnw",
                "dtsCreated": "2023-10-24T12:48:58.974Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25900",
                "cFiTransactionId": "CLIENTID_5fDKiUF3I3oKqzHkDqAdfs",
                "dtsCreated": "2023-10-24T12:48:47.756Z",
                "status": "Manual",
                "error": {
                    "code": "extToucan",
                    "subCode": 409,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C557550"
                    },
                    "message": "referenceID",
                    "httpStatus": 409,
                    "status": 400
                },
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "externalPshTrnId036529",
                "cFiTransactionId": "CLIENTID_5xEV5hW5CQ7LwKMEXj9cKS",
                "dtsCreated": "2023-10-17T15:42:00.291Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "httpStatus": 400,
                    "status": 400
                },
                "amount": 1000,
                "currency": "USD"
            },
            {
                "reference": "externalPshTrnId036525",
                "cFiTransactionId": "CLIENTID_59YcQwXej3rDiQt9FnZKhk",
                "dtsCreated": "2023-10-17T15:41:39.229Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "httpStatus": 400,
                    "status": 400
                },
                "amount": 1000,
                "currency": "USD"
            },
            {
                "reference": "externalPshTrnId036521",
                "cFiTransactionId": "CLIENTID_4ugVJg2gl9eixOzVAELquu",
                "dtsCreated": "2023-10-17T15:41:02.167Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "httpStatus": 400,
                    "status": 400
                },
                "amount": 1000,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25859",
                "cFiTransactionId": "CLIENTID_50KB7OLTfHieufanrOECC6",
                "dtsCreated": "2023-10-04T21:26:12.927Z",
                "status": "Manual",
                "error": {
                    "code": "extToucan",
                    "subCode": 409,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C557550"
                    },
                    "message": "referenceID",
                    "httpStatus": 409,
                    "status": 400
                },
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "externalPshTrnId03652",
                "cFiTransactionId": "CLIENTID_4lAMcqdODHZBWqCRmSJnWO",
                "dtsCreated": "2023-10-04T19:59:42.372Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "httpStatus": 400,
                    "status": 400
                },
                "amount": 1000,
                "currency": "USD"
            },
            {
                "reference": "externalPshTrnId03651",
                "cFiTransactionId": "CLIENTID_41cwhp7RusD7RKfc56fJHI",
                "dtsCreated": "2023-10-04T19:59:24.242Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId258566",
                "cFiTransactionId": "CLIENTID_48LP1jsA4pQD1U58mVY9qO",
                "dtsCreated": "2023-10-03T20:36:29.613Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 403,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C51212C"
                    },
                    "message": "currency",
                    "httpStatus": 403,
                    "status": 400
                },
                "amount": 10.01,
                "currency": "CAD"
            },
            {
                "reference": "exrnl2TnId258564",
                "cFiTransactionId": "CLIENTID_13ceKrsEElc5AgPKTsWIOS",
                "dtsCreated": "2023-10-03T20:12:10.793Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "httpStatus": 400,
                    "status": 400
                },
                "amount": 100,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId258563",
                "cFiTransactionId": "CLIENTID_6AUrowcr4JfnEIVtSWrYT8",
                "dtsCreated": "2023-10-03T20:10:06.897Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "httpStatus": 400,
                    "status": 400
                },
                "amount": 10000,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId258562",
                "cFiTransactionId": "CLIENTID_4Xy82bSvTSWfj8MXUcnYGK",
                "dtsCreated": "2023-10-03T19:47:08.283Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId258561",
                "cFiTransactionId": "CLIENTID_2W8xYRgEXEpJkMt7rH42Ua",
                "dtsCreated": "2023-10-03T19:38:07.282Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25873",
                "cFiTransactionId": "CLIENTID_7njuVztzKhOlxD6Wx9mDGa",
                "dtsCreated": "2023-10-02T14:49:53.734Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25872",
                "cFiTransactionId": "CLIENTID_5wkL4XikWRnezWVpS3SxJE",
                "dtsCreated": "2023-10-02T14:41:02.016Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25857",
                "cFiTransactionId": "CLIENTID_7xhWskTDmqIHoftgltrPyO",
                "dtsCreated": "2023-09-29T15:15:04.566Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnl2TnId25856",
                "cFiTransactionId": "CLIENTID_2mqM1MGGCOvxpCliULF89s",
                "dtsCreated": "2023-09-29T14:48:50.807Z",
                "status": "Complete",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "exrnlPllTnId25871",
                "cFiTransactionId": "CLIENTID_25T7qk8vVrXi6lPLUtbbWy",
                "dtsCreated": "2023-09-27T19:51:37.268Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 10.01,
                "currency": "USD"
            },
            {
                "reference": "externalCardId54",
                "cFiTransactionId": "CLIENTID_1uaj7q3nptfcSfi2pS6PnA",
                "dtsCreated": "2023-09-18T18:57:18.674Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "status": 400
                },
                "amount": 500,
                "currency": "USD"
            },
            {
                "reference": "externalCardId53",
                "cFiTransactionId": "CLIENTID_5KooX9ONEeog9zULInIZ3k",
                "dtsCreated": "2023-09-18T18:46:54.607Z",
                "status": "Declined",
                "error": {
                    "code": "extToucan",
                    "subCode": 400,
                    "isInformative": true,
                    "external": true,
                    "context": {
                        "errorCode": "3C5E1221"
                    },
                    "message": "amount",
                    "status": 400
                },
                "amount": 550,
                "currency": "USD"
            },
            {
                "reference": "externalCardId52",
                "cFiTransactionId": "CLIENTID_63SrPuoPcgi8EbxVcjwvK2",
                "dtsCreated": "2023-09-18T18:18:33.948Z",
                "status": "Complete",
                "reversalStatus": "Reversed",
                "amount": 10.01,
                "currency": "USD"
            }
        ]
    },
    "requestId": "07450a80796f11eeb5658f28ab5fe311"
}