Skip to content

Transaction History

Request URL

POST /ibis/inquiry/transaction-history

Description

This endpoint will retrieve the transaction history of a card or vAccount issued through /ibis. The card or vAccount must be activated before retrieving the transaction history.

Schema

Property table for ibis/inquiry/transaction-history

Property Description Required Schema
cFiCardId The card ID in connectFi Yes {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "description": "common-id"
}
dateFrom The beginning of the requested date range in 'YYYY-MM-DD' format No {
  "type": "string",
  "format": "dateISO",
  "pattern": "^\d{4}-\d{2}-\d{2}$",
  "description": "common-dateOnly"
}
dateTo The end of the requested date range in 'YYYY-MM-DD' format No {
  "type": "string",
  "format": "dateISO",
  "pattern": "^\d{4}-\d{2}-\d{2}$",
  "description": "common-dateOnly"
}
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

{
    "cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw",
    "dateFrom" : "2023-03-01",
    "dateTo" : "2025-05-02"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw",
    "dateFrom" : "2023-03-01",
    "dateTo" : "2025-05-02"
}
;
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/ibis/inquiry/transaction-history',
  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/ibis/inquiry/transaction-history" --data "{    \"cFiCardId\":\"icrd_1qaR2QEPXIRKr4jOyjQkTw\",   \"dateFrom\": \"2023-03-01\",   \"dateTo\": \"2025-05-02\"}" --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

{
    "cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw",
    "dateFrom" : "2023-03-01",
    "dateTo" : "2025-05-02"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "transactions": [
            {
                "transId": "F2166100344",
                "traceAuditNo": "2166100344",
                "originalTraceAuditNo": "2166100335",
                "accountNumber": "999999******4135",
                "transTypeId": "40",
                "businessDate": "11/12/2023",
                "acceptorNameAndLocation": "                                        USA",
                "availableBalance": "21.00",
                "amount": "10.50",
                "description": "Shortfall Currency Exchange",
                "messageTypeIdentifier": "0400",
                "arn": "0000000000000000002J",
                "mcc": "0",
                "deviceType": "H",
                "transDate": "2023-11-12T15:14:00",
                "remainingBalance": "21.00",
                "panSequenceNo": "00",
                "localDateTime": "2023-11-12 15:13:59",
                "serviceId": "C2C_FUNDS_TRSFR",
                "isRecurring": "N",
                "is3DSecure": "N",
                "isDigitalWalletTrans": "N"
            },
            {
                "transId": "F2166100335",
                "traceAuditNo": "2166100335",
                "accountNumber": "999999******4135",
                "transTypeId": "40",
                "businessDate": "11/12/2023",
                "acceptorNameAndLocation": "                                        USA",
                "availableBalance": "10.50",
                "amount": "-10.50",
                "description": "Shortfall Currency Exchange  to 99*************1201 from 99*************4135",
                "messageTypeIdentifier": "0200",
                "arn": "0000000000000000002J",
                "mcc": "0",
                "deviceType": "H",
                "transDate": "2023-11-12T15:13:09",
                "remainingBalance": "10.50",
                "panSequenceNo": "00",
                "authorizationCode": "100335",
                "localDateTime": "2023-11-12 15:13:08",
                "serviceId": "C2C_FUNDS_TRSFR",
                "isRecurring": "N",
                "is3DSecure": "N",
                "isDigitalWalletTrans": "N"
            },
            {
                "transId": "F2166100331",
                "traceAuditNo": "2166100331",
                "accountNumber": "999999******4135",
                "transTypeId": "01",
                "businessDate": "11/12/2023",
                "acceptorNameAndLocation": "                                        USA",
                "availableBalance": "21.00",
                "amount": "-2.50",
                "description": "Paying bill",
                "messageTypeIdentifier": "0200",
                "arn": "0000000000000000002G",
                "mcc": "0",
                "deviceType": "H",
                "transDate": "2023-11-12T15:10:43",
                "remainingBalance": "21.00",
                "panSequenceNo": "00",
                "authorizationCode": "100331",
                "localDateTime": "2023-11-12 15:10:42",
                "serviceId": "WS_WITHD",
                "isRecurring": "N",
                "is3DSecure": "N",
                "isDigitalWalletTrans": "N"
            },
            {
                "transId": "F2166100330",
                "traceAuditNo": "2166100330",
                "accountNumber": "999999******4135",
                "transTypeId": "21",
                "businessDate": "11/12/2023",
                "acceptorNameAndLocation": "                                        USA",
                "availableBalance": "23.50",
                "amount": "5.00",
                "description": "test trn",
                "messageTypeIdentifier": "0200",
                "arn": "0000000000000000002F",
                "mcc": "0",
                "deviceType": "H",
                "transDate": "2023-11-12T15:09:40",
                "remainingBalance": "23.50",
                "panSequenceNo": "00",
                "authorizationCode": "100330",
                "localDateTime": "2023-11-12 15:09:39",
                "serviceId": "POS_MNY_LOD",
                "isRecurring": "N",
                "is3DSecure": "N",
                "isDigitalWalletTrans": "N"
            },
            {
                "transId": "F2166100329",
                "traceAuditNo": "2166100329",
                "accountNumber": "999999******4135",
                "transTypeId": "01",
                "businessDate": "11/12/2023",
                "acceptorNameAndLocation": "                                        USA",
                "availableBalance": "18.50",
                "amount": "-1.50",
                "description": "Paying bill",
                "messageTypeIdentifier": "0200",
                "arn": "0000000000000000002E",
                "mcc": "0",
                "deviceType": "H",
                "transDate": "2023-11-12T15:07:09",
                "remainingBalance": "18.50",
                "panSequenceNo": "00",
                "authorizationCode": "100329",
                "localDateTime": "2023-11-12 15:07:09",
                "serviceId": "WS_WITHD",
                "isRecurring": "N",
                "is3DSecure": "N",
                "isDigitalWalletTrans": "N"
            },
            {
                "transId": "F2166100328",
                "traceAuditNo": "2166100328",
                "accountNumber": "999999******4135",
                "transTypeId": "21",
                "businessDate": "11/12/2023",
                "acceptorNameAndLocation": "                                        USA",
                "availableBalance": "20.00",
                "amount": "20.00",
                "description": "test trn",
                "messageTypeIdentifier": "0200",
                "arn": "0000000000000000002D",
                "mcc": "0",
                "deviceType": "H",
                "transDate": "2023-11-12T15:06:11",
                "remainingBalance": "20.00",
                "panSequenceNo": "00",
                "authorizationCode": "100328",
                "localDateTime": "2023-11-12 15:06:10",
                "serviceId": "POS_MNY_LOD",
                "isRecurring": "N",
                "is3DSecure": "N",
                "isDigitalWalletTrans": "N"
            }
        ]
    },
    "requestId": "5b5a40a081b111ee9b7427220cc6c212"
}