Statement
The statement is a summary of monetary activities and balances between a date range termed as statement or billing cycle. Normally the statement or billing happens for the card account on a monthly frequency i.e. all the monetary activities performed in the previous statement cycle will be generated at the end of the cycle date. Statement data is generated in PDF in a specified template which contains data such as account holder’s name & address, a summary of balances (Available balance, Current Balance, etc.), list of monetary transactions (Purchases and Debits, Load and Credits, etc.), Dispute Balances if any, Reward Point Balance.
The CoreCard system produces the statement for each account as per the billing cycle applicable and keeps a record of all the previous statements generated on the card account.
GetListStatementDate
Action: POST
Endpoint: /api/GetListStatementDate
Use this API to fetch the list of dates on which statement of cardholder is generated previously.
Request Fields Detail
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 |
IsCardMasked string Optional |
Flag to indicate CardNumber should be returned in masked form or in clear form. Valid Values: 0= Clear Card Number in Response. 1= Masked Card Number in Response. 2= No Card Number in Response. Note : Default value is 0 Allowable Values: 1 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "CardNumber": "", "ProxyNumber": "1314932", "IsCardMasked": "1" }
Response Fields Detail
Fields | Description |
---|---|
CardNumber string |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Note: Clear card number is depend upon value provided in IsCardMasked tag. |
ProxyNumber string |
Proxy Number of the cardholder Valid values:0-9 Example:1005 |
StatementDates array |
This property is used to Get OR Set STATEMENTDATE |
DisplayAnnualErrorResolutionNotice string |
Annual Error Resolution Notice |
AnnualErrorResolutionText string |
This property is used to Get OR Set AnnualErrorResolutionText |
institutionName string |
Name of Financial Institution Valid Values:A-Z,a-z Example:FEDERAL RESERVE BANK |
nextStatementDate string |
Next Statement Date Format: MM/DD/YYYY HH:MM:SS:SSS Example: 09/26/2017 23:59:59:000 |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "CardNumber": "406683******6085", "ProxyNumber": "1316756", "StatementDates": [ { "StatementDate": "2020-12-01T00:00:00", "TotalDebits": 120.0, "TotalCredits": 520.0 } ], "DisplayAnnualErrorResolutionNotice": "0", "AnnualErrorResolutionText": "", "institutionName": "First Century Bank", "nextStatementDate": "05/01/2021 23:59:59:000" } }
GetStatementInformation
Action: POST
Endpoint: /api/GetStatementInformation
Use this API to retrieve the statement consisting of transactions posted on the card account during a statement period/cycle. This API retrieves the list of transactions and its details which can be Used to print a statement.
Request Fields Detail
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 Detail
Fields | Description |
---|---|
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 |
|
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 |
|
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 |
StatementPDFData byte[] |
Statement pdf in bytes. Content type/MIME will be 'application/pdf' |
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==" } }