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

Transactions

Read what happened on a card and correct it — transaction history, pending provisions, reversals and slip receipts.


doPaymentTransaction

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/doPaymentTransaction

Performs a credit card payment transaction. Returns transaction identifiers (UTID, RRN, AuthCode), response codes, and success status.

Part of:

  • Journey 01 · Launching a new card product — step 6, Post the first transaction

  • Journey 02 · Managing a card product — step 1, Post and quote payments

doPaymentTransaction › 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

doPaymentTransaction › Request Body

DoPaymentTransactionRequest
transactionSource
​string · maxLength: 5 · required

Channel the payment comes from, forwarded as ChannelID to online. Prefer the three-digit channel code; see the Channels page.

transactionType
​string · maxLength: 4 · required

Payment kind online expects — INV, HGS, REL, SGK, TAX (and related institution types such as RINV).

amount
​number · double · required

Payment amount. Must be greater than zero.

tranDate
​string · required

Business date of the payment.

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
shadowCardNumber
​string · maxLength: 19 · required

The platform's card reference the payment is posted against.

institutionCode
​string · maxLength: 7 · required

Institution / biller code the payment is for.

referenceNumber
​string · maxLength: 50 · required

Caller reference for the payment; used for reconciliation and reverse.

feeAmount
​number · double · optional

Fee when calculated by the caller (IsFeeCalculatedExternally).

bsmvAmount
​number · double · optional

BSMV portion of the fee when calculated by the caller.

description
​string · maxLength: 100 · optional

Free-text description stored with the online payment.

doPaymentTransaction › Responses

Success

DoPaymentTransactionResponse
isSuccess
​boolean · required

Whether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.

uTID
​string · optional

The unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.

authCode
​string · optional

The authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.

rrn
​string · optional

The retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.

responseCode
​string · optional

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

responseReasonCode
​string · optional

Why the downstream system answered as it did, where it narrows the response code.

responseCodeDescription
​string · optional

The description of responseCode, carried alongside it for display. It is not a key: match on the code.

POST/IntegrationDigitalChannelCredit/credit/api/doPaymentTransaction
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doPaymentTransaction \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "transactionSource": "008", "transactionType": "RINV", "amount": 300, "feeAmount": 3, "bsmvAmount": 0.3, "tranDate": "2026-09-15T07:33:11.128Z", "shadowCardNumber": "1201262350000646502", "institutionCode": "123456", "referenceNumber": "1234567", "description": "test" }'
Example Request Body
{ "transactionSource": "008", "transactionType": "RINV", "amount": 300, "feeAmount": 3, "bsmvAmount": 0.3, "tranDate": "2026-09-15T07:33:11.128Z", "shadowCardNumber": "1201262350000646502", "institutionCode": "123456", "referenceNumber": "1234567", "description": "test" }
json
application/json
Example Responses
{ "uTID": "uTID", "authCode": "authCode", "rrn": "rrn", "responseCode": "responseCode", "responseReasonCode": "responseReasonCode", "responseCodeDescription": "responseCodeDescription", "isSuccess": true }
json
application/json

reversePaymentTransaction

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/reversePaymentTransaction

Reverses a payment transaction using the provided shadow card number, UTID, reference number, and authorization code.

Part of:

  • Journey 02 · Managing a card product — step 4, Reversals

reversePaymentTransaction › 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

reversePaymentTransaction › Request Body

ReversePaymentTransactionRequest
uTID
​string · maxLength: 50 · required

UTID returned by the original doPaymentTransaction.

referenceNumber
​string · maxLength: 50 · required

Same reference number as the original payment.

shadowCardNumber
​string · maxLength: 19 · required

Card the original payment was posted on.

authCode
​string · maxLength: 10 · required

Authorisation code from the original payment response.

amount
​number · double · optional

Present on the contract but not forwarded to online by the digital-channels layer; reverse is keyed by UTID / reference / auth.

