Get Auth Data

Request URL

POST /ibis/card/get-auth-data

Description

Use this endpoint to retrieve the CVV/CVC card security code for the specified card. The connectFi API uses tokenization to redact the CVV/CVC card security code while in our system and does not store the security code or card PAN at any point. It is your (the client's) responsibility to ensure that sensitive card data is redacted when being handled in your system.

Schema

Property table for ibis/card/get-auth-data

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" }

Request Body

{
 "cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
 "cFiCardId": "icrd_1qaR2QEPXIRKr4jOyjQkTw"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/ibis/card/get-auth-data',
  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/get-auth-data" --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

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"
}

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",
        "cvv2": "123",
        "status": {
            "code": "B",
            "description": "Open - All Transactions Allowed"
        },
        "expiryDate": "062027",
        "transitionFlag": "N",
        "fee": 0,
        "balance": 0,
        "lastDepositAmount": 0,
        "ledgerBalance": 0
    },
    "requestId": "d6609da081af11ee9b7427220cc6c212"
}