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

Branch management

Move a customer or a card between branches, and read the cards a branch holds.


changeCardBranch

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

Changes the branch of a debit card or customer accounts, including transferring multiple customers between branches. Returns old and new branch information and affected card counts.

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

changeCardBranch › Request Body

ChangeCardBranchRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

targetBranchCode
​integer · int32

Target Branch Code - [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.

changeCardBranch › Responses

Success

ChangeCardBranchResponse
isSuccess
​boolean · required

Is Success

oldBranch
​integer · int32 · required

Old Branch

newBranch
​integer · int32 · required

New Branch

POST/IntegrationDigitalChannelDebit/debit/api/changeCardBranch
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/changeCardBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "targetBranchCode": 0, "channel": "channel" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "targetBranchCode": 0, "channel": "channel" }
json
application/json
Example Responses
{ "isSuccess": true, "oldBranch": 0, "newBranch": 0 }
json
application/json

changeCustomerBranch

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

Changes the branch for a customer and updates all associated cards. Returns the number of changed cards, list of shadow card numbers, old branch, and new branch.

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

changeCustomerBranch › Request Body

ChangeCustomerBranchRequest
customerNumber
​integer · int64

Customer Number - [Optional]

targetBranchCode
​integer · int32

Target Branch Code - [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.

changeCustomerBranch › Responses

Success

ChangeCustomerBranchResponse
oldBranch
​integer · int32 · required

Old Branch

newBranch
​integer · int32 · required

New Branch

changedCardCount
​integer · int32 · required

Changed Card Count

listOfShadowCardNumbers
​array | null

List Of Shadow Card Numbers - [Optional]

POST/IntegrationDigitalChannelDebit/debit/api/changeCustomerBranch
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/changeCustomerBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "customerNumber": 0, "targetBranchCode": 0, "channel": "channel" }'
Example Request Body
{ "customerNumber": 0, "targetBranchCode": 0, "channel": "channel" }
json
application/json
Example Responses
{ "oldBranch": 0, "newBranch": 0, "changedCardCount": 0, "listOfShadowCardNumbers": [ "string" ] }
json
application/json

transferBranchCustomer

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

Transfers a customer to a different branch. Updates the branch assignment for a customer in the debit channel system.

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

transferBranchCustomer › Request Body

TransferBranchCustomer
currentBranchCode
​integer · int32

Current Branch Code - [Optional]

targetBranchCode
​integer · int32

Target Branch Code - [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.

listOfPersonId
​array | null

List Of Person Id - [Optional]

transferBranchCustomer › Responses

Success

TransferBranchCustomerResponse
oldBranch
​integer · int32 · required

Old Branch

newBranch
​integer · int32 · required

New Branch

changedCardCount
​integer · int32 · required

Changed Card Count

listOfShadowCardNumbers
​array | null

List Of Shadow Card Numbers - [Optional]

POST/IntegrationDigitalChannelDebit/debit/api/transferBranchCustomer
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/transferBranchCustomer \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "currentBranchCode": 0, "targetBranchCode": 0, "channel": "channel", "listOfPersonId": [ 0 ] }'
Example Request Body
{ "currentBranchCode": 0, "targetBranchCode": 0, "channel": "channel", "listOfPersonId": [ 0 ] }
json
application/json
Example Responses
{ "oldBranch": 0, "newBranch": 0, "changedCardCount": 0, "listOfShadowCardNumbers": [ "string" ] }
json
application/json

getDebitCustomerLisfOfBranch

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

Retrieves the list of debit customers for a given branch. Uses channel information and branch code to return customer OID list.

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

getDebitCustomerLisfOfBranch › Request Body

GetDebitCustomerLisfOfBranchRequest
branchCode
​integer · int32

Branch Code - [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.

getDebitCustomerLisfOfBranch › Responses

Success

GetDebitCustomerListOfBranchResponse
customerOid
​array | null

Customer Oid - [Optional]

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

No-name cardsCustomers