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

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

Provides methods to change the branch associated with a card or customer. Includes ChangeCardBranch to update a card's branch, ChangeCustomerBranch to update all cards of a customer, and TransferBranchCustomer to transfer multiple customers from one branch to another. Validates requests and returns success status, old/new branch codes, changed card count, and affected shadow card numbers.

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 (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

changeCardBranch › Responses

Success

ChangeCardBranchResponse
isSuccess
​boolean · required

Is Success

oldBranch
​integer · int32 · required

Old Branch

newBranch
​integer · int32 · required

New Branch

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

changeCustomerBranch

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

Changes the branch assignment of a customer or their cards. Provides methods to change a single card's branch, change all cards for a customer, or transfer multiple customers from one branch to another. Validates input and returns details including old and new branch codes and affected card counts.

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 (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

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/IntegrationDigitalChannelCredit/credit/api/changeCustomerBranch
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCustomerBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "customerNumber": 0, "targetBranchCode": 0, "channel": "002" }'
Example Request Body
{ "customerNumber": 0, "targetBranchCode": 0, "channel": "002" }
json
application/json
Example Responses
{ "oldBranch": 0, "newBranch": 0, "changedCardCount": 0, "listOfShadowCardNumbers": [ "string" ] }
json
application/json

transferBranchCustomer

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

Transfers the customer to a new branch, including associated card details, and returns information about the transfer process.

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

TransferBranchCustomerRequest
currentBranchCode
​integer · int32

Current Branch Code - [Optional]

targetBranchCode
​integer · int32

Target Branch Code - [Optional]

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
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/IntegrationDigitalChannelCredit/credit/api/transferBranchCustomer
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/transferBranchCustomer \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "currentBranchCode": 0, "targetBranchCode": 0, "channel": "002", "listOfPersonId": [ 0 ] }'
Example Request Body
{ "currentBranchCode": 0, "targetBranchCode": 0, "channel": "002", "listOfPersonId": [ 0 ] }
json
application/json
Example Responses
{ "oldBranch": 0, "newBranch": 0, "changedCardCount": 0, "listOfShadowCardNumbers": [ "string" ] }
json
application/json

getCreditCustomerListOfBranch

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

Retrieves the list of credit customers associated with a given branch using BranchCode and channel. Validates request parameters, calls the lifecycle service to fetch customer identifiers, and returns a list of customer OIDs for the specified branch.

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

getCreditCustomerListOfBranch › Request Body

GetCreditCustomerLisfOfBranchRequest
branchCode
​integer · int32

Branch Code - [Optional]

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

getCreditCustomerListOfBranch › Responses

Success

GetCreditCustomerListOfBranchResponse
customerOid
​array | null

Customer Oid - [Optional]

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

No-name cardsCustomers