Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • 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://sandboxpub.cms.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 · maxLength: 19 · optional

The card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.

statementDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z

getCardStatementSummary › Responses

Success

GetCardStatementSummaryResponse
minimumPaymentAmount
​number · double · required

The least that may be paid this period.

prevTotalAmount
​number · double · required

What the total came to before this change.

remainingDebt
​number · double · required

What is still owed.

statementDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
earnedPointAmount
​number · double · required
dueDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
nextStatementDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
nextDueDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
statementDebt
​number · double · required

What the statement says is owed.

totalEarnedPointAmount
​number · double · required
remainingMinimumPaymentDebt
​number · double · required

What is left of the minimum payment.

currencyCode
​string · optional

The currency of the amount, as its three-letter code.

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementSummary
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementSummary \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2026-10-16T14:30:00Z" }'
Example Request Body
{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2026-10-16T14:30:00Z" }
json
application/json
Example Responses
{ "minimumPaymentAmount": 0, "prevTotalAmount": 0, "remainingDebt": 0, "statementDate": "2026-10-16T14:30:00Z", "earnedPointAmount": 0, "dueDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z", "currencyCode": "currencyCode", "statementDebt": 0, "totalEarnedPointAmount": 0, "remainingMinimumPaymentDebt": 0 }
json
application/json

getCardStatementDetail

POST
https://sandboxpub.cms.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 · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

mainCardRefNumber
​string · maxLength: 19 · required

The main card's reference, and nothing else will do. A supplementary card's own reference fetches no statement — its spending appears as rows on the main card's. This is the one field any operation on this side checks itself.

statementDate
​string · optional

Required in practice — The statement to read. The schema marks it nullable and the code does not treat it as optional: the header totals are read with this date before the branch for an absent one can take effect, so a request without it does not succeed. Send it.

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
minStatementDate
​string · optional

How far back the detail rows may reach. Ignored when statementDate is sent, and when neither is sent it defaults to the first of the month seven months back — which is the window, and why an older period cannot be reached by widening this field alone.

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z

getCardStatementDetail › Responses

A statement's totals and its rows — read separately, and either can be empty while the other is not.

The totals are looked for in the current statement table first. Where that holds no row and a statementDate was given, a history table is read instead. If both are empty the totals stay at zero and this is still a 200, so zero totals beside a list of rows is a state a caller has to handle rather than a contradiction. Reward detail is a third read, against the same date.

The channel changes which rows come back. Beyond stamping the read, it is matched against one channel in the catalogue for which reward transactions are removed from the detail; and independently of the channel, instalment rows in one transaction group are removed unless they are cash-instalment early releases. The same statement read on two channels is not guaranteed to carry the same rows.

GetCardStatementDetailResponse
​array · optional
prevTotalAmount
​number · double · optional

What the total came to before this change.

totalAmount
​number · double · optional

The amount of every entry in the list added together.

totalDebit
​number · double · optional
totalCredit
​number · double · optional
totalCash
​number · double · optional
totalProfitFeeTax
​number · double · optional
totalProfit
​number · double · optional
totalFee
​number · double · optional
totalTax1
​number · double · optional
totalTax2
​number · double · optional
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetail
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetail \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2026-10-16T14:30:00Z", "minStatementDate": "2026-10-16T14:30:00Z" }'
Example Request Body
{ "channel": "channel", "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2026-10-16T14:30:00Z", "minStatementDate": "2026-10-16T14:30: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": "2026-10-16T14:30: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": "2026-10-16T14:30:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30: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://sandboxpub.cms.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 · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

customerNumber
​integer · int64 · optional

The customer at the bank's core banking system, as a number. The platform stores it rather than issuing it, so it comes from the core.

getCreditCardStatementSendPreference › Responses

Success

GetCreditCardStatementSendPreferenceResponse
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardStatementSendPreference
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardStatementSendPreference \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "customerNumber": 0 }'
Example Request Body
{ "channel": "channel", "customerNumber": 0 }
json
application/json
Example Responses
{ "creditCardStatementSendPreferenceList": [ { "mainCardRefNumber": "mainCardRefNumber", "statementEMailSendFlag": true, "statementPostingFlag": true, "statementSmsSendFlag": true, "postingAddressType": "postingAddressType" } ] }
json
application/json

getCardStatementList

POST
https://sandboxpub.cms.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 · maxLength: 19 · optional

One-of — The card whose statements are listed. Send this or mainCardRefNumber; sending neither is refused as a business failure rather than a field one, so no propertyName arrives with it. When this is the one sent, the facade looks the card master up to find the main card reference.

mainCardRefNumber
​string · maxLength: 19 · optional

One-of — The main card reference the statements hang off. Send this or shadowCardNumber; when both are sent this one is used and no card lookup is done.

getCardStatementList › Responses

Success

CardStatementInfoResponse
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementList
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementList \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber" }
json
application/json
Example Responses
{ "cardStatementInfoList": [ { "amount": 0, "minAmount": 0, "date": "2026-10-16T14:30:00Z", "statementCode": "statementCode", "currencyCode": "currencyCode", "dueDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "documentID": "documentID", "statementRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "revolvingTotalReward": 0 } ] } ] }
json
application/json

