List Transactions
Request URL
POST /transfer-to/bills/list
Description
This endpoint will list transactions that match the desired search criteria. Search criteria may be a specific cFiTransaction or reference ID, a date range, a settlement date, an exception date, 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 transfer-to/bills/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, "description": "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, "description": "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, "description": "common-idNullable" } |
| 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 } |
| dateSettled | dateSettled | No | { "type": "string", "format": "dateISO", "pattern": "^\d{4}-\d{2}-\d{2}$", "description": "common-dateOnly" } |
| dateException | dateException | No | { "type": "string", "format": "dateISO", "pattern": "^\d{4}-\d{2}-\d{2}$", "description": "common-dateOnly" } |
| status | status | No | { "type": "string", "nullable": true, "enum": [ "Initiated", "Processing", "Sent", "Complete", "Settled", "Declined", "Unknown", "DecryptError", "Cancelled" ] } |
| numberOfRecords | The maximum number of desired records to return | No | { "type": "integer", "minimum": 1, "nullable": true, "description": "common-numberOfRecords" } |
| skipRecords | The number of records to skip when returning results | No | { "type": "integer", "minimum": 0, "nullable": true, "description": "common-skipRecords" } |
Request Body
{
"dateCreateFrom": "2023-02-01T14:27:33.684Z",
"dateCreateTo": "2024-05-15T14: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": "2024-05-15T14:27:33.684Z",
"status": "Complete",
"numberOfRecords": 1000,
"skipRecords": 0
};
const config = {
method: 'POST',
url: '${CONNECTFI_BASE_URL}/transfer-to/bills/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/bills/list" --data "{\"dateCreateFrom\":\"2023-02-01T14:27:33.684Z\",\"dateCreateTo\":\"2024-05-15T14: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 TRANSFER-TO/BILLS/LIST SUCCESSFUL RESPONSE USING MULTIPLE CRITERIA 1
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": "2024-05-15T14:27:33.684Z",
"numberOfRecords": 1000,
"skipRecords": 0
}
RESPONSE BODY
{
"code": "0",
"data": {
"total": {
"skipRecords": 0,
"numberOfRecords": 62,
"more": false
},
"items": [
{
"reference": "extTrnBill403",
"cFiTransactionId": "CLIENTID_3uyExblcBiwbG6yQYDkDtw",
"merchantId": "10000001",
"cFiTraceNumber": "000000000006993",
"status": "Processing",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-11-02T11:46:23.865Z"
},
{
"reference": "extTrnBill400",
"cFiTransactionId": "CLIENTID_1ziBaW6k8W1ZNXNAmFDovo",
"merchantId": "10000001",
"cFiTraceNumber": "000000000006989",
"status": "Initiated",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-11-02T11:44:37.831Z"
},
{
"reference": "extTrnBill300",
"cFiTransactionId": "CLIENTID_7aPxTlvNmzwPZKZEQSXGIW",
"merchantId": "10000001",
"cFiTraceNumber": "000000000006985",
"status": "Initiated",
"amount": 7.15,
"currency": "USD",
"dtsCreated": "2023-11-02T11:42:37.329Z"
},
{
"reference": "extTrnBill22712",
"cFiTransactionId": "CLIENTID_7eVhYskdXfzr34ZRwAOKc2",
"merchantId": "10000001",
"cFiTraceNumber": "000000000006756",
"status": "Sent",
"amount": 7.15,
"currency": "USD",
"dtsCreated": "2023-10-30T15:13:49.844Z",
"dtsSent": "2023-10-30T20:30:56.749Z"
},
{
"reference": "extTrnBill297",
"cFiTransactionId": "CLIENTID_3bzlbEvJD9bWQpnQ85glih",
"merchantId": "10000001",
"cFiTraceNumber": "000000000006334",
"status": "Sent",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-10-24T17:40:23.243Z",
"dtsSent": "2023-10-24T20:31:31.984Z"
},
{
"reference": "extBillIdY0bHq",
"cFiTransactionId": "CLIENTID_VwquJtbXM1ajWvhu",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002491",
"status": "Declined",
"amount": 10,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:36.027Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327418eab09a197ba02975"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS15787921369",
"networkFee": -0.06,
"settledAmount": -10,
"status": "Complete",
"settlementDate": "2023-10-12"
},
"dateException": "2023-10-12",
"exception": {
"id": "RPPS15787921369",
"exceptionAmount": 10,
"exceptionCurrency": "USD",
"networkFee": 0,
"exceptionCode": "R02",
"exceptionDescription": "Customer account closed-Merchant paid",
"exceptionDate": "2023-10-12"
}
},
{
"reference": "extBillIdfRYIl",
"cFiTransactionId": "CLIENTID_MR6Cn31Gw3ESrlib",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002490",
"status": "Settled",
"amount": 28,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:36.018Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327418eab09a197ba02970"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS51753435317",
"networkFee": -0.06,
"settledAmount": -28,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdxNtYd",
"cFiTransactionId": "CLIENTID_iOytXrRkuHruxuef",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002489",
"status": "Settled",
"amount": 28,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:36.011Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327418eab09a197ba0296b"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS77808043754",
"networkFee": -0.06,
"settledAmount": -28,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdfB0ya",
"cFiTransactionId": "CLIENTID_346yAcrHz2ASAVHM",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002488",
"status": "Settled",
"amount": 26,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:36.005Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327418eab09a197ba02966"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS37519632739",
"networkFee": -0.06,
"settledAmount": -26,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdSmnGv",
"cFiTransactionId": "CLIENTID_EqUUF5FckkSC5zqo",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002487",
"status": "Settled",
"amount": 16,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.998Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02961"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS06444669607",
"networkFee": -0.06,
"settledAmount": -16,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillId4n0yL",
"cFiTransactionId": "CLIENTID_DMXmd5w61NcFgq6b",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002486",
"status": "Settled",
"amount": 18,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.991Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba0295c"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS82103840084",
"networkFee": -0.06,
"settledAmount": -18,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdWJnPr",
"cFiTransactionId": "CLIENTID_PyzmtLsI2qmI77IT",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002485",
"status": "Settled",
"amount": 28,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.985Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02957"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS28119154491",
"networkFee": -0.06,
"settledAmount": -28,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdLDqf4",
"cFiTransactionId": "CLIENTID_eM4LSY99nCixmHkK",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002484",
"status": "Declined",
"amount": 6,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.968Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02943"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS57759449950",
"networkFee": -0.06,
"settledAmount": -6,
"status": "Complete",
"settlementDate": "2023-10-11"
},
"dateException": "2023-10-11",
"exception": {
"id": "RPPS57759449950",
"exceptionAmount": 6,
"exceptionCurrency": "USD",
"networkFee": 0,
"exceptionCode": "R02",
"exceptionDescription": "Customer account closed-Merchant paid",
"exceptionDate": "2023-10-11"
}
},
{
"reference": "extBillIdk4FOQ",
"cFiTransactionId": "CLIENTID_AKKwdgTPuB1qSa17",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002483",
"status": "Declined",
"amount": 6,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.958Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba0293e"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS49887276912",
"networkFee": -0.06,
"settledAmount": -6,
"status": "Complete",
"settlementDate": "2023-10-11"
},
"dateException": "2023-10-11",
"exception": {
"id": "RPPS49887276912",
"exceptionAmount": 6,
"exceptionCurrency": "USD",
"networkFee": 0,
"exceptionCode": "R02",
"exceptionDescription": "Customer account closed-Merchant paid",
"exceptionDate": "2023-10-11"
}
},
{
"reference": "extBillId8X28R",
"cFiTransactionId": "CLIENTID_WMcTHGoY1VGW2tAm",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002482",
"status": "Settled",
"amount": 30,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.951Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02939"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS37180328443",
"networkFee": -0.06,
"settledAmount": -30,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillId2DgmA",
"cFiTransactionId": "CLIENTID_saVKiNbtuLSvPXo8",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002481",
"status": "Settled",
"amount": 18,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.945Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02934"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS84160020364",
"networkFee": -0.06,
"settledAmount": -18,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillIdG04Nh",
"cFiTransactionId": "CLIENTID_Agi2Ssk7TjgbUZ1K",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002480",
"status": "Settled",
"amount": 26,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.938Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba0292f"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS92263709674",
"networkFee": -0.06,
"settledAmount": -26,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillIdGprGK",
"cFiTransactionId": "CLIENTID_kU7aRbMDxzvzjxxQ",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002479",
"status": "Settled",
"amount": 22,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.931Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02929"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS81579425751",
"networkFee": -0.06,
"settledAmount": -22,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillId6MfKT",
"cFiTransactionId": "CLIENTID_09gY4BPYr7HLfKYX",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002478",
"status": "Settled",
"amount": 22,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.923Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02923"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS12795906291",
"networkFee": -0.06,
"settledAmount": -22,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillIdM4LSX",
"cFiTransactionId": "CLIENTID_maPVjDjZe49QP957",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002477",
"status": "Settled",
"amount": 18,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.915Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba0291d"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS33753497416",
"networkFee": -0.06,
"settledAmount": -18,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillIdKhf7P",
"cFiTransactionId": "CLIENTID_9oLpFgqYoSkxSB5g",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002476",
"status": "Settled",
"amount": 20,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.906Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02917"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS10488556467",
"networkFee": -0.06,
"settledAmount": -20,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillIdtuGX1",
"cFiTransactionId": "CLIENTID_4dHqdMTbvmwdN6zC",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002475",
"status": "Settled",
"amount": 22,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.899Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02911"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS80450089484",
"networkFee": -0.06,
"settledAmount": -22,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillIdRgPSe",
"cFiTransactionId": "CLIENTID_4Ha3CquhwDBAVy9l",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002474",
"status": "Settled",
"amount": 30,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.889Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba0290b"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS11015957512",
"networkFee": -0.06,
"settledAmount": -30,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillIdBb4P7",
"cFiTransactionId": "CLIENTID_5P3PA4CNc8ELeKdf",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002473",
"status": "Settled",
"amount": 30,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.877Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02904"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS75214313457",
"networkFee": -0.06,
"settledAmount": -30,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillId8gIR8",
"cFiTransactionId": "CLIENTID_7JqwJ2EWrBFm8oRL",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002472",
"status": "Settled",
"amount": 22,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.840Z",
"dtsSent": "2023-10-11T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-11",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba028f2"
},
"dateSettled": "2023-10-11",
"settled": {
"id": "RPPS84421354027",
"networkFee": -0.06,
"settledAmount": -22,
"status": "Complete",
"settlementDate": "2023-10-11"
}
},
{
"reference": "extBillIdjyIZS",
"cFiTransactionId": "CLIENTID_niJS9mAtM8CRjk0a",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002459",
"status": "Settled",
"amount": 26,
"currency": "USD",
"dtsCreated": "2023-10-20T12:18:30.773Z",
"dtsSent": "2023-10-10T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-10",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "653270167f7972612e9e732f"
},
"dateSettled": "2023-10-10",
"settled": {
"id": "RPPS65400423625",
"networkFee": -0.06,
"settledAmount": -26,
"status": "Complete",
"settlementDate": "2023-10-10"
}
},
{
"reference": "extBillId3CDIA",
"cFiTransactionId": "CLIENTID_p8HElbOjtdx4l3nr",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002458",
"status": "Settled",
"amount": 16,
"currency": "USD",
"dtsCreated": "2023-10-20T12:18:30.764Z",
"dtsSent": "2023-10-10T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-10",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "653270167f7972612e9e7329"
},
"dateSettled": "2023-10-10",
"settled": {
"id": "RPPS66237433860",
"networkFee": -0.06,
"settledAmount": -16,
"status": "Complete",
"settlementDate": "2023-10-10"
}
},
{
"reference": "extBillIdk6DLA",
"cFiTransactionId": "CLIENTID_vyLs6BwpyJKlTT4U",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002457",
"status": "Settled",
"amount": 30,
"currency": "USD",
"dtsCreated": "2023-10-20T12:18:30.755Z",
"dtsSent": "2023-10-10T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-10",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "653270167f7972612e9e7320"
},
"dateSettled": "2023-10-10",
"settled": {
"id": "RPPS15312175274",
"networkFee": -0.06,
"settledAmount": -30,
"status": "Complete",
"settlementDate": "2023-10-10"
}
},
{
"reference": "extBillIdXcep5",
"cFiTransactionId": "CLIENTID_ARFHdQYlD3Bk3MLA",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002456",
"status": "Settled",
"amount": 30,
"currency": "USD",
"dtsCreated": "2023-10-20T12:18:30.741Z",
"dtsSent": "2023-10-10T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-10",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "653270167f7972612e9e7317"
},
"dateSettled": "2023-10-10",
"settled": {
"id": "RPPS08729506637",
"networkFee": -0.06,
"settledAmount": -30,
"status": "Complete",
"settlementDate": "2023-10-10"
}
},
{
"reference": "extTrnBill299",
"cFiTransactionId": "CLIENTID_5x9YSl5tmAIAVtNvDTBj4B",
"merchantId": "10000001",
"cFiTraceNumber": "000000000006201",
"status": "Sent",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-10-19T16:22:34.514Z",
"dtsSent": "2023-10-19T20:31:30.320Z"
},
{
"reference": "extTrnBill227",
"cFiTransactionId": "CLIENTID_4dd5pCxTSlANkCKIpxDwfT",
"merchantId": "10000001",
"cFiTraceNumber": "000000000006200",
"status": "Initiated",
"amount": 7.15,
"currency": "USD",
"dtsCreated": "2023-10-19T16:14:12.157Z"
},
{
"reference": "extTrnBill298",
"cFiTransactionId": "CLIENTID_4HCqiFxsTO0ZbhpLYUX6mZ",
"merchantId": "10000001",
"cFiTraceNumber": "000000000006141",
"status": "Sent",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-10-18T11:22:20.983Z",
"dtsSent": "2023-10-18T20:31:17.485Z"
},
{
"reference": "extTrnBill296",
"cFiTransactionId": "CLIENTID_4XQpMiqTcWPaG5yv8yR0k3",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005474",
"status": "Initiated",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-10-11T16:17:13.379Z"
},
{
"reference": "extTrnBill295",
"cFiTransactionId": "CLIENTID_4TWuBycwexXQSLUcP6ol23",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005473",
"status": "Initiated",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-10-11T16:10:00.416Z"
},
{
"reference": "extTrnBill294",
"cFiTransactionId": "CLIENTID_3OYoaMF2IkcUq4Bwji5S4H",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005472",
"status": "Initiated",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-10-11T16:09:00.871Z"
},
{
"reference": "extTrnBill293",
"cFiTransactionId": "CLIENTID_1O7H0uxSvfNjYsp8spOVKb",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005471",
"status": "Initiated",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-10-11T16:07:09.866Z"
},
{
"reference": "extTrnBill292",
"cFiTransactionId": "CLIENTID_1iV5SRbB7fzTURPEy9Dkll",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005470",
"status": "Initiated",
"amount": 1.01,
"currency": "USD",
"dtsCreated": "2023-10-11T16:06:42.125Z"
},
{
"reference": "extTrnBill22743",
"cFiTransactionId": "CLIENTID_25gzM0qefhje5X3njOgzNF",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005374",
"status": "Initiated",
"amount": 9.15,
"currency": "USD",
"dtsCreated": "2023-10-10T15:04:10.797Z"
},
{
"reference": "extTrnBill22742",
"cFiTransactionId": "CLIENTID_1nCjuzFy85HLFDNUBxtXtp",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005373",
"status": "Initiated",
"amount": 8.15,
"currency": "USD",
"dtsCreated": "2023-10-10T15:03:31.985Z"
},
{
"reference": "extTrnBill22741",
"cFiTransactionId": "CLIENTID_G3q7euYe2nqpB0QpxAzvR",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005372",
"status": "Initiated",
"amount": 8.15,
"currency": "USD",
"dtsCreated": "2023-10-10T15:02:53.257Z"
},
{
"reference": "extTrnBill2271",
"cFiTransactionId": "CLIENTID_16w84E4KRdUH3UBKlsbjcn",
"merchantId": "10000001",
"cFiTraceNumber": "000000000005172",
"status": "Sent",
"amount": 7.15,
"currency": "USD",
"dtsCreated": "2023-10-06T15:58:07.917Z",
"dtsSent": "2023-10-10T20:31:37.924Z"
},
{
"reference": "extTrnBill228",
"cFiTransactionId": "CLIENTID_7DngxBskEO4C5FYUOycfdM",
"merchantId": "10000001",
"cFiTraceNumber": "000000000004788",
"status": "Initiated",
"amount": 7.15,
"currency": "USD",
"dtsCreated": "2023-07-12T14:54:19.469Z"
},
{
"reference": "extTrnBill226",
"cFiTransactionId": "CLIENTID_7ccmfxPfKturee6xQf3cGv",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002233",
"status": "Initiated",
"amount": 7.15,
"currency": "USD",
"dtsCreated": "2023-06-15T17:41:56.986Z"
},
{
"reference": "extTrnBill225",
"cFiTransactionId": "CLIENTID_1tqpJIJtfHhk5Z1qw3wLtx",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002232",
"status": "Initiated",
"amount": 7.15,
"currency": "USD",
"dtsCreated": "2023-06-15T17:22:22.586Z"
},
{
"reference": "10003",
"cFiTransactionId": "CLIENTID_3P1reEzSreBaqxx3DHsmPL",
"merchantId": "10000001",
"cFiTraceNumber": "000000000001652",
"status": "Initiated",
"amount": 102.94,
"currency": "USD",
"dtsCreated": "2023-05-09T07:45:38.623Z"
},
{
"reference": "2042",
"cFiTransactionId": "CLIENTID_2rkqsB7cc2slzR1S4iNdfA",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000694",
"status": "Initiated",
"amount": 1100,
"currency": "USD",
"dtsCreated": "2023-04-11T10:26:25.774Z"
},
{
"reference": "2041",
"cFiTransactionId": "CLIENTID_24530F67pisg0VXhYuIKDE",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000693",
"status": "Initiated",
"amount": 1100,
"currency": "USD",
"dtsCreated": "2023-04-11T10:26:05.115Z"
},
{
"reference": "202",
"cFiTransactionId": "CLIENTID_2HryhdqKetyQEjvujn80SJ",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000527",
"status": "Initiated",
"amount": 10.93,
"currency": "USD",
"dtsCreated": "2023-03-29T14:52:37.532Z"
},
{
"reference": "201",
"cFiTransactionId": "CLIENTID_1sTk9Tb5K1SJagKy1mElGh",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000526",
"status": "Sent",
"amount": 10.93,
"currency": "USD",
"dtsCreated": "2023-03-29T14:51:29.469Z",
"dtsSent": "2023-03-29T15:30:09.508Z"
},
{
"reference": "200",
"cFiTransactionId": "CLIENTID_5l1R326avPM1sE4duvkuR",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000318",
"status": "Sent",
"amount": 10.93,
"currency": "USD",
"dtsCreated": "2023-03-23T20:19:27.701Z",
"dtsSent": "2023-03-23T21:30:10.186Z"
},
{
"reference": "exteralTrnId23342",
"cFiTransactionId": "CLIENTID_7fQyxxUr9kdHmejVAOFM9c",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000021",
"status": "Initiated",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-16T14:05:13.124Z"
},
{
"reference": "exteralTrnId23341",
"cFiTransactionId": "CLIENTID_6B8anXqcFo2kMgYrj3s3KO",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000020",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-15T16:57:35.994Z",
"dtsSent": "2023-02-15T16:58:07.833Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId23340",
"cFiTransactionId": "CLIENTID_4PQdYxMuKzxjJmFRT6qYnw",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000019",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-15T16:55:58.827Z",
"dtsSent": "2023-02-15T16:58:07.833Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId23339",
"cFiTransactionId": "CLIENTID_7ArCeGEHetUo986oEi2tvc",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000018",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-15T16:44:11.524Z",
"dtsSent": "2023-02-15T16:45:22.663Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId23334",
"cFiTransactionId": "CLIENTID_380Tyn1pcJxCdFjmZx0s2",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000015",
"status": "Initiated",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-14T15:48:20.702Z"
},
{
"reference": "exteralTrnId23333",
"cFiTransactionId": "CLIENTID_PTqDiwZio3jyTplwHnOU2",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000014",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-14T14:58:57.595Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId23332",
"cFiTransactionId": "CLIENTID_3r6YWQ22h2erIdb17e5Pns",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000013",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-14T14:25:33.439Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId23331",
"cFiTransactionId": "CLIENTID_2CHH8dYZzHGlrCWiGOpDk6",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000012",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-14T14:24:48.622Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId23330",
"cFiTransactionId": "CLIENTID_12IZcXwJs8JYPhzlYEb2DM",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000011",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-14T14:23:21.509Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId23329",
"cFiTransactionId": "CLIENTID_1lE62Gb0WQC0fU0RTkhE5A",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000010",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-14T13:55:00.348Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId23328",
"cFiTransactionId": "CLIENTID_3qOnnYFYFPvCd967WDWc38",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000009",
"status": "Complete",
"amount": 10.91,
"currency": "USD",
"dtsCreated": "2023-02-14T09:39:13.312Z",
"processing": {
"dateProcessed": "2023-02-15",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
},
{
"reference": "exteralTrnId2344",
"cFiTransactionId": "CLIENTID_3v43RjrtNka1DO4jxSBp7A",
"merchantId": "10000001",
"cFiTraceNumber": "000000000000001",
"status": "Complete",
"amount": 12.94,
"currency": "USD",
"dtsCreated": "2023-02-03T08:12:06.870Z",
"dtsSent": "2023-02-03T08:13:17.113Z",
"processing": {
"dateProcessed": "2023-02-09",
"isReversal": false,
"remarks": "",
"responseCode": "",
"status": "Completed"
}
}
]
},
"requestId": "ae983810797511eeb5658f28ab5fe311"
}
200 TRANSFER-TO/BILLS/LIST SUCCESSFUL RESPONSE USING MULTIPLE CRITERIA 2
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": "2024-05-15T14:27:33.684Z",
"status": "Settled",
"numberOfRecords": 1000,
"dateSettled": "2023-10-12",
"skipRecords": 0
}
RESPONSE BODY
{
"code": "0",
"data": {
"total": {
"skipRecords": 0,
"numberOfRecords": 6,
"more": false
},
"items": [
{
"reference": "extBillIdfRYIl",
"cFiTransactionId": "CLIENTID_MR6Cn31Gw3ESrlib",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002490",
"status": "Settled",
"amount": 28,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:36.018Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327418eab09a197ba02970"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS51753435317",
"networkFee": -0.06,
"settledAmount": -28,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdxNtYd",
"cFiTransactionId": "CLIENTID_iOytXrRkuHruxuef",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002489",
"status": "Settled",
"amount": 28,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:36.011Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327418eab09a197ba0296b"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS77808043754",
"networkFee": -0.06,
"settledAmount": -28,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdfB0ya",
"cFiTransactionId": "CLIENTID_346yAcrHz2ASAVHM",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002488",
"status": "Settled",
"amount": 26,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:36.005Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327418eab09a197ba02966"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS37519632739",
"networkFee": -0.06,
"settledAmount": -26,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdSmnGv",
"cFiTransactionId": "CLIENTID_EqUUF5FckkSC5zqo",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002487",
"status": "Settled",
"amount": 16,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.998Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02961"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS06444669607",
"networkFee": -0.06,
"settledAmount": -16,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillId4n0yL",
"cFiTransactionId": "CLIENTID_DMXmd5w61NcFgq6b",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002486",
"status": "Settled",
"amount": 18,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.991Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba0295c"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS82103840084",
"networkFee": -0.06,
"settledAmount": -18,
"status": "Complete",
"settlementDate": "2023-10-12"
}
},
{
"reference": "extBillIdWJnPr",
"cFiTransactionId": "CLIENTID_PyzmtLsI2qmI77IT",
"merchantId": "10000001",
"cFiTraceNumber": "000000000002485",
"status": "Settled",
"amount": 28,
"currency": "USD",
"dtsCreated": "2023-10-20T12:35:35.985Z",
"dtsSent": "2023-10-12T00:00:00.000Z",
"processing": {
"status": "Completed",
"dateProcessed": "2023-10-12",
"isReversal": false,
"responseCode": "",
"remarks": "",
"_id": "65327417eab09a197ba02957"
},
"dateSettled": "2023-10-12",
"settled": {
"id": "RPPS28119154491",
"networkFee": -0.06,
"settledAmount": -28,
"status": "Complete",
"settlementDate": "2023-10-12"
}
}
]
},
"requestId": "000a06a0950b11eea89d7100487c0512"
}
200 TRANSFER-TO/BILLS/LIST SUCCESSFUL RESPONSE - NO TRANSACTIONS MATCH 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": "2024-05-15T14:27:33.684Z",
"status": "Unknown",
"numberOfRecords": 1000,
"skipRecords": 0
}
RESPONSE BODY