Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      getCreditApplicationIdByFromShadowCardNumberpostsubmitCardApplicationExtStatuspost
    Card issuance and personalisation
      createIndividualCardpostcreateIndividualSupplementaryCardpostcreateDummyCorporateCardpostcreateCorporateCardpostcreateVirtualCardpostgetApplicableProductsByCustomerNumberpostgetApplicableProductsByMainCustomerPreControlpostcreateNoNameCardpostcancelCardEmbossByShadowCardNumberpostgetPendingCardEmbossListpost
    Card lifecycle
      getCardListpostreplaceCardpostgetCardMemopostchangeCardStatuspostchangeCustomerCreditCardStatuspostchangeAndReplaceCardpostgetRenewCountByShadowCardNumberpostgetCreditCardInfopostgetCustomerCreditCardListByTenantIdpostgetCustomerCreditShadowCardsByTenantIdpostgetCustomerCreditCardListByTenantIdProductNumberpostgetCardListNewpost
    No-name cards
      activateNoNameCardpostreplaceNoNameCardpostreplaceCardUsingNoNameApplicationpostchangeAndReplaceNoNameCardpostcancelNoNameCardApplicationpost
Customers and accounts
    Branch management
      changeCardBranchpostchangeCustomerBranchposttransferBranchCustomerpostgetCreditCustomerListOfBranchpost
    Customers
      getCorporateCustomerInfoByIndividualCustomerpostgetCustomerAssetsSummaryCreditpost
    Account linking
      attachCardAccountpostdetachCardAccountpostdetachCardAccountByAccountNumberpostlistCardAccountByAccountNumberpostlistCardAccountByShadowCardNumberpostrecreateCustomerCardAccountpost
Transactions
    doPaymentTransactionpostreversePaymentTransactionpostdoPaymentFeeInquirypostgetCustomerTransactionDetailpostgetCardIntermTransactionInfopostgetPendingProvisionListpostgetCreditCardTransactionAllpostgetCreditCardCurrentTransactionListpostgetTransactionAllpostgetPendingProvisionListNewpostgetDigitalSlipReceiptpost
    Cash advance
      getCashAdvanceInfopostdoCashAdvancepostreverseCashAdvancepostgetCancelableCashAdvanceListpost
Limits and controls
    Card and customer limits
      changeCardLimitDecreasepostchangeCardLimitIncreasepostchangeCardLimitReversepostresetCardLimitpostchangeCardAutoLimitIncreasepostgetCustomerTotalLimitInfopostgetCreditCardLimitpostgetCardAvailableLimitpostgetCustomerAvailableLimitpostchangeCorporateCardLimitDecreasepostchangeCorporateCardLimitIncreasepostchangeIndividualCardLimitpostdecreaseCustomerLimitpostchangeVirtualCardLimitpost
    Operation limits
      getCardOperationLimitpostsetCardOperationLimitpostremoveCardOperationLimitpostgetCardLimitationParameterDatapostgetCustomerOperationLimitpostsetCustomerOperationLimitpostremoveCustomerOperationLimitpostgetCustomerLimitationParameterDatapost
    Permissions and restrictions
      getCardPermissionspostsaveCardPermissionspostchangeCardMiscOptionpostgetCardMiscOptionpost
Instalments
    getEarlyCloseCandidateListpostdoEarlyClosepostgetInstallmentCountsByUtidpostgetCashInstallmentParameterpostsimulateCashInstallmentForAllpostsimulateCashInstallmentpostdoCashInstallmentpostreverseCashInstallmentpostgetCancelableCashInstallmentListpostgetEarlyReleaseCashInstallmentspostgetEarlyReleaseCashInstallmentpostdoCashInstallmentEarlyReleasePaymentpostcancelCashInstallEarlyReleasePaymentpostgetAllWaitingInstallmentspostgetWaitingInstallmentDetailpostgetWaitingInstallmentSummarypostmanuelInstallmentOrderpostmanuelInstallmentOrderSimulatepostgetInstallmentCountsByUtidNewpostcancelInstallmentEarlyReleasepostgetManuelInstallmentCancelRecordsByCardRefNumberpostgetEarlyReleaseAvailableInstallmentsByCriteriaspostsimulateInstallmentEarlyReleasepostreleasePendingInstallmentpostcancelInstallmentTransactionOrderpost
