Core Card Api Quick Start

Get Statement Metadata

Action: POST

Endpoint: /api/CoreCredit/Statement/GetStatementMetadata

The API retrieves the statement metadata (i.e., field values) for periodically generating account statements by providing a statement ID or a combination of other account attributes, such card number, account number, admin number, account ID, or statement date. The API returns essential statement information, such as current balance, total due, auto-pay amount, billing cycle, payment due date, minimum due, credit limit, loyalty points, non-interest fees, interest assessed details, and APR, along with a minimum payment warning section.

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: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition:At least one of Card Number\Admin Number\Account Number\ Account id is required, when Statement ID is not provided. If Statement ID is provided then this parameter will be ignored. Allowable Values:* 19
CardNumber string Conditional	Card Number of account holder Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896541236 Condition: At least one of Card Number\Admin Number\Account Number\ Account id is required, when Statement ID is not provided. If Statement ID is provided then this parameter will be ignored. Allowable Values:* 16
AdminNumber int64 Conditional	Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: At least one of Card Number\Admin Number\Account Number\ Account id is required, when Statement ID is not provided. *If Statement ID is provided then this parameter will be ignored.
AccountID integer Conditional	Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format: XXXXX Example: 12345 Condition: At least one of Card Number\Admin Number\Account Number\ Account id is required, when Statement ID is not provided. *If Statement ID is provided then this parameter will be ignored.
StatementDate DateTime Conditional	Date when Statement is generated. Format: MM/dd/yyyy Example: 12/21/22019 Condition: Statement Date is mandatory when Statement ID is not provided. *If Statement ID is provided then this parameter will be ignored.
StatementID integer Conditional	Unique Identifier for generated Statement Valid Values: 0-9 Format: XX Condition: Statement Id is optional only when Any one from Card Number, Admin Number, Account Number, Account Id and Statement Date is provided.
ApplicantType string Optional	Selects the type of Applicants. Valid Values: 1, 2, 3 Format: x Example: 1= "Applicant", 2 ="Co-Applicant", 3= "Cosigner", Allowable Values: 20

Fields

Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

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:

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:

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

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:

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:

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:

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: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition:At least one of Card Number\Admin Number\Account Number\ Account id is required, when Statement ID is not provided. *If Statement ID is provided then this parameter will be ignored.

Allowable Values:

CardNumber

string

Conditional

Card Number of account holder Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896541236 Condition: At least one of Card Number\Admin Number\Account Number\ Account id is required, when Statement ID is not provided. *If Statement ID is provided then this parameter will be ignored.

Allowable Values:

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: At least one of Card Number\Admin Number\Account Number\ Account id is required, when Statement ID is not provided. *If Statement ID is provided then this parameter will be ignored.

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format: XXXXX Example: 12345 Condition: At least one of Card Number\Admin Number\Account Number\ Account id is required, when Statement ID is not provided. *If Statement ID is provided then this parameter will be ignored.

StatementDate

DateTime

Conditional

Date when Statement is generated. Format: MM/dd/yyyy Example: 12/21/22019 Condition: Statement Date is mandatory when Statement ID is not provided. *If Statement ID is provided then this parameter will be ignored.

StatementID

integer

Conditional

Unique Identifier for generated Statement Valid Values: 0-9 Format: XX Condition: Statement Id is optional only when Any one from Card Number, Admin Number, Account Number, Account Id and Statement Date is provided.

ApplicantType

string

Optional

Selects the type of Applicants. Valid Values: 1, 2, 3 Format: x Example: 1= "Applicant", 2 ="Co-Applicant", 3= "Cosigner",

Allowable Values:

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,
  "AccountNumber": "5000000000000033",
  "CardNumber": null,
  "AdminNumber": null,
  "AccountID": 7461,
  "StatementDate": "03/31/2016",
  "StatementID": 7272,
  "ApplicantType": null
}

Response fields details

