Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card issuance and personalisation
      getApplicableProductsByCustomerNumberpostcreateIndividualDebitCardpostcreateCorporateDebitCardpostreplaceDebitCardpostcancelDebitEmbossByShadowCardNumberpostgetPendingCardEmbossListpostcancelEmbossByShadowCardNumberpost
    Card lifecycle
      getBasicCardInformationByPanpostgetDebitCardInfopostchangeDebitCardStatuspostchangeDebitCardBranchpostattachDebitCardAccountpostgetDebitCardLogDataListByShadowCardNumberpostgetCreditCardLogDataListByShadowCardNumberpostgetCardByCardNumberpostgetSecureCardByPanpostgetCardByShadowCardNumberpost
Customers and accounts
    Customers
      getAssetByShadowCardNumberpostgetCustomerDetailpostcreateCustomerpostupdateCustomerpost
    Account linking
      accountStatuspost
Transactions
    getCreditTransactionListpostgetPaymentAndCashadvanceInformationByCriteriaspostgetDebitTransactionAllpostgetAuthorizationListByBegindateEnddatepostgetDbttransactionByCardrefCustomernumpost
Limits and controls
    Card and customer limits
      changeCreditCardLimitDecreasepostchangeCreditCardLimitIncreasepostchangeCustomerLimitDecreasepostchangeCustomerLimitIncreasepost
    Operation limits
      getCustomerOperationLimitpostsetCustomerOperationLimitpostremoveCustomerOperationLimitpostsetCardOperationLimitpostgetCardOperationLimitpostremoveCardOperationLimitpost
    Permissions and restrictions
      getCardRestrictionpost
Billing and statements
    Collections and legal follow-up
      getCardDelinquencyInfoByCustomerNumberpostcreateFollowUpByMainCustomerNumberpostaddToLegalFollowUppost
    Debt payment
      getAutoPaymentQueuepost
    Statements and billing
      getDelinquencyInterestAmountpostsetStatementDocumentIdpostsetStatementDocumentOnlypostgetCardStatementCutoffReportpost
Security
    PIN and card security
      setCardPinViaSMSpostisSetCardPinViaSMSControlpostgetClearPanByShadowpostgetCardInfoByClearPanpostsetCreditCardPinpostverifyCreditCardPinpostgetEncryptDataBlockpostdecryptDataBlockpost
Disputes
    Disputes and chargebacks
      createDisputeCasepostcancelDisputeCasepostaddDocumentByCaseNumberpostgetDisputeListpostgetDisputeReasonDefListpost
Rewards
    Campaigns and rewards
      executeCampaignTransactionpostgetDebitCardForRewardByBankpost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getCardTypeByBinpostgetProductByShadowCardNumberpostgetAvailableCardStatusListpostgetEmbossReasonSubDefByValidFlagpostgetAvailableEmbossReasonListpostgetMccGroupAllpostgetTrnStatusAllpostgetBinDomesticByBinpostgetApplicableProductspostgetMccDefinitionGroupbyMccMccdescriptionpostgetNetworkTypeDefByValidFlagpostgetResponseCodeDefByValidFlagpostgetResponseReasonCodeDefByValidFlagpostgetTrnCodeDefByValidFlagpostgetTrnCodeMatrixByValidFlagpost
SchemasError codesChannels
powered by Zudoku
Ana Bankacılık Iletisim Servisi Ripper istikameti
Ana Bankacılık Iletisim Servisi Ripper istikameti

PIN and card security

Set and change a PIN, manage the try counter, and generate or verify the card verification values.


setCardPinViaSMS

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/setCardPinViaSMS

Attempts to set a card PIN via SMS by sending a notification through the notification service. Uses the provided channel, tenant ID, template code, customer number, recipient, and parameters to send the PIN information. Returns true if the SMS is sent successfully, otherwise false and logs the error.

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

setCardPinViaSMS › Request Body

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

mobilePhoneNumber
​string | null

Mobile Phone Number - [Optional]

cardNumberLastFourDigits
​string | null

Card Number Last Four Digits - [Optional]

clearPin
​string | null

Clear Pin - [Optional]

bankKey
​string | null

Bank Key - [Optional]

setCardPinViaSMS › Responses

Success

SetCardPinViaSMSResponse
success
​boolean · required

Success

errorCode
​integer · int32 · required

Error Code

customerNumber
​integer · int64 · required

Customer Number

errorText
​string | null

Error Text - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