Billing and statements
    Collections and legal follow-up
      getCardDelinquencyInfoByCustomerNumberpostgetCreditCardCollectionInfoByCardRefNumberpostgetCreditCardCollectionInfoByMainCustomerNumberpostgetCreditCardCollectionTransactionListByDatepostgetCreditCardPortfolioSummarypost
    Debt payment
      checkCreditCardForDebtPaymentpostdoCreditCardDebtPaymentpostcancelCreditCardDebtPaymentpostgetCancelableCreditCardDebtPaymentListpostsaveCreditCardAutoPaymentOrderpostgetCreditCardAutoPaymentOrderpost
    Statements and billing
      getCardStatementSummarypostgetCardStatementDetailpostgetCreditCardStatementSendPreferencepostgetCardStatementListpostgetCreditCardLastStatementpostgetCreditCardLastStatementNewpostgetCardStatementDetailSummarypostgetCardStatementDetailSummaryNewpostchangeCreditCardStatementPeriodpostgetStatementPeriodChangeCountpostgetCalculatedStatementPeriodpostgetStatementPeriodByProductNumberpostchangeCreditCardStatementSendPreferencepostgetCardStatementAddressInformationpostgetCardFinancialInfoByCardRefNumberpostgetStatementPeriodChangeInfopost
Security
    PIN and card security
      setCardPinpostchangeCardPinpostverifyCardPinpostverifyRsaPinpostverifyRsaPinWithStaticSaltpostsetRsaPinpostincreasePinTryCountpostchangeRsaPinpostverifyCardVerificationValuepostgenerateCardVVpostverifyPartialCardVerificationValuepostresetCvvCounterpost
Disputes
    Disputes and chargebacks
      createDisputeCasepostcancelDisputeCasepostaddDocumentByCaseNumberpostgetDisputeListpostgetDisputeReasonDefListpost
Rewards
    Campaigns and rewards
      getCreditCardDateRangeForRewardByCustomerNumberReqSourcepost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getAvailableCardStatusListpost
SchemasError codesChannels
powered by Zudoku
Credit Digital Channels Integration
Credit Digital Channels Integration

Statements and billing

Produce the statement a cardholder reads, and manage the period, delivery preference and address behind it.


getCardStatementSummary

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getCardStatementSummary › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardStatementSummary › Request Body

GetCardStatementSummaryRequest
mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

statementDate
​string · date-time

Statement Date - [Optional]

getCardStatementSummary › Responses

Success

GetCardStatementSummaryResponse
minimumPaymentAmount
​number · double · required

Minimum Payment Amount

prevTotalAmount
​number · double · required

Prev Total Amount

remainingDebt
​number · double · required

Remaining Debt

statementDate
​string · date-time · required

Statement Date

earnedPointAmount
​number · double · required

Earned Point Amount

dueDate
​string · date-time · required

Due Date

nextStatementDate
​string · date-time · required

Next Statement Date

nextDueDate
​string · date-time · required

Next Due Date

statementDebt
​number · double · required

Statement Debt

totalEarnedPointAmount
​number · double · required

Total Earned Point Amount

remainingMinimumPaymentDebt
​number · double · required

Remaining Minimum Payment Debt

currencyCode
​string | null

Currency Code - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementSummary
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementSummary \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2024-08-25T15:00:00Z" }
json
application/json
Example Responses
{ "minimumPaymentAmount": 0, "prevTotalAmount": 0, "remainingDebt": 0, "statementDate": "2024-08-25T15:00:00Z", "earnedPointAmount": 0, "dueDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z", "currencyCode": "currencyCode", "statementDebt": 0, "totalEarnedPointAmount": 0, "remainingMinimumPaymentDebt": 0 }
json
application/json

getCardStatementDetail

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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

getCardStatementDetail › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardStatementDetail › Request Body

GetCardStatementDetailRequest
channel
​string | null

Three-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.

Example: 002
mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

statementDate
​string | null · date-time

Statement Date - [Optional]

minStatementDate
​string | null · date-time

Min Statement Date - [Optional]

getCardStatementDetail › Responses

Success

GetCardStatementDetailResponse
​array | null

List Of Card Statement Detail Row - [Optional]

