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

Disputes and chargebacks

Open a dispute against a transaction, attach the evidence, and cancel a case that should not have been raised.


createDisputeCase

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

Creates a dispute case for a card using provided card info, case type, dispute date, reason, and explanation. Maps optional dispute case details (UTID, currency, amount) and DMS references. Calls _bkmBatchService.CreateDisputeCase and returns CaseNumber and list of DisputeTransaction details including DisputeTransactionId and UTID.

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

createDisputeCase › Request Body

CreateDisputeCaseRequest
DisputeDate
​string · date-time · required

Dispute Date

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]

CardRefNumber
​string | null

Card Ref Number - [Optional]

EncryptedCardNumber
​string | null

Encrypted Card Number - [Optional]

CardNumber
​string | null

Card Number - [Optional]

CaseType
​string | null

Case Type - [Optional]

DisputeReasonCode
​string | null

Dispute Reason Code - [Optional]

DisputeExplanation
​string | null

Dispute Explanation - [Optional]

​array | null

Create Dispute Case Detail - [Optional]

​array | null

Dms Reference - [Optional]

createDisputeCase › Responses

Success

CreateDisputeCaseResponse
CaseNumber
​integer · int32 · required

Case Number

​array | null

Dispute Transaction - [Optional]

POST/Integrationcorebanking/Indoor/api/createDisputeCase
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/createDisputeCase \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "Channel": "Channel", "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "CardNumber": "CardNumber", "CaseType": "CaseType", "DisputeDate": "2024-08-25T15:00:00Z", "DisputeReasonCode": "DisputeReasonCode", "DisputeExplanation": "DisputeExplanation", "CreateDisputeCaseDetail": [ { "UTID": "UTID", "CurrencyCode": "CurrencyCode", "DisputeAmount": 0 } ], "DmsReference": [ { "DmsReferenceId": "DmsReferenceId" } ] }'
Example Request Body
{ "Channel": "Channel", "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "CardNumber": "CardNumber", "CaseType": "CaseType", "DisputeDate": "2024-08-25T15:00:00Z", "DisputeReasonCode": "DisputeReasonCode", "DisputeExplanation": "DisputeExplanation", "CreateDisputeCaseDetail": [ { "UTID": "UTID", "CurrencyCode": "CurrencyCode", "DisputeAmount": 0 } ], "DmsReference": [ { "DmsReferenceId": "DmsReferenceId" } ] }
json
application/json
Example Responses
{ "CaseNumber": 0, "DisputeTransaction": [ { "UTID": "UTID", "DisputeTransactionId": 0 } ] }
json
application/json

cancelDisputeCase

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

Cancels a dispute case by calling the internal BKM batch service with CaseNumber, Channel, DisputeTransactionId, UTID, and Description. Returns a response indicating whether the cancellation was successful.

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

cancelDisputeCase › Request Body

CancelDisputeCaseRequest
CaseNumber
​integer · int32 · required

Case Number

DisputeTransactionId
​integer · int64 · required

Dispute Transaction Id

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.

UTID
​string | null

U T I D - [Optional]

Description
​string | null

Description - [Optional]

cancelDisputeCase › Responses

Success

CancelDisputeCaseResponse
isSuccessful
​boolean · required

Is Successful

POST/Integrationcorebanking/Indoor/api/cancelDisputeCase
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/cancelDisputeCase \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "Channel": "Channel", "CaseNumber": 0, "DisputeTransactionId": 0, "UTID": "UTID", "Description": "Description" }'
Example Request Body
{ "Channel": "Channel", "CaseNumber": 0, "DisputeTransactionId": 0, "UTID": "UTID", "Description": "Description" }
json
application/json
Example Responses
{ "isSuccessful": true }
json
application/json

addDocumentByCaseNumber

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

Adds one or more document references to an existing case in the core banking system using the provided case number. The service accepts channel information, case number, and a list of DMS document references, and forwards them to the BKM batch service for processing. This operation performs a state-changing action by attaching documents to the specified case.

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

addDocumentByCaseNumber › Request Body

AddDocumentByCaseNumberRequest
CaseNumber
​integer · int32 · required

Case Number

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.

​array | null

Dms References - [Optional]