reversePaymentTransaction › Responses

Success

ReversePaymentTransactionResponse
isSuccess
​boolean · required

Whether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.

uTID
​string · optional

The unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.

authCode
​string · optional

The authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.

responseCode
​string · optional

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

responseCodeDescription
​string · optional

The description of responseCode, carried alongside it for display. It is not a key: match on the code.

responseReasonCode
​string · optional

Why the downstream system answered as it did, where it narrows the response code.

responseReasonCodeDescription
​string · optional

The description of responseReasonCode, carried alongside it for display. It is not a key: match on the code.

POST/IntegrationDigitalChannelCredit/credit/api/reversePaymentTransaction
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/reversePaymentTransaction \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "uTID": "uTID", "referenceNumber": "referenceNumber", "shadowCardNumber": "shadowCardNumber", "amount": 0, "authCode": "authCode" }'
Example Request Body
{ "uTID": "uTID", "referenceNumber": "referenceNumber", "shadowCardNumber": "shadowCardNumber", "amount": 0, "authCode": "authCode" }
json
application/json
Example Responses
{ "uTID": "uTID", "authCode": "authCode", "responseCode": "responseCode", "responseCodeDescription": "responseCodeDescription", "responseReasonCode": "responseReasonCode", "responseReasonCodeDescription": "responseReasonCodeDescription", "isSuccess": true }
json
application/json

doPaymentFeeInquiry

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/doPaymentFeeInquiry

Inquires the payment fee for a credit card transaction. Returns fee, BSMV, total commission, and transaction identifiers like UTID, RRN, and authorization code.

Part of:

  • Journey 01 · Launching a new card product — step 6, Post the first transaction

  • Journey 02 · Managing a card product — step 1, Post and quote payments

doPaymentFeeInquiry › 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

doPaymentFeeInquiry › Request Body

DoPaymentFeeInquiryRequest
transactionSource
​string · maxLength: 5 · required

Channel of the would-be payment; see the Channels page.

transactionType
​string · maxLength: 4 · required

Same transaction type codes as doPaymentTransaction.

amount
​number · double · required

Principal amount the fee is calculated against.

tranDate
​string · required

Business date used for the fee calculation.

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
shadowCardNumber
​string · maxLength: 19 · required

The card the fee is calculated for.

institutionCode
​string · maxLength: 7 · required

Institution / biller code.

referenceNumber
​string · maxLength: 50 · required

Caller reference for the inquiry.

description
​string · maxLength: 100 · optional

Optional description passed through to online.

doPaymentFeeInquiry › Responses

Success

DoPaymentFeeInquiryResponse
feeAmount
​number · double · required

The fee charged on the transaction.

bsmvAmount
​number · double · required

The BSMV levy on the transaction.

totalCommissionAmount
​number · double · required
uTID
​string · optional

The unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.

authCode
​string · optional

The authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.

rrn
​string · optional

The retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.

responseCode
​string · optional

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

responseReasonCode
​string · optional

Why the downstream system answered as it did, where it narrows the response code.

responseCodeDescription
​string · optional

The description of responseCode, carried alongside it for display. It is not a key: match on the code.

POST/IntegrationDigitalChannelCredit/credit/api/doPaymentFeeInquiry
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doPaymentFeeInquiry \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "transactionSource": "008", "transactionType": "RINV_INQ", "amount": 155, "tranDate": "2026-09-14T15:29:35.628Z", "shadowCardNumber": "1201262350000646502", "institutionCode": "123456", "referenceNumber": "1234567", "description": "FEE INQ" }'
Example Request Body
{ "transactionSource": "008", "transactionType": "RINV_INQ", "amount": 155, "tranDate": "2026-09-14T15:29:35.628Z", "shadowCardNumber": "1201262350000646502", "institutionCode": "123456", "referenceNumber": "1234567", "description": "FEE INQ" }
json
application/json
Example Responses
{ "uTID": "uTID", "authCode": "authCode", "rrn": "rrn", "responseCode": "responseCode", "responseReasonCode": "responseReasonCode", "responseCodeDescription": "responseCodeDescription", "feeAmount": 0, "bsmvAmount": 0, "totalCommissionAmount": 0 }
json
application/json

