Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • 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

Customers

Read the customer behind the cards — portfolio summary, corporate relationships and total assets.


getCorporateCustomerInfoByIndividualCustomer

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getCorporateCustomerInfoByIndividualCustomer

Retrieves corporate customer information for a given individual customer. Validates the request, fetches customer assets, and filters for corporate supplementary cards (ProductSegmentCode = "T"). Returns a GetCorporateCustomerInfoByIndividualCustomerResponse containing MainCustomerNumber, ShadowCardNumber, and MaskedCardNumber for each relevant card.

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

getCorporateCustomerInfoByIndividualCustomer › Request Body

GetCorporateCustomerInfoByIndividualCustomerRequest
customerNumber
​integer | null · int64

Customer Number - [Optional]

channel
​string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

getCorporateCustomerInfoByIndividualCustomer › Responses

Success

GetCorporateCustomerInfoByIndividualCustomerResponse
​array | null

List Of Debit Corporate Customer Info - [Optional]

POST/IntegrationDigitalChannelDebit/debit/api/getCorporateCustomerInfoByIndividualCustomer
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCorporateCustomerInfoByIndividualCustomer \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "customerNumber": 0, "channel": "channel" }'
Example Request Body
{ "customerNumber": 0, "channel": "channel" }
json
application/json
Example Responses
{ "listOfDebitCorporateCustomerInfo": [ { "mainCustomerNumber": "mainCustomerNumber", "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber" } ] }
json
application/json

getCustomerAsset

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getCustomerAsset

Retrieves all debit card assets for a given customer. Fetches card details, sensitive data, account info, status, and delivery info. Uses _dcidRepository.GetCustomerAssetByCustomernumber for card data, _dbtServiceProxy.ListCardAccountByShadowCardNumber for account info, _coreBankingIntegrationOutdoor.GetAccountInformation for balances, and GetSensitiveData for sensitive card info (CVV2, PAN). Returns a GetCustomerAssetResponse containing a list of DebitCardModel with all relevant information.

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

getCustomerAsset › Request Body

GetCustomerAssetRequest
customerNumber
​integer · int64

Customer Number - [Optional]

purpose
​string | null

Purpose - [Optional]

channelCode
​string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

getCustomerAsset › Responses

Success

GetCustomerAssetResponse
​array | null

List Of Card - [Optional]

POST/IntegrationDigitalChannelDebit/debit/api/getCustomerAsset
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCustomerAsset \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "customerNumber": 0, "purpose": "purpose", "channelCode": "channelCode" }'
Example Request Body
{ "customerNumber": 0, "purpose": "purpose", "channelCode": "channelCode" }
json
application/json
Example Responses
{ "listOfCard": [ { "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "customerNumber": 0, "mainCustomerNumber": 0, "relatedCardRefNumber": "relatedCardRefNumber", "supplementaryCardFlag": true, "cardRefCurrentCardFlag": true, "branchCode": 0, "branchName": "branchName", "ownerName": "ownerName", "ownerSecondName": "ownerSecondName", "ownerSurname": "ownerSurname", "embossName": "embossName", "productNumber": "productNumber", "productSegmentCode": "productSegmentCode", "cardStatusCode": "cardStatusCode", "cardStatusDscr": "cardStatusDscr", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonDscr": "cardStatusReasonDscr", "virtualFlag": true, "digitalCardFlag": true, "productName": "productName", "productShortName": "productShortName", "tenantId": "tenantId", "emvFlag": true, "magneticStripeFlag": true, "contactlessFlag": true, "rewardEarningFlag": true, "cardBrand": "cardBrand", "cardBrandDescription": "cardBrandDescription", "cardDeliveryType": "cardDeliveryType", "expiryDateStr": "expiryDateStr", "provisionStatusFlag": true, "cardFormType": "cardFormType", "insertDate": "2024-08-25T15:00:00Z", "cvv2RetryCount": 0, "pinRetryCount": 0, "barcode": "barcode", "fromShadowCardNumber": "fromShadowCardNumber", "toShadowCardNumber": "toShadowCardNumber", "requestDate": "2024-08-25T15:00:00Z", "requestChannel": "requestChannel", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "cardStatusChangeDate": "2024-08-25T15:00:00Z", "firstTrnDate": "2024-08-25T15:00:00Z", "lastTrnDate": "2024-08-25T15:00:00Z", "firstPinSetDate": "2024-08-25T15:00:00Z", "lastPinSetDate": "2024-08-25T15:00:00Z", "lastPinChangeDate": "2024-08-25T15:00:00Z", "deliveryAddress": "deliveryAddress", "isFirstPinSet": "isFirstPinSet", "sendingBranchCode": "sendingBranchCode", "sendingAddressType": "sendingAddressType", "productGroupCode": "productGroupCode", "productGroupDescription": "productGroupDescription", "fromMaskedCardNumber": "fromMaskedCardNumber", "toMaskedCardNumber": "toMaskedCardNumber", "disabledFlag": true, "cardAccountInfoList": [ { "accountNumber": 0, "cardAccountType": "cardAccountType", "accountType": "accountType", "accountSubType": "accountSubType", "accountBranchId": 0, "accountOrderFlag": true, "fecCode": 0, "currencyCode": "currencyCode", "balance": 0, "usableBalance": 0, "iBAN": "iBAN", "errorDescription": "errorDescription" } ], "sensitiveData": { "pan": "pan", "cvv2": "cvv2" }, "pendingReplaceApplicationExists": true, "pinStatus": "pinStatus", "cardStatusChangeChannel": "cardStatusChangeChannel", "securityFlag": true, "citizenshipNumber": "citizenshipNumber", "taxNumber": "taxNumber", "customerNameSurname": "customerNameSurname", "cardSeqNumber": 0, "isDelivered": true } ] }
json
application/json

