Get Account Documents
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetAccountDocuments
Use this API to retrieve documents available for the card account by the account number or D or admin number. The API fetches the list of the account documents along with information such as the cardholder's account number, merchant ID under which the card account is created, and the date the document was added.
Request fields details
Fields | Description |
---|---|
Source string Mandatory |
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 |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 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 Mandatory |
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 Mandatory |
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 |
Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXX Example:123654789632 Condition:At least one of AccountNumber/AdminNumber/AccountID is required. Allowable Values: 19 |
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 Example:12345 Condition:At least one of AccountNumber/AdminNumber/AccountID is required. |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Example:12345 Condition:At least one of AccountNumber/AdminNumber/AccountID is required. |
DisputeCaseID int64 Conditional |
Case ID assigned to a Dispute Case. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 23654789 |
SKeyList string Optional |
System Unique ID, to be Used as Input while Deleting or Updating Account Documents. Valid Values: 0-9 Example: 17852 |
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": "8110000000000109", "AccountID": null, "AdminNumber": null, "DisputeCaseID": null, "SKeyList": null }
Response fields details
Fields | Description |
---|---|
ListAccountDocument array |
Details of Documents available for the Account. |
Sample response body
{ "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "ListAccountDocument": [ { "SUID": 1, "DocumentType": "Bankruptcy Paper", "DocumentName": "adhar_07232020085039.PNG", "UploadBy": "portalsuperuser", "AccountID": 167615, "AccountNumber": "8110000000000380", "MerchantID": 11617, "CreatedDate": "03/15/2020 00:00:00", "UpdateDate": null, "IsDeleted": false, "BinaryData": "ICAgICAgIA==", "DisputeDocumentCategory": null, "DisputeCaseID": null, "DisputeDocumentSource": null, "FileSize": null } ] } }