addDocumentByCaseNumber › Responses

Success

No data returned
POST/Integrationcorebanking/Indoor/api/addDocumentByCaseNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/addDocumentByCaseNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "Channel": "Channel", "CaseNumber": 0, "DmsReference": [ { "DmsReferenceId": "DmsReferenceId" } ] }'
Example Request Body
{ "Channel": "Channel", "CaseNumber": 0, "DmsReference": [ { "DmsReferenceId": "DmsReferenceId" } ] }
json
application/json
Example Responses
No example specified for this content type

getDisputeList

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

Retrieves the list of dispute transactions. Accepts GetDisputeListRequest with parameters such as CardNumber, CardRefNumber, CaseNumber, CustomerNumber, DisputeTransactionId, EncryptedCardNumber, ShadowCardNumber, and UTID. Calls _bkmBatchService.GetDisputeList() and maps results to GetDisputeListResponse containing DisputeList with properties like CaseNumber, DisputeTransactionId, CustomerNumber, DisputeAmount, DisputeCurrencyCode, DisputeDate, DisputeReasonCode, MaskedCardNumber, MerchantName, TrnAmount, InsertUserId, TrnCurrencyCode, TrnDate, TrnStatusDescription, AuthorizationNumber, Mcc, SourceNetwork, and Utid.

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

getDisputeList › Request Body

GetDisputeListRequest
CaseNumber
​integer · int32 · required

Case Number

DisputeTransactionId
​integer · int64 · required

Dispute Transaction Id

CustomerNumber
​integer · int64 · required

Customer Number

UTID
​string | null

U T I D - [Optional]

ShadowCardNumber
​string | null

Shadow Card Number - [Optional]

CardRefNumber
​string | null

Card Ref Number - [Optional]

EncryptedCardNumber
​string | null

Encrypted Card Number - [Optional]

CardNumber
​string | null

Card Number - [Optional]

getDisputeList › Responses

Success

GetDisputeListResponse
​array | null

Dispute List - [Optional]

POST/Integrationcorebanking/Indoor/api/getDisputeList
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getDisputeList \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "CaseNumber": 0, "DisputeTransactionId": 0, "UTID": "UTID", "CustomerNumber": 0, "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "CardNumber": "CardNumber" }'
Example Request Body
{ "CaseNumber": 0, "DisputeTransactionId": 0, "UTID": "UTID", "CustomerNumber": 0, "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "CardNumber": "CardNumber" }
json
application/json
Example Responses
{ "DisputeTransaction": [ { "CaseNumber": 0, "CustomerNumber": 0, "DisputeAmount": 0, "DisputeCurrencyCode": "DisputeCurrencyCode", "DisputeDate": "2024-08-25T15:00:00Z", "DisputeReasonCode": "DisputeReasonCode", "DisputeTransactionId": 0, "InsertUserId": "InsertUserId", "MaskedCardNumber": "MaskedCardNumber", "MerchantName": "MerchantName", "TrnAmount": 0, "TrnCurrencyCode": "TrnCurrencyCode", "TrnDate": "2024-08-25T15:00:00Z", "TrnStatusDescription": "TrnStatusDescription", "AuthorizationNumber": "AuthorizationNumber", "Mcc": "Mcc", "SourceNetwork": "SourceNetwork", "Utid": "Utid" } ] }
json
application/json

getDisputeReasonDefList

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

Retrieves the list of dispute reason definitions. Calls _bkmBatchService.GetDisputeReasonDefList() and maps results to GetDisputeReasonDefResponse containing DisputeReasonDefinitions with properties DisputeReasonCode and DisputeReasonDescription.

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

getDisputeReasonDefList › Responses

Success

GetDisputeReasonDefResponse
​array | null

Dispute Reason Definitions - [Optional]

POST/Integrationcorebanking/Indoor/api/getDisputeReasonDefList
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getDisputeReasonDefList \ --request POST \ --header 'evrst-ptrnid: x_request_id'
Example Responses
{ "DisputeReasonDefinitions": [ { "DisputeReasonCode": 0, "DisputeReasonDescription": "DisputeReasonDescription" } ] }
json
application/json

PIN and card securityCampaigns and rewards