prevTotalAmount
​number | null · double

Prev Total Amount - [Optional]

totalAmount
​number | null · double

Total Amount - [Optional]

totalDebit
​number | null · double

Total Debit - [Optional]

totalCredit
​number | null · double

Total Credit - [Optional]

totalCash
​number | null · double

Total Cash - [Optional]

totalProfitFeeTax
​number | null · double

Total Profit Fee Tax - [Optional]

totalProfit
​number | null · double

Total Profit - [Optional]

totalFee
​number | null · double

Total Fee - [Optional]

totalTax1
​number | null · double

Total Tax1 - [Optional]

totalTax2
​number | null · double

Total Tax2 - [Optional]

​array | null

Statement Reward Details - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetail
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetail \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "002", "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2024-08-25T15:00:00Z", "minStatementDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "channel": "002", "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2024-08-25T15:00:00Z", "minStatementDate": "2024-08-25T15:00:00Z" }
json
application/json
Example Responses
{ "listOfCardStatementDetailRow": [ { "remainingInstallAmount": 0, "utid": "utid", "authorizationNumber": "authorizationNumber", "panEntryMode": "panEntryMode", "panEntryModeDescription": "panEntryModeDescription", "rrn": "rrn", "amount": 0, "currencyCode": "currencyCode", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "date": "2024-08-25T15:00:00Z", "description": "description", "earnedPoint": { "amount": 0, "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription" }, "isDeferrable": true, "isSplittableIntoInstallments": true, "totalInstallmentCount": 0, "currentInstallmentNumber": 0, "trnCodeMatrixId": "trnCodeMatrixId", "trnCodeMatrixDescription": "trnCodeMatrixDescription", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "mainCardRefNumber": "mainCardRefNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "mCCGroupDescription": "mCCGroupDescription", "mccDescription": "mccDescription", "trnEffect": "trnEffect", "channelType": "channelType", "channelTypeDescription": "channelTypeDescription", "sourceNetwork": "sourceNetwork", "networkTypeDescription": "networkTypeDescription", "supplementaryCardFlag": true, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "installOrderedFlag": true, "orderedInstallCount": 0, "orderedDeferCount": 0, "recordId": 0, "earlyReleaseOrderedFlag": true, "statementFlag": true, "digitalSlipFlag": true, "digitalSlipValue": "digitalSlipValue", "currentEodDate": "2024-08-25T15:00:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z" } ], "prevTotalAmount": 0, "totalAmount": 0, "totalDebit": 0, "totalCredit": 0, "totalCash": 0, "totalProfitFeeTax": 0, "totalProfit": 0, "totalFee": 0, "totalTax1": 0, "totalTax2": 0, "statementRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "revolvingTotalReward": 0 } ] }
json
application/json

getCreditCardStatementSendPreference

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getCreditCardStatementSendPreference › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCreditCardStatementSendPreference › Request Body

GetCreditCardStatementSendPreferenceRequest
channel
​string | null

Three-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.

Example: 002
customerNumber
​integer · int64

Customer Number - [Optional]

getCreditCardStatementSendPreference › Responses

Success

GetCreditCardStatementSendPreferenceResponse
​array | null

Credit Card Statement Send Preference List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardStatementSendPreference
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardStatementSendPreference \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "002", "customerNumber": 0 }'
Example Request Body
{ "channel": "002", "customerNumber": 0 }
json
application/json
Example Responses
{ "creditCardStatementSendPreferenceList": [ { "mainCardRefNumber": "mainCardRefNumber", "statementEMailSendFlag": true, "statementPostingFlag": true, "statementSmsSendFlag": true, "postingAddressType": "postingAddressType" } ] }
json
application/json

getCardStatementList

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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

getCardStatementList › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardStatementList › Request Body

GetCardStatementListRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

getCardStatementList › Responses

Success

CardStatementInfoResponse
​array | null

