Category links

API Links

Card Status

CoreCard offers various card statuses to manage card-related attributes. You can issue a card in Active or Pending Activation status. Active status means the cardholder can use the card for monetary transactions and there is no card activation requirement prior to use. Pending Activation means the cardholder may not be able to use the card to perform a transaction based on the status definition. Card activation is mandatory to make the card operational when it is issued in Pending Activation status.

Card Status Update Request

Action: POST

Endpoint: /api/CoreCredit/CardManagement/CardStatusUpdateRequest

POST /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."
  }
}

Reset Generated Status

Action: POST

Endpoint: /api/CoreCredit/CardManagement/ResetGeneratedStatus

POST /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."
  }
}