Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • OAuth2
  • Delivery
Information
Cards
    Card lifecycle
      getBasicCardInformationByPanpostgetDebitCardLogDataListByShadowCardNumberpostgetCreditCardLogDataListByShadowCardNumberpostgetCardByCardNumberpostgetSecureCardByPanpostgetCardByShadowCardNumberpost
Customers and accounts
    Customers
      getAssetByShadowCardNumberpostgetCustomerDetailpostcreateCustomerpostupdateCustomerpost
    Account linking
      accountStatuspost
Transactions
    getCreditTransactionListpostgetPaymentAndCashadvanceInformationByCriteriaspostgetAuthorizationListByBegindateEnddatepostgetDbttransactionByCardrefCustomernumpost
Limits and controls
    Card and customer limits
      changeCustomerLimitDecreasepostchangeCustomerLimitIncreasepost
    Permissions and restrictions
      getCardRestrictionpost
Billing and statements
    Collections and legal follow-up
      createFollowUpByMainCustomerNumberpostaddToLegalFollowUppost
    Debt payment
      getAutoPaymentQueuepost
    Statements and billing
      getDelinquencyInterestAmountpostsetStatementDocumentIdpostsetStatementDocumentOnlypostgetCardStatementCutoffReportpost
Security
    PIN and card security
      isSetCardPinViaSMSControlpostgetClearPanByShadowpostgetCardInfoByClearPanpostgetEncryptDataBlockpostdecryptDataBlockpost
Rewards
    Campaigns and rewards
      executeCampaignTransactionpostgetDebitCardForRewardByBankpost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getProductByShadowCardNumberpostgetEmbossReasonSubDefByValidFlagpostgetAvailableEmbossReasonListpostgetMccGroupAllpostgetTrnStatusAllpostgetBinDomesticByBinpostgetApplicableProductspostgetMccDefinitionGroupbyMccMccdescriptionpostgetNetworkTypeDefByValidFlagpostgetResponseCodeDefByValidFlagpostgetResponseReasonCodeDefByValidFlagpostgetTrnCodeDefByValidFlagpostgetTrnCodeMatrixByValidFlagpost
SchemasError codesChannels
powered by Zudoku
Common Methods
Common Methods

Account linking

Attach and detach the accounts a card draws on, and read back what a card is currently linked to.


accountStatus

POST
https://sandboxpub.cms.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/accountStatus

Retrieves the current status of an account by querying the core banking and BKM management systems. The service accepts account identification details and returns the account status information mapped from the BKM response. This operation is read-only and does not perform any state-changing action on the account.

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

accountStatus › Request Body

AccountStatusReq
timeStamp
​integer · int64 · required

Request timestamp as a 64-bit integer. It is a non-nullable value on the contract, which is why the schema marks it required; an omitted value is carried downstream as zero rather than as absent. The facade does not check it.

transactionID
​string · optional

Part of an external account-status contract that this platform passes through; none of its fields is stored here.

dsTransID
​string · optional

Part of an external account-status contract that this platform passes through; none of its fields is stored here.

sourceSystem
​string · optional

Part of an external account-status contract that this platform passes through; none of its fields is stored here.

version
​string · optional

Part of an external account-status contract that this platform passes through; none of its fields is stored here.

​object · optional

The cardholder the authentication is being run for.

​object · optional

The transaction being authenticated.

​object · optional

The device the transaction is being made from.

​object · optional

The merchant the transaction is being made at.

accountStatus › Responses

Success.

The facade is a pass-through with no logic of its own. It converts the request onto the BKM management service's own AccountStatusRequest, calls that service and converts the reply back. There is no validation, no defaulting, no branching and no error handling in the facade, so every rule behind this operation belongs to the BKM management service.

The reply is never inspected. A refusal the BKM management service reports inside its result block (resultCode, resultMsg, resultDetail) is returned unchanged as a 200, so a 200 here does not mean the account status check succeeded. Callers must read result to decide.

The conversion is a whole-object copy in both directions. Any request field with no counterpart on the downstream contract is dropped without a warning, and any downstream field with no counterpart here is discarded on the way back.

AccountStatusRes
timeStamp
​integer · int64 · required
transactionID
​string · optional
memberRefID
​string · optional
status
​string · optional
challengeType
​integer · int32 · optional
language
​string · optional
riskValue
​string · optional
​object · optional
version
​string · optional
​object · optional

