Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      getCreditApplicationIdByFromShadowCardNumberpostsubmitCardApplicationExtStatuspost
    Card issuance and personalisation
      createIndividualCardpostcreateIndividualSupplementaryCardpostcreateDummyCorporateCardpostcreateCorporateCardpostcreateVirtualCardpostgetApplicableProductsByCustomerNumberpostgetApplicableProductsByMainCustomerPreControlpostcreateNoNameCardpostcancelCardEmbossByShadowCardNumberpostgetPendingCardEmbossListpost
    Card lifecycle
      getCardListpostreplaceCardpostgetCardMemopostchangeCardStatuspostchangeCustomerCreditCardStatuspostchangeAndReplaceCardpostgetRenewCountByShadowCardNumberpostgetCreditCardInfopostgetCustomerCreditCardListByTenantIdpostgetCustomerCreditShadowCardsByTenantIdpostgetCustomerCreditCardListByTenantIdProductNumberpostgetCardListNewpost
    No-name cards
      activateNoNameCardpostreplaceNoNameCardpostreplaceCardUsingNoNameApplicationpostchangeAndReplaceNoNameCardpostcancelNoNameCardApplicationpost
Customers and accounts
    Branch management
      changeCardBranchpostchangeCustomerBranchposttransferBranchCustomerpostgetCreditCustomerListOfBranchpost
    Customers
      getCorporateCustomerInfoByIndividualCustomerpostgetCustomerAssetsSummaryCreditpost
    Account linking
      attachCardAccountpostdetachCardAccountpostdetachCardAccountByAccountNumberpostlistCardAccountByAccountNumberpostlistCardAccountByShadowCardNumberpostrecreateCustomerCardAccountpost
Transactions
    doPaymentTransactionpostreversePaymentTransactionpostdoPaymentFeeInquirypostgetCustomerTransactionDetailpostgetCardIntermTransactionInfopostgetPendingProvisionListpostgetCreditCardTransactionAllpostgetCreditCardCurrentTransactionListpostgetTransactionAllpostgetPendingProvisionListNewpostgetDigitalSlipReceiptpost
    Cash advance
      getCashAdvanceInfopostdoCashAdvancepostreverseCashAdvancepostgetCancelableCashAdvanceListpost
Limits and controls
    Card and customer limits
      changeCardLimitDecreasepostchangeCardLimitIncreasepostchangeCardLimitReversepostresetCardLimitpostchangeCardAutoLimitIncreasepostgetCustomerTotalLimitInfopostgetCreditCardLimitpostgetCardAvailableLimitpostgetCustomerAvailableLimitpostchangeCorporateCardLimitDecreasepostchangeCorporateCardLimitIncreasepostchangeIndividualCardLimitpostdecreaseCustomerLimitpostchangeVirtualCardLimitpost
    Operation limits
      getCardOperationLimitpostsetCardOperationLimitpostremoveCardOperationLimitpostgetCardLimitationParameterDatapostgetCustomerOperationLimitpostsetCustomerOperationLimitpostremoveCustomerOperationLimitpostgetCustomerLimitationParameterDatapost
    Permissions and restrictions
      getCardPermissionspostsaveCardPermissionspostchangeCardMiscOptionpostgetCardMiscOptionpost
Instalments
    getEarlyCloseCandidateListpostdoEarlyClosepostgetInstallmentCountsByUtidpostgetCashInstallmentParameterpostsimulateCashInstallmentForAllpostsimulateCashInstallmentpostdoCashInstallmentpostreverseCashInstallmentpostgetCancelableCashInstallmentListpostgetEarlyReleaseCashInstallmentspostgetEarlyReleaseCashInstallmentpostdoCashInstallmentEarlyReleasePaymentpostcancelCashInstallEarlyReleasePaymentpostgetAllWaitingInstallmentspostgetWaitingInstallmentDetailpostgetWaitingInstallmentSummarypostmanuelInstallmentOrderpostmanuelInstallmentOrderSimulatepostgetInstallmentCountsByUtidNewpostcancelInstallmentEarlyReleasepostgetManuelInstallmentCancelRecordsByCardRefNumberpostgetEarlyReleaseAvailableInstallmentsByCriteriaspostsimulateInstallmentEarlyReleasepostreleasePendingInstallmentpostcancelInstallmentTransactionOrderpost