Card Statement Info List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementList
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementList \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber" }
json
application/json
Example Responses
{ "cardStatementInfoList": [ { "amount": 0, "minAmount": 0, "date": "2024-08-25T15:00:00Z", "statementCode": "statementCode", "currencyCode": "currencyCode", "dueDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z", "documentID": "documentID", "statementRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "revolvingTotalReward": 0 } ] } ] }
json
application/json

getCreditCardLastStatement

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getCreditCardLastStatement › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCreditCardLastStatement › Request Body

GetCreditCardLastStatementRequest
channel
​string | null

Three-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.

Example: 002
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

getCreditCardLastStatement › Responses

Success

GetCreditCardLastStatementResponse
existingPoint
​number · double · required

Existing Point

​object

Credit Card Statement - [Optional]

​array | null

Card Statement Info List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardLastStatement
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardLastStatement \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "002", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "channel": "002", "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
{ "existingPoint": 0, "creditCardStatement": { "recordId": 0, "statementDebt": 0, "minimumPaymentAmount": 0, "remainingDebt": 0, "prevTotalAmount": 0, "statementDate": "2024-08-25T15:00:00Z", "dueDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z", "currencyCode": "currencyCode", "remainingMinimumPaymentDebt": 0, "listOfTransaction": [ { "remainingInstallAmount": 0, "utid": "utid", "authorizationNumber": "authorizationNumber", "panEntryMode": "panEntryMode", "panEntryModeDescription": "panEntryModeDescription", "rrn": "rrn", "amount": 0, "currencyCode": "currencyCode", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "date": "2024-08-25T15:00:00Z", "description": "description", "earnedPoint": { "amount": 0, "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription" }, "isDeferrable": true, "isSplittableIntoInstallments": true, "totalInstallmentCount": 0, "currentInstallmentNumber": 0, "trnCodeMatrixId": "trnCodeMatrixId", "trnCodeMatrixDescription": "trnCodeMatrixDescription", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "mainCardRefNumber": "mainCardRefNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "mCCGroupDescription": "mCCGroupDescription", "mccDescription": "mccDescription", "trnEffect": "trnEffect", "channelType": "channelType", "channelTypeDescription": "channelTypeDescription", "sourceNetwork": "sourceNetwork", "networkTypeDescription": "networkTypeDescription", "supplementaryCardFlag": true, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "installOrderedFlag": true, "orderedInstallCount": 0, "orderedDeferCount": 0, "recordId": 0, "earlyReleaseOrderedFlag": true, "statementFlag": true, "digitalSlipFlag": true, "digitalSlipValue": "digitalSlipValue", "currentEodDate": "2024-08-25T15:00:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z" } ] }, "cardStatementInfoList": [ { "amount": 0, "minAmount": 0, "date": "2024-08-25T15:00:00Z", "statementCode": "statementCode", "currencyCode": "currencyCode", "dueDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z", "documentID": "documentID", "statementRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "revolvingTotalReward": 0 } ] } ] }
json
application/json

getCreditCardLastStatementNew

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getCreditCardLastStatementNew › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCreditCardLastStatementNew › Request Body

GetCreditCardLastStatementRequest
channel
​string | null

Three-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.

Example: 002
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

getCreditCardLastStatementNew › Responses

Success

GetCreditCardLastStatementResponse
existingPoint
​number · double · required

Existing Point

​object

Credit Card Statement - [Optional]

​array | null

Card Statement Info List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardLastStatementNew
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardLastStatementNew \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "002", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "channel": "002", "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
{ "existingPoint": 0, "creditCardStatement": { "recordId": 0, "statementDebt": 0, "minimumPaymentAmount": 0, "remainingDebt": 0, "prevTotalAmount": 0, "statementDate": "2024-08-25T15:00:00Z", "dueDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z", "currencyCode": "currencyCode", "remainingMinimumPaymentDebt": 0, "listOfTransaction": [ { "remainingInstallAmount": 0, "utid": "utid", "authorizationNumber": "authorizationNumber", "panEntryMode": "panEntryMode", "panEntryModeDescription": "panEntryModeDescription", "rrn": "rrn", "amount": 0, "currencyCode": "currencyCode", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "date": "2024-08-25T15:00:00Z", "description": "description", "earnedPoint": { "amount": 0, "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription" }, "isDeferrable": true, "isSplittableIntoInstallments": true, "totalInstallmentCount": 0, "currentInstallmentNumber": 0, "trnCodeMatrixId": "trnCodeMatrixId", "trnCodeMatrixDescription": "trnCodeMatrixDescription", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "mainCardRefNumber": "mainCardRefNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "mCCGroupDescription": "mCCGroupDescription", "mccDescription": "mccDescription", "trnEffect": "trnEffect", "channelType": "channelType", "channelTypeDescription": "channelTypeDescription", "sourceNetwork": "sourceNetwork", "networkTypeDescription": "networkTypeDescription", "supplementaryCardFlag": true, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "installOrderedFlag": true, "orderedInstallCount": 0, "orderedDeferCount": 0, "recordId": 0, "earlyReleaseOrderedFlag": true, "statementFlag": true, "digitalSlipFlag": true, "digitalSlipValue": "digitalSlipValue", "currentEodDate": "2024-08-25T15:00:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z" } ] }, "cardStatementInfoList": [ { "amount": 0, "minAmount": 0, "date": "2024-08-25T15:00:00Z", "statementCode": "statementCode", "currencyCode": "currencyCode", "dueDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z", "documentID": "documentID", "statementRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "revolvingTotalReward": 0 } ] } ] }
json
application/json

getCardStatementDetailSummary

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getCardStatementDetailSummary › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardStatementDetailSummary › Request Body

GetCardStatementDetailSummaryRequest
mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

statementDate
​string · date-time

Statement Date - [Optional]

getCardStatementDetailSummary › Responses

Success

GetCardStatementDetailSummaryResponse
minimumPaymentAmount
​number · double · required

Minimum Payment Amount

prevTotalAmount
​number · double · required

Prev Total Amount

remainingDebt
​number · double · required

Remaining Debt

statementDate
​string · date-time · required

Statement Date

earnedPointAmount
​number · double · required

Earned Point Amount

dueDate
​string · date-time · required

Due Date

nextStatementDate
​string · date-time · required

Next Statement Date

nextDueDate
​string · date-time · required

Next Due Date

statementDebt
​number · double · required

Statement Debt

totalEarnedPointAmount
​number · double · required

Total Earned Point Amount

remainingMinimumPaymentDebt
​number · double · required

Remaining Minimum Payment Debt

​array | null

List Of Card Statement Detail Row - [Optional]

currencyCode
​string | null

Currency Code - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetailSummary
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetailSummary \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2024-08-25T15:00:00Z" }
json
application/json
Example Responses
{ "listOfCardStatementDetailRow": [ { "remainingInstallAmount": 0, "utid": "utid", "authorizationNumber": "authorizationNumber", "panEntryMode": "panEntryMode", "panEntryModeDescription": "panEntryModeDescription", "rrn": "rrn", "amount": 0, "currencyCode": "currencyCode", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "date": "2024-08-25T15:00:00Z", "description": "description", "earnedPoint": { "amount": 0, "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription" }, "isDeferrable": true, "isSplittableIntoInstallments": true, "totalInstallmentCount": 0, "currentInstallmentNumber": 0, "trnCodeMatrixId": "trnCodeMatrixId", "trnCodeMatrixDescription": "trnCodeMatrixDescription", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "mainCardRefNumber": "mainCardRefNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "mCCGroupDescription": "mCCGroupDescription", "mccDescription": "mccDescription", "trnEffect": "trnEffect", "channelType": "channelType", "channelTypeDescription": "channelTypeDescription", "sourceNetwork": "sourceNetwork", "networkTypeDescription": "networkTypeDescription", "supplementaryCardFlag": true, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "installOrderedFlag": true, "orderedInstallCount": 0, "orderedDeferCount": 0, "recordId": 0, "earlyReleaseOrderedFlag": true, "statementFlag": true, "digitalSlipFlag": true, "digitalSlipValue": "digitalSlipValue", "currentEodDate": "2024-08-25T15:00:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z" } ], "minimumPaymentAmount": 0, "prevTotalAmount": 0, "remainingDebt": 0, "statementDate": "2024-08-25T15:00:00Z", "earnedPointAmount": 0, "dueDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z", "currencyCode": "currencyCode", "statementDebt": 0, "totalEarnedPointAmount": 0, "remainingMinimumPaymentDebt": 0 }
json
application/json

getCardStatementDetailSummaryNew

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getCardStatementDetailSummaryNew › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardStatementDetailSummaryNew › Request Body

GetCardStatementDetailSummaryRequest
mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

statementDate
​string · date-time

Statement Date - [Optional]

getCardStatementDetailSummaryNew › Responses

Success

GetCardStatementDetailSummaryResponse
minimumPaymentAmount
​number · double · required

Minimum Payment Amount

prevTotalAmount
​number · double · required

Prev Total Amount

remainingDebt
​number · double · required

Remaining Debt

statementDate
​string · date-time · required

Statement Date

earnedPointAmount
​number · double · required

Earned Point Amount

dueDate
​string · date-time · required

Due Date

nextStatementDate
​string · date-time · required

Next Statement Date

nextDueDate
​string · date-time · required

Next Due Date

statementDebt
​number · double · required

Statement Debt

totalEarnedPointAmount
​number · double · required

Total Earned Point Amount

remainingMinimumPaymentDebt
​number · double · required

Remaining Minimum Payment Debt

​array | null

List Of Card Statement Detail Row - [Optional]

currencyCode
​string | null

Currency Code - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetailSummaryNew
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetailSummaryNew \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2024-08-25T15:00:00Z" }
json
application/json
Example Responses
{ "listOfCardStatementDetailRow": [ { "remainingInstallAmount": 0, "utid": "utid", "authorizationNumber": "authorizationNumber", "panEntryMode": "panEntryMode", "panEntryModeDescription": "panEntryModeDescription", "rrn": "rrn", "amount": 0, "currencyCode": "currencyCode", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "date": "2024-08-25T15:00:00Z", "description": "description", "earnedPoint": { "amount": 0, "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription" }, "isDeferrable": true, "isSplittableIntoInstallments": true, "totalInstallmentCount": 0, "currentInstallmentNumber": 0, "trnCodeMatrixId": "trnCodeMatrixId", "trnCodeMatrixDescription": "trnCodeMatrixDescription", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "mainCardRefNumber": "mainCardRefNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "mCCGroupDescription": "mCCGroupDescription", "mccDescription": "mccDescription", "trnEffect": "trnEffect", "channelType": "channelType", "channelTypeDescription": "channelTypeDescription", "sourceNetwork": "sourceNetwork", "networkTypeDescription": "networkTypeDescription", "supplementaryCardFlag": true, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "installOrderedFlag": true, "orderedInstallCount": 0, "orderedDeferCount": 0, "recordId": 0, "earlyReleaseOrderedFlag": true, "statementFlag": true, "digitalSlipFlag": true, "digitalSlipValue": "digitalSlipValue", "currentEodDate": "2024-08-25T15:00:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z" } ], "minimumPaymentAmount": 0, "prevTotalAmount": 0, "remainingDebt": 0, "statementDate": "2024-08-25T15:00:00Z", "earnedPointAmount": 0, "dueDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z", "currencyCode": "currencyCode", "statementDebt": 0, "totalEarnedPointAmount": 0, "remainingMinimumPaymentDebt": 0 }
json
application/json

changeCreditCardStatementPeriod

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

changeCreditCardStatementPeriod › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

changeCreditCardStatementPeriod › Request Body

ChangeCreditCardStatementPeriodRequest
statementPeriod
​string · required

Statement Period

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

changeCreditCardStatementPeriod › Responses

Success

ChangeCreditCardStatementPeriodResponse
changeRecordId
​integer · int64 · required

Change Record Id

POST/IntegrationDigitalChannelCredit/credit/api/changeCreditCardStatementPeriod
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCreditCardStatementPeriod \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "statementPeriod": "statementPeriod" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "statementPeriod": "statementPeriod" }
json
application/json
Example Responses
{ "changeRecordId": 0 }
json
application/json

getStatementPeriodChangeCount

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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).

getStatementPeriodChangeCount › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getStatementPeriodChangeCount › Request Body

GetStatementPeriodChangeCountRequest
cardRefNumber
​string | null

Card Ref Number - [Optional]

getStatementPeriodChangeCount › Responses

Success

GetStatementPeriodChangeCountResponse
changeCountExceeded
​boolean · required

Change Count Exceeded

changeCount
​integer · int32 · required

Change Count

POST/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodChangeCount
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodChangeCount \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "cardRefNumber": "cardRefNumber" }'
Example Request Body
{ "cardRefNumber": "cardRefNumber" }
json
application/json
Example Responses
{ "changeCountExceeded": true, "changeCount": 0 }
json
application/json

getCalculatedStatementPeriod

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getCalculatedStatementPeriod

Calculates the first and next statement dates for a given shadow card number based on the provided new statement period code.

getCalculatedStatementPeriod › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCalculatedStatementPeriod › Request Body

GetCalculatedStatementPeriodRequest
newStatementCode
​string · required

New Statement Code

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

getCalculatedStatementPeriod › Responses

Success

GetCalculatedStatementPeriodResponse
firstStatementDate
​string | null · date-time

First Statement Date - [Optional]

nextStatementDate
​string | null · date-time

Next Statement Date - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCalculatedStatementPeriod
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCalculatedStatementPeriod \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "newStatementCode": "newStatementCode" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "newStatementCode": "newStatementCode" }
json
application/json
Example Responses
{ "firstStatementDate": "2024-08-25T15:00:00Z", "nextStatementDate": "2024-08-25T15:00:00Z" }
json
application/json

getStatementPeriodByProductNumber

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getStatementPeriodByProductNumber › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getStatementPeriodByProductNumber › Request Body

GetStatementPeriodByProductNumberRequest
productNumber
​string · required

Product Number

getStatementPeriodByProductNumber › Responses

Success

GetStatementPeriodByProductNumberResponse
​array | null

List Of Statement Period - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodByProductNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodByProductNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "productNumber": "productNumber" }'
Example Request Body
{ "productNumber": "productNumber" }
json
application/json
Example Responses
{ "listOfStatementPeriod": [ { "statementCode": "statementCode", "description": "description" } ] }
json
application/json

changeCreditCardStatementSendPreference

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

changeCreditCardStatementSendPreference › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

changeCreditCardStatementSendPreference › Request Body

ChangeCreditCardStatementSendPreferenceRequest
mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

emailSendFlag
​boolean | null

Email Send Flag - [Optional]

postingFlag
​boolean | null

Posting Flag - [Optional]

smsSendFlag
​boolean | null

Sms Send Flag - [Optional]

postingAddressType
​string | null

Posting Address Type - [Optional]

changeCreditCardStatementSendPreference › Responses

Success

ChangeCreditCardStatementSendPreferenceResponse
POST/IntegrationDigitalChannelCredit/credit/api/changeCreditCardStatementSendPreference
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCreditCardStatementSendPreference \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "mainCardRefNumber": "mainCardRefNumber", "emailSendFlag": true, "postingFlag": true, "smsSendFlag": true, "postingAddressType": "postingAddressType" }'
Example Request Body
{ "mainCardRefNumber": "mainCardRefNumber", "emailSendFlag": true, "postingFlag": true, "smsSendFlag": true, "postingAddressType": "postingAddressType" }
json
application/json
Example Responses
{}
json
application/json

getCardStatementAddressInformation

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getCardStatementAddressInformation › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardStatementAddressInformation › Request Body

GetCardStatementAddressInformationRequest
mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

getCardStatementAddressInformation › Responses

Success

GetCardStatementAddressInformationResponse
statementPostingFlag
​boolean · required

Statement Posting Flag

statementSmsSendFlag
​boolean · required

Statement Sms Send Flag

statementEMailSendFlag
​boolean · required

Statement E Mail Send Flag

addressId
​integer · int64 · required

Address Id

addressType
​string | null

Address Type - [Optional]

statementSendAddressType
​string | null

Statement Send Address Type - [Optional]

email
​string | null

Email - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementAddressInformation
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementAddressInformation \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "mainCardRefNumber": "mainCardRefNumber" }'
Example Request Body
{ "mainCardRefNumber": "mainCardRefNumber" }
json
application/json
Example Responses
{ "statementPostingFlag": true, "statementSmsSendFlag": true, "statementEMailSendFlag": true, "addressId": 0, "addressType": "addressType", "statementSendAddressType": "statementSendAddressType", "email": "email" }
json
application/json

