Statements and billing
Produce the statement a cardholder reads, and manage the period, delivery preference and address behind it.
getCardStatementSummary
Retrieves a summary of a credit card statement for a given main card reference and statement date. Returns information such as minimum payment amount, previous total amount, remaining debt, statement date, earned points, due date, next statement date, next due date, currency code, statement debt, total earned points, and remaining minimum payment debt.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardStatementSummary › Request Body
mainCardRefNumberMain Card Ref Number - [Optional]
statementDateStatement Date - [Optional]
getCardStatementSummary › Responses
Success
minimumPaymentAmountMinimum Payment Amount
prevTotalAmountPrev Total Amount
remainingDebtRemaining Debt
statementDateStatement Date
earnedPointAmountEarned Point Amount
dueDateDue Date
nextStatementDateNext Statement Date
nextDueDateNext Due Date
statementDebtStatement Debt
totalEarnedPointAmountTotal Earned Point Amount
remainingMinimumPaymentDebtRemaining Minimum Payment Debt
currencyCodeCurrency Code - [Optional]
getCardStatementDetail
Retrieves detailed credit card statement information including transaction rows, totals, installment details, reward points, and payment history. Supports filtering by statement date and channel, handles historical and current statement data, and maps results to CreditCardDetailTransactionItem objects.
Part of:
- Journey 02 · Managing a card product — step 1, Retrieve statements
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardStatementDetail › Request Body
channelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
mainCardRefNumberMain Card Ref Number - [Optional]
statementDateStatement Date - [Optional]
minStatementDateMin Statement Date - [Optional]
getCardStatementDetail › Responses
Success
List Of Card Statement Detail Row - [Optional]
prevTotalAmountPrev Total Amount - [Optional]
totalAmountTotal Amount - [Optional]
totalDebitTotal Debit - [Optional]
totalCreditTotal Credit - [Optional]
totalCashTotal Cash - [Optional]
totalProfitFeeTaxTotal Profit Fee Tax - [Optional]
totalProfitTotal Profit - [Optional]
totalFeeTotal Fee - [Optional]
totalTax1Total Tax1 - [Optional]
totalTax2Total Tax2 - [Optional]
Statement Reward Details - [Optional]
getCreditCardStatementSendPreference
Retrieves credit card statement delivery preferences for a customer using CustomerNumber and channel. Fetches customer-level statement delivery settings and active main credit cards, and returns per-card preferences including statement email, SMS, and physical posting options along with the posting address type.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCreditCardStatementSendPreference › Request Body
channelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
customerNumberCustomer Number - [Optional]
getCreditCardStatementSendPreference › Responses
Success
Credit Card Statement Send Preference List - [Optional]
getCardStatementList
Retrieves a list of credit card statements for a given main card reference or shadow card number. Returns statement information including total amount, minimum amount, statement date, next statement date, due date, next due date, currency code, document ID, and associated reward details for each statement.
Part of:
- Journey 02 · Managing a card product — step 1, Retrieve statements
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardStatementList › Request Body
shadowCardNumberShadow Card Number - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
getCardStatementList › Responses
Success
Card Statement Info List - [Optional]
getCreditCardLastStatement
Retrieves the most recent credit card statement information using ShadowCardNumber and channel. Validates card identifiers, resolves the main card reference number, and fetches the latest statement summary. Returns existing reward points, detailed last statement data, and a list of recent statement summaries ordered by statement period.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCreditCardLastStatement › Request Body
channelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
getCreditCardLastStatement › Responses
Success
existingPointExisting Point
Credit Card Statement - [Optional]
Card Statement Info List - [Optional]
getCreditCardLastStatementNew
Retrieves the most recent credit card statement information using ShadowCardNumber and channel. Validates card identifiers, resolves the main card reference number, and fetches the latest statement summary. Returns existing reward points, detailed last statement data, and a list of recent statement summaries ordered by statement period.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCreditCardLastStatementNew › Request Body
channelThree-digit channel code (for example "002", not "Internet"). Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.
shadowCardNumberShadow Card Number - [Optional]
getCreditCardLastStatementNew › Responses
Success
existingPointExisting Point
Credit Card Statement - [Optional]
Card Statement Info List - [Optional]
getCardStatementDetailSummary
Retrieves a summary of credit card statement details including transaction rows, total amounts, minimum payments, remaining debt, earned points, due dates, and currency information. Uses GetCardStatementDetail or GetCardStatementDetailNew internally and maps results to GetCardStatementDetailSummaryResponse objects.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardStatementDetailSummary › Request Body
mainCardRefNumberMain Card Ref Number - [Optional]
statementDateStatement Date - [Optional]
getCardStatementDetailSummary › Responses
Success
minimumPaymentAmountMinimum Payment Amount
prevTotalAmountPrev Total Amount
remainingDebtRemaining Debt
statementDateStatement Date
earnedPointAmountEarned Point Amount
dueDateDue Date
nextStatementDateNext Statement Date
nextDueDateNext Due Date
statementDebtStatement Debt
totalEarnedPointAmountTotal Earned Point Amount
remainingMinimumPaymentDebtRemaining Minimum Payment Debt
List Of Card Statement Detail Row - [Optional]
currencyCodeCurrency Code - [Optional]
getCardStatementDetailSummaryNew
Retrieves a summary of credit card statement details including transaction rows, total amounts, minimum payments, remaining debt, earned points, due dates, and currency information. Uses GetCardStatementDetail or GetCardStatementDetailNew internally and maps results to GetCardStatementDetailSummaryResponse objects.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardStatementDetailSummaryNew › Request Body
mainCardRefNumberMain Card Ref Number - [Optional]
statementDateStatement Date - [Optional]
getCardStatementDetailSummaryNew › Responses
Success
minimumPaymentAmountMinimum Payment Amount
prevTotalAmountPrev Total Amount
remainingDebtRemaining Debt
statementDateStatement Date
earnedPointAmountEarned Point Amount
dueDateDue Date
nextStatementDateNext Statement Date
nextDueDateNext Due Date
statementDebtStatement Debt
totalEarnedPointAmountTotal Earned Point Amount
remainingMinimumPaymentDebtRemaining Minimum Payment Debt
List Of Card Statement Detail Row - [Optional]
currencyCodeCurrency Code - [Optional]
changeCreditCardStatementPeriod
Changes the statement period of a credit card. Validates input, retrieves the card master data, and calls the lifecycle service to update the statement period. Returns the record ID of the change. Also supports calculating the next statement dates without updating.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCreditCardStatementPeriod › Request Body
statementPeriodStatement Period
shadowCardNumberShadow Card Number - [Optional]
changeCreditCardStatementPeriod › Responses
Success
changeRecordIdChange Record Id
getStatementPeriodChangeCount
Retrieves the count of statement period changes for a given credit card. The service calls the lifecycle service proxy with the CardRefNumber and returns a GetStatementPeriodChangeCountResponse containing the number of changes (ChangeCount) and a flag indicating whether the allowed change count has been exceeded (ChangeCountExceeded).
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getStatementPeriodChangeCount › Request Body
cardRefNumberCard Ref Number - [Optional]
getStatementPeriodChangeCount › Responses
Success
changeCountExceededChange Count Exceeded
changeCountChange Count
getCalculatedStatementPeriod
Calculates the first and next statement dates for a given shadow card number based on the provided new statement period code.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCalculatedStatementPeriod › Request Body
newStatementCodeNew Statement Code
shadowCardNumberShadow Card Number - [Optional]
getCalculatedStatementPeriod › Responses
Success
firstStatementDateFirst Statement Date - [Optional]
nextStatementDateNext Statement Date - [Optional]
getStatementPeriodByProductNumber
Retrieves the statement periods associated with a given credit card product number. The service validates that the ProductNumber is not null or empty, calls the repository to get statement period information, and returns a GetStatementPeriodByProductNumberResponse containing a list of StatementCodeInfo objects with StatementCode and Description.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getStatementPeriodByProductNumber › Responses
Success
List Of Statement Period - [Optional]
changeCreditCardStatementSendPreference
Updates the credit card statement delivery preferences. Allows changing email, SMS, and postal delivery flags for the main card. Calls the lifecycle service to persist the preferences and returns an empty response object.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCreditCardStatementSendPreference › Request Body
mainCardRefNumberMain Card Ref Number - [Optional]
emailSendFlagEmail Send Flag - [Optional]
postingFlagPosting Flag - [Optional]
smsSendFlagSms Send Flag - [Optional]
postingAddressTypePosting Address Type - [Optional]
changeCreditCardStatementSendPreference › Responses
getCardStatementAddressInformation
Retrieves statement delivery preferences for a credit card based on MainCardRefNumber. Includes flags for statement posting, email, and SMS delivery. Fetches CardMaster and CustomerMaster data.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardStatementAddressInformation › Request Body
mainCardRefNumberMain Card Ref Number - [Optional]
getCardStatementAddressInformation › Responses
Success
statementPostingFlagStatement Posting Flag
statementSmsSendFlagStatement Sms Send Flag
statementEMailSendFlagStatement E Mail Send Flag
addressIdAddress Id
addressTypeAddress Type - [Optional]
statementSendAddressTypeStatement Send Address Type - [Optional]
emailEmail - [Optional]
getCardFinancialInfoByCardRefNumber
Retrieves detailed financial information for a card based on CardRefNumber, including limits, debts, statement info, delinquency status, and reward details for the card and customer.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardFinancialInfoByCardRefNumber › Request Body
cardRefNumberCard Ref Number - [Optional]
customerNumberCustomer Number - [Optional]
shadowCardNumberShadow Card Number - [Optional]
getCardFinancialInfoByCardRefNumber › Responses
Success
Card Financial Info By Card Ref Number Item List - [Optional]
Customer Reward Details - [Optional]
getStatementPeriodChangeInfo
Retrieves detailed information about statement period changes for a specific credit card. The service validates the CardRefNumber, fetches the card master record, and then retrieves statement change info from the repository. The response includes the current StatementDate, the next two statement dates (Next1StatementDate, Next2StatementDate), the LastChangeDate, the remaining allowed yearly statement changes (YearlyRemainingStatementChangeCount), and a flag indicating whether a statement period change is currently available (IsStatementPeriodChangeAvailable).
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getStatementPeriodChangeInfo › Responses
Success
yearlyRemainingStatementChangeCountYearly Remaining Statement Change Count
statementDateStatement Date - [Optional]
next1StatementDateNext1 Statement Date - [Optional]
next2StatementDateNext2 Statement Date - [Optional]
lastChangeDateLast Change Date - [Optional]
isStatementPeriodChangeAvailableIs Statement Period Change Available - [Optional]