GetStatementInformation
Action: POST
Endpoint: /api/GetStatementInformation
API Version 1.3
Request fields details
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
CardNumber string Conditional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number is required. Allowable Values: 16 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number is required. Allowable Values: 19 |
StatementDate string Mandatory |
Statement Date. Format : MMDDYYYY Example : 03102015 |
Sample request body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CardNumber": "4066836120006077", "ProxyNumber": "1316624", "StatementDate": "08062020" }
Response fields details
Fields | Description |
---|---|
Message string |
Returns Error Message in case of Error. |
Status boolean |
Returns result of API processing. If any error is found then value will be 'false' else 'true'. |
ErrorCode string |
Returns Error Code in case of Error. |
ResponseData
|
This is group of below data elements. |
AccountNumber string |
Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 |
CustomerId string |
Unique ID linked to the customer Valid Values:0-9 Example: 3212212 |
CustomerName string |
Name of the customer |
CardLimit decimal |
Total Available Balance Valid Values: 0-9 Example: 120.00 |
CardNumber string |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 |
AddressLine1 string |
Address Line 1 of the Cardholder Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point |
ReprintIndicator string |
Reserved for future use |
AddressLine2 string |
Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way |
City string |
Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross |
State string |
Cardholder State of residence Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes (US) |
Country string |
Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values |
PostalCode string |
Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093 |
PurchasesAndDebits decimal |
Sum of Debits and Credit Reversals |
TotalFees decimal |
Sum of all fees |
TotalPaymentsCreditsReturns decimal |
Sum of Credits and Debit Reversals |
CurrentBalance decimal |
This tag indicates the current balance of the account |
StatementPeriod string |
Reserved for future use |
StatementDate string |
Statement Date. Format: MMDDYYYY Example:01202021 |
LastStatementDate string |
Last Statement Date Format: MMDDYYYY Example: 09032021 |
DisputeAmount string |
Disputed amount on the card Example : 100 |
StatementMessageDetails array |
|
MessageNumber string |
Message number |
MessageType string |
Type of message |
StatementMessage string |
Message defined for Statement |
TransactionDetails array |
|
TransactionDetailList array |
|
EndingBalance decimal |
Current Balance at the end of month Example:200.00 |
MerchantLocationName string |
Name of the merchant and its location from where the transaction initiated |
CustomAccountID string |
Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789 |
NextStatementDate string |
Next Statement Date Format: MM/DD/YYYY Example: 09/03/2021 |
StatementLogo string |
Path where the logo of the product is placed. |
AnnualErrorResolutionText string |
Annual Error Resolution Text from the product |
DisplayAnnualErrorResolutionNotice string |
Annual Error Resolution Notice |
FeeDetail array |
|
FeeName string |
Name of the Fee |
TotalFeeForPeriod decimal |
Sum of all fees in given month |
TotalFeeForYear decimal |
Sum of all fees in given Year |
HeaderEmail string |
Email to be displayed in header |
HeaderCall string |
Call center number to be displayed in header |
HeaderWebsite string |
Website to be displayed in header |
FooterName string |
Name to be displayed in footer |
FooterAddLineOne string |
Address line one to be displayed in footer |
FooterAddLineTwo string |
Address line two to be displayed in footer |
FooterCity string |
City to be displayed in footer |
FooterState string |
State to be displayed in footer |
FooterPostalCode string |
Postal code to be displayed in footer |
SavingAccountTransaction array |
Purpose is to display the Saving txns list Application Version is 1.3 |
SequenceNumber string |
Card Sequence Number Valid Values:0-9 Example: 3 |
StatementDate datetime |
Statement Date. Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00 |
TransactionDate string |
Date of transaction posted on account Format: yyyy-mm-dd hh:mm:ss Example:2017-09-26 00:00:00 |
TransactingCardNumber string |
Card number from which card transaction has been performed in masked form. |
TransactionID string |
Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example : 147852369 |
TransactionDescription string |
Description of transaction Valid Values:A-Z,a-z Example: Load |
TransactionCode string |
This tag indicates the transction code that is displayed after a transaction is executed. Example: ABC14433222 |
TransactionAmount decimal |
Transaction Amount to be posted Valid value 0-9 Example: 300, 3.5 |
TransactionDebitCreditIndicator string |
Indicator showing transaction type Valid Values: CR for credit, DR for debit Example : CR |
MerchantNameAndLocation string |
Name of the merchant and its location from where the transaction initiated |
TransactionType string |
Transaction Code which indicates type of transaction |
TypeOfTransaction string |
Unique number assigned to a transaction and is used to track the transaction posted in CoreCard System Example : 147852369 |
MerchantType string |
Merchant Type. Example : 3021=Air Algerie Please refer Appendix Merchant Type. |
MerchantTypeDescription string |
Merchant Type Description Example : Air Conditioning, Heating, and Plumbing Contractors |
SpendCategory string |
Category of Transaction |
BalanceAtTransaction decimal |
Balance available after a particular transaction Valid Values:0-9 Example : 100.00 |
ProxyNumber string |
Proxy Number of the cardholder Valid values:0-9 Example:1005 |
StatementPDFData byte[] |
Statement pdf in bytes. Content type/MIME will be 'application/pdf' |
AvailableBalance number |
Available Balance of Account |
UserID string |
Purpose is Employee Id Application Version is 1.3 |
Sample response body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "AccountNumber": "60000000031846", "CustomerId": "60000000031846", "CustomerName": "k s", "CardLimit": 0.01, "CardNumber": "406683******6077", "AddressLine1": "", "ReprintIndicator": "", "AddressLine2": "", "City": "", "State": "", "Country": "US", "PostalCode": "", "PurchasesAndDebits": 111.01, "TotalFees": 130.01, "TotalPaymentsCreditsReturns": 11.01, "CurrentBalance": 12.01, "StatementDate": "", "LastStatementDate": "", "DisputeAmount": "", "StatementMessageDetails": [ { "MessageNumber": "", "MessageType": "", "StatementMessage": "" } ], "TransactionDetails": [ { "SequenceNumber": "1", "StatementDate": "2020-12-01T00:00:00", "TransactionDate": "", "TransactingCardNumber": "", "TransactionID": "", "TransactionDescription": "LOAD", "TransactionCode": "", "TransactionAmount": 125.01, "TransactionDebitCreditIndicator": "CR", "MerchantNameAndLocation": "", "TransactionType": "37", "TypeOfTransaction": "", "MerchantType": "", "MerchantTypeDescription": "", "SpendCategory": "", "BalanceAtTransaction": 125.01, "ProxyNumber": "1316624" } ], "TransactionDetailList": [ { "SequenceNumber": "", "StatementDate": "2020-12-01T00:00:00", "TransactionDate": "", "TransactingCardNumber": "", "TransactionID": "", "TransactionDescription": "", "TransactionCode": "", "TransactionAmount": 12.01, "TransactionDebitCreditIndicator": "", "MerchantNameAndLocation": "", "TransactionType": "", "TypeOfTransaction": "", "MerchantType": "", "MerchantTypeDescription": "", "SpendCategory": "", "BalanceAtTransaction": 124.01, "ProxyNumber": "" } ], "EndingBalance": 100.01, "MerchantLocationName": "", "CustomAccountID": "", "NextStatementDate": "08052020", "StatementLogo": "", "AnnualErrorResolutionText": "", "DisplayAnnualErrorResolutionNotice": "", "FeeDetail": [ { "FeeName": "", "TotalFeeForPeriod": 0.0, "TotalFeeForYear": 0.0 } ], "HeaderEmail": "", "HeaderCall": "", "HeaderWebsite": "", "FooterName": "", "FooterAddLineOne": "", "FooterAddLineTwo": "", "FooterCity": "", "FooterState": "", "FooterPostalCode": "", "SavingAccountTransaction": [ { "SequenceNumber": "1", "StatementDate": "2020-12-01T00:00:00", "TransactionDate": "", "TransactingCardNumber": "", "TransactionID": "", "TransactionDescription": "LOAD", "TransactionCode": "", "TransactionAmount": 125.01, "TransactionDebitCreditIndicator": "CR", "MerchantNameAndLocation": "", "TransactionType": "37", "TypeOfTransaction": "", "MerchantType": "", "MerchantTypeDescription": "", "SpendCategory": "", "BalanceAtTransaction": 125.01, "ProxyNumber": "1316624" } ], "StatementPDFData": "U3RhdGVtZW50UERGRGF0YQ==" } }