getCardFinancialInfoByCardRefNumber

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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.

getCardFinancialInfoByCardRefNumber › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getCardFinancialInfoByCardRefNumber › Request Body

GetCardFinancialInfoByCardRefNumberRequest
cardRefNumber
​string | null

Card Ref Number - [Optional]

customerNumber
​integer | null · int64

Customer Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

getCardFinancialInfoByCardRefNumber › Responses

Success

GetCardFinancialInfoByCardRefNumberResponse
​array | null

Card Financial Info By Card Ref Number Item List - [Optional]

​array | null

Customer Reward Details - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardFinancialInfoByCardRefNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardFinancialInfoByCardRefNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "cardRefNumber": "cardRefNumber", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "cardRefNumber": "cardRefNumber", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
{ "cardFinancialInfoByCardRefNumberItemList": [ { "authorizationAmount": 0, "availableLimit": 0, "cardLimit": 0, "cardOpeningDate": "2024-08-25T15:00:00Z", "cardRefNumber": "cardRefNumber", "cardStatusCode": "cardStatusCode", "cardStatusDescription": "cardStatusDescription", "currentAmount": 0, "customerNumber": 0, "customerRoofLimit": 0, "customerType": "customerType", "customerTypeDescription": "customerTypeDescription", "delayDayCount": 0, "delayProfitBsmvRate": "delayProfitBsmvRate", "delayProfitKkdfRate": "delayProfitKkdfRate", "delayProfitRate": 0, "delinquencyPeriod": 0, "delinquencyStatusCode": "delinquencyStatusCode", "delinquencyStatusDescription": "delinquencyStatusDescription", "firstDelayDate": "2024-08-25T15:00:00Z", "maskedCardNumber": "maskedCardNumber", "nextStatementDate": "2024-08-25T15:00:00Z", "nextStatementDueDate": "2024-08-25T15:00:00Z", "nextStatementDueOptionDate": "2024-08-25T15:00:00Z", "pendingInstallmentAmount": 0, "productName": "productName", "productNumber": "productNumber", "rediscountProfitAmount": 0, "rediscountTaxAmount": 0, "rediscountTax1Amount": 0, "rediscountTax2Amount": 0, "remainingStatementAmount": 0, "remainingStatementMinAmount": 0, "shadowCardNumber": "shadowCardNumber", "statementAmount": 0, "statementDate": "2024-08-25T15:00:00Z", "statementDueDate": "2024-08-25T15:00:00Z", "statementDueOptionDate": "2024-08-25T15:00:00Z", "statementMinAmount": 0, "totalDebt": 0, "totalDebtWithRediscount": 0, "totalDebtWithRediscountAuthorization": 0, "totalDebtWithDailyPayment": 0, "currentPeriodDebt": 0, "currentPeriodRediscountProfit": 0, "customerCurrentDebtWithRediscount": 0, "customerCurrentDebtWithoutRediscount": 0, "totalDebtIfCardCancelled": 0, "cardRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "availableBankReward": 0 } ] } ], "customerRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "availableBankReward": 0 } ] }
json
application/json