getCustomerTransactionDetail

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getCustomerTransactionDetail

Retrieves detailed information about a customer transaction based on the provided UTID (Unique Transaction ID). The method fetches the transaction and associated credit card information, calculates installment limits, and adjusts them if the transaction occurs in an emergency city, applying the appropriate multiplier. The response includes transaction amount, date, description, and the calculated installment counts and limits.

Part of:

  • Journey 02 · Managing a card product — step 3, History and detail

getCustomerTransactionDetail › 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

getCustomerTransactionDetail › Request Body

GetCustomerTransactionDetailRequest
utid
​string · maxLength: 50 · optional

The unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.

getCustomerTransactionDetail › Responses

Success

GetCustomerTransactionDetailResponse
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCustomerTransactionDetail
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCustomerTransactionDetail \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "utid": "utid" }'
Example Request Body
{ "utid": "utid" }
json
application/json
Example Responses
{ "transactions": [ { "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" } ] }
json
application/json

getCardIntermTransactionInfo

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getCardIntermTransactionInfo

Retrieves all intermediate transactions for a card, including detailed transaction info, rewards, installment info, MCC summaries, statement summary, and digital slip details. Supports pagination and optional inclusion of waiting installments.

getCardIntermTransactionInfo › 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

getCardIntermTransactionInfo › Request Body

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

addWaitingInstallments
​boolean · optional

Whether instalments not yet billed are included.

pageNumber
​integer · int32 · optional

Which page of results to return, counting from 1.

rowCount
​integer · int32 · optional

How many rows a page holds.

getCardIntermTransactionInfo › Responses

Success

CardIntermTransactionInfo
lastStatementTotalDebt
​number · double · required
lastStatementUsedPoint
​number · double · required
totalCurrentPoint
​number · double · required
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
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
remaingStatementDebt
​number · double · required

What is left of the statement's debt.