The outcome, as the downstream system words it.

POST/Integrationcorebanking/Indoor/api/accountStatus
curl https://sandboxpub.cms.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/accountStatus \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "transactionID": "transactionID", "dsTransID": "dsTransID", "sourceSystem": "sourceSystem", "version": "version", "timeStamp": 0, "cardHolderData": { "encryptedAccountNumber": { "encData": "encData", "cryptoAlgorithm": 0, "keyID": 0 }, "cardExpiryDate": 0, "cardHolderName": "cardHolderName", "addrMatch": "addrMatch", "billAddrCity": "billAddrCity", "billAddrCountry": "billAddrCountry", "billAddrLine1": "billAddrLine1", "billAddrLine2": "billAddrLine2", "billAddrLine3": "billAddrLine3", "billAddrPostCode": "billAddrPostCode", "email": "email", "homePhone": { "cc": "cc", "subscriber": "subscriber" }, "mobilePhone": { "cc": "cc", "subscriber": "subscriber" }, "shipAddrCity": "shipAddrCity", "shipAddrCountry": "shipAddrCountry", "shipAddrLine1": "shipAddrLine1", "shipAddrLine2": "shipAddrLine2", "shipAddrLine3": "shipAddrLine3", "shipAddrPostCode": "shipAddrPostCode", "workPhone": { "cc": "cc", "subscriber": "subscriber" }, "acctInfo": { "chAccAgeInd": "chAccAgeInd", "chAccDate": "chAccDate", "chAccChangeInd": "chAccChangeInd", "chAccChange": "chAccChange", "chAccPwChangeInd": "chAccPwChangeInd", "chAccPwChange": "chAccPwChange", "shipAddressUsageInd": "shipAddressUsageInd", "shipAddressUsage": "shipAddressUsage", "txnActivityDay": "txnActivityDay", "txnActivityYear": "txnActivityYear", "provisionAttemptsDay": "provisionAttemptsDay", "nbPurchaseAccount": "nbPurchaseAccount", "suspiciousAccActivity": "suspiciousAccActivity", "shipNameIndicator": "shipNameIndicator", "paymentAccInd": "paymentAccInd", "paymentAccAge": "paymentAccAge" } }, "transactionData": { "messageCategory": "messageCategory", "threeDSRequestorAuthenticationInfo": { "threeDSReqAuthMethod": "threeDSReqAuthMethod", "threeDSReqAuthTimestamp": "threeDSReqAuthTimestamp", "threeDSReqAuthData": "threeDSReqAuthData" }, "threeDSRequestorPriorAuthenticationInfo": { "threeDSReqPriorAuthMethod": "threeDSReqPriorAuthMethod", "threeDSReqPriorAuthTimestamp": "threeDSReqPriorAuthTimestamp", "threeDSReqPriorAuthData": "threeDSReqPriorAuthData", "threeDSReqPriorRef": "threeDSReqPriorRef" }, "threeDSRequestorAuthenticationInd": "threeDSRequestorAuthenticationInd", "threeDSRequestorChallengeInd": "threeDSRequestorChallengeInd", "purchaseAmount": "purchaseAmount", "purchaseCurrency": "purchaseCurrency", "purchaseExponent": "purchaseExponent", "purchaseInstallData": "purchaseInstallData", "purchaseDate": "purchaseDate", "transType": "transType", "recurringExpiry": "recurringExpiry" }, "deviceData": { "deviceChannel": "deviceChannel", "browserIP": "browserIP", "deviceInfo": "deviceInfo" }, "merchantData": { "acquirerMerchantID": "acquirerMerchantID", "merchantRiskIndicator": { "shipIndicator": "shipIndicator", "deliveryTimeframe": "deliveryTimeframe", "deliveryEmailAddress": "deliveryEmailAddress", "reorderItemsInd": "reorderItemsInd", "preOrderPurchaseInd": "preOrderPurchaseInd", "preOrderDate": "preOrderDate", "giftCardAmount": "giftCardAmount", "giftCardCurr": "giftCardCurr", "giftCardCount": "giftCardCount" }, "merchantCountryCode": "merchantCountryCode", "merchantName": "merchantName", "mcc": "mcc" } }'
Example Request Body
{ "transactionID": "transactionID", "dsTransID": "dsTransID", "sourceSystem": "sourceSystem", "version": "version", "timeStamp": 0, "cardHolderData": { "encryptedAccountNumber": { "encData": "encData", "cryptoAlgorithm": 0, "keyID": 0 }, "cardExpiryDate": 0, "cardHolderName": "cardHolderName", "addrMatch": "addrMatch", "billAddrCity": "billAddrCity", "billAddrCountry": "billAddrCountry", "billAddrLine1": "billAddrLine1", "billAddrLine2": "billAddrLine2", "billAddrLine3": "billAddrLine3", "billAddrPostCode": "billAddrPostCode", "email": "email", "homePhone": { "cc": "cc", "subscriber": "subscriber" }, "mobilePhone": { "cc": "cc", "subscriber": "subscriber" }, "shipAddrCity": "shipAddrCity", "shipAddrCountry": "shipAddrCountry", "shipAddrLine1": "shipAddrLine1", "shipAddrLine2": "shipAddrLine2", "shipAddrLine3": "shipAddrLine3", "shipAddrPostCode": "shipAddrPostCode", "workPhone": { "cc": "cc", "subscriber": "subscriber" }, "acctInfo": { "chAccAgeInd": "chAccAgeInd", "chAccDate": "chAccDate", "chAccChangeInd": "chAccChangeInd", "chAccChange": "chAccChange", "chAccPwChangeInd": "chAccPwChangeInd", "chAccPwChange": "chAccPwChange", "shipAddressUsageInd": "shipAddressUsageInd", "shipAddressUsage": "shipAddressUsage", "txnActivityDay": "txnActivityDay", "txnActivityYear": "txnActivityYear", "provisionAttemptsDay": "provisionAttemptsDay", "nbPurchaseAccount": "nbPurchaseAccount", "suspiciousAccActivity": "suspiciousAccActivity", "shipNameIndicator": "shipNameIndicator", "paymentAccInd": "paymentAccInd", "paymentAccAge": "paymentAccAge" } }, "transactionData": { "messageCategory": "messageCategory", "threeDSRequestorAuthenticationInfo": { "threeDSReqAuthMethod": "threeDSReqAuthMethod", "threeDSReqAuthTimestamp": "threeDSReqAuthTimestamp", "threeDSReqAuthData": "threeDSReqAuthData" }, "threeDSRequestorPriorAuthenticationInfo": { "threeDSReqPriorAuthMethod": "threeDSReqPriorAuthMethod", "threeDSReqPriorAuthTimestamp": "threeDSReqPriorAuthTimestamp", "threeDSReqPriorAuthData": "threeDSReqPriorAuthData", "threeDSReqPriorRef": "threeDSReqPriorRef" }, "threeDSRequestorAuthenticationInd": "threeDSRequestorAuthenticationInd", "threeDSRequestorChallengeInd": "threeDSRequestorChallengeInd", "purchaseAmount": "purchaseAmount", "purchaseCurrency": "purchaseCurrency", "purchaseExponent": "purchaseExponent", "purchaseInstallData": "purchaseInstallData", "purchaseDate": "purchaseDate", "transType": "transType", "recurringExpiry": "recurringExpiry" }, "deviceData": { "deviceChannel": "deviceChannel", "browserIP": "browserIP", "deviceInfo": "deviceInfo" }, "merchantData": { "acquirerMerchantID": "acquirerMerchantID", "merchantRiskIndicator": { "shipIndicator": "shipIndicator", "deliveryTimeframe": "deliveryTimeframe", "deliveryEmailAddress": "deliveryEmailAddress", "reorderItemsInd": "reorderItemsInd", "preOrderPurchaseInd": "preOrderPurchaseInd", "preOrderDate": "preOrderDate", "giftCardAmount": "giftCardAmount", "giftCardCurr": "giftCardCurr", "giftCardCount": "giftCardCount" }, "merchantCountryCode": "merchantCountryCode", "merchantName": "merchantName", "mcc": "mcc" } }
json
application/json
Example Responses
{ "transactionID": "transactionID", "memberRefID": "memberRefID", "status": "status", "challengeType": 0, "language": "language", "riskValue": "riskValue", "mobileNo": { "cc": "cc", "subscriber": "subscriber" }, "timeStamp": 0, "version": "version", "result": { "resultCode": "resultCode", "resultMsg": "resultMsg", "resultDetail": "resultDetail" } }
json
application/json

CustomersTransactions