Activate Card
Request URL
POST /ibis/card/activate
Description
Use this endpoint to activate a card or vAccount created with /ibis. A successful request will activate the card or vAccount and return the relevant details for the card. When using this endpoint with a vAccount only account, use the issued cFiAccountId as the value for the cFiCardId property.
An /ibis/card/activate
request can successfully be made for cards/vAccounts with the following status values: "A" (Pre-Active), "S" (OFF), "I". (Inactive)
Schema
Property table for ibis/card/activate
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" } |
attributes | An object containing attributes | No | attributes object |
Property table for attributes object
Property | Description | Required | Schema |
---|---|---|---|
cardExpDate | The card expiration date in MMYY format | No | { "nullable": true, "type": "string", "pattern": "^\d{4}$" } |
Request Body
Snippet Examples
javascript
const axios = require('axios');
const data = {
"cFiCardId" : "icrd_575fma7wGFKTgSx537PMcO"
};
const config = {
method: 'POST',
url: '${CONNECTFI_BASE_URL}/ibis/card/activate',
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/activate" --data "{\"cFiCardId\": \"icrd_575fma7wGFKTgSx537PMcO\"}" --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 ACTIVATING DEBIT CARD
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",
"expiryDate": "112026",
"cardReferenceId": "110195634081158",
"maaSubUnSubRespDesc": "Approved",
"transId": "F2166100322",
"fee": 0,
"balance": 0,
"lastDepositAmount": 0,
"ledgerBalance": 0
},
"requestId": "3c8bc6b081ae11ee9b7427220cc6c212"
}
200 SUCCESSFUL RESPONSE ACTIVATING CREDIT CARD
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_5jp4oVmXTH9siQNTouZ7vY",
"cFiStatus": "Complete",
"customerId": "cstap_7uvAC6nLftLGCq7yic3TfI",
"cFiAggregatorId": "CLIENTID",
"reference": "ExtRefICC100",
"memberNumber": "cstcp_2WZ7ariGgrtumtUlD452LM",
"cardProgramId": "Evolve_Test",
"programType": "credit",
"boReferenceId": "333219449753",
"boCustomerId": "333000000002194497",
"vAccountNumber": "1234567890123456",
"abaRoutingNumber": "121182810",
"dtsCreatedAt": "2023-11-01T18:01:29.193Z",
"expiryDate": "112026",
"cardReferenceId": "333219449753",
"maaSubUnSubRespDesc": "Approved",
"transId": "F12696119",
"fee": 0,
"balance": 0,
"lastDepositAmount": 0,
"ledgerBalance": 0
},
"requestId": "b8d26490bb8311eeaa76ffd7d3224a12"
}
200 SUCCESSFUL RESPONSE ACTIVATING VACCOUNTONLY ACCOUNT
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_7bCpK7s3qeH5OEQqmljYYy",
"cFiStatus": "Complete",
"customerId": "cstap_6reGTr3k8vpAu8uFV7EdiN",
"cFiAggregatorId": "CLIENTID",
"reference": "extIvAccount200",
"memberNumber": "cstcp_6rcsxJFsPmkTYSPvaGPpQe",
"cardProgramId": "d_gpr_test",
"programType": "vAccountOnly",
"boReferenceId": "110195638888030",
"boCustomerId": "110000001956388880",
"vAccountNumber": "1234567890123456",
"abaRoutingNumber": "122244184",
"dtsCreatedAt": "2024-01-18T14:57:38.802Z",
"expiryDate": "012027",
"cardReferenceId": "110195638888030",
"maaSubUnSubRespDesc": "Approved",
"transId": "F2166324896",
"fee": 0,
"balance": 0,
"lastDepositAmount": 0,
"ledgerBalance": 0
},
"requestId": "6da7c750b61311eeaa76ffd7d3224a12"
}