next
​boolean · required
​array · optional
​array · optional
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCardIntermTransactionInfo
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardIntermTransactionInfo \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "addWaitingInstallments": true, "pageNumber": 0, "rowCount": 0 }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "addWaitingInstallments": true, "pageNumber": 0, "rowCount": 0 }
json
application/json
Example Responses
{ "lastStatementTotalDebt": 0, "lastStatementUsedPoint": 0, "totalCurrentPoint": 0, "listOfIntermTransactions": [ { "pageNumber": 0, "rowCount": 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" } ], "mccAmountSummary": [ { "mccGroupCode": "mccGroupCode", "amount": 0, "currencyCode": "currencyCode" } ], "mccRewardSummary": [ { "mccGroupCode": "mccGroupCode", "point": 0 } ], "statementDate": "2026-10-16T14:30:00Z", "nextStatementDate": "2026-10-16T14:30:00Z", "remaingStatementDebt": 0, "next": true }
json
application/json

getPendingProvisionList

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getPendingProvisionList

Retrieves a list of pending provisions (pending transactions) for a given ShadowCardNumber. The service aggregates transaction details including amounts, currency, transaction date and description, earned rewards, installment eligibility, MCC and product info, transaction type, merchant details, and authorization/response info. Transactions are enriched with MCC definitions, card product info, and transaction code matrices. Special handling is applied for refunded transactions and certain channels (e.g., GetirFinans). Returns the mapped list of CreditCardPendingTransactionItem objects for integration purposes.

getPendingProvisionList › 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

getPendingProvisionList › Request Body

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

getPendingProvisionList › Responses

Success

GetPendingProvisionListResponse
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getPendingProvisionList
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getPendingProvisionList \ --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
{ "listOfPendingProvisionInfo": [ { "approvedAuthorizationFlag": true, "responseCode": "responseCode", "responseCodeDescription": "responseCodeDescription", "responseReasonCode": "responseReasonCode", "responseReasonCodeDescription": "responseReasonCodeDescription", "trnStatusCode": "trnStatusCode", "trnStatusDescription": "trnStatusDescription", "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" } ] }
json
application/json

getCreditCardTransactionAll

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getCreditCardTransactionAll

Retrieves all credit card transaction data using ShadowCardNumber or MainCardRefNumber. Validates card information, fetches current period transactions, pending provisions, installment transactions, and next period installments. Calculates total amounts, debts, estimated statement debt, remaining statement debt, and returns detailed transaction, installment, provision, and statement-related information.

Part of:

  • Journey 02 · Managing a card product — step 3, History and detail

getCreditCardTransactionAll › 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

getCreditCardTransactionAll › Request Body

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

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.

beginDate
​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
endDate
​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
onlySuccessFlag
​boolean · optional

Whether to return only the transactions that succeeded.

getCreditCardTransactionAll › Responses

Success

GetCreditCardTransactionAllResponse
​object · optional
​object · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardTransactionAll
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardTransactionAll \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "beginDate": "2026-10-16T14:30:00Z", "endDate": "2026-10-16T14:30:00Z", "onlySuccessFlag": true }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "beginDate": "2026-10-16T14:30:00Z", "endDate": "2026-10-16T14:30:00Z", "onlySuccessFlag": true }
json
application/json
Example Responses
{ "creditCardNextPeriodInstallments": { "listOfNextPeriodInstallment": [ { "statementDate": "2026-10-16T14:30:00Z", "totalAmount": 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" } ] } ], "totalAmount": 0, "currencyCode": "currencyCode" }, "creditCardCurrentPeriodTransactions": { "totalAmount": 0, "currentDebt": 0, "remaingStatementDebt": 0, "estimatedStatementDebt": 0, "currencyCode": "currencyCode", "listOfPendingProvision": [ { "approvedAuthorizationFlag": true, "responseCode": "responseCode", "responseCodeDescription": "responseCodeDescription", "responseReasonCode": "responseReasonCode", "responseReasonCodeDescription": "responseReasonCodeDescription", "trnStatusCode": "trnStatusCode", "trnStatusDescription": "trnStatusDescription", "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" } ], "listOfCurrentPeriodTransaction": [ { "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" } ], "listOfInstalledTransaction": [ { "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" } ] } }
json
application/json

getCreditCardCurrentTransactionList

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getCreditCardCurrentTransactionList

Retrieves the current period credit card transaction list using ShadowCardNumber or MainCardRefNumber. Fetches all transactions for the current statement period, separates installment and non-installment transactions, and enriches transaction data with transaction code descriptions and channel descriptions. Returns summary financial information such as current debt, estimated statement debt, remaining statement debt, total amount, and detailed transaction lists including amounts, dates, merchant info, rewards, installment details, and channel information.

Part of:

  • Journey 01 · Launching a new card product — step 6, Post the first transaction

  • Journey 02 · Managing a card product — step 3, History and detail

getCreditCardCurrentTransactionList › 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

getCreditCardCurrentTransactionList › Request Body

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

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.

getCreditCardCurrentTransactionList › Responses

Success

GetCreditCardCurrentTransactionListResponse
​object · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardCurrentTransactionList
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardCurrentTransactionList \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "shadowCardNumber": "1201230750000009383" }'
Example Request Body
{ "shadowCardNumber": "1201230750000009383" }
json
application/json
Example Responses
{ "creditCardCurrentPeriodTransactions": { "totalAmount": 0, "currentDebt": 0, "remaingStatementDebt": 0, "estimatedStatementDebt": 0, "currencyCode": "currencyCode", "listOfCurrentPeriodTransaction": [ { "utid": "utid", "amount": 0, "currencyCode": "currencyCode", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "date": "2026-10-16T14:30:00Z", "trnCodeMatrixId": "trnCodeMatrixId", "description": "description", "earnedPoint": { "amount": 0 }, "isDeferrable": true, "isSplittableIntoInstallments": true, "totalInstallmentCount": 0, "currentInstallmentNumber": 0, "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "trnEffect": "trnEffect", "supplementaryCardFlag": true, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "trnCode": "trnCode", "trnCodeDescription": "trnCodeDescription", "channelType": "channelType", "channelDescription": "channelDescription" } ], "listOfInstalledTransaction": [ { "remainingInstallAmount": 0, "utid": "utid", "amount": 0, "currencyCode": "currencyCode", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "date": "2026-10-16T14:30:00Z", "trnCodeMatrixId": "trnCodeMatrixId", "description": "description", "earnedPoint": { "amount": 0 }, "isDeferrable": true, "isSplittableIntoInstallments": true, "totalInstallmentCount": 0, "currentInstallmentNumber": 0, "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "trnEffect": "trnEffect", "supplementaryCardFlag": true, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "trnCode": "trnCode", "trnCodeDescription": "trnCodeDescription", "channelType": "channelType", "channelDescription": "channelDescription" } ] } }
json
application/json

getTransactionAll

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getTransactionAll

Retrieves all credit card transactions for a given card, including current period transactions, next period installments, and reward transactions. The service validates the card, fetches current and upcoming installments, filters reward transactions, and maps them into response models. The response includes CreditCardCurrentPeriodTransactions (current period transactions and pending provisions) and CreditCardNextPeriodInstallments (installments for the next period), with details on amounts, dates, descriptions, rewards, installments, and card product attributes.

getTransactionAll › 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

getTransactionAll › Request Body

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

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.

beginDate
​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
endDate
​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
onlySuccessFlag
​boolean · optional

Whether to return only the transactions that succeeded.

getTransactionAll › Responses

Success

GetCreditCardTransactionAllResponse
​object · optional
​object · optional
POST/IntegrationDigitalChannelCredit/credit/api/getTransactionAll
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getTransactionAll \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "beginDate": "2026-10-16T14:30:00Z", "endDate": "2026-10-16T14:30:00Z", "onlySuccessFlag": true }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "beginDate": "2026-10-16T14:30:00Z", "endDate": "2026-10-16T14:30:00Z", "onlySuccessFlag": true }
json
application/json
Example Responses
{ "creditCardNextPeriodInstallments": { "listOfNextPeriodInstallment": [ { "statementDate": "2026-10-16T14:30:00Z", "totalAmount": 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" } ] } ], "totalAmount": 0, "currencyCode": "currencyCode" }, "creditCardCurrentPeriodTransactions": { "totalAmount": 0, "currentDebt": 0, "remaingStatementDebt": 0, "estimatedStatementDebt": 0, "currencyCode": "currencyCode", "listOfPendingProvision": [ { "approvedAuthorizationFlag": true, "responseCode": "responseCode", "responseCodeDescription": "responseCodeDescription", "responseReasonCode": "responseReasonCode", "responseReasonCodeDescription": "responseReasonCodeDescription", "trnStatusCode": "trnStatusCode", "trnStatusDescription": "trnStatusDescription", "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" } ], "listOfCurrentPeriodTransaction": [ { "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" } ], "listOfInstalledTransaction": [ { "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" } ] } }
json
application/json

getPendingProvisionListNew

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getPendingProvisionListNew

Retrieves a list of pending provisions (pending transactions) for a given ShadowCardNumber. The service aggregates transaction details including amounts, currency, transaction date and description, earned rewards, installment eligibility, MCC and product info, transaction type, merchant details, and authorization/response info. Transactions are enriched with MCC definitions, card product info, and transaction code matrices. Special handling is applied for refunded transactions and certain channels (e.g., GetirFinans). Returns the mapped list of CreditCardPendingTransactionItem objects for integration purposes.

getPendingProvisionListNew › 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

getPendingProvisionListNew › Request Body

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

getPendingProvisionListNew › Responses

Success

GetPendingProvisionListResponse
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getPendingProvisionListNew
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getPendingProvisionListNew \ --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
{ "listOfPendingProvisionInfo": [ { "approvedAuthorizationFlag": true, "responseCode": "responseCode", "responseCodeDescription": "responseCodeDescription", "responseReasonCode": "responseReasonCode", "responseReasonCodeDescription": "responseReasonCodeDescription", "trnStatusCode": "trnStatusCode", "trnStatusDescription": "trnStatusDescription", "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" } ] }
json
application/json

getDigitalSlipReceipt

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getDigitalSlipReceipt

Retrieves the digital slip (transaction receipt) for a given UTID (Unique Transaction ID) and channel. The method returns detailed transaction information including card numbers (masked and shadow), transaction amount and currency, merchant details, authorization and response codes, terminal and transaction identifiers, ICC data, and transaction status.

getDigitalSlipReceipt › 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

getDigitalSlipReceipt › Request Body

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

utid
​string · maxLength: 50 · optional

The unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.

getDigitalSlipReceipt › Responses

Success

GetDigitalSlipReceiptResponse
utid
​string · optional

The unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.

refUtid
​string · optional

The transaction this one refers to — the original, for a reversal or a correction.

trnCodeMatrixId
​string · optional

Which row of the transaction-code matrix this transaction was classified by.

shadowCardNumber
​string · 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.

cardRefNumber
​string · optional

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

maskedCardNumber
​string · optional

The card number with its middle digits masked, as the platform stores it. It is a display form, not a key: operations take the shadow number.

trnAmount
​number · double · optional

The amount of the transaction, in its own currency.

trnCurrencyCode
​string · optional

The currency the transaction was made in.

responseCode
​string · optional

The downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.

trnDatetime
​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
trnStatus
​string · optional

Where the transaction has got to.

stan
​integer · int32 · optional

The system trace audit number — the scheme's sequence number for the message, unique within a day and a terminal.

rrn
​string · optional

The retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.

authorizationNumber
​string · optional

The authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.

terminalNumber
​string · optional

The terminal the transaction was made at.

merchantNumber
​string · optional

The merchant's number with the acquirer.

merchantName
​string · optional

The merchant's name as it reached the platform from the scheme.

panEntryMode
​string · optional

How the card was read at the terminal — chip, stripe, contactless, keyed, or stored on file. The scheme's own code.

iccData84
​string · optional
iccData9f26
​string · optional
cardSeqNumber
​string · optional

Which chip on the card was used, where a customer holds more than one card on the same number.

merchantAddress
​string · optional

The merchant's address as it reached the platform.

POST/IntegrationDigitalChannelCredit/credit/api/getDigitalSlipReceipt
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getDigitalSlipReceipt \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "utid": "utid" }'
Example Request Body
{ "channel": "channel", "utid": "utid" }
json
application/json
Example Responses
{ "utid": "utid", "refUtid": "refUtid", "trnCodeMatrixId": "trnCodeMatrixId", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "responseCode": "responseCode", "trnDatetime": "2026-10-16T14:30:00Z", "trnStatus": "trnStatus", "stan": 0, "rrn": "rrn", "authorizationNumber": "authorizationNumber", "terminalNumber": "terminalNumber", "merchantNumber": "merchantNumber", "merchantName": "merchantName", "panEntryMode": "panEntryMode", "iccData84": "iccData84", "iccData9f26": "iccData9f26", "cardSeqNumber": "cardSeqNumber", "merchantAddress": "merchantAddress" }
json
application/json

Cash advanceCard and customer limits