getCreditCardLastStatement

POST
https://sandboxpub.cms.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 · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

shadowCardNumber
​string · maxLength: 19 · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

getCreditCardLastStatement › Responses

Success

GetCreditCardLastStatementResponse
existingPoint
​number · double · required
​object · optional
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardLastStatement
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardLastStatement \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
{ "existingPoint": 0, "creditCardStatement": { "recordId": 0, "statementDebt": 0, "minimumPaymentAmount": 0, "remainingDebt": 0, "prevTotalAmount": 0, "statementDate": "2026-10-16T14:30:00Z", "dueDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30: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": "2026-10-16T14:30: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": "2026-10-16T14:30:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z" } ] }, "cardStatementInfoList": [ { "amount": 0, "minAmount": 0, "date": "2026-10-16T14:30:00Z", "statementCode": "statementCode", "currencyCode": "currencyCode", "dueDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "documentID": "documentID", "statementRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "revolvingTotalReward": 0 } ] } ] }
json
application/json

getCreditCardLastStatementNew

POST
https://sandboxpub.cms.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 · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

shadowCardNumber
​string · maxLength: 19 · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

getCreditCardLastStatementNew › Responses

Success

GetCreditCardLastStatementResponse
existingPoint
​number · double · required
​object · optional
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardLastStatementNew
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardLastStatementNew \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
{ "existingPoint": 0, "creditCardStatement": { "recordId": 0, "statementDebt": 0, "minimumPaymentAmount": 0, "remainingDebt": 0, "prevTotalAmount": 0, "statementDate": "2026-10-16T14:30:00Z", "dueDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30: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": "2026-10-16T14:30: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": "2026-10-16T14:30:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z" } ] }, "cardStatementInfoList": [ { "amount": 0, "minAmount": 0, "date": "2026-10-16T14:30:00Z", "statementCode": "statementCode", "currencyCode": "currencyCode", "dueDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "documentID": "documentID", "statementRewardDetails": [ { "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "revolvingTotalReward": 0 } ] } ] }
json
application/json

getCardStatementDetailSummary

POST
https://sandboxpub.cms.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 · maxLength: 19 · optional

The card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.

statementDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z

getCardStatementDetailSummary › Responses

Success

GetCardStatementDetailSummaryResponse
minimumPaymentAmount
​number · double · required

The least that may be paid this period.

prevTotalAmount
​number · double · required

What the total came to before this change.

remainingDebt
​number · double · required

What is still owed.

statementDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
earnedPointAmount
​number · double · required
dueDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
nextStatementDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
nextDueDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
statementDebt
​number · double · required

What the statement says is owed.

totalEarnedPointAmount
​number · double · required
remainingMinimumPaymentDebt
​number · double · required

What is left of the minimum payment.

​array · optional
currencyCode
​string · optional