getStatementPeriodChangeInfo

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/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).

getStatementPeriodChangeInfo › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

getStatementPeriodChangeInfo › Request Body

GetStatementPeriodChangeInfoRequest
cardRefNumber
​string · required

Card Ref Number

getStatementPeriodChangeInfo › Responses

Success

GetStatementPeriodChangeInfoResponse
yearlyRemainingStatementChangeCount
​integer · int32 · required

Yearly Remaining Statement Change Count

statementDate
​string | null · date-time

Statement Date - [Optional]

next1StatementDate
​string | null · date-time

Next1 Statement Date - [Optional]

next2StatementDate
​string | null · date-time

Next2 Statement Date - [Optional]

lastChangeDate
​string | null · date-time

Last Change Date - [Optional]

isStatementPeriodChangeAvailable
​string | null

Is Statement Period Change Available - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodChangeInfo
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodChangeInfo \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "cardRefNumber": "cardRefNumber" }'
Example Request Body
{ "cardRefNumber": "cardRefNumber" }
json
application/json
Example Responses
{ "statementDate": "2024-08-25T15:00:00Z", "next1StatementDate": "2024-08-25T15:00:00Z", "next2StatementDate": "2024-08-25T15:00:00Z", "lastChangeDate": "2024-08-25T15:00:00Z", "yearlyRemainingStatementChangeCount": 0, "isStatementPeriodChangeAvailable": "isStatementPeriodChangeAvailable" }
json
application/json

Debt paymentPIN and card security