Reissue Card

Request URL

POST /ibis/card/reissue

Description

Use this endpoint to reissue a specified card. A card can be reissued with the existing card number (in cases such as when the expiration date is updated), or the card can be reissued using a new card number (in cases such as if the card has been lost or stolen).

Reissue Codes

reasonCode Value	reissueType Value	cardShippingMethodId Value
"1" - Damaged	"1" - same card number with same profile	"1" - Normal shipment (default)
"2" - Expired	"2" - same card number with updated expiration	"2" - Urgent shipment
"3" - Lost/Stolen	"3" - new card number with existing profile	"3" - VIP shipment
"4" - Fraud/Compromised
"5" - Return
"6" - New Enrollment

Schema

Property table for ibis/card/reissue

Property	Description	Required	Schema
customerId	Customer ID in connectFi	Yes	{ "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "description": "common-id" }
cFiCardId	The card ID in connectFi	Yes	{ "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "description": "common-id" }
profile	An object containing profile details	No	ibisFacade syncProfile object
reference	An external alphanumeric reference ID for the entity in your system	Yes	{ "type": "string", "pattern": "^[0-9a-zA-Z]+$", "minLength": 1, "maxLength": 32, "description": "common-reference" }
reissueType	The type of reissue, allowed reissue types are dependent on card program permissions	Yes	{ "type": "string", "enum": [ "1", "2", "3" ] }
reasonCode	The reason for the reissue, allowed reason codes are dependent on card program permissions	Yes	{ "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ] }
cardShippingMethodId	The shipping method for the new card, '1' is default	No	{ "type": "string", "nullable": true, "enum": [ "1", "2", "3" ] }
activateNewCard	If 'Y', the new card will be activated upon reissue, 'N' is default	No	{ "type": "string", "enum": [ "Y", "N" ], "description": "ibis-ibisBoolean" }

Property table for ibisFacade syncProfile object

Property	Description	Required	Schema
cardHolderId	An ID for the cardholder (required for business card holders only, nullable for individual customers). Must match customerId if included for individual customers.	No	{ "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "nullable": true, "description": "common-idNullable" }
cardHolderType	The type of card holder (required for business account holders only, nullable for individual customers). The value 'representative' indicates that this account holder is categorized as a business representative of the business customer. The value 'individual' indicates that this account holder is either an individual customer or an employee of a business customer, but is not categorized as a business representative.	No	{ "type": "string", "enum": [ "representative", "individual" ] }

Request Body

{
    "cFiCardId" : "icrd_48gpHBNE4pF7GH1AXHXsrw",
    "reference": "extReI137",
    "profile": {
        "email": "newemail1@test.email"
    },
    "reissueType": "1",
    "reasonCode": "3",
    "cardShippingMethodId": "1",
    "activateNewCard": "N"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "cFiCardId" : "icrd_48gpHBNE4pF7GH1AXHXsrw",
    "reference": "extReI137",
    "profile": {
        "email": "newemail1@test.email"
    },
    "reissueType": "1",
    "reasonCode": "3",
    "cardShippingMethodId": "1",
    "activateNewCard": "N"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/ibis/card/reissue',
  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/reissue" --data "{\"cFiCardId\": \"icrd_48gpHBNE4pF7GH1AXHXsrw\",   \"reference\":\"extReI137\",   \"profile\":{        \"email\":\"newemail1@test.email\"    },   \"reissueType\":\"1\",   \"reasonCode\":\"3\",   \"cardShippingMethodId\":\"1\",   \"activateNewCard\":\"N\"}" --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_575fma7wGFKTgSx537PMcO",
    "reference": "extReI138",
    "profile": {
        "email": "newemail1@test.email"
    },
    "reissueType": "1",
    "reasonCode": "1",
    "cardShippingMethodId": "1",
    "activateNewCard": "N"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "cFiCardId": "icrd_575fma7wGFKTgSx537PMcO",
        "cFiStatus": "Complete",
        "customerId": "cstap_7uvAC6nLftLGCq7yic3TfI",
        "cFiAggregatorId": "CLIENTID",
        "reference": "extCrd171121413",
        "memberNumber": "cstcp_2WZ7ariGgrtumtUlD452LM",
        "cardProgramId": "d_gpr_test",
        "programType": "debit",
        "boReferenceId": "110195634020706",
        "boCustomerId": "110000001956340207",
        "vAccountNumber": "1234567890123456",
        "abaRoutingNumber": "122244184",
        "dtsCreatedAt": "2023-10-30T20:19:40.990Z",
        "transId": "F2166100401",
        "fee": 0,
        "balance": 20,
        "lastDepositAmount": 0,
        "ledgerBalance": 0
    },
    "requestId": "b2d4739081b711ee9b7427220cc6c212"
}