Billing and statements
    Collections and legal follow-up
      getCardDelinquencyInfoByCustomerNumberpostgetCreditCardCollectionInfoByCardRefNumberpostgetCreditCardCollectionInfoByMainCustomerNumberpostgetCreditCardCollectionTransactionListByDatepostgetCreditCardPortfolioSummarypost
    Debt payment
      checkCreditCardForDebtPaymentpostdoCreditCardDebtPaymentpostcancelCreditCardDebtPaymentpostgetCancelableCreditCardDebtPaymentListpostsaveCreditCardAutoPaymentOrderpostgetCreditCardAutoPaymentOrderpost
    Statements and billing
      getCardStatementSummarypostgetCardStatementDetailpostgetCreditCardStatementSendPreferencepostgetCardStatementListpostgetCreditCardLastStatementpostgetCreditCardLastStatementNewpostgetCardStatementDetailSummarypostgetCardStatementDetailSummaryNewpostchangeCreditCardStatementPeriodpostgetStatementPeriodChangeCountpostgetCalculatedStatementPeriodpostgetStatementPeriodByProductNumberpostchangeCreditCardStatementSendPreferencepostgetCardStatementAddressInformationpostgetCardFinancialInfoByCardRefNumberpostgetStatementPeriodChangeInfopost
Security
    PIN and card security
      setCardPinpostchangeCardPinpostverifyCardPinpostverifyRsaPinpostverifyRsaPinWithStaticSaltpostsetRsaPinpostincreasePinTryCountpostchangeRsaPinpostverifyCardVerificationValuepostgenerateCardVVpostverifyPartialCardVerificationValuepostresetCvvCounterpost
Disputes
    Disputes and chargebacks
      createDisputeCasepostcancelDisputeCasepostaddDocumentByCaseNumberpostgetDisputeListpostgetDisputeReasonDefListpost
Rewards
    Campaigns and rewards
      getCreditCardDateRangeForRewardByCustomerNumberReqSourcepost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getAvailableCardStatusListpost
SchemasError codesChannels
powered by Zudoku
Credit Digital Channels Integration
Credit Digital Channels Integration

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
/IntegrationDigitalChannelCredit/credit/api/createDisputeCase

Creates a new dispute case for a credit card transaction. Supports multiple dispute case details and DMS references. Returns the case number and related dispute transaction details.

Part of:

  • Journey 02 · Managing a card product — step 1, Open and evidence a case

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
Channel
​string | null

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

Example: 002
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]

DisputeDate
​string · date-time

Dispute Date - [Optional]

DisputeReasonCode
​string | null

Dispute Reason Code - [Optional]

DisputeExplanation
​string | null

Dispute Explanation - [Optional]

ExternalCaseId
​string | null

External Case Id

SpecialFollowup
​string | null

Special Followup

VipFlag
​string | null

Vip Flag