The currency of the amount, as its three-letter code.

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetailSummary
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetailSummary \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2026-10-16T14:30:00Z" }'
Example Request Body
{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2026-10-16T14:30: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": "2026-10-16T14:30: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": "2026-10-16T14:30:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z" } ], "minimumPaymentAmount": 0, "prevTotalAmount": 0, "remainingDebt": 0, "statementDate": "2026-10-16T14:30:00Z", "earnedPointAmount": 0, "dueDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z", "currencyCode": "currencyCode", "statementDebt": 0, "totalEarnedPointAmount": 0, "remainingMinimumPaymentDebt": 0 }
json
application/json

getCardStatementDetailSummaryNew

POST
https://sandboxpub.cms.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 · maxLength: 19 · optional

The card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.

statementDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z

getCardStatementDetailSummaryNew › Responses

Success

GetCardStatementDetailSummaryResponse
minimumPaymentAmount
​number · double · required

The least that may be paid this period.

prevTotalAmount
​number · double · required

What the total came to before this change.

remainingDebt
​number · double · required

What is still owed.

statementDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
earnedPointAmount
​number · double · required
dueDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
nextStatementDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
nextDueDate
​string · required

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
statementDebt
​number · double · required

What the statement says is owed.

totalEarnedPointAmount
​number · double · required
remainingMinimumPaymentDebt
​number · double · required

What is left of the minimum payment.

​array · optional
currencyCode
​string · optional

The currency of the amount, as its three-letter code.

POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetailSummaryNew
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementDetailSummaryNew \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2026-10-16T14:30:00Z" }'
Example Request Body
{ "mainCardRefNumber": "mainCardRefNumber", "statementDate": "2026-10-16T14:30: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": "2026-10-16T14:30: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": "2026-10-16T14:30:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z" } ], "minimumPaymentAmount": 0, "prevTotalAmount": 0, "remainingDebt": 0, "statementDate": "2026-10-16T14:30:00Z", "earnedPointAmount": 0, "dueDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "nextDueDate": "2026-10-16T14:30:00Z", "currencyCode": "currencyCode", "statementDebt": 0, "totalEarnedPointAmount": 0, "remainingMinimumPaymentDebt": 0 }
json
application/json

changeCreditCardStatementPeriod

POST
https://sandboxpub.cms.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 · maxLength: 6 · required

Which statement period the card is billed on. The periods a product allows come from the reference data.

shadowCardNumber
​string · maxLength: 19 · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

changeCreditCardStatementPeriod › Responses

Success

ChangeCreditCardStatementPeriodResponse
changeRecordId
​integer · int64 · required
POST/IntegrationDigitalChannelCredit/credit/api/changeCreditCardStatementPeriod
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCreditCardStatementPeriod \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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://sandboxpub.cms.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 · maxLength: 19 · optional

The card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.

getStatementPeriodChangeCount › Responses

Success

GetStatementPeriodChangeCountResponse
changeCountExceeded
​boolean · required
changeCount
​integer · int32 · required
POST/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodChangeCount
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodChangeCount \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "cardRefNumber": "cardRefNumber" }'
Example Request Body
{ "cardRefNumber": "cardRefNumber" }
json
application/json
Example Responses
{ "changeCountExceeded": true, "changeCount": 0 }
json
application/json

getCalculatedStatementPeriod

POST
https://sandboxpub.cms.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 · maxLength: 6 · required

The statement period to move the card to.

shadowCardNumber
​string · maxLength: 19 · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

getCalculatedStatementPeriod › Responses

Success

GetCalculatedStatementPeriodResponse
firstStatementDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
nextStatementDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
POST/IntegrationDigitalChannelCredit/credit/api/getCalculatedStatementPeriod
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCalculatedStatementPeriod \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "shadowCardNumber": "shadowCardNumber", "newStatementCode": "newStatementCode" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "newStatementCode": "newStatementCode" }
json
application/json
Example Responses
{ "firstStatementDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z" }
json
application/json

getStatementPeriodByProductNumber

POST
https://sandboxpub.cms.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 · maxLength: 5 · required

The card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.

getStatementPeriodByProductNumber › Responses

Success

GetStatementPeriodByProductNumberResponse
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodByProductNumber
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodByProductNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "productNumber": "productNumber" }'
Example Request Body
{ "productNumber": "productNumber" }
json
application/json
Example Responses
{ "listOfStatementPeriod": [ { "statementCode": "statementCode", "description": "description" } ] }
json
application/json

changeCreditCardStatementSendPreference

