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

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
/IntegrationDigitalChannelDebit/debit/api/createDisputeCase

Create Dispute 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

Channel

CardNumber
​string | null

Card Number

ShadowCardNumber
​string | null

Shadow Card Number

CardRefNumber
​string | null

Card Ref Number

EncryptedCardNumber
​string | null

Encrypted Card Number

CaseType
​string | null

Case Type

DisputeDate
​string · date-time

Dispute Date

DisputeReasonCode
​string | null

Dispute Reason Code

DisputeExplanation
​string | null

Dispute Explanation

ExternalCaseId
​string | null

External Case Id

SpecialFollowup
​string | null

Special Followup

VipFlag
​string | null

Vip Flag

​array | null

Create Dispute Case Detail

​array | null

Dms Reference

createDisputeCase › Responses

Success

CreateDisputeCaseResponse
CaseNumber
​integer · int64 · required

Case Number

​array | null

Dispute Transaction

POST/IntegrationDigitalChannelDebit/debit/api/createDisputeCase
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createDisputeCase \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "Channel": "Channel", "CardNumber": "CardNumber", "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "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": "Channel", "CardNumber": "CardNumber", "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "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

getDisputeList

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

Get Dispute List

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 | null · int64

Case Number

DisputeTransactionId
​integer | null · int64

Dispute Transaction Id

UTID
​string | null

U T I D

CustomerNumber
​integer | null · int64

Customer Number

CardNumber
​string | null

Card Number

ShadowCardNumber
​string | null

Shadow Card Number

CardRefNumber
​string | null

Card Ref Number

EncryptedCardNumber
​string | null

Encrypted Card Number

ExternalCaseId
​string | null

External Case Id

getDisputeList › Responses

Success

GetDisputeListResponse
​array | null

Dispute List

POST/IntegrationDigitalChannelDebit/debit/api/getDisputeList
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getDisputeList \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "CaseNumber": 0, "DisputeTransactionId": 0, "UTID": "UTID", "CustomerNumber": 0, "CardNumber": "CardNumber", "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "ExternalCaseId": "ExternalCaseId" }'
Example Request Body
{ "CaseNumber": 0, "DisputeTransactionId": 0, "UTID": "UTID", "CustomerNumber": 0, "CardNumber": "CardNumber", "ShadowCardNumber": "ShadowCardNumber", "CardRefNumber": "CardRefNumber", "EncryptedCardNumber": "EncryptedCardNumber", "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

addDocumentByCaseNumber

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

Add Document By Case Number

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

Channel

CaseNumber
​integer | null · int64

Case Number

ExternalCaseId
​string | null

External Case Id

ExternalDocumentId
​string | null

External Document Id

​array | null

Dms Reference

addDocumentByCaseNumber › Responses

Success

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

cancelDisputeCase

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

Cancel Dispute Case

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

Channel

CaseNumber
​integer | null · int64

Case Number

DisputeTransactionId
​integer | null · int64

Dispute Transaction Id

UTID
​string | null

U T I D

Description
​string | null

Description

cancelDisputeCase › Responses

Success

CancelDisputeCaseResponse
isSuccessful
​boolean · required

Is Successful

POST/IntegrationDigitalChannelDebit/debit/api/cancelDisputeCase
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/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

PIN and card securityPlatform operations