Skip to content

Retrieve Transaction

Request URL

POST /ibis/financial/retrieve

Description

This endpoint will retrieve the details of an existing transaction. You may use one of the following IDs to retrieve a transaction: cFiFundsId, reference, or arn. If you include more than one of these ID types in a single request, an error will be thrown.

Schema

Property table for schema 1 for ibis/financial/retrieve

Property Description Required Schema
cFiFundsId The funds transfer ID in connectFi Yes {
  "type": "string",
  "pattern": "^[0-9a-zA-Z_]+$",
  "minLength": 1,
  "maxLength": 36,
  "$id": "common-id"
}

Property table for schema 2 for ibis/financial/retrieve

Property Description Required Schema
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 schema 3 for ibis/financial/retrieve

Property Description Required Schema
arn arn Yes {
  "type": "string",
  "pattern": "^((?![<>]).)*$",
  "minLength": 1,
  "maxLength": 50,
  "isNotOnlyWhitespace": true,
  "$id": "common-commonStr50Req"
}

Request Body

{
    "cFiFundsId": "ifnd_1BbJoybpUZYZRiTkAD4RZE"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "cFiFundsId": "ifnd_1BbJoybpUZYZRiTkAD4RZE"
}
;
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/ibis/financial/retrieve',
  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/financial/retrieve" --data "{    \"cFiFundsId\":\"ifnd_1BbJoybpUZYZRiTkAD4RZE\"}" --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 CFIFUNDSID

HEADERS

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

REQUEST BODY

{
    "cFiFundsId": "ifnd_1BbJoybpUZYZRiTkAD4RZE"
}

RESPONSE BODY

{
    "code": "0",
    "data": [
        {
            "reference": "ExtDFunds200",
            "cFiFundsId": "ifnd_1BbJoybpUZYZRiTkAD4RZE",
            "cFiAggregatorId": "CLIENTID",
            "type": "debit",
            "cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw",
            "cFiStatus": "Complete",
            "boTransId": "F2166100329",
            "arn": "0000000000000000002E",
            "fee": 0,
            "balance": 18.5,
            "lastDepositAmount": 0,
            "ledgerBalance": 18.5,
            "dtsCreatedAt": "2023-11-12T23:07:09.125Z"
        }
    ],
    "requestId": "6fb6eb3081b011ee9b7427220cc6c212"
}

200 SUCCESSFUL RESPONSE USING REFERENCE

HEADERS

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

REQUEST BODY

{
    "reference": "ExtDFunds200"
}

RESPONSE BODY

{
    "code": "0",
    "data": [
        {
            "reference": "ExtDFunds200",
            "cFiFundsId": "ifnd_1BbJoybpUZYZRiTkAD4RZE",
            "cFiAggregatorId": "CLIENTID",
            "type": "debit",
            "cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw",
            "cFiStatus": "Complete",
            "boTransId": "F2166100329",
            "arn": "0000000000000000002E",
            "fee": 0,
            "balance": 18.5,
            "lastDepositAmount": 0,
            "ledgerBalance": 18.5,
            "dtsCreatedAt": "2023-11-12T23:07:09.125Z"
        }
    ],
    "requestId": "6297e98094ad11eea89d7100487c0512"
}

200 SUCCESSFUL RESPONSE USING ARN

HEADERS

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

REQUEST BODY

{
    "arn": "0000000000000000002E"
}

RESPONSE BODY

{
    "code": "0",
    "data": [
        {
            "reference": "ExtDFunds200",
            "cFiFundsId": "ifnd_1BbJoybpUZYZRiTkAD4RZE",
            "cFiAggregatorId": "CLIENTID",
            "type": "debit",
            "cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw",
            "cFiStatus": "Complete",
            "boTransId": "F2166100329",
            "arn": "0000000000000000002E",
            "fee": 0,
            "balance": 18.5,
            "lastDepositAmount": 0,
            "ledgerBalance": 18.5,
            "dtsCreatedAt": "2023-11-12T23:07:09.125Z"
        }
    ],
    "requestId": "7378221094ad11eea89d7100487c0512"
}