POST/Integrationcorebanking/Indoor/api/setCardPinViaSMS
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/setCardPinViaSMS \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastFourDigits": "cardNumberLastFourDigits", "clearPin": "clearPin", "bankKey": "bankKey" }'
Example Request Body
{ "channel": "channel", "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastFourDigits": "cardNumberLastFourDigits", "clearPin": "clearPin", "bankKey": "bankKey" }
json
application/json
Example Responses
{ "success": true, "errorCode": 0, "errorText": "errorText", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber" }
json
application/json

isSetCardPinViaSMSControl

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/isSetCardPinViaSMSControl

Checks if a customer has any card eligible for PIN change via SMS and allows setting a new PIN for credit, debit, or prepaid cards. Validates mobile number, card last four digits, clear PIN, and bank key.

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

isSetCardPinViaSMSControl › Request Body

IsSetCardPinViaSMSControlRequest
mobilePhoneNumber
​string | null

Mobile Phone Number - [Optional]

cardNumberLastFourDigits
​string | null

Card Number Last Four Digits - [Optional]

isSetCardPinViaSMSControl › Responses

Success

IsSetCardPinViaSMSControlResponse
isHaveAnyCard
​boolean · required

Is Have Any Card

customerNumber
​integer · int64 · required

Customer Number

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

POST/Integrationcorebanking/Indoor/api/isSetCardPinViaSMSControl
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/isSetCardPinViaSMSControl \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastFourDigits": "cardNumberLastFourDigits" }'
Example Request Body
{ "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastFourDigits": "cardNumberLastFourDigits" }
json
application/json
Example Responses
{ "isHaveAnyCard": true, "customerNumber": 0, "shadowCardNumber": "shadowCardNumber" }
json
application/json

getClearPanByShadow

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getClearPanByShadow

Resolves the clear PAN (Primary Account Number) from a given shadow card number. Accepts GetClearPanByShadowRequest with ShadowCardNumber and returns GetClearPanByShadowResponse containing ClearPan. Internally calls _cisServiceProxy.GetCardInfoByShadowCardNumber(). Also provides GetCardInfoByClearPan which retrieves detailed card information by ClearPan, returning GetCardInfoByClearPanResponse with properties like Bin, CardRefNumber, ProductNumber, CardSeqNumber, CardType, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ShadowCardNumber, StatusCode, and StatusReasonCode.

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

getClearPanByShadow › Request Body

GetClearPanByShadowRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

getClearPanByShadow › Responses

Success

GetClearPanByShadowResponse
clearPan
​string | null

Clear Pan - [Optional]

POST/Integrationcorebanking/Indoor/api/getClearPanByShadow
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getClearPanByShadow \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
{ "clearPan": "clearPan" }
json
application/json

getCardInfoByClearPan

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getCardInfoByClearPan

Retrieves card information for a given clear PAN (primary account number). Accepts GetCardInfoByClearPanRequest with ClearPan. Returns GetCardInfoByClearPanResponse containing Bin, CardRefNumber, ProductNumber, CardSeqNumber, CardType, ClearPan, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ShadowCardNumber, StatusCode, and StatusReasonCode.

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

getCardInfoByClearPan › Request Body

GetCardInfoByClearPanRequest
clearPan
​string | null

Clear Pan - [Optional]

getCardInfoByClearPan › Responses

Success

GetCardInfoByClearPanResponse
customerNumber
​integer · int64 · required

Customer Number

expiryDate
​string · date-time · required

Expiry Date

mainCustomerNumber
​integer · int64 · required

Main Customer Number

hashCardNumber
​string | null

Hash Card Number - [Optional]

encryptedCardNumber
​string | null

Encrypted Card Number - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

bin
​string | null

Bin - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardSeqNumber
​string | null

Card Seq Number - [Optional]

statusCode
​string | null

Status Code - [Optional]

statusReasonCode
​string | null

Status Reason Code - [Optional]

clearPan
​string | null

Clear Pan - [Optional]

cardType
​string | null

Card Type - [Optional]

productNumber
​string | null

Product Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

maskedPanAlternative
​string | null

Masked Pan Alternative - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

ownerSearchName
​string | null

Owner Search Name - [Optional]

POST/Integrationcorebanking/Indoor/api/getCardInfoByClearPan
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getCardInfoByClearPan \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "clearPan": "clearPan" }'
Example Request Body
{ "clearPan": "clearPan" }
json
application/json
Example Responses
{ "hashCardNumber": "hashCardNumber", "encryptedCardNumber": "encryptedCardNumber", "maskedCardNumber": "maskedCardNumber", "customerNumber": 0, "bin": "bin", "shadowCardNumber": "shadowCardNumber", "expiryDate": "2024-08-25T15:00:00Z", "cardSeqNumber": "cardSeqNumber", "statusCode": "statusCode", "statusReasonCode": "statusReasonCode", "clearPan": "clearPan", "cardType": "cardType", "productNumber": "productNumber", "cardRefNumber": "cardRefNumber", "maskedPanAlternative": "maskedPanAlternative", "mainCardRefNumber": "mainCardRefNumber", "ownerSearchName": "ownerSearchName", "mainCustomerNumber": 0 }
json
application/json

