Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      getCardApplicationListpostgetDebitApplicationIdByFromShadowCardNumberpostsubmitCardApplicationExtStatuspost
    Card issuance and personalisation
      getApplicableProductsByCustomerNumberpostcreateIndividualCardpostcreateIndividualSupplementaryCardpostcreateCorporateCardpostcreateDummyCorporateCardpostcreateVirtualCardpostgetPendingCardEmbossListpostcancelCardEmbossByShadowCardNumberpost
    Card lifecycle
      getCustomerDebitCardListByTenantIdpostgetCustomerDebitShadowCardsByTenantIdpostchangeCardStatuspostgetCardListpostgetCardListNewpostgetCardInfopostreplaceCardpostchangeAndReplaceCardpostisCardFoundInpostaddDebitCardLogpost
    No-name cards
      createNoNameCardApplicationpostcancelNoNameCardApplicationpostupdateNoNameCardApplicationpostactivateNoNameCardpostcreateCardUsingNoNameApplicationpostcreateAndProcessNoNameCardApplicationpostreplaceNoNameCardpostreplaceCardUsingNoNameApplicationpostchangeAndReplaceNoNameCardpost
Customers and accounts
    Branch management
      changeCardBranchpostchangeCustomerBranchposttransferBranchCustomerpostgetDebitCustomerLisfOfBranchpost
    Customers
      getCorporateCustomerInfoByIndividualCustomerpostgetCustomerAssetpostisCustomerConvertToRipperpostgetCustomerAssetsSummaryDebitpost
    Account linking
      attachCardAccountpostdetachCardAccountpostdetachCardAccountByAccountNumberpostmodifyCardAccountpostlistCardAccountByAccountNumberpostlistCardAccountByShadowCardNumberpostrecreateCustomerCardAccountspostsaveCardAccountCurrencyConversionpostgetCardAccountCurrencyConversionpost
Transactions
    getDebitCardTransactionByUtidpostgetDebitCardTransactionByUtidNewpostgetDebitTransactionAllpostupdateTransactionForBNPLpostgetDigitalSlipReceiptpostgetAuthorizationListByBegindateEnddatepostgetDbttransactionByCardrefCustomernumpost
Limits and controls
    Card and customer limits
      getAvailableECommerceLimitpost
    Operation limits
      getCardLimitationParameterDatapostgetCardOperationLimitpostsetCardOperationLimitpostremoveCardOperationLimitpostgetCustomerOperationLimitpostsetCustomerOperationLimitpostremoveCustomerOperationLimitpostgetCustomerLimitationParameterDatapost
    Permissions and restrictions
      getCardPermissionspostsaveCardPermissionspostsaveCardBnplPermissionpostchangeCardMiscOptionpostgetCardMiscOptionpost
Security
    PIN and card security
      setCardPinpostchangeCardPinpostverifyCardPinpostverifyRsaPinpostsetRsaPinpostchangeRsaPinpostincreasePinTryCountpostverifyRsaPinWithStaticSaltpostverifyCVVpostverifyCVVPartialpostgenerateCVVpostgetCardPinOperationHistorypostresetCvvCounterpost
Disputes
    Disputes and chargebacks
      createDisputeCasepostgetDisputeListpostaddDocumentByCaseNumberpostcancelDisputeCasepost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getCardTypeByBinpost
SchemasError codesChannels
powered by Zudoku
Debit Digital Channels Integration
Debit Digital Channels Integration

Transactions

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


getDebitCardTransactionByUtid

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getDebitCardTransactionByUtid

Retrieves a debit card transaction by UTID. Resolves shadow card number and transaction date using UTID, queries debit transactions within a date range around the transaction date, and returns the matching transaction record. Includes an alternative implementation that directly fetches transactions by UTID.

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

getDebitCardTransactionByUtid › Request Body

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

getDebitCardTransactionByUtid › Responses

Success

GetDebitTransactionAllResponseItem
cardProductVirtualFlag
​boolean · required