Fields	Description
FileName string	Filename of Statement generated Valid Values: 0-9 A-Z Example: Statement_569845_02102020.PDF Allowable Values: 100
AccountNumber string	Account number of cardholder Valid Values:0-9 Example:8000000000000037 Allowable Values: 19
AccountID integer	Unique number represents account Format:XXXXX Example:12345
StatementID integer	Unique number represents statement Valid Values:0-9 Format: XX
StatementStartDate datetime	Start Date for Statement Generation Format: MM/dd/yyyy Example: 01/22/2020
StatementEndDate datetime	End Date for Statement Generation Format: MM/dd/yyyy Example: 01/22/2020
StatementDueDate datetime	Due Date for Statement Generation Format: MM/dd/yyyy Example: 01/22/2020
NextStatementDate datetime	Next Date for Statement Generation Format: MM/dd/yyyy Example: 01/22/2020
PreviousBalance decimal	Balance at statement's beginning date Valid Values: 0-9 Format: XXX.00 Example: 500.00
StatementCredits decimal	Payments made in statement duration Valid Values: 1000 Format: XXXX Example: 1000
StatementPurchases decimal	Purchases made in statement duration Valid Values: 1000 Format: XXXX Example: 1000
NonInterestFees decimal	This will show All fees charged as of statement date Valid Values: 0-9 Format: XXXX Example: 100
InterestAssesed decimal	This will show Amount of Interest charged as of statement date Valid Values: 0-9 Format: XXXX Example: 100
OtherDebits decimal	Debits on account other than purchases in statement cycle Valid Values: 0-9 Format: XXXX Example: 100
CurrentBalance decimal	Current balance of account/Debtor Owing Valid Values: 0-9 Format: XXX.XX Example: 2000.00
StatementMinPayment decimal	Minimum Payment due as per statement Valid Values: 0-9 Format: XXXX Example: 100
PreviousMinPaymentremaning decimal	Minimum Payment pending from previous statement duration Valid Values: 0-9 Format: XXXX Example: 100
CurrentMinPayment decimal	Minimum Payment due as per current balance Valid Values: 0-9 Format: XXXX Example: 100
TotalFeesChargedThisYear decimal	Total fees charged YTD Valid Values: 0-9 Format: XXXX Example: 100
TotalInterestChargedThisYear decimal	Total interest charged YTD Valid Values: 0-9 Format: XXXX Example: 100
PastDueDays integer	Number of days past due date Format: XX Example: 5 Allowable Values: 4
AutoPayAmount decimal	Amount set as Auto pay Valid Values: 0-9 Format: XX Example: 150
RemainingCashBackBalance decimal	Remaining amount as Cash back Valid Values: 0-9 Format: XX Example: 150
AccountOpenDate datetime	Date when Account was Opened Format: MM/dd/yyyy Example: 01/22/2020
AccountCloseDate datetime	Date when account was closed Format: MM/dd/yyyy Example: 01/22/2020
PaymentDueDate datetime	Date when payment is due to avoid penalty Format: MM/dd/yyyy Example: 01/22/2020
ResponseID string	Ensure that API hit our internal servers. This will always be unique.API is returned from our external server Example: 20770 Allowable Values: 15
UniversalUniqueID string	Universal Unique Identification Number generated by system From StatementHeader Example:a585f533-0d33-4282-ab98-4852146e5e17 Allowable Values: 64
GoodConsecutivePaymentCounter integer	Count of good consecutive payment done at current Statement Valid Values: 5 Format: X Example:5
AccountUniversalUniqueID string	AccountUniversal Unique Identification Number generated by system From BSegment Example:a585f533-0d33-4282-ab98-4852146e5e17 Allowable Values: 64
SummaryHeaderDetails array	Header of Summary Details Array.
StmtLoyaltyPointsList array	Header of Statement Loyalty Points array.
MinimumPaymentWarningGroup	Minimum Payment Warning Group.

Fields

Description

FileName

string

Filename of Statement generated Valid Values: 0-9 A-Z Example: Statement_569845_02102020.PDF

Allowable Values:

100

AccountNumber

string