setCreditCardPin

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/setCreditCardPin

Sets or verifies the PIN for a credit card. The SetCreditCardPin method first validates the card status of the customer and throws an exception if the card is in an invalid or problematic state. It then calls the credit PIN management service to set the PIN and returns the encrypted PIN and success flag. The VerifyCreditCardPin method verifies the provided PIN against the credit PIN management service and returns whether it is correct, along with remaining attempt counts and whether the try limit is exceeded.

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

setCreditCardPin › Request Body

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

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

clearPin
​string | null

Clear Pin - [Optional]

setCreditCardPin › Responses

Success

SetCardPinResponse
success
​boolean · required

Success

errorCode
​integer · int32 · required

Error Code

errorText
​string | null

Error Text - [Optional]

encryptedPin
​string | null

encrypted Pin - [Optional]

POST/Integrationcorebanking/Indoor/api/setCreditCardPin
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/setCreditCardPin \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "clearPin": "clearPin" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "clearPin": "clearPin" }
json
application/json
Example Responses
{ "success": true, "errorCode": 0, "errorText": "errorText", "encryptedPin": "encryptedPin" }
json
application/json

verifyCreditCardPin

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/verifyCreditCardPin

Verifies the PIN of a credit card. The method takes the shadow card number, clear PIN, and channel as input, calls the underlying credit PIN management service, and returns whether the PIN is verified along with the remaining try count and whether the maximum try count has been exceeded.

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

verifyCreditCardPin › Request Body

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

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

clearPin
​string | null

Clear Pin - [Optional]

verifyCreditCardPin › Responses

Success

VerifyCardPinResponse
verified
​boolean · required

Verified

lastTryCount
​integer · int32 · required

last Try Count

tryCountExceed
​boolean · required

try Count Exceed

errorText
​string | null

Error Text - [Optional]

POST/Integrationcorebanking/Indoor/api/verifyCreditCardPin
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/verifyCreditCardPin \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "clearPin": "clearPin" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "clearPin": "clearPin" }
json
application/json
Example Responses
{ "verified": true, "lastTryCount": 0, "tryCountExceed": true, "errorText": "errorText" }
json
application/json

getEncryptDataBlock

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getEncryptDataBlock

Encrypts a given data block using KMT service. Validates input DataBlock, retrieves encryption parameters from cache, calls _kmtServiceProxy.EncryptDataBlock() with KeyId, IV, and CBC mode, and returns GetEncryptDataBlockResponse containing EncryptedDataBlock.

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

getEncryptDataBlock › Request Body

GetEncryptDataBlockRequest
dataBlock
​string | null

Data Block - [Optional]

getEncryptDataBlock › Responses

Success

GetEncryptDataBlockResponse
encryptedDataBlock
​string | null

Encrypted Data Block - [Optional]

POST/Integrationcorebanking/Indoor/api/getEncryptDataBlock
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getEncryptDataBlock \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "dataBlock": "dataBlock" }'
Example Request Body
{ "dataBlock": "dataBlock" }
json
application/json
Example Responses
{ "encryptedDataBlock": "encryptedDataBlock" }
json
application/json

decryptDataBlock

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/decryptDataBlock

Decrypts an encrypted data block using KMT service. Validates that EncryptDataBlock is not null or empty, retrieves encryption parameters from cache, calls DecryptDataBlock on KMT proxy with KeyId, IV, and CBC mode, and returns the clear data block.

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

decryptDataBlock › Request Body

DecryptDataBlockRequest
encryptDataBlock
​string | null

Encrypt Data Block - [Optional]

decryptDataBlock › Responses

Success

DecryptDataBlockResponse
clearDataBlock
​string | null

Clear Data Block - [Optional]

POST/Integrationcorebanking/Indoor/api/decryptDataBlock
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/decryptDataBlock \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "encryptDataBlock": "encryptDataBlock" }'
Example Request Body
{ "encryptDataBlock": "encryptDataBlock" }
json
application/json
Example Responses
{ "clearDataBlock": "clearDataBlock" }
json
application/json

Statements and billingDisputes and chargebacks