Whether the product is a virtual one.

cardProductDigitalFlag
​boolean · required

Whether the product can be issued digitally.

sourceTab
​string · optional
terminalNumber
​string · optional

The terminal the transaction was made at.

authorizationNumber
​string · optional

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

authorizationMatchStatus
​string · optional

Whether the clearing record was matched to an authorisation.

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.

cardSeqNumber
​integer · int32 · optional

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

channelTypeDescription
​string · optional

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

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

digitalSlipValue
​string · optional

The digital receipt itself.

isChipFlag
​boolean · optional

Whether the card's chip was used rather than the stripe.

localAmount
​number · double · optional

The amount converted into the bank's own currency.

localCurrencyDescription
​string · optional

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

mainCustomerNumber
​integer · int64 · optional

The main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.

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.

matchStatusDescription
​string · optional
mccDescription
​string · optional

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

merchantCountryCode
​string · optional

Where the merchant is, as a country code.

merchantName
​string · optional

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

merchantNumber
​string · optional

The merchant's number with the acquirer.

networkTypeDescription
​string · optional
offlineFlag
​boolean · optional

Whether the terminal approved the transaction without asking the issuer.

panEntryMode
​string · optional

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

pinUsage
​string · optional

Whether the transaction was authorised with a PIN.

responseCodeDescription
​string · optional
responseReasonCodeDescription
​string · optional
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.

settlementAmount
​number · double · optional

The amount as it settles between the scheme and the bank.

settlementCurrencyDescription
​string · optional
terminalType
​string · optional

What kind of terminal that was — POS, ATM, or another.

transactionDate
​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
trnAmount
​number · double · optional

The amount of the transaction, in its own currency.

trnCodeMatrixDescription
​string · optional

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

trnCurrencyDescription
​string · optional

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

trnStatusCode
​string · optional

Where the transaction has got to, as a code.

trnStatusDescription
​string · optional

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

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.

trnEffect
​string · optional

Whether the transaction adds to the balance or takes from it.

channelType
​string · optional

Which channel the row applies to.

capitalRewardIndicator
​string · optional

Whether the reward counts towards the capital scheme.

trnCurrencyCode
​string · optional

The currency the transaction was made in.

transactionDescription
​string · optional
​object · optional

What the transaction earned.

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.

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

mcc
​string · optional

The merchant category code — the four-digit code the scheme classifies the merchant's trade with.

mccGroupCode
​string · optional

Which group of merchant categories the merchant falls in.

localCurrencyCode
​string · optional

The bank's own currency, which localAmount is in.

accountNumber
​number · double · optional

The account at the bank's core banking system that the card draws on. It must already exist, belong to the card's customer, and be neither shared nor a foreign-currency account.

acqInstitutionId
​string · optional
supplementaryCardFlag
​boolean · optional

Whether this is a supplementary card rather than a main one.

