Card Replacement
You can manage the card reissue and replacement activities using CoreCard APIs. When an existing card is stolen, lost, or damaged, you can have the card replaced with the same or a different card number (as applicable) & expiry date using the API. If you want, you can charge the card replacement fee to the cardholder. The old card status is updated accordingly so that further transactions cannot be completed on the old card. You can also have the card reissued using the CoreCard API when it is near expiry. In this case, you can have the new card generated with the same number and new expiry date or a new number and new expiry date (refer CardStatusUpdateRequest API).
ReplacementCard
Action: POST
Endpoint: /api/ReplacementCard
Use this API to replace a card by marking it Lost/Stolen/Damage/Other/Re-Issue/Personalize and providing a replacement card by generating a new card or using a preprinted card from inventory.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CardNumber string Conditional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 16 |
AccountNumber string Conditional |
Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 19 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 19 |
Reason string Mandatory |
Reason for card replacement Valid values: 1 = Stolen 2 = Lost 3 = Damage 4 = Other 5 = Reissue 6 = Personalize 11 = Issue Physical Card Example : 2 Allowable Values: 2 |
DecisionFlag string Mandatory |
Used for performing various operations when respective flag values defined below are passed. Valid values: 0 = Do not Generate new Embossing 1 = Generate New Embossing Note: When 'Reason' = 5 (Reissue) then Value of DecisionFlag would be '0' Allowable Values: 2 |
CardFee Int32 Optional |
Flag to Decide Fee should be charged or not 1 = fee should be charged 0 = fee should not be charged. |
DeliveryMechanism string Mandatory |
Description:Shipment delivery mechanism. By Default Setting must be for standard Delivery Valid Values: 0-9 Example: 0 = Standard , 1 = Priority, 2 = Overnight 3 = USPS Mail (First Class) 4 = FedEx Economy 5 = 2nd business day Allowable Values: 40 |
CardType Int32 Mandatory |
Type of card Valid Values : 0 = Card from Shelf 1 = Print New Card Condition: Required, if value of DecisionFlag tag is 1 |
NewCardNumber string Conditional |
Card Number of New/Personalized card. Ex: *********1234567[For Compliance masked BIN and Extended BIN] Valid values are 0-9 Clear Card Number Condition: NewCardNumber is required, if value of CardType tag is 0. Allowable Values: 16 |
NameOnCard string Conditional |
Name to be Embossed on Card Valid values are A-Z, a-z, 0-9. Example: Hudson M Charles Condition: Mandatory when setup is Automatic/Mandatory Allowable Values: 28 |
IsCardMasked string Optional |
This tag indicates whether CardNumber should be returned in masked form or in clear form. Valid Values: 0= Card Number without Masked in Resonse. 1= Card Number with Masked in Resonse. 2= No Card Number in Resonse. Condition:If No value is given then by default it returns Card Number with Masked in Response. Allowable Values: 1 |
MemoFlag string Conditional |
Possible Values: 1:Card Replacement on Legitimate Address 0:Card Replacement on Fraudulent Address Example : 1 Condition : when On Product, ReplaceWarningChangeAddr not null or zero and DecisionFlag = 1 and ReissueReason = 1 or 2 Allowable Values: 1 |
MemoDesc string Conditional |
Description for Memo Condition : when On Product, ReplaceWarningChangeAddr not null or zero and DecisionFlag = 1 and ReissueReason = 1 or 2 Allowable Values: 2000 |
ShippingAddressFlag string Conditional |
Decision flag to select Shipping Address Valid Values: '0' Ship to Existing Address '1' Ship to Other Address Example: 1 Condition: When Reason = 1 or 2 and DecisionFlag = 0 it will become optional else mandatory Allowable Values: 1 |
ShipToFirstName string Optional |
First Name for Shipping address Valid Values: A-Z,a-z. Example: TestName Condition:It is mandatory when value of ShippingAddressFlag =1 Allowable Values: 50 |
ShipToMiddleName string Optional |
Middle Name for Shipping address Valid Values: A-Z,a-z. Example: MName Allowable Values: 50 |
ShipToLastName string Optional |
Last Name for Shipping address Valid Values: A-Z,a-z. Example: LastName Condition:It is mandatory when value of ShippingAddressFlag =1 Allowable Values: 50 |
ShipToAddressLine1 string Conditional |
Address Line 1 for Shipping address Valid values:A-Z, a-z, 0-9 Example: 1 Meca Way Condition:It is mandatory when value of ShippingAddressFlag =1 Allowable Values: 50 |
ShipToAddressLine2 string Optional |
Address Line 2 for Shipping address Valid values:A-Z, a-z, 0-9 Example:15 Penang Street Point Allowable Values: 50 |
ShipToCity string Conditional |
City for Shipping address Valid values:A-Z, a-z, 0-9 Example:Norcross Condition:It is mandatory when value of ShippingAddressFlag =1 Allowable Values: 25 |
ShipToState string Conditional |
State for Shipping address Valid Values:A-Z,a-z Example:NY Condition:It is mandatory when value of ShippingAddressFlag =1 Refer Appendix Section: State Codes (US) Allowable Values: 3 |
ShipToPostalCode string Conditional |
ZIP code for Shipping address Valid values:A-Z, a-z,0-9 Example: 30093 Condition:It is mandatory when value of ShippingAddressFlag =1 Allowable Values: 10 |
ShipToCountry string Conditional |
Country Code for Shipping address Valid values are A-Z, a-z Example: US Condition:It is mandatory when value of ShippingAddressFlag =1 Refer Appendix Section : Country Code Values Allowable Values: 2 |
HoldEmbossing Int32 Optional |
Tag to decide physical card or virtual card by holding embossing file. Valid Values: 0 - No (Physical card) 1 - Yes (Virtual card) Note : field will be ignored with reason = 11 |
Sample Request Body
{ "APIVersion": "1.4", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "CardNumber": "4066850001000935", "AccountNumber": "", "ProxyNumber": "1316728", "Reason": "1", "DecisionFlag": "1", "CardFee": 120, "DeliveryMechanism": "1", "CardType": 1, "NewCardNumber": "", "NameOnCard": "", "IsCardMasked": "1", "MemoFlag": "1", "MemoDesc": "Stolen", "ShippingAddressFlag": "", "ShipToFirstName": "", "ShipToMiddleName": "", "ShipToLastName": "", "ShipToAddressLine1": "", "ShipToAddressLine2": "", "ShipToCity": "", "ShipToState": "", "ShipToPostalCode": "", "ShipToCountry": "", "HoldEmbossing": 1 }
Response Fields Detail
Fields | Description |
---|---|
CardNumber string |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Allowable Values: 16 |
ProxyNumber string |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Allowable Values: 19 |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "CardNumber": "406683******6085", "ProxyNumber": "1316756" } }
SSCardReplacement
Action: POST
Endpoint: /api/SSCardReplacement
Use this API when customer wants to mark his card Lost/Stolen/Damage/Other.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CardNumber string Conditional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number is required. Allowable Values: 16 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number is required. Allowable Values: 19 |
CardStatus string Mandatory |
Card Plastic Status Example : New Card Pending Activation Allowable Values: 10 |
DateOfCardLostStolen string Optional |
Date On which card is Lost or stolen Format:yyyymmdd Example : 20190227 Allowable Values: 8 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CardNumber": "", "ProxyNumber": "1321478", "CardStatus": "Lost", "DateOfCardLostStolen": "20210816" }
Response Fields Detail
Fields | Description |
---|---|
NewCardNumber string |
Clear Card Number of the New card Valid values: 0-9 Example: 123456******0001 |
AccessToSS string |
Self Service Access present or not when the card is marked as Lost or stolen. valid values YES or NO Example = Yes |
HeaderCall string |
Call center number to be displayed in header |
ProductEmailId string |
E-mail id of the Product. Example : customerservice@cnb-enid.com |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "NewCardNumber": "", "AccessToSS": "YES", "HeaderCall": "", "ProductEmailId": "kratika.shrivastava@corecard.com" } }