Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Common Methods
  • 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://sandboxpub.cms.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
channel
​string · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

shadowCardNumber
​string · maxLength: 19 · optional

The platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.

targetBranchCode
​integer · int32 · optional

The branch to move the card or customer to.

changeCardBranch › Responses

Success

ChangeCardBranchResponse
isSuccess
​boolean · required

Whether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.

oldBranch
​integer · int32 · required

The branch before the move.

newBranch
​integer · int32 · required

The branch after it.

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

changeCustomerBranch

POST
https://sandboxpub.cms.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
channel
​string · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

customerNumber
​integer · int64 · optional

The customer at the bank's core banking system, as a number. The platform stores it rather than issuing it, so it comes from the core.

targetBranchCode
​integer · int32 · optional

The branch to move the card or customer to.

changeCustomerBranch › Responses

Success

ChangeCustomerBranchResponse
oldBranch
​integer · int32 · required

The branch before the move.

newBranch
​integer · int32 · required

The branch after it.

changedCardCount
​integer · int32 · required

How many cards the operation changed.

listOfShadowCardNumbers
​array · optional

The cards the operation acted on.

POST/IntegrationDigitalChannelCredit/credit/api/changeCustomerBranch
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCustomerBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "customerNumber": 0, "targetBranchCode": 0 }'
Example Request Body
{ "channel": "channel", "customerNumber": 0, "targetBranchCode": 0 }
json
application/json
Example Responses
{ "oldBranch": 0, "newBranch": 0, "changedCardCount": 0, "listOfShadowCardNumbers": [ "string" ] }
json
application/json

transferBranchCustomer

POST
https://sandboxpub.cms.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
channel
​string · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

currentBranchCode
​integer · int32 · required

The branch the customers are moved from. Refused when it is the same as targetBranchCode — a transfer to the branch already held is an error here, not a no-op.

targetBranchCode
​integer · int32 · required

The branch the customers are moved to.

listOfPersonId
​integer[] · required

Which customers to move. Checked for presence, not for contents.

transferBranchCustomer › Responses

Success

TransferBranchCustomerResponse
oldBranch
​integer · int32 · required

The branch before the move.

newBranch
​integer · int32 · required

The branch after it.

changedCardCount
​integer · int32 · required

How many cards the operation changed.

listOfShadowCardNumbers
​array · optional

The cards the operation acted on.

POST/IntegrationDigitalChannelCredit/credit/api/transferBranchCustomer
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/transferBranchCustomer \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "currentBranchCode": 0, "targetBranchCode": 0, "listOfPersonId": [ 0 ] }'
Example Request Body
{ "channel": "channel", "currentBranchCode": 0, "targetBranchCode": 0, "listOfPersonId": [ 0 ] }
json
application/json
Example Responses
{ "oldBranch": 0, "newBranch": 0, "changedCardCount": 0, "listOfShadowCardNumbers": [ "string" ] }
json
application/json

getCreditCustomerListOfBranch

POST
https://sandboxpub.cms.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
channel
​string · maxLength: 3 · required

Three-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.

branchCode
​integer · int32 · optional

Required in practice — Branch whose customers are listed. Not validated — the facade's null check on it cannot fail, because the field is a bare int, so an omitted value arrives as zero, matches no branch and comes back as an empty list rather than a refusal.

getCreditCustomerListOfBranch › Responses

Success

GetCreditCustomerListOfBranchResponse
customerOid
​array · optional
POST/IntegrationDigitalChannelCredit/credit/api/getCreditCustomerListOfBranch
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCustomerListOfBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --header 'Authorization: Bearer <access_token>' \ --data '{ "channel": "channel", "branchCode": 0 }'
Example Request Body
{ "channel": "channel", "branchCode": 0 }
json
application/json
Example Responses
{ "customerOid": [ 0 ] }
json
application/json

No-name cardsCustomers