POST/IntegrationDigitalChannelDebit/debit/api/getDebitCardTransactionByUtid
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getDebitCardTransactionByUtid \ --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
{ "sourceTab": "sourceTab", "terminalNumber": "terminalNumber", "authorizationNumber": "authorizationNumber", "authorizationMatchStatus": "authorizationMatchStatus", "cardRefNumber": "cardRefNumber", "cardSeqNumber": 0, "channelTypeDescription": "channelTypeDescription", "customer": "customer", "customerNumber": 0, "digitalSlipValue": "digitalSlipValue", "isChipFlag": true, "localAmount": 0, "localCurrencyDescription": "localCurrencyDescription", "mainCustomerNumber": 0, "maskedCardNumber": "maskedCardNumber", "matchStatusDescription": "matchStatusDescription", "mccDescription": "mccDescription", "merchantCountryCode": "merchantCountryCode", "merchantName": "merchantName", "merchantNumber": "merchantNumber", "networkTypeDescription": "networkTypeDescription", "offlineFlag": true, "panEntryMode": "panEntryMode", "pinUsage": "pinUsage", "responseCodeDescription": "responseCodeDescription", "responseReasonCodeDescription": "responseReasonCodeDescription", "rrn": "rrn", "settlementAmount": 0, "settlementCurrencyDescription": "settlementCurrencyDescription", "terminalType": "terminalType", "transactionDate": "2026-10-16T14:30:00Z", "trnAmount": 0, "trnCodeMatrixDescription": "trnCodeMatrixDescription", "trnCurrencyDescription": "trnCurrencyDescription", "trnStatusCode": "trnStatusCode", "trnStatusDescription": "trnStatusDescription", "utid": "utid", "trnEffect": "trnEffect", "channelType": "channelType", "capitalRewardIndicator": "capitalRewardIndicator", "cardProductVirtualFlag": true, "trnCurrencyCode": "trnCurrencyCode", "cardProductDigitalFlag": true, "transactionDescription": "transactionDescription", "earnedPoint": { "amount": 0, "rewardType": "rewardType" }, "trnCodeMatrixId": "trnCodeMatrixId", "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "localCurrencyCode": "localCurrencyCode", "accountNumber": 0, "acqInstitutionId": "acqInstitutionId", "supplementaryCardFlag": true }
json
application/json

getDebitCardTransactionByUtidNew

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getDebitCardTransactionByUtidNew

Retrieves a debit card transaction by UTID using the new transaction flow. Directly queries debit transactions by UTID and returns the matching transaction record.

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

getDebitCardTransactionByUtidNew › Request Body

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

getDebitCardTransactionByUtidNew › Responses

Success

GetDebitTransactionAllResponseItem
cardProductVirtualFlag
​boolean · required

Whether the product is a virtual one.

cardProductDigitalFlag
​boolean · required

Whether the product can be issued digitally.

sourceTab
​string · optional
terminalNumber
​string · optional

The terminal the transaction was made at.

authorizationNumber
​string · optional

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

authorizationMatchStatus
​string · optional

Whether the clearing record was matched to an authorisation.

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.

cardSeqNumber
​integer · int32 · optional

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

channelTypeDescription
​string · optional

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

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

digitalSlipValue
​string · optional

The digital receipt itself.

isChipFlag
​boolean · optional

Whether the card's chip was used rather than the stripe.

localAmount
​number · double · optional

The amount converted into the bank's own currency.

localCurrencyDescription
​string · optional

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

mainCustomerNumber
​integer · int64 · optional

The main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.

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.

matchStatusDescription
​string · optional
mccDescription
​string · optional

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

merchantCountryCode
​string · optional

Where the merchant is, as a country code.

merchantName
​string · optional

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

merchantNumber
​string · optional

The merchant's number with the acquirer.

networkTypeDescription
​string · optional
offlineFlag
​boolean · optional

Whether the terminal approved the transaction without asking the issuer.

panEntryMode
​string · optional

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

pinUsage
​string · optional

Whether the transaction was authorised with a PIN.

responseCodeDescription
​string · optional
responseReasonCodeDescription
​string · optional
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.

settlementAmount
​number · double · optional

The amount as it settles between the scheme and the bank.

settlementCurrencyDescription
​string · optional
terminalType
​string · optional

What kind of terminal that was — POS, ATM, or another.

transactionDate
​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
trnAmount
​number · double · optional

The amount of the transaction, in its own currency.

trnCodeMatrixDescription
​string · optional

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

trnCurrencyDescription
​string · optional

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

trnStatusCode
​string · optional

Where the transaction has got to, as a code.

trnStatusDescription
​string · optional

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

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.

trnEffect
​string · optional

Whether the transaction adds to the balance or takes from it.

channelType
​string · optional

Which channel the row applies to.

capitalRewardIndicator
​string · optional

Whether the reward counts towards the capital scheme.

trnCurrencyCode
​string · optional

The currency the transaction was made in.

transactionDescription
​string · optional
​object · optional

What the transaction earned.

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.

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

mcc
​string · optional

The merchant category code — the four-digit code the scheme classifies the merchant's trade with.

mccGroupCode
​string · optional

Which group of merchant categories the merchant falls in.

localCurrencyCode
​string · optional

The bank's own currency, which localAmount is in.

accountNumber
​number · double · optional

The account at the bank's core banking system that the card draws on. It must already exist, belong to the card's customer, and be neither shared nor a foreign-currency account.

acqInstitutionId
​string · optional
supplementaryCardFlag
​boolean · optional

Whether this is a supplementary card rather than a main one.

POST/IntegrationDigitalChannelDebit/debit/api/getDebitCardTransactionByUtidNew
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getDebitCardTransactionByUtidNew \ --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
{ "sourceTab": "sourceTab", "terminalNumber": "terminalNumber", "authorizationNumber": "authorizationNumber", "authorizationMatchStatus": "authorizationMatchStatus", "cardRefNumber": "cardRefNumber", "cardSeqNumber": 0, "channelTypeDescription": "channelTypeDescription", "customer": "customer", "customerNumber": 0, "digitalSlipValue": "digitalSlipValue", "isChipFlag": true, "localAmount": 0, "localCurrencyDescription": "localCurrencyDescription", "mainCustomerNumber": 0, "maskedCardNumber": "maskedCardNumber", "matchStatusDescription": "matchStatusDescription", "mccDescription": "mccDescription", "merchantCountryCode": "merchantCountryCode", "merchantName": "merchantName", "merchantNumber": "merchantNumber", "networkTypeDescription": "networkTypeDescription", "offlineFlag": true, "panEntryMode": "panEntryMode", "pinUsage": "pinUsage", "responseCodeDescription": "responseCodeDescription", "responseReasonCodeDescription": "responseReasonCodeDescription", "rrn": "rrn", "settlementAmount": 0, "settlementCurrencyDescription": "settlementCurrencyDescription", "terminalType": "terminalType", "transactionDate": "2026-10-16T14:30:00Z", "trnAmount": 0, "trnCodeMatrixDescription": "trnCodeMatrixDescription", "trnCurrencyDescription": "trnCurrencyDescription", "trnStatusCode": "trnStatusCode", "trnStatusDescription": "trnStatusDescription", "utid": "utid", "trnEffect": "trnEffect", "channelType": "channelType", "capitalRewardIndicator": "capitalRewardIndicator", "cardProductVirtualFlag": true, "trnCurrencyCode": "trnCurrencyCode", "cardProductDigitalFlag": true, "transactionDescription": "transactionDescription", "earnedPoint": { "amount": 0, "rewardType": "rewardType" }, "trnCodeMatrixId": "trnCodeMatrixId", "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "localCurrencyCode": "localCurrencyCode", "accountNumber": 0, "acqInstitutionId": "acqInstitutionId", "supplementaryCardFlag": true }
json
application/json

getDebitTransactionAll

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getDebitTransactionAll

Retrieves all debit card transactions for a given ShadowCardNumber and date range. Combines authorization and posted transaction records, merges unmatched authorizations, filters reward transactions, calculates total amount, and returns ordered transaction details including amounts, merchant info, status, rewards, and digital slip data. Also supports UTID-based retrieval via an alternative method.

Part of:

  • Journey 01 · Launching a new card product — step 4, Activate, PIN, transact

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

getDebitTransactionAll › Request Body

GetDebitTransactionAllRequest
shadowCardNumber
​string · maxLength: 19 · required

The card whose transactions are listed. The only checked field, and a card that matches no master is an empty answer rather than a refusal — the operation returns before it queries anything.

beginDate
​string · optional

Start of the window. Not checked, and not checked against endDate either.

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

End of the window.

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

Narrows the authorisations to one response code. Not applied to the settled transactions, which are queried without it.

Comes back from the transaction services; no column behind this API holds it.

responseReasonCode
​string · optional

Narrows the authorisations to one response reason code. Not applied to the settled transactions either.

Comes back from the transaction services; no column behind this API holds it.

networkType
​string · optional

Narrows both halves of the answer to one network.

Resolved by the transaction services. A column of this name exists on the operation limit tables, which this operation does not read, so its five characters are not published here.

Values:

  • O — on-us
  • D — domestic, through BKM
  • M — Mastercard
  • V — Visa
trnCodeMatrixId
​string · maxLength: 20 · optional

Narrows both halves to one transaction-code matrix entry.

maxAmount
​number · double · optional

Upper bound on the amount, applied to both halves.

minAmount
​number · double · optional

Lower bound on the amount, applied to both halves.

getDebitTransactionAll › Responses

Success

GetDebitTransactionAllResponse
totalAmount
​number · double · required

The amount of every entry in the list added together.

​array · optional

The transactions the search matched.

POST/IntegrationDigitalChannelDebit/debit/api/getDebitTransactionAll
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getDebitTransactionAll \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "shadowCardNumber": "1202253520000036620", "beginDate": "2026-01-14T15:55:01.116Z", "endDate": "2026-09-14T15:55:01.116Z" }'
Example Request Body
{ "shadowCardNumber": "1202253520000036620", "beginDate": "2026-01-14T15:55:01.116Z", "endDate": "2026-09-14T15:55:01.116Z" }
json
application/json
Example Responses
{ "listOfTransaction": [ { "sourceTab": "sourceTab", "terminalNumber": "terminalNumber", "authorizationNumber": "authorizationNumber", "authorizationMatchStatus": "authorizationMatchStatus", "cardRefNumber": "cardRefNumber", "cardSeqNumber": 0, "channelTypeDescription": "channelTypeDescription", "customer": "customer", "customerNumber": 0, "digitalSlipValue": "digitalSlipValue", "isChipFlag": true, "localAmount": 0, "localCurrencyDescription": "localCurrencyDescription", "mainCustomerNumber": 0, "maskedCardNumber": "maskedCardNumber", "matchStatusDescription": "matchStatusDescription", "mccDescription": "mccDescription", "merchantCountryCode": "merchantCountryCode", "merchantName": "merchantName", "merchantNumber": "merchantNumber", "networkTypeDescription": "networkTypeDescription", "offlineFlag": true, "panEntryMode": "panEntryMode", "pinUsage": "pinUsage", "responseCodeDescription": "responseCodeDescription", "responseReasonCodeDescription": "responseReasonCodeDescription", "rrn": "rrn", "settlementAmount": 0, "settlementCurrencyDescription": "settlementCurrencyDescription", "terminalType": "terminalType", "transactionDate": "2026-10-16T14:30:00Z", "trnAmount": 0, "trnCodeMatrixDescription": "trnCodeMatrixDescription", "trnCurrencyDescription": "trnCurrencyDescription", "trnStatusCode": "trnStatusCode", "trnStatusDescription": "trnStatusDescription", "utid": "utid", "trnEffect": "trnEffect", "channelType": "channelType", "capitalRewardIndicator": "capitalRewardIndicator", "cardProductVirtualFlag": true, "trnCurrencyCode": "trnCurrencyCode", "cardProductDigitalFlag": true, "transactionDescription": "transactionDescription", "earnedPoint": { "amount": 0, "rewardType": "rewardType" }, "trnCodeMatrixId": "trnCodeMatrixId", "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "localCurrencyCode": "localCurrencyCode", "accountNumber": 0, "acqInstitutionId": "acqInstitutionId", "supplementaryCardFlag": true } ], "totalAmount": 0 }
json
application/json

updateTransactionForBNPL

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/updateTransactionForBNPL

Updates installment information for BNPL (Buy Now Pay Later) transactions. Updates corresponding transaction records for Installment Count, Installment Parameter, and Installment Profit Rate to synchronize with core banking system.

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

updateTransactionForBNPL › Request Body

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

installmentCount
​integer · int32 · optional

How many instalments to split the amount across. The available counts for a card and amount come from the simulation operations.

installmentParameter
​string · maxLength: 1 · optional

Which instalment rule the transaction is split by.

installmentProfitRate
​number · double · optional

The rate applied across the instalments.

updateTransactionForBNPL › Responses

Success

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

errorMessage
​string · optional
POST/IntegrationDigitalChannelDebit/debit/api/updateTransactionForBNPL
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/updateTransactionForBNPL \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "utid": "utid", "installmentCount": 0, "installmentParameter": "installmentParameter", "installmentProfitRate": 0 }'
Example Request Body
{ "utid": "utid", "installmentCount": 0, "installmentParameter": "installmentParameter", "installmentProfitRate": 0 }
json
application/json
Example Responses
{ "isSuccess": true, "errorMessage": "errorMessage" }
json
application/json

getDigitalSlipReceipt

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getDigitalSlipReceipt

Retrieves the digital slip (receipt) for a debit card transaction using UTID. Returns transaction details including amounts, currency, card info, authorization, terminal and merchant information, ICC data, and reference UTID if available.

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/IntegrationDigitalChannelDebit/debit/api/getDigitalSlipReceipt
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/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

getAuthorizationListByBegindateEnddate

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getAuthorizationListByBegindateEnddate

Retrieves the list of debit card authorizations for a given period. Requires start date and end date as input and returns the authorization transactions that occurred within that date range.

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

getAuthorizationListByBegindateEnddate › Request Body

GetAuthorizationListByBegindateEnddateRequest
​object · optional

The search itself. The request body carries a single object, named after the query behind it, and its fields are the criteria.

getAuthorizationListByBegindateEnddate › Responses

Success

GetAuthorizationListByBegindateEnddateResponse
​array · optional
POST/IntegrationDigitalChannelDebit/debit/api/getAuthorizationListByBegindateEnddate
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getAuthorizationListByBegindateEnddate \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "GetAuthorizationListByBegindateEnddateParam": { "AuthorizationMatchStatus": "AuthorizationMatchStatus", "BeginDate": "2026-10-16T14:30:00Z", "CardRefNumber": "CardRefNumber", "CustomerNumber": 0, "EndDate": "2026-10-16T14:30:00Z", "MaxAmount": 0, "Mcc": "Mcc", "MinAmount": 0, "NetworkType": "NetworkType", "NotSuccesfullResponse": "NotSuccesfullResponse", "ResponseCode": "ResponseCode", "ResponseReasonCode": "ResponseReasonCode", "Rrn": "Rrn", "ShadowCardNumber": "ShadowCardNumber", "TrnCodeMatrixId": "TrnCodeMatrixId", "TrnStatus": "TrnStatus" } }'
Example Request Body
{ "GetAuthorizationListByBegindateEnddateParam": { "AuthorizationMatchStatus": "AuthorizationMatchStatus", "BeginDate": "2026-10-16T14:30:00Z", "CardRefNumber": "CardRefNumber", "CustomerNumber": 0, "EndDate": "2026-10-16T14:30:00Z", "MaxAmount": 0, "Mcc": "Mcc", "MinAmount": 0, "NetworkType": "NetworkType", "NotSuccesfullResponse": "NotSuccesfullResponse", "ResponseCode": "ResponseCode", "ResponseReasonCode": "ResponseReasonCode", "Rrn": "Rrn", "ShadowCardNumber": "ShadowCardNumber", "TrnCodeMatrixId": "TrnCodeMatrixId", "TrnStatus": "TrnStatus" } }
json
application/json
Example Responses
{ "GetAuthorizationListByBegindateEnddateResult": [ { "AccountNumber": 0, "AcqInstitutionId": "AcqInstitutionId", "AuthorizationMatchStatus": "AuthorizationMatchStatus", "AuthorizationNumber": "AuthorizationNumber", "CardRefNumber": "CardRefNumber", "CardSeqNumber": 0, "ChannelType": "ChannelType", "ChannelTypeDescription": "ChannelTypeDescription", "CommissionAmount": 0, "Customer": "Customer", "CustomerNumber": 0, "DigitalSlipValue": "DigitalSlipValue", "EarnedPoint": 0, "FeeAmount": 0, "InstallmentCount": 0, "InstallmentParameter": "InstallmentParameter", "InstallmentProfitRate": 0, "IsChipFlag": true, "LocalAmount": 0, "LocalCurrencyCode": "LocalCurrencyCode", "LocalCurrencyDescription": "LocalCurrencyDescription", "MainCardRefNumber": "MainCardRefNumber", "MainCustomerNumber": 0, "MaskedCardNumber": "MaskedCardNumber", "MatchStatusDescription": "MatchStatusDescription", "Mcc": "Mcc", "MccDescription": "MccDescription", "MccGroupCode": "MccGroupCode", "MerchantCountryCode": "MerchantCountryCode", "MerchantName": "MerchantName", "MerchantNumber": "MerchantNumber", "NetworkTypeDescription": "NetworkTypeDescription", "OfflineFlag": true, "OpenReceiptFormIsEnabledFlag": true, "PanEntryMode": "PanEntryMode", "PinUsage": "PinUsage", "PreAuthorizationStatus": "PreAuthorizationStatus", "ProductDigitalFlag": true, "ProductName": "ProductName", "ProductVirtualFlag": true, "ResponseCodeDescription": "ResponseCodeDescription", "ResponseReasonCodeDescription": "ResponseReasonCodeDescription", "Rrn": "Rrn", "SettlementAmount": 0, "SettlementCurrencyDescription": "SettlementCurrencyDescription", "ShadowCardNumber": "ShadowCardNumber", "SourceTab": "SourceTab", "SuccessCode": "SuccessCode", "SupplementaryCardFlag": true, "TerminalNumber": "TerminalNumber", "TerminalType": "TerminalType", "TransactionDate": "2026-10-16T14:30:00Z", "TransactionDescription": "TransactionDescription", "TransactionTime": "TransactionTime", "TrnAmount": 0, "TrnCodeMatrixDescription": "TrnCodeMatrixDescription", "TrnCodeMatrixId": "TrnCodeMatrixId", "TrnCurrencyCode": "TrnCurrencyCode", "TrnCurrencyDescription": "TrnCurrencyDescription", "TrnEffect": "TrnEffect", "TrnRewardAbility": "TrnRewardAbility", "TrnStatusCode": "TrnStatusCode", "TrnStatusDescription": "TrnStatusDescription", "Utid": "Utid" } ] }
json
application/json

getDbttransactionByCardrefCustomernum

POST
https://sandboxpub.cms.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getDbttransactionByCardrefCustomernum

Retrieves debit card transaction records based on card reference number and customer number. Calls DCID repository to fetch transaction data and returns the result without additional filtering or transformation.

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

getDbttransactionByCardrefCustomernum › Request Body

GetDbttransactionByCardrefCustomernumRequest
​object · optional

The search itself. The request body carries a single object, named after the query behind it, and its fields are the criteria.

getDbttransactionByCardrefCustomernum › Responses

Success

GetDbttransactionByCardrefCustomernumResponse
​array · optional
POST/IntegrationDigitalChannelDebit/debit/api/getDbttransactionByCardrefCustomernum
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getDbttransactionByCardrefCustomernum \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "GetDbttransactionByCardrefCustomernumParam": { "CardRefNumber": "CardRefNumber", "CustomerNumber": 0, "EmbossName": "EmbossName", "MaxAmount": 0, "MinAmount": 0, "ShadowCardNumber": "ShadowCardNumber", "SourceNetwork": "SourceNetwork", "Transactiondatebegin": "2026-10-16T14:30:00Z", "Transactiondateend": "2026-10-16T14:30:00Z", "TrnCodeMatrixId": "TrnCodeMatrixId" } }'
Example Request Body
{ "GetDbttransactionByCardrefCustomernumParam": { "CardRefNumber": "CardRefNumber", "CustomerNumber": 0, "EmbossName": "EmbossName", "MaxAmount": 0, "MinAmount": 0, "ShadowCardNumber": "ShadowCardNumber", "SourceNetwork": "SourceNetwork", "Transactiondatebegin": "2026-10-16T14:30:00Z", "Transactiondateend": "2026-10-16T14:30:00Z", "TrnCodeMatrixId": "TrnCodeMatrixId" } }
json
application/json
Example Responses
{ "GetDbttransactionByCardrefCustomernumResult": [ { "AccountNumber": 0, "AcqInstitutionId": "AcqInstitutionId", "AcqRefNumber": "AcqRefNumber", "AuthorizationMatchStatus": "AuthorizationMatchStatus", "AuthorizationNumber": "AuthorizationNumber", "BillingAmount": 0, "BillingCurrency": "BillingCurrency", "BkmUniqueMerchantId": "BkmUniqueMerchantId", "CampaignCodeAcq": "CampaignCodeAcq", "CampaignCodeIss": "CampaignCodeIss", "ChannelType": "ChannelType", "ChannelTypeDescription": "ChannelTypeDescription", "ClearingChannel": "ClearingChannel", "ClearingDate": "2026-10-16T14:30:00Z", "ClearingNumber": 0, "CustomerNumberList": 0, "DigitalSlipValue": "DigitalSlipValue", "DisplayAtChannels": 0, "EarnedRewardBank": 0, "EarnedRewardCampaignAcq": 0, "EarnedRewardCampaignIss": 0, "EarnedRewardMerchant": 0, "EmbossName": "EmbossName", "EodDate": "2026-10-16T14:30:00Z", "InstallmentCount": 0, "InstallmentParameter": "InstallmentParameter", "InstallmentProfitRate": 0, "InvoiceNumber": "InvoiceNumber", "LocalAmount": 0, "LocalCurrency": "LocalCurrency", "LocalCurrencyCode": "LocalCurrencyCode", "MainCardRefNumber": "MainCardRefNumber", "MainCustomerNumber": 0, "MaskedCardNumber": "MaskedCardNumber", "MatchStatusDescription": "MatchStatusDescription", "Mcc": "Mcc", "MccDescription": "MccDescription", "MccGroupCode": "MccGroupCode", "MerchantAmexId": "MerchantAmexId", "MerchantCity": "MerchantCity", "MerchantCountryCode": "MerchantCountryCode", "MerchantName": "MerchantName", "MerchantNumber": "MerchantNumber", "NetworkDescription": "NetworkDescription", "OfflineFlag": true, "PanEntryMode": "PanEntryMode", "PinUsage": "PinUsage", "Product": "Product", "ProductDigitalFlag": true, "ProductVirtualFlag": true, "RefUtid": "RefUtid", "RequestDate": "2026-10-16T14:30:00Z", "RewardTypeDescription": "RewardTypeDescription", "Rrn": "Rrn", "SettlementAmount": 0, "SettlementCurrency": "SettlementCurrency", "ShadowCardNumber": "ShadowCardNumber", "SupplementaryCardFlag": true, "TerminalNumber": "TerminalNumber", "TerminalType": "TerminalType", "TransactionDescription": "TransactionDescription", "TrnAmount": 0, "TrnCodeMatrixDesc": "TrnCodeMatrixDesc", "TrnCodeMatrixId": "TrnCodeMatrixId", "TrnCurrency": "TrnCurrency", "TrnCurrencyCode": "TrnCurrencyCode", "TrnDate": "2026-10-16T14:30:00Z", "TrnDescription": "TrnDescription", "TrnEffect": "TrnEffect", "TrnOrigin": 0, "TrnRewardAbility": "TrnRewardAbility", "TrnStatus": "TrnStatus", "Utid": "Utid" } ] }
json
application/json

Account linkingCard and customer limits