Category links

API Links

Documents

CoreCard allows the Issuer to add, update, and delete account-related documents from the system using API.

Manage Account Documents

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/AddUpdateDelAccountDocuments

POST /api/CoreCredit/AccountManagement/AddUpdateDelAccountDocuments

For any card account, the card issuer is required to generate and maintain the card account-related documents. This API can be used to add, update and delete documents from CoreCARD's database.

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

SUID

int64

Conditional

System Unique ID Mandatory only If DecisionFlag is Either '1' Or '2'

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: At least one of AccountNumber\ AccountID is required.

AccountNumber

string

Conditional

Account number of cardholder Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one of AccountNumber\ AccountID is required.

Allowable Values:

19

MerchantID

integer

Optional

Unique number of merchant account Valid Values: 0-9 Format: XXXXX Example: 12345

DocumentType

string

Conditional

Type of the Document - BankRuptcy Paper, Debt Management Plan or Other (Types as Per Panel). No Restriction User can provide any name for Document Type. Condition: This Tag is Mandatory only If DecisionFlag is Either '0' or '2'.

Allowable Values:

50

DocumentName

string

Conditional

User must input the Name of the Document with Extension. Extensions allowed are .pdf, .png, .jpg and .jpeg Condition: This Tag is Mandatory only If DecisionFlag is Either '0' or '2'.

Allowable Values:

100

FileSize

string

Conditional

Size of the file in bytes. It can be used only via Panel, where Upload file Size will be Validated as per allowed in the System and if exceeds the file size will throw an error on Application Panel. Example: 85138 Condition: This Tag is Mandatory only If DecisionFlag is Either '0' or '2'.

Allowable Values:

100

UploadBy

string

Conditional

UserID of the User Creating/Uploading the Document Example: User1 Condition: This Tag is Mandatory only If DecisionFlag is '0'

Allowable Values:

50

UpdateBy

string

Conditional

UserID of the User Updating the Document Condition: This Tag is Mandatory only If DecisionFlag is Either '1' or '2'.

Allowable Values:

50

DecisionFlag

integer

Mandatory

Decision Flag must accept three values '0', '1' and '2' If User Inputs '0' then the API must Add the Document If User Inputs '1' then the API must Delete the Document If User Inputs '2' then the API must Update the Document Valid Values: 0, 1, 2 Example: 0 - Add, 1 - Delete, 2 - Update

FileLocation

string

Conditional

It can be used only Via Panel, where Upload location of the file will be auto populated as per the System Or via API user may input the actual loaction of File saved in User System for Reference. Example: \\\CoreCredit\\\DocumentUpload\\\Screenshot58_05222020053109.png

ImageThumbLocation

string

Optional

It can be used only Via Panel, where Upload location of the file will be auto populated as per the System Or via API user may input the actual loaction of File saved in User System for Reference. Example: \\\CoreCredit\\\DocumentUpload\\\ThumbImage\\\Screenshot58_05222020053109.png

HashFile

string

Optional

It can be used only via Panel, where Document Content is duplicate or not, will be checked if duplicate will throw an error on Panel It is a hash of the File, which Client System must generate to Check for Document Content Duplicacy.

BinaryData

byte[]

Conditional

User must input the Binary data of the document to be uploaded Condition: Mandatory only if Decision Flag is '0' or '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,
  "SUID": null,
  "AccountID": null,
  "AccountNumber": "1000000700000271",
  "MerchantID": null,
  "DocumentType": "Other",
  "DocumentName": "Screenshot_05222020053109.png",
  "DecisionFlag": 0,
  "BinaryData": "ICAgICAgIA=="
}
Response fields detail
Fields Description

SUID

int64

System Unique ID, to be Used as Input while Deleting or Updating Account Documents

UploadBy

string

UserID of the User Creating/Uploading the Document Valid Values:USER1 Format:XXXX Example:USER1

Allowable Values:

50

UpdateBy

string

UserID of the User Updating the Document

Allowable Values:

50

CreatedDate

datetime

the Date and Time if New Document Uploaded Valid Values: 0-9 Format: MM/dd/yyyy HH:mm:ss Example: 02/20/2020 20:20:20

UpdateDate

datetime

the Date and Time If Existing Document Updated Valid Values: 0-9 Format: MM/dd/yyyy HH:mm:ss Example: 02/20/2020 20:20:20

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": null
  }
}