isCustomerConvertToRipper

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/isCustomerConvertToRipper

Checks whether a customer has any cards in the system. Accepts a CustomerNumber and returns flags indicating whether the customer has Credit, Debit, or Prepaid cards.

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

isCustomerConvertToRipper › Request Body

IsCustomerConvertToRipperRequest
customerNumber
​integer · int64

Customer Number - [Optional]

isCustomerConvertToRipper › Responses

Success

IsCustomerConvertToRipperResponse
haveAnyDebitCard
​boolean · required

Have Any Debit Card

haveAnyCreditCard
​boolean · required

Have Any Credit Card

haveAnyPrepaidCard
​boolean · required

Have Any Prepaid Card

POST/IntegrationDigitalChannelDebit/debit/api/isCustomerConvertToRipper
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/isCustomerConvertToRipper \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "customerNumber": 0 }'
Example Request Body
{ "customerNumber": 0 }
json
application/json
Example Responses
{ "haveAnyDebitCard": true, "haveAnyCreditCard": true, "haveAnyPrepaidCard": true }
json
application/json

getCustomerAssetsSummaryDebit

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getCustomerAssetsSummaryDebit

Retrieves a summarized list of debit card assets for a customer. Fetches card details, status, and related accounts. Uses _dcidRepository.GetCustomerAssetsSummaryDebit for card info, _dbtServiceProxy.ListCardAccountByShadowCardNumber for accounts, _coreBankingIntegrationOutdoor.GetAccountInformation for balances, and _cache for product and status descriptions. Filters out invalid or expired reissue cards and orders the list according to sort rules. Returns GetCustomerAssetsSummaryDebitResponse containing a list of GetCustomerAssetsSummaryDebitCardModel with card and account info.

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

getCustomerAssetsSummaryDebit › Request Body

GetCustomerAssetsSummaryDebitRequest
customerNumber
​integer · int64

Customer Number - [Optional]

channelCode
​string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

getCustomerAssetsSummaryDebit › Responses

Success

GetCustomerAssetsSummaryDebitResponse
​array | null

List Of Card - [Optional]

POST/IntegrationDigitalChannelDebit/debit/api/getCustomerAssetsSummaryDebit
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCustomerAssetsSummaryDebit \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "customerNumber": 0, "channelCode": "channelCode" }'
Example Request Body
{ "customerNumber": 0, "channelCode": "channelCode" }
json
application/json
Example Responses
{ "listOfCard": [ { "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "customerNumber": "customerNumber", "mainCustomerNumber": "mainCustomerNumber", "supplementaryCardFlag": true, "productNumber": "productNumber", "productName": "productName", "productShortName": "productShortName", "expiryDateStr": "expiryDateStr", "digitalCardFlag": true, "cardStatusCode": "cardStatusCode", "cardStatusCodeDescription": "cardStatusCodeDescription", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonCodeDescription": "cardStatusReasonCodeDescription", "cardStatusChangeChannel": "cardStatusChangeChannel", "securityFlag": true, "cardAccountInfoList": [ { "accountNumber": 0, "cardAccountType": "cardAccountType", "accountType": "accountType", "accountSubType": "accountSubType", "accountBranchId": 0, "accountOrderFlag": true, "fecCode": 0, "currencyCode": "currencyCode", "balance": 0, "usableBalance": 0, "iBAN": "iBAN", "errorDescription": "errorDescription" } ] } ] }
json
application/json

Branch managementAccount linking