POST
https://sandboxpub.cms.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 · maxLength: 19 · optional

The card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.

emailSendFlag
​boolean · optional

Whether the statement is sent by e-mail.

postingFlag
​boolean · optional

Whether the statement is posted on paper.

smsSendFlag
​boolean · optional

Whether the statement is announced by SMS.

postingAddressType
​string · maxLength: 2 · optional

Which kind of address the statement is posted to.

changeCreditCardStatementSendPreference › Responses

Success

ChangeCreditCardStatementSendPreferenceResponse
POST/IntegrationDigitalChannelCredit/credit/api/changeCreditCardStatementSendPreference
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCreditCardStatementSendPreference \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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://sandboxpub.cms.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 · maxLength: 19 · optional

The card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.

getCardStatementAddressInformation › Responses

Success

GetCardStatementAddressInformationResponse
statementPostingFlag
​boolean · required

Whether the statement is posted on paper.

statementSmsSendFlag
​boolean · required

Whether the statement is announced by SMS.

statementEMailSendFlag
​boolean · required
addressId
​integer · int64 · required
addressType
​string · enum · optional

Values:

  • RA — home
  • AL — business
  • EA — employer
  • OO — alternative
  • WA — previous
  • SW — SWIFT
  • SS — SWIFT name and address
  • MR — Mernis, registered
  • MS — Mernis, stated

Not set is --.

statementSendAddressType
​string · optional
email
​string · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCardStatementAddressInformation
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardStatementAddressInformation \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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://sandboxpub.cms.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 · maxLength: 19 · optional

The card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.

customerNumber
​integer · int64 · optional

The customer at the bank's core banking system, as a number. The platform stores it rather than issuing it, so it comes from the core.

shadowCardNumber
​string · maxLength: 19 · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

getCardFinancialInfoByCardRefNumber › Responses

Success

GetCardFinancialInfoByCardRefNumberResponse
​array · optional
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCardFinancialInfoByCardRefNumber
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardFinancialInfoByCardRefNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --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": "2026-10-16T14:30: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": "2026-10-16T14:30:00Z", "maskedCardNumber": "maskedCardNumber", "nextStatementDate": "2026-10-16T14:30:00Z", "nextStatementDueDate": "2026-10-16T14:30:00Z", "nextStatementDueOptionDate": "2026-10-16T14:30:00Z", "pendingInstallmentAmount": 0, "productName": "productName", "productNumber": "productNumber", "rediscountProfitAmount": 0, "rediscountTaxAmount": 0, "rediscountTax1Amount": 0, "rediscountTax2Amount": 0, "remainingStatementAmount": 0, "remainingStatementMinAmount": 0, "shadowCardNumber": "shadowCardNumber", "statementAmount": 0, "statementDate": "2026-10-16T14:30:00Z", "statementDueDate": "2026-10-16T14:30:00Z", "statementDueOptionDate": "2026-10-16T14:30: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://sandboxpub.cms.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 · maxLength: 19 · required

The card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.

getStatementPeriodChangeInfo › Responses

Success

GetStatementPeriodChangeInfoResponse
yearlyRemainingStatementChangeCount
​integer · int32 · required
statementDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
next1StatementDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
next2StatementDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
lastChangeDate
​string · optional

A date and time as a string, in RFC 3339 form: 2026-10-16T14:30:00Z, or with an offset, 2026-10-16T17:30:00+03:00.

Example: 2026-10-16T14:30:00Z
isStatementPeriodChangeAvailable
​string · optional
POST/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodChangeInfo
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getStatementPeriodChangeInfo \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "cardRefNumber": "cardRefNumber" }'
Example Request Body
{ "cardRefNumber": "cardRefNumber" }
json
application/json
Example Responses
{ "statementDate": "2026-10-16T14:30:00Z", "next1StatementDate": "2026-10-16T14:30:00Z", "next2StatementDate": "2026-10-16T14:30:00Z", "lastChangeDate": "2026-10-16T14:30:00Z", "yearlyRemainingStatementChangeCount": 0, "isStatementPeriodChangeAvailable": "isStatementPeriodChangeAvailable" }
json
application/json

Debt paymentPIN and card security