Status
Request URL
POST /ibis/card/status
Description
Use this endpoint to check the status of a card or vAccount created with /ibis. A successful request will return the available details for the requested card/vAccount. Either the cFiCardId or the reference ID can be used to request the card status, but not both in the same request. When using this endpoint with a vAccount only account, use the issued cFiAccountId as the value for the cFiCardId property.
Schema
Property table for schema 1 for ibis/card/status
Property | Description | Required | Schema |
---|---|---|---|
cFiCardId | The card 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/card/status
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" } |
Request Body
Snippet Examples
javascript
const axios = require('axios');
const data = {
"cFiCardId" : "icrd_1qaR2QEPXIRKr4jOyjQkTw"
};
const config = {
method: 'POST',
url: '${CONNECTFI_BASE_URL}/ibis/card/status',
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/card/status" --data "{\"cFiCardId\": \"icrd_1qaR2QEPXIRKr4jOyjQkTw\"}" --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 CFICARDID
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": {
"cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw",
"cFiStatus": "Complete",
"customerId": "cstap_7uvAC6nLftLGCq7yic3TfI",
"cFiAggregatorId": "CLIENTID",
"reference": "extIDCrd100",
"memberNumber": "cstcp_2WZ7ariGgrtumtUlD452LM",
"cardProgramId": "d_gpr_test",
"programType": "debit",
"boReferenceId": "110195634081158",
"boCustomerId": "110000001956340811",
"vAccountNumber": "1234567890123456",
"abaRoutingNumber": "122244184",
"dtsCreatedAt": "2023-11-01T18:05:04.208Z",
"isBadPinTriesExceeded": "N",
"status": {
"code": "B",
"description": "Open - All Transactions Allowed"
},
"transitionFlag": "N",
"isOfflinePinTryLimitExceeded": "N",
"fee": 0,
"balance": 0,
"lastDepositAmount": 0,
"ledgerBalance": 0
},
"requestId": "bfde707081af11ee9b7427220cc6c212"
}
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
RESPONSE BODY
{
"code": "0",
"data": {
"cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw",
"cFiStatus": "Complete",
"customerId": "cstap_7uvAC6nLftLGCq7yic3TfI",
"cFiAggregatorId": "CLIENTID",
"reference": "extIDCrd100",
"memberNumber": "cstcp_2WZ7ariGgrtumtUlD452LM",
"cardProgramId": "d_gpr_test",
"programType": "debit",
"boReferenceId": "110195634081158",
"boCustomerId": "110000001956340811",
"vAccountNumber": "1234567890123456",
"abaRoutingNumber": "122244184",
"dtsCreatedAt": "2023-11-01T18:05:04.208Z",
"isBadPinTriesExceeded": "N",
"status": {
"code": "B",
"description": "Open - All Transactions Allowed"
},
"transitionFlag": "N",
"isOfflinePinTryLimitExceeded": "N",
"fee": 0,
"balance": 10.5,
"lastDepositAmount": 0,
"ledgerBalance": 21
},
"requestId": "ad844be094a411eea89d7100487c0512"
}