Card Management
When a card is issued to an account holder, various operations can be performed on an account and the card. Using CoreCard APIs, you can activate the card, register the card for online payments, define your spending limit, block the card, reissue or replace the card in case of loss/theft/damage, apply for a status, retrieve a card, and account holders data. You can also have the card number tokenized for a digital wallet using API.
When a card account is created in the CoreCard system, the card does not need to be printed. You can use CoreCard API to request a hold on the card printing so that only the digital card number will be generated.
Get Card Details
Action: POST
Endpoint: /api/CoreCredit/CardManagement/GetCardDetails
Use this API to retrieve details of the card by providing the account\admin number and card sequence number in input. Details like card limit, expiry date, manual status, card type, etc. are returned.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AccountNumber string Conditional |
Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Allowable Values: 19 |
AdminNumber int64 Conditional |
Admin number. Valid Values: 0-9 Example: 12345 Condition: Either of AdminNumber or AccountID is required. |
AccountID integer Conditional |
This tag reflects the Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values: 0-9 Example: 12345 Condition: Either of AdminNumber or AccountID is required. |
CardSequenceNumber integer Optional |
This tag reflects the Sequence Number of the Card. Valid Values: 0-9 Example: 2 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AccountNumber": "9000000900001547", "AdminNumber": 100720, "AccountID": null, "CardSequenceNumber": null }
Response fields detail
Fields | Description |
---|---|
EmbossingGroup
|
This is a group of Embossing related fields. |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "EmbossingGroup": { "AdminNumber": 100720, "CardExpirationDate": "01/2024", "PendingCardExpirationDate": null, "CardSequenceNumber": 1, "VirtualCardLimit": 0.0, "VirtualCardAvailableLimit": 0.0, "PINAttempts": 0, "NameOnCard": "Alberta Charleson", "IssueStatus": "Activated", "CardType": "Primary Card", "CardActivationDate": "03/20/2019 00:00:00", "AccountNumber": "9000000900001547", "CancellationStatus": null, "DateIssued": "03/20/2024 00:00:00", "CustomerType": "Individual", "CardClosedDate": null, "ReissueReportDate": null, "PreissueReportDate": null, "SSNLast4Digits": "9008", "AssociatedAddress": "2992 Cameron Road, Malakoff, US 14236", "DateOfBirth": "06/25/1984 00:00:00", "HoldPlastic": null, "DeliveryMechanism": "Standard", "DeliveryDate": null, "TotalOutStandingAmount": 0.0, "TotalOutStandingCount": 0, "CashOutStandingAmount": 0.0, "CashOutStandingCount": 0, "PurchaseOutStandingAmount": 0.0, "PurchaseOutStandingCount": 0, "ReturnOutStandingAmount": 0.0, "ReturnOutStandingCount": 0, "EmbossingManualStatus": 2, "EmbossingManualStatusText": "Active", "EmbossingGeneratedStatus": 2, "EmbossingGeneratedStatusText": "Active", "VirtualCardExpiryDate": null, "VirtualCardExpiryOptions": null, "VirtualCardLimitMethod": null, "UsageRestriction": "0", "CardActivationInvalidAttempts": 0, "AvailableDeliveryMechanisms": [ { "LutCode": "0", "LutDescription": "Standard" }, { "LutCode": "1", "LutDescription": "Priority" }, { "LutCode": "2", "LutDescription": "Overnight" } ], "SameAsParentAddress": null, "AllowReissueCancelledCard": false, "UserID": "100720", "AllowSecurityAnswerReset": 1, "AllowPasswordReset": 1, "TokenStatus": 1, "CardImageID": "abc123", "UniversalUniqueID": "df55eb4b-e2bd-42cf-8a91-c14f623a39c9", "ActivationCode": "123456", "AdditionalCardActivationCode": null, "RegistrationStatus": null, "UserStatus": 0, "AllowResetVirtualCardLimit": false, "NumberOfPINTry": 0, "AllowedTxnsOnVirtualCard": 0, "RemainingAllowedTxnOnVirtualCard": 0, "AllowResetTxnOnVirtualCard": false, "MaskedCardNumber": "525751XXXXXX9219", "AllowResetPINAttempts": false, "CustomerID": "76701", "ManualCardStatus": "Active" } } } }
Change PIN
Action: POST
Endpoint: /api/CoreCredit/CardManagement/ChangePin
Use this API to change the card PIN. The card number or admin number, along with new PIN and DOB, must be provided for the system to validate the request and store the new PIN upon successful validation.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
CardNumber string Conditional |
Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition: At least one of Card Number\Admin Number is required Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one of Card Number\Admin Number is required |
NewPIN string Mandatory |
New pin for the card. Allowable Values: 4 |
ConfirmPIN string Mandatory |
Confirmation of new pin. Allowable Values: 4 |
DateOfBirth datetime Mandatory |
Card Holder's Date of Birth. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 |
Sample request body
{ "Source": "Web", "IPAddress": null, "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.205.0.56", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "CardNumber": null, "AdminNumber": 5626, "NewPIN": "3256", "ConfirmPIN": "3256", "DateOfBirth": "01/01/1970 00:00:00" }
Response fields detail
Fields | Description |
---|---|
ResponseID string |
This number indicates that API responded.Response ID is unique.This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200 Allowable Values: 15 |
Sample response body
{ "application/json": { "Message": "Your PIN has been changed Successfully.", "Status": true, "ErrorCode": "ERR01096", "ResponseData": { "ResponseID": "56944623" } } }
Update Cardholder Information
Action: POST
Endpoint: /api/CoreCredit/CardManagement/UpdateCardholderInformation
This API allows updates to a cardholder's PII (personal identification information), address information, and additional information (if applicable).
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language == en: means use English ---- es: means Spanish Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required. |
AdminNumber int64 Conditional |
Admin number. Valid Values:0-9 Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required. |
HomePhoneNumber string Optional |
Card holder's Home Phone number. Valid Values:0-9 Example:7895463241 Allowable Values: 15 |
AddressLine1 string Optional |
Card Holder's address line 1. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50 |
AddressLine2 string Optional |
Card holder's address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Allowable Values: 50 |
City string Optional |
City name of the Card holder's address. Example:Los Angeles Allowable Values: 40 |
Country string Optional |
This tag reflects the Country code. Allowable Values: 3 |
State string Optional |
State of the card holder address. Example:Virginia Allowable Values: 40 |
PostalCode string Optional |
Postal code of the card holder address. Valid Values:0-9 Example:46206 Allowable Values: 9 |
ClientID integer Optional |
Client ID of the client. Valid Values: 1422245 Example: 5558547 |
FirstName string Optional |
Card holder's First name. Valid Values:A-Z Example:User1 Allowable Values: 50 |
MiddleName string Optional |
Card holder's Middle Name. Valid Values: A-Z Example: LEE Allowable Values: 50 |
LastName string Optional |
Card holder's last name. Valid Values:A-Z Example:Smith Allowable Values: 50 |
Title string Optional |
Title of the card holder. Format: A-Z Example:Mr Allowable Values: 9 |
WorkPhoneNumber string Optional |
Card holder's Work phone number. Valid Values:0-9 Example:5678909876 Allowable Values: 15 |
MobilePhoneNumber string Optional |
Card holder Mobile Phone Number. Valid Values:0-9 Example:987567757 Allowable Values: 20 |
EmailID string Optional |
Card holder's Email ID. Format:XXX@XXX.XXX Example:abc@gmail.com Condition: Email id is not mandatory but user can not set it blank if it is having some value in Core. But user can update with new.Email ID can not be duplicate between card holder’s. Allowable Values: 50 |
MobileCarrier string Optional |
Carrier of Mobile Phone number. Valid Values:a-z,0-9 Example: BSNL Allowable Values: 50 |
DateOfBirth datetime Optional |
Card Holder's Date of Birth. Format:MM/dd/YYYY Example:11/23/1980 |
SSN string Conditional |
Card holder's Social Security Number. Format:AAAGGSSSS Example::078051120 Allowable Values: 9 |
GovernmentID string Conditional |
Card holder's Government ID. Valid Values:A-Z Example:CDDT9741Q Allowable Values: 30 |
IDNumber string Conditional |
Card holder's Government ID Number. Format:AAAGGSSSS Example:078051120 Condition:This field is mandatory when government id type other than Other ID is used for cardholder identification. Allowable Values: 40 |
IDCountry string Conditional |
Country of Identification proof. Valid Values:a-z, 0-9 Example: Canada Condition:This field is mandatory when government id Type other than Other ID is used for cardholder identification.Two character country code should be passed in the request and not country name. Allowable Values: 5 |
IDState string Conditional |
Government identification issued state. Condition: GovernmentID issue state is mandatory, when Government id type is 'Drivers license' Or 'State ID' and ID issue country is US. Allowable Values: 50 |
IDIssueDate datetime Conditional |
Issue date of ID card. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: GovernmentID issue date is mandatory when governmentID type is 'Drivers license' and ID issue country is US and Id issue state is other than Massachusetts, Michigan, Missouri, Texas. |
IDExpirationDate datetime Conditional |
Government issued identification expiration date. Valid Values: MM/DD/YYYY Example: 02012020 Condition: This field is mandatory when government id type other than Other ID is used for cardholder identification. |
BankruptcyNotificationDate datetime Optional |
Date when bankruptcy is notified. Format: MM/dd/YYYY Example: 07/25/1991 Condition: Mandatory for bankruptcy account |
Education string Optional |
Educational details of the applicant Valid Values: a-z,0-9 Example: B.E Allowable Values: 50 |
Deceased integer Optional |
Flag for card holder is deceased or not Valid Values: 0,1 Example: 0 - No, 1 - Yes |
MaritalStatus integer Optional |
Card holder's Marital Status Valid Values: 0,1 Example: 0 - No, 1 - Yes |
LanguageIndicator string Optional |
Language indicator Allowable Values: 35 |
Gender string Optional |
Gender of card holder Valid Values: A-Z Example: Male Allowable Values: 5 |
SurnameSuffix string Optional |
Cardholder's surname-suffix Example:SR Allowable Values: 5 |
MotherMaidenName string Optional |
Card holder's mother Maiden Name Valid Values:a-z,0-9 Example:Johnson Allowable Values: 50 |
OtherPhoneNumber string Optional |
Card holder's other Phone Number Valid Values:0-9 Example:987567757 Allowable Values: 15 |
ResidenceType string Optional |
Type of Residince that cardholder lives in. Valid Values:A-Z Example:Own Allowable Values: 35 |
MonthsAtAddress integer Optional |
Duration on residence in months Valid Values: 0-9 Example:9 |
OptOutForEmailMarketing integer Optional |
Flag to Opt out for email marketing Valid Values: 0,1 Example: 0-no, 1-yes |
AdditionalAddressFirstName string Optional |
First Name provided in additional address section. Valid Values:A-Z, 0-9 Format: xxxx Example:abcd 01234 Allowable Values: 50 |
AdditionalAddressMiddleName string Optional |
Middle Name provided in additional address section. Valid Values: 0-9 A-Z Format: xxxx Example:abcd 01234 Allowable Values: 50 |
AdditionalAddressLastName string Optional |
Last Name provided in additional address section. Valid Values: 0-9 A-Z Format: xxxx Example:abcd 01234 Allowable Values: 50 |
AdditionalAddressLine1 string Optional |
Address line 1 of cardholder's additional address. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 40 |
AdditionalAddressLine2 string Optional |
Address line 2 of cardholder's additional address. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 40 |
AdditionalAddressCity string Optional |
City of cardholder's additional address Valid Values:a-z Format:XXXX Example: Atlanta Allowable Values: 40 |
AdditionalAddressState string Optional |
State of cardholder's additional address Valid Values:a-z Format:XXXX Example: Georgia Allowable Values: 5 |
AdditionalAddressCountry string Optional |
Country of cardholder's additional address Valid Values:a-z Example: France Allowable Values: 50 |
AdditionalAddressPhoneNumber string Optional |
Phone number of cardholder's additional address Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
AdditionalAddressEmailID string Optional |
Additional Address Email ID Valid Values: a-z Format: xx @xx.com Example:ABC @gmail.com Allowable Values: 50 |
POATitle string Optional |
Title of the POA Valid Values: Mr Example:Mr Allowable Values: 5 |
POAWorkPhone string Optional |
Work Phone of POA Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAWorkPhoneBadIndCo integer Optional |
Flag for bad phone for POA Valid Values: 0,1 Example: 0-no, 1-yes |
POAMI string Optional |
Middle name. Valid Values: a-z Allowable Values: 50 |
POAHomePhone string Optional |
POA Home Phone number Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAHomePhoneBadIndCo integer Optional |
Flag for bad home phone for POA Valid Values: 0,1 Example: 0-no, 1-yes |
POAFirstName string Optional |
Power Of Attorney First name. Valid Values:A-Z Example:User1 Allowable Values: 50 |
POAMobilePhone string Optional |
POA mobile Phone number Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAMobilePhoneBadIndCo integer Optional |
Flag for mobile number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
POALastName string Optional |
Power Of Attorney Last name. Valid Values:A-Z Example:User1 Allowable Values: 50 |
POAOtherPhonePhone string Optional |
POA other Phone number Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAOtherPhoneBadIndCo integer Optional |
flag for POA other number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
POALanguage string Optional |
Language indicatior for POA Valid Values: A-Z Example: French Allowable Values: 50 |
POAAlternatePhone string Optional |
POA alternate Phone number Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAAlternatePhoneBadIndCo integer Optional |
Flag for POA Alternate number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
POAEmailAddress string Optional |
POA Email ID Valid Values: a-z Format: xx @xx.com Example:ABC @gmail.com Allowable Values: 50 |
POAFromTime1 string Optional |
Preferred time 1 to call POA contact Valid Values:0-9 Format:HHMMMSS Example: 120505 Allowable Values: 10 |
POAToTime1 string Optional |
Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000 Allowable Values: 10 |
POAFromTime2 string Optional |
Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000 Allowable Values: 10 |
POAToTime2 string Optional |
Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000 Allowable Values: 10 |
ConsumerInfoIndicator string Optional |
Customer related indications Valid Values: A-Z, 0-9 Example:2A = Lease Assumption Allowable Values: 150 |
HomePhoneBadIndicator integer Optional |
Flag for Home number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
MobilePhoneBadIndicator integer Optional |
Flag for Mobile number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
OthrPhoneBadIndicator integer Optional |
Flag for Other number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
WorkPhoneBadIndicator integer Optional |
Flag for Work number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
CeaseAndDesistIndicator integer Optional |
Flag for card holder Cease And Desist Valid Values: 0,1 Example: 0-no, 1-yes |
Bankruptcy integer Optional |
Flag for Bankruptcy Valid Values:0,1 Example:0-no, 1-yes |
ThirdPDM integer Optional |
Third party debt management Valid Values: 0,1 Example: 0-no, 1-yes |
DoNotCallHomePhoneNUM integer Optional |
Flag for Do not call at home phone number Valid Values: 0,1 Example: 0-no, 1-yes |
DoNotCallMobileNUM integer Optional |
Flag for Do not call at Mobile phone number. Valid Values: 0,1 Example: 0-no, 1-yes |
DoNotCallWorkPhoneNUM integer Optional |
Flag for Do not call at work phone number Valid Values: 0,1 Example: 0-no, 1-yes |
DoNotCallOtherPhoneNUM integer Optional |
Flag for Do not call at other phone number Valid Values: 0,1 Example: 0-no, 1-yes |
CardNumber string Conditional |
This tag reflect the card number Valid Values:0-9 Example:1236547896541236 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required. Allowable Values: 19 |
NameOnCard string Optional |
Name to be print?ed on the card. Valid Values:a-z Example:John J Allowable Values: 50 |
HomeFaxNumber string Optional |
This tag reflects the Home Fax number Valid Values:0-9 Example:5678909876 Allowable Values: 19 |
AdditionalAddressPostalCode string Optional |
Postal Code of cardholder's additional address. Valid Values:46077 Example:46077 Allowable Values: 10 |
DeceasedNotificationDate datetime Conditional |
Date when deceased is notified Format:MM/DD/YYYY Example:02/20/2020 Condition: Mandatory for deceased account |
FraudVictim integer Optional |
Flag to identify any individual that is victim of Fraud Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required. |
AdminNumber int64 Conditional |
Admin number. Valid Values:0-9 Example:12345 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required. |
HomePhoneNumber string Optional |
Card holder's Home Phone number. Valid Values:0-9 Example:7895463241 Allowable Values: 15 |
AddressLine1 string Optional |
Card Holder's address line 1. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50 |
AddressLine2 string Optional |
Card holder's address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Allowable Values: 50 |
City string Optional |
City name of the Card holder's address. Example:Los Angeles Allowable Values: 35 |
Country string Optional |
This tag reflects the Country code. Allowable Values: 3 |
State string Optional |
State of the card holder address. Example:Virginia Allowable Values: 30 |
PostalCode string Optional |
Postal code of the card holder address. Valid Values:0-9 Example:46206 Allowable Values: 9 |
ClientID integer Optional |
Client ID of the client. Valid Values: 1422245 Example: 5558547 |
FirstName string Optional |
Card holder's First name. Valid Values:A-Z Example:User1 Allowable Values: 40 |
MiddleName string Optional |
Card holder's Middle Name. Valid Values: A-Z Example: LEE Allowable Values: 10 |
LastName string Optional |
Card holder's last name. Valid Values:A-Z Example:Smith Allowable Values: 40 |
Title string Optional |
Title of the card holder. Format: A-Z Example:Mr Allowable Values: 5 |
WorkPhoneNumber string Optional |
Card holder's Work phone number. Valid Values:0-9 Example:5678909876 Allowable Values: 15 |
MobilePhoneNumber string Optional |
Card holder Mobile Phone Number. Valid Values:0-9 Example:987567757 Allowable Values: 20 |
EmailID string Optional |
Card holder's Email ID. Format:XXX@XXX.XXX Example:abc@gmail.com Condition: Email id is not mandatory but user can not set it blank if it is having some value in Core. But user can update with new.Email ID can not be duplicate between card holder’s. Allowable Values: 50 |
MobileCarrier string Optional |
Carrier of Mobile Phone number. Valid Values:a-z,0-9 Example: BSNL Allowable Values: 50 |
DateOfBirth datetime Optional |
Card Holder's Date of Birth. Format:MM/dd/YYYY Example:11/23/1980 |
SSN string Conditional |
Card holder's Social Security Number. Format:AAAGGSSSS Example::078051120 Allowable Values: 9 |
GovernmentID string Conditional |
Card holder's Government ID. Valid Values:A-Z Example:CDDT9741Q Allowable Values: 30 |
IDNumber string Conditional |
Card holder's Government ID Number. Format:AAAGGSSSS Example:078051120 Condition:This field is mandatory when government id type other than Other ID is used for cardholder identification. Allowable Values: 40 |
IDCountry string Conditional |
Country of Identification proof. Valid Values:a-z, 0-9 Example: Canada Condition:This field is mandatory when government id Type other than Other ID is used for cardholder identification.Two character country code should be passed in the request and not country name. Allowable Values: 5 |
IDState string Conditional |
Government identification issued state. Condition: GovernmentID issue state is mandatory, when Government id type is 'Drivers license' Or 'State ID' and ID issue country is US. Allowable Values: 50 |
IDIssueDate datetime Conditional |
Issue date of ID card. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: GovernmentID issue date is mandatory when governmentID type is 'Drivers license' and ID issue country is US and Id issue state is other than Massachusetts, Michigan, Missouri, Texas. |
IDExpirationDate datetime Conditional |
Government issued identification expiration date. Valid Values: MM/DD/YYYY Example: 02012020 Condition: This field is mandatory when government id type other than Other ID is used for cardholder identification. |
BankruptcyNotificationDate datetime Optional |
Date when bankruptcy is notified. Format: MM/dd/YYYY Example: 07/25/1991 Condition: Mandatory for bankruptcy account |
Education string Optional |
Educational details of the applicant Valid Values: a-z,0-9 Example: B.E Allowable Values: 50 |
Deceased integer Optional |
Flag for card holder is deceased or not Valid Values: 0,1 Example: 0 - No, 1 - Yes |
MaritalStatus integer Optional |
Card holder's Marital Status Valid Values: 0,1 Example: 0 - No, 1 - Yes |
LanguageIndicator string Optional |
Language indicator Allowable Values: 35 |
Gender string Optional |
Gender of card holder Valid Values: A-Z Example: Male Allowable Values: 5 |
SurnameSuffix string Optional |
Cardholder's surname-suffix Example:SR Allowable Values: 5 |
MotherMaidenName string Optional |
Card holder's mother Maiden Name Valid Values:a-z,0-9 Example:Johnson Allowable Values: 50 |
OtherPhoneNumber string Optional |
Card holder's other Phone Number Valid Values:0-9 Example:987567757 Allowable Values: 15 |
ResidenceType string Optional |
Type of Residince that cardholder lives in. Valid Values:A-Z Example:Own Allowable Values: 35 |
MonthsAtAddress integer Optional |
Duration on residence in months Valid Values: 0-9 Example:9 |
OptOutForEmailMarketing integer Optional |
Flag to Opt out for email marketing Valid Values: 0,1 Example: 0-no, 1-yes |
AdditionalAddressFirstName string Optional |
First Name provided in additional address section. Valid Values:A-Z, 0-9 Format: xxxx Example:abcd 01234 Allowable Values: 50 |
AdditionalAddressMiddleName string Optional |
Middle Name provided in additional address section. Valid Values: 0-9 A-Z Format: xxxx Example:abcd 01234 Allowable Values: 50 |
AdditionalAddressLastName string Optional |
Last Name provided in additional address section. Valid Values: 0-9 A-Z Format: xxxx Example:abcd 01234 Allowable Values: 50 |
AdditionalAddressLine1 string Optional |
Address line 1 of cardholder's additional address. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 40 |
AdditionalAddressLine2 string Optional |
Address line 2 of cardholder's additional address. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 40 |
AdditionalAddressCity string Optional |
City of cardholder's additional address Valid Values:a-z Format:XXXX Example: Atlanta Allowable Values: 40 |
AdditionalAddressState string Optional |
State of cardholder's additional address Valid Values:a-z Format:XXXX Example: Georgia Allowable Values: 5 |
AdditionalAddressPostalCode string Optional |
Postal Code of cardholder's additional address. Valid Values:46077 Example:46077 Allowable Values: 10 |
AdditionalAddressCountry string Optional |
Country of cardholder's additional address Valid Values:a-z Example: France Allowable Values: 50 |
AdditionalAddressPhoneNumber string Optional |
Phone number of cardholder's additional address Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
AdditionalAddressEmailID string Optional |
Additional Address Email ID Valid Values: a-z Format: xx @xx.com Example:ABC @gmail.com Allowable Values: 50 |
POATitle string Optional |
Title of the POA Valid Values: Mr Example:Mr Allowable Values: 5 |
POAWorkPhone string Optional |
Work Phone of POA Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAWorkPhoneBadIndCo integer Optional |
Flag for bad phone for POA Valid Values: 0,1 Example: 0-no, 1-yes |
POAMI string Optional |
Middle name. Valid Values: a-z Allowable Values: 50 |
POAHomePhone string Optional |
POA Home Phone number Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAHomePhoneBadIndCo integer Optional |
Flag for bad home phone for POA Valid Values: 0,1 Example: 0-no, 1-yes |
POAFirstName string Optional |
Power Of Attorney First name. Valid Values:A-Z Example:User1 Allowable Values: 50 |
POAMobilePhone string Optional |
POA mobile Phone number Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAMobilePhoneBadIndCo integer Optional |
Flag for mobile number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
POALastName string Optional |
Power Of Attorney Last name. Valid Values:A-Z Example:User1 Allowable Values: 50 |
POAOtherPhonePhone string Optional |
POA other Phone number Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAOtherPhoneBadIndCo integer Optional |
flag for POA other number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
POALanguage string Optional |
Language indicatior for POA Valid Values: A-Z Example: French Allowable Values: 50 |
POAAlternatePhone string Optional |
POA alternate Phone number Valid Values:0-9 Example:7895463214 Allowable Values: 12 |
POAAlternatePhoneBadIndCo integer Optional |
Flag for POA Alternate number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
POAEmailAddress string Optional |
POA Email ID Valid Values: a-z Format: xx @xx.com Example:ABC @gmail.com Allowable Values: 50 |
POAFromTime1 string Optional |
Preferred time 1 to call POA contact Valid Values:0-9 Format:HHMMMSS Example: 120505 Allowable Values: 10 |
POAToTime1 string Optional |
Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000 Allowable Values: 10 |
POAFromTime2 string Optional |
Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000 Allowable Values: 10 |
POAToTime2 string Optional |
Preffered time to call POA contact Valid Values:1215090000 Format:MMDDHHMMSS Example:1215090000 Allowable Values: 10 |
ConsumerInfoIndicator string Optional |
Customer related indications Valid Values: A-Z, 0-9 Example:2A = Lease Assumption Allowable Values: 150 |
HomePhoneBadIndicator integer Optional |
Flag for Home number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
MobilePhoneBadIndicator integer Optional |
Flag for Mobile number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
OthrPhoneBadIndicator integer Optional |
Flag for Other number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
WorkPhoneBadIndicator integer Optional |
Flag for Work number bad phone Valid Values: 0,1 Example: 0-no, 1-yes |
CeaseAndDesistIndicator integer Optional |
Flag for card holder Cease And Desist Valid Values: 0,1 Example: 0-no, 1-yes |
Bankruptcy integer Optional |
Flag for Bankruptcy Valid Values:0,1 Example:0-no, 1-yes |
ThirdPDM integer Optional |
Third party debt management Valid Values: 0,1 Example: 0-no, 1-yes |
DoNotCallHomePhoneNUM integer Optional |
Flag for Do not call at home phone number Valid Values: 0,1 Example: 0-no, 1-yes |
DoNotCallMobileNUM integer Optional |
Flag for Do not call at Mobile phone number. Valid Values: 0,1 Example: 0-no, 1-yes |
DoNotCallWorkPhoneNUM integer Optional |
Flag for Do not call at work phone number Valid Values: 0,1 Example: 0-no, 1-yes |
DoNotCallOtherPhoneNUM integer Optional |
Flag for Do not call at other phone number Valid Values: 0,1 Example: 0-no, 1-yes |
CardNumber string Conditional |
This tag reflect the card number Valid Values:0-9 Example:1236547896541236 Condition:At least one of CardNumber/AdminNumber/AccountNumber/AccountID is required. Allowable Values: 19 |
NameOnCard string Optional |
Name to be print?ed on the card. Valid Values:a-z Example:John J Allowable Values: 50 |
HomeFaxNumber string Optional |
This tag reflects the Home Fax number Valid Values:0-9 Example:5678909876 Allowable Values: 19 |
DeceasedNotificationDate datetime Conditional |
Date when deceased is notified Format:MM/DD/YYYY Example:02/20/2020 Condition: Mandatory for deceased account |
FraudVictim integer Optional |
Flag to identify any individual that is victim of Fraud Valid Values: 0,1 Format: x Example: 0-no, 1-yes |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": "840", "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AccountID": 21991, "AdminNumber": 24429, "HomePhoneNumber": null, "AddressLine1": "test", "AddressLine2": null, "City": "AK", "Country": "US", "State": "AK", "PostalCode": "85645", "ClientID": null, "FirstName": "Test", "MiddleName": "H", "LastName": "Test", "Title": "03", "WorkPhoneNumber": null, "MobilePhoneNumber": null, "EmailID": null, "MobileCarrier": null, "DateOfBirth": null, "SSN": null, "GovernmentID": null, "IDNumber": null, "IDCountry": null, "IDState": null, "IDIssueDate": null, "IDExpirationDate": null, "BankruptcyNotificationDate": null, "Education": null, "Deceased": null, "MaritalStatus": null, "LanguageIndicator": null, "Gender": null, "SurnameSuffix": "II", "MotherMaidenName": null, "OtherPhoneNumber": null, "ResidenceType": null, "MonthsAtAddress": null, "OptOutForEmailMarketing": null, "AdditionalAddressFirstName": null, "AdditionalAddressMiddleName": null, "AdditionalAddressLastName": null, "AdditionalAddressLine1": null, "AdditionalAddressLine2": null, "AdditionalAddressCity": null, "AdditionalAddressState": null, "AdditionalAddressPostalCode": null, "AdditionalAddressCountry": null, "AdditionalAddressPhoneNumber": null, "AdditionalAddressEmailID": null, "POATitle": null, "POAWorkPhone": null, "POAWorkPhoneBadIndCo": null, "POAMI": null, "POAHomePhone": null, "POAHomePhoneBadIndCo": null, "POAFirstName": null, "POAMobilePhone": null, "POAMobilePhoneBadIndCo": null, "POALastName": null, "POAOtherPhonePhone": null, "POAOtherPhoneBadIndCo": null, "POALanguage": null, "POAAlternatePhone": null, "POAAlternatePhoneBadIndCo": null, "POAEmailAddress": null, "POAFromTime1": null, "POAToTime1": null, "POAFromTime2": null, "POAToTime2": null, "ConsumerInfoIndicator": null, "HomePhoneBadIndicator": null, "MobilePhoneBadIndicator": null, "OthrPhoneBadIndicator": null, "WorkPhoneBadIndicator": null, "CeaseAndDesistIndicator": null, "Bankruptcy": null, "ThirdPDM": null, "DoNotCallHomePhoneNUM": null, "DoNotCallMobileNUM": null, "DoNotCallWorkPhoneNUM": null, "DoNotCallOtherPhoneNUM": null, "CardNumber": null, "NameOnCard": null, "HomeFaxNumber": null, "DeceasedNotificationDate": null, "FraudVictim": null }
Response fields detail
Fields | Description |
---|---|
AccountNumber string |
This tag reflects the account number. Valid Values:0-9 Example:8000000000000037 Allowable Values: 19 |
AccountNumber string |
This tag reflects the account number. Valid Values:0-9 Example:8000000000000037 Allowable Values: 19 |
Sample response body
{ "application/json": { "Message": "Card Updated Successfully", "Status": true, "ErrorCode": "Msgcu01", "ResponseData": { "AccountNumber": "0000000010048695" } } }
Update Embossing Manual Status
Action: POST
Endpoint: /api/CoreCredit/CardManagement/UpdateEmbossingManualStatus
Use this API to update the plastic card's status by providing a card number or admin number. The API allows marking a plastic card's status as closed, fraud, inactive, or blocked.
Note
This API should not be used to mark card status as lost or stolen.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Mandatory |
Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Example: 12345 |
EmbossingManualStatus integer Mandatory |
Manual status of card. Please refer to Appendix file section 5.21 (Card/Account Statuses) for a list of valid codes and values. Example: 2 - Active, 3 - Delinquent, 4 - Overlimit, 7 - Fraud, 10 - Blocked, 11 - Closed |
Sample request body
{ "Source": "WEB", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AdminNumber": 129329, "EmbossingManualStatus": 2 }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Embossing Manual Status has been changed successfully", "Status": true, "ErrorCode": "ERR01018", "ResponseData": null } }
Update Shipping Address
Action: POST
Endpoint: /api/CoreCredit/CardManagement/UpdateShippingAddress
Use this API to update the shipping address and physical card delivery options on an existing customer record. CoreCARD uses the shipping address and delivery options when a physical card is to be delivered to a cardholder.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Mandatory |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:12345 |
CardSequenceNumber integer Mandatory |
Card Sequence Number.Physical Card order can be uniquely identify by combination of Admin Number and Card Sequence Number. Valid Values:0-9 Example: 1 |
ShippingAddressLine1 string Mandatory |
Shipping address line 1. Example: 2354 Main road Allowable Values: 50 |
ShippingAddressLine2 string Mandatory |
Shipping address line 2. Example:xyz Avenue Allowable Values: 50 |
ShippingCity string Mandatory |
Shipping address city name. Example: chicago Allowable Values: 25 |
ShippingState string Mandatory |
Sate of the shipping address. Example:AK(Alaska) Allowable Values: 5 |
ShippingCountry string Mandatory |
Shipping address Country name. Example:US(United States) Allowable Values: 5 |
ShippingPostalCode string Mandatory |
Zip code of the shipping address. Example:12345 Allowable Values: 10 |
NameOnCard string Mandatory |
Name to be Embossed on Card. Example: John K Peter Allowable Values: 50 |
IsPermanentAddress integer Mandatory |
Flag to mark permanent address same as mailing address. Valid Values: 0 - No, 1- Yes Example: 1 |
DeliveryMechanism string Mandatory |
Shipment delivery mechanism. Valid Values: 0 = Standard 1 = Priority 2 = Overnight Example: 0 Allowable Values: 9 |
Sample request body
{ "Source": "Web", "IPAddress": null, "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.205.0.56", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AdminNumber": 129427, "CardSequenceNumber": 1, "ShippingAddressLine1": "145 Stree 1", "ShippingAddressLine2": "Park Avenue", "ShippingCity": "Chicago", "ShippingState": "AK", "ShippingCountry": "US", "ShippingPostalCode": "12345", "NameOnCard": "John k Peter", "IsPermanentAddress": 1, "DeliveryMechanism": "0" }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": null } }
Card Status Update Request
Action: POST
Endpoint: /api/CoreCredit/CardManagement/CardStatusUpdateRequest
The purpose of this API is to update the card status if any report found for lost or stolen. The same API is getting used for hole embossing.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language == en: means use English ---- es: means Spanish Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
Reason integer Mandatory |
Reason to identify why we are requesting card replacement. Possible Values: 1- Stolen 2- Lost 3- Damaged(Status will be marked Closed) 9- ReIssue 10- Breach 11- Other 13- Physical Card Valid Values:0-9 Format:XX Example:1,9 |
DecisionFlag integer Mandatory |
Flag to decide if new card need to be generated with different card number or new plastic with same embossing information. 1- New card with different card number 0- New card with same embossing information. Valid Values: 0-9 Format:X Example:1,0 Allowable Values: 2 |
DeliveryMechanism string Conditional |
Shipment delivery mechanism. By Default Setting must be for standard Delivery and Usually overnight delivery involves card fee in credit environment. (2-Overnight, 1-Priority , 0-Standard) Valid Values: 0-9 Format:xxxx Example:0,1,2 Allowable Values: 9 |
CardFee integer Conditional |
Fee on Card Shipment. If the value is 1 then fees will be charged and if this is 0 then fees will not be charged. Valid Values: 0-1 Format:xxxx Example:0,1 Condition:Delivery Mechanism = 2(Overnight) then fees will always be charged |
InstantPersonalize string Optional |
This flag decides if we want to generate a new card or if want to personalize a card from stack. Valid Values: 0-9 Format:xxxx Example:0,1 Condition: Should be 1 when Decision Flag is 1 Allowable Values: 19 |
ShippingAddressFlag integer Optional |
This flag decides if we want to ship the new card to existing address or alternate address. Valid Values:0,1 Format:X Example:0,1 |
ShippingAddressCompanyName string Conditional |
Indicates Company Name for alternate address which need to be added, This is mandatory only when HoldEmbossing tag value is 0(NO) and AddressFlag as 1 Allowable Values: 40 |
ShippingAddressContactName string Conditional |
Indicates shipping Contact Name for alternate address which need to be added, This is mandatory only when HoldEmbossing tag value is 0(NO) and AddressFlag as 1. Valid Values: 0-9,A-z Format:xxxx Example:XYZ Allowable Values: 40 |
AdditionalAddressLine1 string Conditional |
Indicates shipping AddressLine1 for alternate address which need to be added, This is mandatory only when HoldEmbossing tag value is 0(NO) and AddressFlag as 1 Valid Values: 0 - 9, a-z Format: XXXXX Example: XYZ Allowable Values: 35 |
AdditionalAddressLine2 string Conditional |
Indicates shipping AddressLine2 for alternate address which need to be added, This is mandatory only when HoldEmbossing tag value is 0(NO), AddressFlag as 1 and Country selected as Non-US. Valid Values: 0 - 9, a-z Format: XXXXX Example: XYZ Allowable Values: 35 |
AdditionalAddressCity string Conditional |
Cardholder's City associated with additional address details Valid Values: 0-9 a-z Format:xxxx Example:kansas |
AdditionalAddressCountry string Conditional |
Cardholder's Country associated with additional address details Valid Values:0-9 a-z Format:xxxx Example:USA |
AdditionalAddressState string Conditional |
Cardholder's State/Province associated with additional address details Valid Values: 0-9 a-z Format: xxxx Example: CA |
AdditionalAddressPostalCode string Conditional |
Cardholder's PostalCode associated with additional address details. Valid Values:0-9 Format:xxxx Example:123456 |
CardImageID string Optional |
Based on this physical card’s art will be generate. Valid Values:0-9 Format:XX(String) Example:12 Allowable Values: 100 |
NameOnCard string Optional |
Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J Allowable Values: 50 |
NameOnTrack string Optional |
Name to be printed on the card. Valid Values:a-z Format:XXXX Example:John J Allowable Values: 50 |
ActivationCode string Optional |
At the time of Account creation/Registration user provide activation code, Present in Account Parameter accordion which is saved in EmbossingAccounts table. Valid Values: A-Z 0-9 Example: AB12345 Condition: This shall be a mandatory tag, if Card Activation Parameter on product is set as 'Activation Code'. Allowable Values: 50 |
HoldEmbossing integer Optional |
Hold Embossing indicator. Valid Values:1= YES, 0 = NO Format: X Example: 1 |
FirstName string Optional |
Card holder's First name. Valid Values:A-Z Format:XXXXX Example:User1 Allowable Values: 50 |
LastName string Optional |
Card holder's last name. Valid Values:A-Z Format:XXXXX Example:Smith Allowable Values: 50 |
MiddleName string Optional |
Card holder's Middle Name Valid Values: A-Z Format:XXX Example: LEE Allowable Values: 50 |
ReplacementOriginalCardStatus integer Optional |
Indicates the Status of the original card when request of card replacemnet is made. Possible values are : 1 = Close Existing Card Immediately 3 = Close Existing When New Card Is Activated Valid Values: 0 - 9, Format: X Example: 1,3 Condition: This shall be a mandatory tag, if Card Activation Parameter on product is set as Activation Code. |
ReplacementOriginalCardAction integer Optional |
Replacement Original Card Action Possible values are 1 = Cancel 2 = Closed Note : If we are not passing any value to this tag, then a default value = 1(Cancel) on this tag in the API. Valid Values: 0 - 9 Format: X Example: 1,2 |
Sample request body
[ { "in": "header", "name": "Authorization", "description": "access token", "required": true, "type": "string", "default": "Bearer " }, { "in": "body", "name": "body", "description": "CardStatusUpdateRequestModel.", "schema": { "$ref": "#/definitions/CardStatusUpdateRequestModel" } } ]
Response fields detail
Fields | Description |
---|
Sample response body
{ "200": { "description": "Success", "schema": { "$ref": "#/definitions/CardStatusUpdateResponseModelApiResult" }, "examples": { "application/json": { "Message": "Request accepted: Card reported as Lost / Stolen", "Status": true, "ErrorCode": "ERR01080", "ResponseData": { "AccountNumber": null, "AdminNumber": null, "ExpirationDate": null, "CVV": null, "ResponseID": null, "ManualCardStatus": null, "EmbossingManualStatus": null, "EmbossingGeneratedStatus": null, "CurrencySymbol": null } } } }, "VErr0045": { "description": "Please Select Card Status." }, "VErr0046": { "description": "Please Select Delivery Machanism." }, "VErr0047": { "description": "Please Select Card Number." }, "VErr0048": { "description": "Please Select Address Mode." }, "VErr0036": { "description": "Address Line 1 can not be left blank." }, "VErr0037": { "description": "City can not be left blank." }, "VErr0038": { "description": "Country can not be left blank." }, "VErr0039": { "description": "Postal Code can not be left blank." }, "VErr0040": { "description": "State can not be left blank." }, "Err00016": { "description": "System could not process your request at this time. Please try again." }, "Err00001": { "description": "Admin Number cannot be blank." }, "Err00027": { "description": "Decision Flag Cannot be blank." }, "ERR03043": { "description": "Invalid Account identifier input parameter(s)." }, "ERR01010": { "description": "Card replaced successfully." }, "ERR04025": { "description": "Card reported as Lost Or Stolen." }, "ERR02027": { "description": "Can not replace card." }, "ERR03033": { "description": "Generate Plastic not allowed." }, "ERR03184": { "description": "Status Definition not allowed." }, "ERR03161": { "description": "Outstanding Cards not allowed." }, "ERR04026": { "description": "Card Status is Already Marked As Lost/Stolen/Closed/Fraud." }, "ERR01505": { "description": "No eligible cards have been found to be reported as Lost/Stolen/Closed." }, "ERR04111": { "description": "There is no eligible card to replace." }, "ERR02029": { "description": "Card can not be reported as Lost/Stolen." }, "ERR04020": { "description": "Card does not have relevant data in authorization database." }, "ERR04000": { "description": "A new card will not be created because the Product's card number range is completed." }, "ERR04009": { "description": "Allow Card Re issuance on Lost/Stolen is set no on product." }, "ERR04024": { "description": "Card Replacement failed - CVC2 generation Error." }, "ERR04001": { "description": "Access Denied." }, "ERR02005": { "description": "Address Line 1 can not be left blank for Alternate Address." }, "ERR02039": { "description": "City is mandatory for Alternate Address." }, "ERR02166": { "description": "State is mandatory for Alternate Address." }, "ERR02057": { "description": "Country is mandatory for Alternate Address." }, "ERR02134": { "description": "Postal Code is mandatory for Alternate Address." }, "ERR02199": { "description": "Virtual Card Status can not be updated." }, "ERR04097": { "description": "Request Rejected." }, "ERR04100": { "description": "Requested Card Status is matching with current card status." }, "ERR03076": { "description": "Invalid Delivery Mechanism." }, "ERR03060": { "description": "Invalid Card Fee." }, "ERR03075": { "description": "Invalid Decision Flag." }, "ERR03048": { "description": "Invalid Address Flag." }, "ERR03117": { "description": "Invalid Reason." }, "ERR03042": { "description": "Instant Personalize should be 1 when Decision Flag is 1." }, "ERR02062": { "description": "Delivery Mechanism is missing." }, "ERR02061": { "description": "Decision Flag can not be left blank." }, "ERR02136": { "description": "Reason can not be left blank." }, "ERR02031": { "description": "Card Fee is missing." }, "ERR02063": { "description": "Delivery mechanism should not be 2 = Over Night due to suspend address." }, "ERR01077": { "description": "Request accepted: Card reported as Active." }, "ERR01078": { "description": "Request accepted: Card reported as Inactive." }, "ERR01080": { "description": "Request accepted: Card reported as Lost/Stolen." }, "ERR01081": { "description": "Request accepted: Card reported as Fraud." }, "ERR01082": { "description": "Request accepted: Card reported as Blocked." }, "ERR04027": { "description": "Card status is not active." }, "ERR03068": { "description": "Program Restriction :Invalid Service User or Account Identifier." }, "ERR04175": { "description": "Request Rejected : Issue Status is Requested To Be Embossed." }, "ERR04199": { "description": "Request Rejected : Issue Status is Hold Embossing." }, "ERR04200": { "description": "Request Rejected : Issue Status is not Hold Embossing." }, "ERR03433": { "description": "Request rejected: DecisionFlag should be = 1 when Reason is 13(Physical Card)." }, "ERR03426": { "description": "Invalid Hold Embossing Option." }, "ERR01128": { "description": "Request accepted: Card release to generate Physical Card." }, "ERR04201": { "description": "This card is not eligible to issue physical card." } }
Cancel Physical Card Order
Action: POST
Endpoint: /api/CoreCredit/CardManagement/CancelPhysicalCardOrder
Use this API to cancel a plastic card order.
Note
Cancellation of physical card order is processed only until a card is not printed by the embosser. Any cancellation request received after the printing of the card is rejected by CoreCARD.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Mandatory |
Admin number (Embossing Account ID) Valid Values: 0-9 Example: 12345 |
CardSequenceNumber integer Mandatory |
Card Sequence Number.Physical Card order can be uniquely identify by combination of Admin Number and Card Sequence Number Valid Values: 0-9 Example: 1 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AdminNumber": 129409, "CardSequenceNumber": 1 }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Order Canceled Successfully", "Status": true, "ErrorCode": "ERR01160", "ResponseData": null } }
Get Card Image
Action: POST
Endpoint: /api/CoreCredit/CardManagement/GetCardImage
Use this API to obtain the virtual card's URL in order to see card information by providing the account number, account ID, or admin number.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AccountNumber string Mandatory |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
AccountID int64 Optional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 |
AdminNumber int64 Mandatory |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AccountNumber": "1000000700000548", "AccountID": 6794, "AdminNumber": 6202 }
Response fields detail
Fields | Description |
---|---|
CardImageUrl string |
URL of the virtual card where we can see the card details. Allowable Values: 1000 |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "CardImageUrl": "https://testccapplinks.corecard.com/Kabbage/VerifyUrl?Auth=WERFSAFIHFG%7c2EBF567BE8BA865C0AFDA903C93B3A86137D315093ED6FD6%7cWERFSAFIHFG" } } }
Get Cardholder Detail
Action: POST
Endpoint: /api/CoreCredit/CardManagement/GetCardHolderDetail
Use this API to get cardholder details by providing the customer ID. The API retrieves details like name, address, identification and contact numbers.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language == en: means use English ---- es: means Spanish Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
CustomerID integer Mandatory |
Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 |
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
CustomerID integer Mandatory |
Unique ID associated with Customer Valid Values: 0-9 a-z Format: xxxx Example: abc2123 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "CustomerID": 167257 }
Response fields detail
Fields | Description |
---|---|
AddressGroup
|
AddressGroup |
CustomerGroup
|
CustomerGroup |
AddressGroup
|
AddressGroup |
CustomerGroup
|
CustomerGroup |
EmbossingGroup
|
EmbossingGroup |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "AddressGroup": { "AddressLine1": "test", "AddressLine2": "test", "City": "test", "State": "test", "Country": "test", "PostalCode": "test", "ResidenceType": "test", "DurationatAddress": 12 }, "CustomerGroup": { "CustomerID": 167257, "Title": null, "FirstName": null, "MiddleName": null, "LastName": null, "SurnameSuffix": "0", "PassportNumber": null, "DriverLicenseNumber": null, "DriverLicenseState": null, "DriverLicenseExpDate": null, "TaxIdentificationNumber": null, "OtherID": null, "OtherIdType": null, "DateOfBirth": "01/01/1970 00:00:00", "LanguageIndicator": null, "HomePhoneNumber": null, "WorkPhoneNumber": "8745981256", "MobileNumber": null, "FaxNumber": null, "OtherIdCountry": null, "OtherIDExpiryDate": null, "IssuanceCountry": null, "DriverLicenseCountry": null, "OtherIDIssueDate": null, "PassportIssueDate": null, "DriverLicenceIssueDate": null, "OtherIdState": null, "OtherIDDescription": null, "EmailID": null, "MaritalStatus": null, "BankruptcyNotificationDate": null, "DBA": null, "Education": null, "Deceased": 0, "Gender": null, "Income": null, "MotherMaidenName": null, "OtherPhoneNumber": null, "CeaseAndDesistIndicator": false, "Bankruptcy": false, "ThreePDM": false, "DoNotCallHomePhoneNUM": false, "DoNotCallMobileNUM": false, "DoNotCallWorkPhoneNUM": false, "DoNotCallOtherPhoneNUM": false, "MobileCarrier": null, "DeceasedNotificationDate": null, "FraudVictim": false, "ProductName": "Abc revolving" }, "EmbossingGroup": null } } }
Get Travel Notification Detail
Action: POST
Endpoint: /api/CoreCredit/CardManagement/GetTravelNotificationDetail
This API searches any past or present travel notifications on an account by providing an admin number. These details may include country of travel, travel start date, travel end date, and travel status (i.e., active, expired, deleted).
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Mandatory |
Admin number. Valid Values: 0-9 Example: 12345 |
Sample request body
{ "Source": "WEB", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AdminNumber": 129333 }
Response fields detail
Fields | Description |
---|---|
TravelNotificationsDetail array |
TravelNotificationsDetail. |
CurrencySymbol string |
This tag reflects the currency symbol |
Sample response body
{ "application/json": { "Message": "Travel notification details have been retrieved successfully", "Status": true, "ErrorCode": "ERR01062", "ResponseData": { "TravelNotificationsDetail": [ { "TNUniqueID": 2, "CountryOfTravel": "USA", "TravelStartDate": "04/04/2020 00:00:00", "TravelEndDate": "04/10/2020 00:00:00", "StatusOfTravel": "Active" } ] } } }
Update Travel Notification
Action: POST
Endpoint: /api/CoreCredit/CardManagement/TravelSettingCRUD
A cardholder can use the API's travel notifications functionality which allows the customer to perform international transactions for a given admin number and a specific country within the defined date range. A cardholder can add a new travel notification request or edit or delete an existing request.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Mandatory |
Admin number Valid Values: 0-9 Example: 12345 |
RequestType integer Mandatory |
Request Type defines the action to be performed. Valid Values: 0, 1, 2 Format: X Example: 0-Add, 1-Delete, 2-Update |
TNUniqueID int64 Conditional |
Travel Notification's Unique ID Valid Values: 0-9 Example: 12345 Condition: It is required when the value of RequestType is 1 or 2. |
CountryOfTravel string Conditional |
Country of Travel Please refer to Appendix file section 5.1 for a list of valid codes and values. Valid Values:A-Z Format:XX Example:IN, US, GE Condition: It is required when the value of RequestType is 0 i.e Addition of new travel details Allowable Values: 3 |
TravelStartDate datetime Conditional |
Travel Start Date Format: MM/dd/yyyy Example: 02/25/2020 Condition: It is required when the value of RequestType is 0 i.e Addition of new travel details |
TravelEndDate datetime Conditional |
Travel End Date Format: MM/dd/yyyy Example: 02/25/2020 Condition: It is required when the value of RequestType is 0 i.e Addition of new travel details |
StatusOfTravel integer Conditional |
Status of Travel 1 = Active, 2 = Expired, 3 = Deleted Valid Values: 1, 2, 3 Format: X Example:1,2,3 Condition: It is required when the value of RequestType is 0 i.e Addition of new travel details |
Sample request body
{ "Source": "WEB", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AdminNumber": 129333, "RequestType": 0, "TNUniqueID": null, "CountryOfTravel": "USA", "TravelStartDate": "04/04/2020 00:00:00", "TravelEndDate": "04/10/2020 00:00:00", "StatusOfTravel": 1 }
Response fields detail
Fields | Description |
---|---|
ResponseID string |
This number will ensure that API hit our internal servers. This will always be unique. API is returned from our external server. Valid Values: 0-9 Format: xxx Example: 200 Allowable Values: 15 |
Sample response body
{ "application/json": { "Message": "Travel notification added successfully", "Status": true, "ErrorCode": "ERR01060", "ResponseData": { "ResponseID": "56876638" } } }
Get All Card Information
Action: POST
Endpoint: /api/CoreCredit/CardManagement/GetAllCardInformation
Use this API to retrieve details of all cards linked to an account number or a specific card linked to an admin number. The API, when provided an account number, also returns the cardholder's personal information and each card's balance and embossing information.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
PageIndex integer Mandatory |
Number of page Valid Values:0-9 Format:XX Example:12 |
Limit integer Mandatory |
Limit can have value 1-50,On the basis of Page and Limit paging will be done . Limit can not exceed 50.It means at a time API wont return more than 50 records as a card detail if only account number passed in input. If AdminNumber is passed then Page and Limit parameters will be ignored, As we will have only one record to return. Valid Values:0-9 Format:XXXXX Example:50 |
AccountUUID string Optional |
Basesegment's Universal Unique Id. Valid Values:0-9 Format:XXXXX Example:12345 Allowable Values: 64 |
AdminNumberUUID string Optional |
EmbossingAccount's Universal Unique Id. Valid Values:0-9 Format:XXXXX Example:12345 Allowable Values: 64 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AdminNumber": 5798, "AccountNumber": "1000000700000049", "PageIndex": 1, "Limit": 50, "AccountUUID": null, "AdminNumberUUID": null }
Response fields detail
Fields | Description |
---|---|
AccountNumber string |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
AvailableBalance decimal |
Available Balance to make new transactions. Valid Values:0-9 Format:XXX.XX Example:500.00 |
CurrencyCode string |
Currency Code Example:840 = US Doller Allowable Values: 3 |
NumberOfCards integer |
Number of Cards attached to the Account. |
CurrentBalance decimal |
Current balance of account. |
TotalAmountDue decimal |
Total amount due on Account. |
PaymentDueDate datetime |
Due date as to by when payment needs to be made to avoid late fees |
FirstName string |
Card holder's First name. Valid Values:A-Z Format:XXXXX Example:User1 Allowable Values: 50 |
MiddleName string |
Card holder's Middle name. Allowable Values: 40 |
LastName string |
Card holder's last name. Allowable Values: 40 |
AddressLine1 string |
Card Holder's address line 1. Allowable Values: 40 |
AddressLine2 string |
Card holder's address line 2. Allowable Values: 40 |
City string |
City name of the Card holder's address. Allowable Values: 40 |
State string |
A State of the card holder address. Allowable Values: 40 |
PostalCode string |
Postal code of the card holder's address. Allowable Values: 15 |
Country string |
Country name of the Card holder's address. Allowable Values: 40 |
EmailID string |
This Tag reflects the applicant Email ID. Allowable Values: 100 |
DateOfBirth datetime |
This Tag reflects the applicant Email ID. |
ResponseID string |
This number will ensure that API hit our internal servers. This will always be unique.API is returned from our external server Allowable Values: 15 |
GeneratedStatus string |
Account Generated Status. Allowable Values: 15 |
ManualAccountStatus string |
Account Manual Status. Allowable Values: 255 |
StatementProduction string |
Statement prduction to be process normally, online only or hold statement . Allowable Values: 50 |
ClientId string |
Client ID of the account. Allowable Values: 25 |
AccountDerivedStatus string |
Derived status based on Account Status, Card Manual Status and Embossing Status. Possible values - Active Blocked Cancelled Disabled |
AccountUUID string |
Basesegment's Universal Unique Id. |
CardList array |
CardList |
PlanList array |
Plan List. |
Sample response body
{ "application/json": { "Message": "Card Details Returned Successfully", "Status": true, "ErrorCode": "ERR01009", "ResponseData": { "AccountNumber": "1000000700000049", "AvailableBalance": 13101.09, "CurrencyCode": "840", "NumberOfCards": 1, "CurrentBalance": -1.09, "TotalAmountDue": 0.0, "PaymentDueDate": null, "FirstName": "FirstName_7048", "MiddleName": "MiddleName", "LastName": "LASTNAME", "AddressLine1": "123 East Main Street", "AddressLine2": null, "City": "Dallas", "State": "GA", "PostalCode": "73701", "Country": "US", "EmailID": "ABC@ABC.com", "DateOfBirth": "01/01/1970 00:00:00", "ResponseID": "56932637", "GeneratedStatus": "2", "ManualAccountStatus": "5212", "StatementProduction": "Process normally", "ClientId": null, "AccountDerivedStatus": null, "AccountUUID": null, "CardList": [ { "AdminNumber": 5798, "CardType": "0", "EmbossingGeneratedStatus": "2", "EmbossingManualStatus": "5212", "ManualCardStatus": "1", "CardNumberLast4Digit": "2748", "SecondaryCardType": 0, "CardExpirationDate": "12/31/2037 00:00:00", "VirtualCardLimit": 0.0, "VirtualCardStandInLimit": 0.0, "FirstName": "FirstName_7048", "MiddleName": "MiddleName", "LastName": "LASTNAME", "AddressLine1": "123 East Main Street", "AddressLine2": null, "City": "Dallas", "State": "GA", "PostalCode": "73701", "Country": "US", "EmailID": "ABC@ABC.com", "DateOfBirth": "01/01/1970 00:00:00", "MailingAddressLine1": null, "MailingAddressLine2": null, "MailingCity": null, "MailingState": null, "MailingPostalCode": null, "MailingCountyCode": null, "GovernmentIDType": null, "GovernmentID": null, "IDExpirationDate": null, "IDIssueDate": null, "IDIssueState": null, "IDIssueCountry": null, "OtherIDDescription": null, "MobilePhoneNumber": null, "SameAsParentAddress": false, "CustomerID": "7048", "CardSequenceNumber": 1, "CardImageID": null, "AdminNumberUUID": null, "CGIdentifier": "1028", "NameOnTrack": null } ], "PlanList": [ { "APR": 7.9, "PlanAcctID": 1007 } ] } } }
Update Usage Restriction
Action: POST
Endpoint: /api/CoreCredit/CardManagement/UpdateUsageRestriction
Use this API to update a card's usage restriction in the domestic or international market. Based on a cardholder request, a user can set a usage restriction preference.
Note
This API allows the card usage preference which is set to international use only when the card program is configured to work its cards in the international market.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Mandatory |
Admin number. Valid Values: 0-9 Example: 12345 |
UsageRestriction integer Mandatory |
Usage restrictions applied on the card. Valid Values: 0, 1, 2 Format: X Example: 0 - Limited Usage, 1 - Local Use Only, 2 - No Restriction |
Sample request body
{ "Source": "WEB", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AdminNumber": 129333, "UsageRestriction": 2 }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Usage restriction updated successfully", "Status": true, "ErrorCode": "ERR01064", "ResponseData": null } }
Card Activation Invalid Attempts
Action: POST
Endpoint: /api/CoreCredit/CardManagement/CardActivationInvalidAttempts
The API is to check the number of attempts we get to reset the pin of card.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
CardNumber string Conditional |
Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXX Example:123654789654 Condition:At least one of AdminNumber/CardNumber is required. Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format:XXXXXX Example:123654 Condition:At least one of AdminNumber/CardNumber is required. |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "CardNumber": null, "AdminNumber": 167257354 }
Response fields detail
Fields | Description |
---|---|
NoOfPinAttempts integer |
Number of Pin Attempts to be made. Valid Values:0-9 Example : 2 |
NumberOfPinAttempts integer |
Number of Pin Attempts to be made. Valid Values:0-9 Example : 2 |
Sample response body
{ "application/json": { "Message": "IVR Attempts counter has been reset successfully.", "Status": true, "ErrorCode": "ERR01036", "ResponseData": { "NumberOfPinAttempts": 1 } } }
Reset Generated Status
Action: POST
Endpoint: /api/CoreCredit/CardManagement/ResetGeneratedStatus
Reset the automatically assigned status by the system to "Active".
Request fields detail
Fields | Description |
---|
Sample request body
[ { "in": "header", "name": "Authorization", "description": "access token", "required": true, "type": "string", "default": "Bearer " }, { "in": "body", "name": "body", "description": "ResetSystemStatusRequestModel.", "schema": { "$ref": "#/definitions/ResetSystemStatusRequestModel" } } ]
Response fields detail
Fields | Description |
---|
Sample response body
{ "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResetSystemStatusResponseModelApiResult" }, "examples": { "application/json": { "Message": "Generated Status has been reset successfully", "Status": true, "ErrorCode": "ERR01020", "ResponseData": {} } } }, "Err00016": { "description": "System could not process your request at this time. Please try again." }, "ERR03004": { "description": "At least one Account identifier input parameter should be passed." }, "ERR03043": { "description": "Invalid Account identifier input parameter(s)." }, "ERR03001": { "description": "Admin Number should be numeric." }, "ERR01020": { "description": "Generated Status has been reset successfully." }, "ERR04110": { "description": "There is an error while processing this request." }, "ERR04007": { "description": "Accounts is already in active state." }, "ERR04005": { "description": "Account is in charge off state." } }
Card Registration
Action: POST
Endpoint: /api/CoreCredit/CardManagement/CardRegistration
With the inventory of preprinted cards, a user may send a post request with card number, account number, or admin number along with the customer PII data, address information, ID, and other required details to update a card account's customer records and register it with the customer. This allows a customer to instantly receive a card.
Note
The successful update of a customer record and registration of the card account is subject to the passing of customer verification and various compliance-related checks. In case any of the required checks fails, CoreCARD terminates the card registration request.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language == en: means use English ---- es: means Spanish Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
CardNumber string Conditional |
Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition:Card Number of the Card Holder Mandatory If Account Number or Admin Number not Inputted. Allowable Values: 19 |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:Account Number of the Account Holder Mandatory If Card Number or Admin Number not Inputted. Allowable Values: 19 |
AdminNumber int64 Conditional |
Description: Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:Admin Number Mandatory If Account Number or Card Number not Inputted |
IsMLAAccount boolean Optional |
Identify whether the account is MLA type or not Valid Values:Yes-1 No-0 Format:X Example:0 |
RegulationOFlag boolean Optional |
Regulation O Flag to classify Rego Account |
RegulationOFlagEffectiveDate datetime Conditional |
Date of effective Reg "O" Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2020 Condition:RegulationOFlagEffectiveDate, mandatory if Regulation O Flag is Yes. |
Title string Optional |
Title of the cardholder Format: A-Z Example:Mr Allowable Values: 10 |
FirstName string Mandatory |
Card holder's First name. Valid Values:A-Z Example:User1 Allowable Values: 50 |
MiddleName string Optional |
Card holder's Middle Name. Valid Values: A-Z Example: LEE Allowable Values: 50 |
LastName string Mandatory |
Card holder's last name. Valid Values:A-Z Example:Smith Allowable Values: 50 |
SurnameSuffix string Optional |
Cardholder's surname-suffix Example:SR Allowable Values: 5 |
AddressLine1 string Mandatory |
Card Holder's address line 1. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50 |
AddressLine2 string Optional |
Card holder's address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Allowable Values: 50 |
City string Mandatory |
City name of the Card holder's address. Example:Los Angeles Allowable Values: 40 |
State string Mandatory |
Address State of the Card Holder. For Input Values Refer Appendix Section 5.6 for State Name Codes Example:Virginia Allowable Values: 40 |
PostalCode string Mandatory |
Postal code of the card holder address. Valid Values:0-9 Example:46206 Allowable Values: 9 |
Country string Mandatory |
Address Country of the Card Holder For Input Values Refer Appendix Section 5.1 for Country Name Codes. Valid Values: a-z Format:XXX Example:US Allowable Values: 3 |
DateOfBirth datetime Mandatory |
Card Holder's Date of Birth. Format:MM/dd/YYYY Example:11/23/1980 |
ResidenceType string Mandatory |
Type of Residince that cardholder lives in. For Input Values Refer Appendix Section 5.15 for Residence Ownership Codes. Valid Values:A-Z Example:Own Allowable Values: 35 |
MonthsAtResidence integer Mandatory |
Duration on residence in months Valid Values: 0-9 Example:9 |
HomePhoneNumber string Mandatory |
Card holder's Home Phone number. Valid Values:0-9 Example:7895463241 Allowable Values: 15 |
WorkPhoneNumber string Optional |
Card holder's Work phone number. Valid Values:0-9 Example:5678909876 Allowable Values: 15 |
MobilePhoneNumber string Optional |
Card holder Mobile Phone Number. Valid Values:0-9 Example:987567757 Allowable Values: 20 |
EmailID string Mandatory |
Card holder's Email ID. Format:XXX@XXX.XXX Example:abc@gmail.com Allowable Values: 50 |
LanguageIndicator string Optional |
Language Indicator of the institution. Valid Values: a-z, 0-9 Format: xxxx Allowable Values: 35 |
MotherMaidenName string Optional |
Card holder's mother Maiden Name Valid Values:a-z,0-9 Example:Johnson Allowable Values: 50 |
SocialSecurityNumber string Conditional |
Card holder's Social Security Number. Format:AAAGGSSSS Example:078051120 Condition:Mandatory if ID type is Not Inputted Allowable Values: 9 |
IDType string Conditional |
Cardholder's Identity type. For Input Values Refer Appendix Section 5.2 for ID Name Value Codes Valid Values: a-z Format: xxxxx Example: E.g.Passport, Driving License, Governemnt ID etc. Allowable Values: 25 |
IDNumber string Conditional |
Card holder's Government ID Number. Format:AAAGGSSSS Example:078051120 Condition:This field is mandatory when government id type other than Other ID is used for cardholder identification. Allowable Values: 40 |
IDIssueDate datetime Optional |
Issue date of ID card. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: GovernmentID issue date is mandatory when governmentID type is 'Drivers license' and ID issue country is US and Id issue state is other than Massachusetts, Michigan, Missouri, Texas. |
IDExpirationDate datetime Optional |
Government issued identification expiration date. Valid Values: MM/DD/YYY Example: 02/01/2020 Condition: This field is mandatory when government id type other than Other ID is used for cardholder identification. |
IDIssueCountry string Optional |
Country of Identification proof. Valid Values:a-z, 0-9 Example: Canada Condition:This field is mandatory when government id Type other than Other ID is used for cardholder identification.Two character country code should be passed in the request and not country name. Allowable Values: 5 |
IDState string Optional |
Government identification issued state. Condition: GovernmentID issue state is mandatory, when Government id type is 'Drivers license' Or 'State ID' and ID issue country is US. Allowable Values: 50 |
ShippingAddressFlag boolean Mandatory |
Shipping address is existing or new. Valid Values:0,1 Format:X Example:Ship to Existing Address – 0 Ship Address – 1 |
ShippingAddressLine1 string Conditional |
Shipping address line 1 Example: 2354 Main road Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 50 |
ShippingAddressLine2 string Optional |
Shipping address line 2 Example:xyz Avenue Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 50 |
ShippingCity string Conditional |
Shipping address city name. Example: chicago Allowable Values: 50 |
ShippingState string Conditional |
State of the shipping address For Input Values Refer Appendix Section 5.6 for State Name Codes Valid Values: a-z Format:XXX Example:MO Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 40 |
ShippingCountry string Conditional |
Shipping address Country name For Input Values Refer Appendix Section 5.1 for Country Name Codes Format: USA Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 50 |
ShippingPostalCode string Conditional |
Zip code of the shipping address. Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 10 |
CreditLimit decimal Mandatory |
Credit Limit of account Valid Values:0-9 Format:XXX.XX Example:500.00 |
BillingTable integer Mandatory |
Name of the Billing Table assigned on the Card Holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 |
BillingCycle integer Mandatory |
Billing Cycle to be Assigned on the Card Holder Use the Billing Cycle API to Get the Billing Cycles available and assign out of the available for the Card Holder For Input Values Refer Appendix Section 5.2 for Billing Cycle Codes Valid Values:0-9 Format: x Example:1 |
NumberofCardsRequested integer Mandatory |
Number of Cards Requested Valid Values:0-9x Format:XX Example:02 |
NameOnCard string Mandatory |
Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J Allowable Values: 50 |
EmbossingLine4 string Optional |
Embossing line4 Allowable Values: 50 |
CashCreditLimit decimal Optional |
Cash Credit Limit of account Valid Values:0-9 Format:XXX.XX Example:500.00 |
CardImageID string Optional |
This is the card image type number which is already decided for embossing them. Valid Values: 0-9 Example: 12 Allowable Values: 100 |
NameOnTrack string Optional |
Details to be provided in the Magnetic Strip (mostly derived from Last Name and First name of the Card Holder). Valid Values: A-z Example: John J Allowable Values: 50 |
ActivationCode string Optional |
Code which is provided at the time of Account Creation/Registration should be pass as a user validation. Allowable Values: 50 |
TotalAnnualIncome decimal Mandatory |
Total Annual Income of cardholder Valid Values: 0-9 Format: XXX.XX Example: 500.00 |
CurrentEmploymentMonths string Mandatory |
Number of months in current employment Allowable Values: 10 |
Position string Optional |
This field reflects the employement position of the card holder Valid Values: A-Z, 0-9 Allowable Values: 100 |
EmploymentType string Mandatory |
Type of employement of cardholder Allowable Values: 5 |
EmployerName string Mandatory |
Card Holder's employer name. Allowable Values: 100 |
EmployerContactPhoneNumber string Optional |
Card Holder's employer Phone number Valid Values: 0-9 Format: XXXXXXXXXX Example: 789654121 Allowable Values: 15 |
HoldEmbossing string Optional |
Hold embossing indicator. Valid Values: 1= YES, 0 = NO Allowable Values: 2 |
Cardhandover boolean Mandatory |
Card hand over Valid Values: 1= YES, 0 = NO |
DeliveryMechanism string Optional |
Delivery Mechanism(Overnight, Priority or Standard). Valid Values: 0 -for Standard ,1 -for Priority , 2 -for Overnight Condition: Delivery mechanism is optional. Allowable Values: 5 |
MobileCarrier string Optional |
Cosigner's Mobile carrier company. Valid Values:A-z, 0-9 Format:XXXXXXXX Example: c.vodafone.ne.jp, csouth1.com, m1.com.sg Allowable Values: 15 |
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
CardNumber string Conditional |
Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition:Card Number of the Card Holder Mandatory If Account Number or Admin Number not Inputted. Allowable Values: 19 |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:Account Number of the Account Holder Mandatory If Card Number or Admin Number not Inputted. Allowable Values: 19 |
AdminNumber int64 Conditional |
Description: Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition:Admin Number Mandatory If Account Number or Card Number not Inputted |
IsMLAAccount boolean Optional |
Identify whether the account is MLA type or not Valid Values:Yes-1 No-0 Format:X Example:0 |
RegulationOFlag boolean Optional |
Regulation O Flag to classify Rego Account |
RegulationOFlagEffectiveDate datetime Conditional |
Date of effective Reg "O" Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2020 Condition:RegulationOFlagEffectiveDate, mandatory if Regulation O Flag is Yes. |
Title string Optional |
Title of the cardholder Format: A-Z Example:Mr Allowable Values: 5 |
FirstName string Mandatory |
Card holder's First name. Valid Values:A-Z Example:User1 Allowable Values: 40 |
MiddleName string Optional |
Card holder's Middle Name. Valid Values: A-Z Example: LEE Allowable Values: 10 |
LastName string Mandatory |
Card holder's last name. Valid Values:A-Z Example:Smith Allowable Values: 40 |
SurnameSuffix string Optional |
Cardholder's surname-suffix Example:SR Allowable Values: 5 |
AddressLine1 string Mandatory |
Card Holder's address line 1. Valid Values:A-Z, 0-9 Example:123 HWY Allowable Values: 50 |
AddressLine2 string Optional |
Card holder's address line 2. Valid Values:A-Z, 0-9 Example:Park Avenue Allowable Values: 50 |
City string Mandatory |
City name of the Card holder's address. Example:Los Angeles Allowable Values: 35 |
State string Mandatory |
Address State of the Card Holder. For Input Values Refer Appendix Section 5.6 for State Name Codes Example:Virginia Allowable Values: 30 |
PostalCode string Mandatory |
Postal code of the card holder address. Valid Values:0-9 Example:46206 Allowable Values: 9 |
Country string Mandatory |
Address Country of the Card Holder For Input Values Refer Appendix Section 5.1 for Country Name Codes. Valid Values: a-z Format:XXX Example:US Allowable Values: 3 |
DateOfBirth datetime Mandatory |
Card Holder's Date of Birth. Format:MM/dd/YYYY Example:11/23/1980 |
ResidenceType string Mandatory |
Type of Residince that cardholder lives in. For Input Values Refer Appendix Section 5.15 for Residence Ownership Codes. Valid Values:A-Z Example:Own Allowable Values: 35 |
MonthsAtResidence integer Mandatory |
Duration on residence in months Valid Values: 0-9 Example:9 |
HomePhoneNumber string Mandatory |
Card holder's Home Phone number. Valid Values:0-9 Example:7895463241 Allowable Values: 15 |
WorkPhoneNumber string Optional |
Card holder's Work phone number. Valid Values:0-9 Example:5678909876 Allowable Values: 15 |
MobileCarrier string Optional |
Cosigner's Mobile carrier company. Valid Values:A-z, 0-9 Format:XXXXXXXX Example: c.vodafone.ne.jp, csouth1.com, m1.com.sg Allowable Values: 15 |
MobilePhoneNumber string Optional |
Card holder Mobile Phone Number. Valid Values:0-9 Example:987567757 Allowable Values: 20 |
EmailID string Mandatory |
Card holder's Email ID. Format:XXX@XXX.XXX Example:abc@gmail.com Allowable Values: 50 |
LanguageIndicator string Optional |
Language Indicator of the institution. Valid Values: a-z, 0-9 Format: xxxx Allowable Values: 35 |
MotherMaidenName string Optional |
Card holder's mother Maiden Name Valid Values:a-z,0-9 Example:Johnson Allowable Values: 50 |
SocialSecurityNumber string Conditional |
Card holder's Social Security Number. Format:AAAGGSSSS Example:078051120 Condition:Mandatory if ID type is Not Inputted Allowable Values: 9 |
IDType string Conditional |
Cardholder's Identity type. For Input Values Refer Appendix Section 5.2 for ID Name Value Codes Valid Values: a-z Format: xxxxx Example: E.g.Passport, Driving License, Governemnt ID etc. Allowable Values: 25 |
IDNumber string Conditional |
Card holder's Government ID Number. Format:AAAGGSSSS Example:078051120 Condition:This field is mandatory when government id type other than Other ID is used for cardholder identification. Allowable Values: 40 |
IDIssueDate datetime Optional |
Issue date of ID card. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: GovernmentID issue date is mandatory when governmentID type is 'Drivers license' and ID issue country is US and Id issue state is other than Massachusetts, Michigan, Missouri, Texas. |
IDExpirationDate datetime Optional |
Government issued identification expiration date. Valid Values: MM/DD/YYY Example: 02/01/2020 Condition: This field is mandatory when government id type other than Other ID is used for cardholder identification. |
IDIssueCountry string Optional |
Country of Identification proof. Valid Values:a-z, 0-9 Example: Canada Condition:This field is mandatory when government id Type other than Other ID is used for cardholder identification.Two character country code should be passed in the request and not country name. Allowable Values: 5 |
IDState string Optional |
Government identification issued state. Condition: GovernmentID issue state is mandatory, when Government id type is 'Drivers license' Or 'State ID' and ID issue country is US. Allowable Values: 50 |
ShippingAddressFlag boolean Mandatory |
Shipping address is existing or new. Valid Values:0,1 Format:X Example:Ship to Existing Address – 0 Ship Address – 1 |
ShippingAddressLine1 string Conditional |
Shipping address line 1 Example: 2354 Main road Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 50 |
ShippingAddressLine2 string Optional |
Shipping address line 2 Example:xyz Avenue Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 50 |
ShippingCity string Conditional |
Shipping address city name. Example: chicago Allowable Values: 50 |
ShippingState string Conditional |
State of the shipping address For Input Values Refer Appendix Section 5.6 for State Name Codes Valid Values: a-z Format:XXX Example:MO Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 40 |
ShippingCountry string Conditional |
Shipping address Country name For Input Values Refer Appendix Section 5.1 for Country Name Codes Format: USA Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 50 |
ShippingPostalCode string Conditional |
Zip code of the shipping address. Condition:If ShippingAddressFlag is 1 then it is mandatory Allowable Values: 10 |
CreditLimit decimal Mandatory |
Credit Limit of account Valid Values:0-9 Format:XXX.XX Example:500.00 |
BillingTable integer Mandatory |
Name of the Billing Table assigned on the Card Holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 |
BillingCycle integer Mandatory |
Billing Cycle to be Assigned on the Card Holder Use the Billing Cycle API to Get the Billing Cycles available and assign out of the available for the Card Holder For Input Values Refer Appendix Section 5.2 for Billing Cycle Codes Valid Values:0-9 Format: x Example:1 |
NumberofCardsRequested integer Mandatory |
Number of Cards Requested Valid Values:0-9x Format:XX Example:02 |
NameOnCard string Mandatory |
Name to be printed on the card. Valid Values:A-Z, 0-9 Format:XXXX Example:John J Allowable Values: 50 |
EmbossingLine4 string Optional |
Embossing line4 Allowable Values: 20 |
CashCreditLimit decimal Optional |
Cash Credit Limit of account Valid Values:0-9 Format:XXX.XX Example:500.00 |
CardImageID string Optional |
This is the card image type number which is already decided for embossing them. Valid Values: 0-9 Example: 12 Allowable Values: 100 |
NameOnTrack string Optional |
Details to be provided in the Magnetic Strip (mostly derived from Last Name and First name of the Card Holder). Valid Values: A-z Example: John J Allowable Values: 26 |
ActivationCode string Optional |
Code which is provided at the time of Account Creation/Registration should be pass as a user validation. Allowable Values: 50 |
TotalAnnualIncome decimal Mandatory |
Total Annual Income of cardholder Valid Values: 0-9 Format: XXX.XX Example: 500.00 |
CurrentEmploymentMonths string Mandatory |
Number of months in current employment Allowable Values: 10 |
Position string Optional |
This field reflects the employement position of the card holder Valid Values: A-Z, 0-9 Allowable Values: 100 |
EmploymentType string Mandatory |
Type of employement of cardholder Allowable Values: 5 |
EmployerName string Mandatory |
Card Holder's employer name. Allowable Values: 100 |
EmployerContactPhoneNumber string Optional |
Card Holder's employer Phone number Valid Values: 0-9 Format: XXXXXXXXXX Example: 789654121 Allowable Values: 15 |
HoldEmbossing string Optional |
Hold embossing indicator. Valid Values: 1= YES, 0 = NO Allowable Values: 2 |
Cardhandover boolean Mandatory |
Card hand over Valid Values: 1= YES, 0 = NO |
DeliveryMechanism string Optional |
Delivery Mechanism(Overnight, Priority or Standard). Valid Values: 0 -for Standard ,1 -for Priority , 2 -for Overnight Condition: Delivery mechanism is optional. Allowable Values: 5 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "CardNumber": "", "AccountNumber": "1200001000000004", "AdminNumber": null, "IsMLAAccount": false, "RegulationOFlag": false, "RegulationOFlagEffectiveDate": null, "Title": null, "FirstName": "monika", "MiddleName": null, "LastName": "gupta", "SurnameSuffix": null, "AddressLine1": "test", "AddressLine2": null, "City": "test", "State": "test", "PostalCode": "354646", "Country": "US", "DateOfBirth": null, "ResidenceType": null, "MonthsAtResidence": 0, "HomePhoneNumber": "975757646465", "WorkPhoneNumber": null, "MobileCarrier": null, "MobilePhoneNumber": null, "EmailID": "monika@gmail.com", "LanguageIndicator": "en", "MotherMaidenName": null, "SocialSecurityNumber": "111111111", "IDType": "2", "IDNumber": "123456789", "IDIssueDate": null, "IDExpirationDate": null, "IDIssueCountry": null, "IDState": null, "ShippingAddressFlag": false, "ShippingAddressLine1": null, "ShippingAddressLine2": null, "ShippingCity": null, "ShippingState": null, "ShippingCountry": null, "ShippingPostalCode": null, "CreditLimit": 1000.0, "BillingTable": 0, "BillingCycle": 0, "NumberofCardsRequested": 0, "NameOnCard": "Monika Gupta", "EmbossingLine4": null, "CashCreditLimit": 0.0, "CardImageID": null, "NameOnTrack": null, "ActivationCode": null, "TotalAnnualIncome": 0.0, "CurrentEmploymentMonths": null, "Position": null, "EmploymentType": null, "EmployerName": null, "EmployerContactPhoneNumber": null, "HoldEmbossing": null, "Cardhandover": null, "DeliveryMechanism": "0" }
Response fields detail
Fields | Description |
---|---|
ResponseID string |
This number indicates that API responded. Response ID is unique.This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200 Allowable Values: 15 |
ResponseID string |
This number indicates that API responded. Response ID is unique.This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9,a-z Format:xxx Example:200 Allowable Values: 15 |
Sample response body
{ "application/json": { "Message": "Bulk Card Register successfully", "Status": true, "ErrorCode": "ERR01125", "ResponseData": { "ResponseID": "7011" } } }
Card Life Cycle Change Log
Action: POST
Endpoint: /api/CoreCredit/CardManagement/CardLifeCycleChangeLog
Use this API to obtain a card's life cycle changes to the issue status, shipping status, or manual card status. The API can also retrieve information for a specific card life cycle event (e.g., specific manual card status for the provided admin number). Additionally, the API returns the old and new values and other information, such as change date and time. If no change entity is provided, the API will display an all status change log.
Request fields detail
Fields | Description |
---|---|
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Mandatory |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
ChangeEntity string Optional |
Card Status entity based specific details can be obtain by ChangeEntity Possible Values: IssueStatus, ShippingStatus, ManualCardStatus If no value mentioned above specified, it will show all Status change log Format: XXXXXXXXX Example: IssueStatus Allowable Values: 50 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "AdminNumber": 129308, "ChangeEntity": "" }
Response fields detail
Fields | Description |
---|---|
CardType string |
Specifies if its primary card or secondary card. Valid Values: 0,1 Format: X Example:0 – Primary Card, 1 – Secondary Card Allowable Values: 50 |
CardLifeCycleDetails array |
array CardLifeCycleDetails |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "CardType": "Primary Card", "CardLifeCycleDetails": [ { "ChangeEntity": "IssueStatus", "ChangeDateTime": "01/15/2017 13:06:22", "OldValue": "NULL", "NewValue": "2" } ] } } }
Card Replacement
Action: POST
Endpoint: /api/CoreCredit/CardManagement/CardReplacement
Use this API to replace a card. The card needs to be replaced for various reasons like the card is lost\stolen\damage\other\reissue. The decision flag decides that a new card should be generated with the same card number or old card number. The delivery mechanism and shipping address can also be provided in the input.
Request fields detail
Fields | Description |
---|---|
QRCode string Optional |
This tag is to to capture the QR Code image file URL. Valid Values: a-z,0-9 Format: url format Example: https://test/qr/d969e78921 Allowable Values: 50 |
SignatureID string Optional |
This tag is to to capture the user signature image file URL. Valid Values: a-z,0-9 Format:url format Example: https://test/qr/d969e78921 Allowable Values: 50 |
Source string |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
AdminNumber int64 Mandatory |
Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 |
Reason integer Mandatory |
Reason to identify why we are requesting card replacement. Possible Values: 1- Stolen 2- Lost 3- Damaged(Status will be mark |