Account number of cardholder Valid Values:0-9 Example:8000000000000037

Allowable Values:

AccountID

integer

Unique number represents account Format:XXXXX Example:12345

StatementID

integer

Unique number represents statement Valid Values:0-9 Format: XX

StatementStartDate

datetime

Start Date for Statement Generation Format: MM/dd/yyyy Example: 01/22/2020

StatementEndDate

datetime

End Date for Statement Generation Format: MM/dd/yyyy Example: 01/22/2020

StatementDueDate

datetime

Due Date for Statement Generation Format: MM/dd/yyyy Example: 01/22/2020

NextStatementDate

datetime

Next Date for Statement Generation Format: MM/dd/yyyy Example: 01/22/2020

PreviousBalance

decimal

Balance at statement's beginning date Valid Values: 0-9 Format: XXX.00 Example: 500.00

StatementCredits

decimal

Payments made in statement duration Valid Values: 1000 Format: XXXX Example: 1000

StatementPurchases

decimal

Purchases made in statement duration Valid Values: 1000 Format: XXXX Example: 1000

NonInterestFees

decimal

This will show All fees charged as of statement date Valid Values: 0-9 Format: XXXX Example: 100

InterestAssesed

decimal

This will show Amount of Interest charged as of statement date Valid Values: 0-9 Format: XXXX Example: 100

OtherDebits

decimal

Debits on account other than purchases in statement cycle Valid Values: 0-9 Format: XXXX Example: 100

CurrentBalance

decimal

Current balance of account/Debtor Owing Valid Values: 0-9 Format: XXX.XX Example: 2000.00

StatementMinPayment

decimal

Minimum Payment due as per statement Valid Values: 0-9 Format: XXXX Example: 100

PreviousMinPaymentremaning

decimal

Minimum Payment pending from previous statement duration Valid Values: 0-9 Format: XXXX Example: 100

CurrentMinPayment

decimal

Minimum Payment due as per current balance Valid Values: 0-9 Format: XXXX Example: 100

TotalFeesChargedThisYear

decimal

Total fees charged YTD Valid Values: 0-9 Format: XXXX Example: 100

TotalInterestChargedThisYear

decimal

Total interest charged YTD Valid Values: 0-9 Format: XXXX Example: 100

PastDueDays

integer

Number of days past due date Format: XX Example: 5

Allowable Values:

AutoPayAmount

decimal

Amount set as Auto pay Valid Values: 0-9 Format: XX Example: 150

RemainingCashBackBalance

decimal

Remaining amount as Cash back Valid Values: 0-9 Format: XX Example: 150

AccountOpenDate

datetime

Date when Account was Opened Format: MM/dd/yyyy Example: 01/22/2020

AccountCloseDate

datetime

Date when account was closed Format: MM/dd/yyyy Example: 01/22/2020

PaymentDueDate

datetime

Date when payment is due to avoid penalty Format: MM/dd/yyyy Example: 01/22/2020

ResponseID

string

Ensure that API hit our internal servers. This will always be unique.API is returned from our external server Example: 20770

Allowable Values:

UniversalUniqueID

string

Universal Unique Identification Number generated by system From StatementHeader Example:a585f533-0d33-4282-ab98-4852146e5e17

Allowable Values:

GoodConsecutivePaymentCounter

integer

Count of good consecutive payment done at current Statement Valid Values: 5 Format: X Example:5

AccountUniversalUniqueID

string

AccountUniversal Unique Identification Number generated by system From BSegment Example:a585f533-0d33-4282-ab98-4852146e5e17

Allowable Values:

SummaryHeaderDetails

array

Header of Summary Details Array.

StmtLoyaltyPointsList

array

Header of Statement Loyalty Points array.

MinimumPaymentWarningGroup

Minimum Payment Warning Group.

Sample response body