​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/IntegrationDigitalChannelCredit/credit/api/createDisputeCase
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createDisputeCase \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "Channel": "002", "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "CardNumber": "CardNumber", "CaseType": "CaseType", "DisputeDate": "2024-08-25T15:00:00Z", "DisputeReasonCode": "DisputeReasonCode", "DisputeExplanation": "DisputeExplanation", "ExternalCaseId": "ExternalCaseId", "SpecialFollowup": "SpecialFollowup", "VipFlag": "VipFlag", "CreateDisputeCaseDetail": [ { "UTID": "UTID", "CurrencyCode": "CurrencyCode", "DisputeAmountCurrencyCode": "DisputeAmountCurrencyCode", "DisputeAmount": 0, "ClearingChannel": "ClearingChannel", "ClearingTableName": "ClearingTableName", "ClearingNumber": 0, "AcquirerRefNumber": "AcquirerRefNumber", "ExternalCaseId": "ExternalCaseId", "ExternalDocumentId": "ExternalDocumentId", "SpecialFollowup": "SpecialFollowup", "VipFlag": "VipFlag", "DmsReference": [ { "DmsReferenceId": "DmsReferenceId" } ] } ], "DmsReference": [ { "DmsReferenceId": "DmsReferenceId" } ] }'
Example Request Body
{ "Channel": "002", "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "CardNumber": "CardNumber", "CaseType": "CaseType", "DisputeDate": "2024-08-25T15:00:00Z", "DisputeReasonCode": "DisputeReasonCode", "DisputeExplanation": "DisputeExplanation", "ExternalCaseId": "ExternalCaseId", "SpecialFollowup": "SpecialFollowup", "VipFlag": "VipFlag", "CreateDisputeCaseDetail": [ { "UTID": "UTID", "CurrencyCode": "CurrencyCode", "DisputeAmountCurrencyCode": "DisputeAmountCurrencyCode", "DisputeAmount": 0, "ClearingChannel": "ClearingChannel", "ClearingTableName": "ClearingTableName", "ClearingNumber": 0, "AcquirerRefNumber": "AcquirerRefNumber", "ExternalCaseId": "ExternalCaseId", "ExternalDocumentId": "ExternalDocumentId", "SpecialFollowup": "SpecialFollowup", "VipFlag": "VipFlag", "DmsReference": [ { "DmsReferenceId": "DmsReferenceId" } ] } ], "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
/IntegrationDigitalChannelCredit/credit/api/cancelDisputeCase

Cancels a dispute case by calling the BKM batch service with case number, channel, description, dispute transaction ID, and UTID. Returns a response indicating whether the cancellation was successful.

Part of:

  • Journey 02 · Managing a card product — step 2, Track and manage

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
Channel
​string | null

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

Example: 002
CaseNumber
​integer · int32

Case Number - [Optional]

DisputeTransactionId
​integer · int64

Dispute Transaction Id - [Optional]

UTID
​string | null

U T I D - [Optional]

Description
​string | null

Description - [Optional]

cancelDisputeCase › Responses

Success

CancelDisputeCaseResponse
isSuccessful
​boolean · required

Is Successful

POST/IntegrationDigitalChannelCredit/credit/api/cancelDisputeCase
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/cancelDisputeCase \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "Channel": "002", "CaseNumber": 0, "DisputeTransactionId": 0, "UTID": "UTID", "Description": "Description" }'
Example Request Body
{ "Channel": "002", "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
/IntegrationDigitalChannelCredit/credit/api/addDocumentByCaseNumber

Adds one or more document references to a case number in the BKM batch system. It requires the channel, case number, and a list of DMS references.

Part of:

  • Journey 02 · Managing a card product — step 1, Open and evidence a 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
Channel
​string | null

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

Example: 002
CaseNumber
​integer · int32

Case Number - [Optional]

ExternalCaseId
​string | null

External Case Id

ExternalDocumentId
​string | null

External Document Id

​array | null

Dms References - [Optional]

addDocumentByCaseNumber › Responses

Success

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

getDisputeList

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelCredit/credit/api/getDisputeList

Retrieves a list of dispute transactions for a given card or customer. Filters can be applied by card number, card reference number, case number, customer number, dispute transaction ID, shadow card number, encrypted card number, or UTID. Returns detailed information for each dispute including case number, dispute transaction ID, dispute amount and currency, dispute date and reason code, transaction details (amount, currency, date, status, authorization number, MCC, merchant name), source network, and associated customer/card information.

Part of:

  • Journey 02 · Managing a card product — step 2, Track and manage

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

Case Number - [Optional]

DisputeTransactionId
​integer · int64

Dispute Transaction Id - [Optional]

UTID
​string | null

U T I D - [Optional]

CustomerNumber
​integer · int64

Customer Number - [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]

ExternalCaseId
​string | null

External Case Id

getDisputeList › Responses

Success

GetDisputeListResponse
​array | null

Dispute List - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getDisputeList
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/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", "ExternalCaseId": "ExternalCaseId" }'
Example Request Body
{ "CaseNumber": 0, "DisputeTransactionId": 0, "UTID": "UTID", "CustomerNumber": 0, "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "CardNumber": "CardNumber", "ExternalCaseId": "ExternalCaseId" }
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", "ShadowCardNumber": "ShadowCardNumber", "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
/IntegrationDigitalChannelCredit/credit/api/getDisputeReasonDefList

Retrieves a list of all dispute reason definitions in the system. Each item includes the dispute reason code and its corresponding description. No input parameters are required.

Part of:

  • Journey 02 · Managing a card product — step 1, Open and evidence a case

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/IntegrationDigitalChannelCredit/credit/api/getDisputeReasonDefList
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/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