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

The card being moved to another branch.

targetBranchCode
​integer · int32 · required

The branch the card is moved to. There is no current-branch field on this operation — the card's branch is read rather than asserted.

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/IntegrationDigitalChannelDebit/debit/api/changeCardBranch
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/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
/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
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/IntegrationDigitalChannelDebit/debit/api/changeCustomerBranch
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/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
/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
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/IntegrationDigitalChannelDebit/debit/api/transferBranchCustomer
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/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

getDebitCustomerLisfOfBranch

POST
https://sandboxpub.cms.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
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 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.

getDebitCustomerLisfOfBranch › Responses

Success

GetDebitCustomerListOfBranchResponse
customerOid
​array · optional
POST/IntegrationDigitalChannelDebit/debit/api/getDebitCustomerLisfOfBranch
curl https://sandboxpub.cms.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getDebitCustomerLisfOfBranch \ --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