{
  "Message": "Statement Returned Successfully",
  "Status": true,
  "ErrorCode": "ERR01076",
  "ResponseData": {
    "FileName": "Statements/2015-10-31/Normal/5000000000000033_2015-10-31_7272_4.pdf",
    "AccountNumber": "5000000000000033",
    "AccountID": 7461,
    "StatementID": 7272,
    "StatementStartDate": "03/31/2016 00:00:00",
    "StatementEndDate": "01/22/2020 23:59:57",
    "StatementDueDate": "01/22/2020 23:59:57",
    "NextStatementDate": "01/22/2020 23:59:57",
    "PreviousBalance": 0.0,
    "StatementCredits": 4.25,
    "StatementPurchases": 50.0,
    "NonInterestFees": 37.5,
    "InterestAssesed": 5.0,
    "OtherDebits": 10.0,
    "CurrentBalance": 98.25,
    "StatementMinPayment": 50.0,
    "PreviousMinPaymentremaning": 0.0,
    "CurrentMinPayment": 50.0,
    "TotalFeesChargedThisYear": 33.75,
    "TotalInterestChargedThisYear": 5.0,
    "PastDueDays": 1229,
    "AutoPayAmount": 0.0,
    "RemainingCashBackBalance": 0.0,
    "AccountOpenDate": "03/31/2016 00:00:00",
    "AccountCloseDate": null,
    "PaymentDueDate": "03/31/2016 00:00:00",
    "ResponseID": "108397583",
    "UniversalUniqueID": null,
    "GoodConsecutivePaymentCounter": null,
    "AccountUniversalUniqueID": null,
    "TotalPayment": null,
    "SummaryHeaderDetails": [
      {
        "APR": 18.0,
        "CreditPlanAccountID": 9056,
        "CurrentBalance": 98.25,
        "Principal": 49.5,
        "TotalDue": 50.0,
        "NewTransactionsBSFC": 49.5,
        "NewTransactionsAgg": 1200.0,
        "RevolvingBSFC": 0.0,
        "RevolvingAgg": 0.0,
        "BalanceSubjectToInterestRate": 0.0
      }
    ],
    "StmtLoyaltyPointsList": [
      {
        "LoyaltyProgramID": 1,
        "LoyaltyProgramName": "abc Loyalty Program",
        "LoyaltyProgramStartDate": null,
        "LoyaltyProgramEndDate": null,
        "LoyaltyPoints": 0.0,
        "LoyaltyRewardBalance": 0.0,
        "RewardBeginningBalance": 0.0,
        "RewardBeginningBalanceAmount": null,
        "RewardEarned": null,
        "RewardEarnedAmount": null,
        "RewardRedeemed": 50.0,
        "RewardRedeemedAmount": 0.5,
        "RewardRecovered": null,
        "RewardRecoveredAmount": null,
        "PendingRedeemRewardBalance": null,
        "PendingRedeemRewardBalanceAmount": null,
        "RedeemReversalBalance": 0.0,
        "RedeemReversalBalanceAmount": 0.0,
        "ApprovedRewardRedeem": null,
        "ApprovedRewardRedeemAmount": null,
        "RewardReturn": null,
        "RewardReturnAmount": null,
        "RewardAbandoned": 0.0,
        "RewardAbandonedAmount": 0.0,
        "RewardAbandonedReversal": 0.0,
        "RewardAbandonedReversalAmount": 0.0,
        "PointsEarnedYTD": null,
        "AmountEarnedYTD": null,
        "PointsEarnedLTD": null,
        "AmountEarnedLTD": null
      }
    ],
    "MinimumPaymentWarningGroup": {
      "MinPaymentAmtWhenPaidMinDuesMonthly": "Only the minimum payment",
      "PayoffMonthsWhenPaidMinDuesMonthly": "3 months",
      "PayoffTotalCostWhenPaidMinDuesMonthly": "$101",
      "MinPaymentAmtWhenPaidAdvisedDuesMonthly": null,
      "PayoffMonthsWhenPaidAdvisedDuesMonthly": null,
      "PayoffTotalCostWhenPaidAdvicedDuesMonthly": null,
      "PayoffCostSaving": null
    }
  }
}