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

Account linking

Attach and detach the accounts a card draws on, and read back what a card is currently linked to.


attachCardAccount

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

Provides methods to attach, deattach, and list card accounts for a customer. Includes operations for attaching an account to a card, removing it, recreating multiple accounts, and listing accounts by shadow card number or account number.

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

attachCardAccount › Request Body

AttachCardAccountRequest
fecCode
​integer · int32

Fec Code - [Optional]

accountBranchId
​integer · int32

Account Branch Id - [Optional]

accountType
​string | null

Account Type - [Optional]

accountSuffix
​integer · int32

Account Suffix - [Optional]

accountNumber
​integer · int64

Account Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

accountAlias
​string | null

Account Alias - [Optional]

iban
​string | null

Iban - [Optional]

accountOrderFlag
​boolean

Account Order Flag - [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

attachCardAccount › Responses

Success

AttachCardAccountResponse
recordId
​integer · int64 · required

Record Id

POST/IntegrationDigitalChannelCredit/credit/api/attachCardAccount
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/attachCardAccount \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "fecCode": 0, "accountBranchId": 0, "accountType": "accountType", "accountSuffix": 0, "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "accountAlias": "accountAlias", "iban": "iban", "accountOrderFlag": true, "channel": "002" }'
Example Request Body
{ "fecCode": 0, "accountBranchId": 0, "accountType": "accountType", "accountSuffix": 0, "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "accountAlias": "accountAlias", "iban": "iban", "accountOrderFlag": true, "channel": "002" }
json
application/json
Example Responses
{ "recordId": 0 }
json
application/json

detachCardAccount

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

Detach Card Account

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

detachCardAccount › Request Body

DetachCardAccountRequest
recordId
​integer · int64

Record Id

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
shadowCardNumber
​string | null

Shadow Card Number

detachCardAccount › Responses

Success

DetachCardAccountResponse
recordId
​integer · int64 · required

Record Id

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

detachCardAccountByAccountNumber

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

Detach Card Account By Account Number

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

detachCardAccountByAccountNumber › Request Body

DetachCardAccountByAccountNumberRequest
shadowCardNumber
​string | null

Shadow Card Number

accountNumber
​integer · int64

Account Number

accountSuffix
​integer · int32

Account Suffix

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

detachCardAccountByAccountNumber › Responses

Success

DetachCardAccountByAccountNumberResponse
POST/IntegrationDigitalChannelCredit/credit/api/detachCardAccountByAccountNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/detachCardAccountByAccountNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "accountNumber": 0, "accountSuffix": 0, "channel": "002" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "accountNumber": 0, "accountSuffix": 0, "channel": "002" }
json
application/json
Example Responses
{}
json
application/json

listCardAccountByAccountNumber

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

Retrieves a list of card accounts associated with a given account number. Uses the lifecycle service proxy to fetch all accounts and maps them to CardAccount objects including details such as account alias, branch, suffix, type, IBAN, currency, validity, and audit information.

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

listCardAccountByAccountNumber › Request Body

ListCardAccountByAccountNumberRequest
accountNumber
​integer · int64

Account Number - [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

listCardAccountByAccountNumber › Responses

Success

ListCardAccountByAccountNumberResponse
​array | null

List Of Account - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/listCardAccountByAccountNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/listCardAccountByAccountNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "accountNumber": 0, "channel": "002" }'
Example Request Body
{ "accountNumber": 0, "channel": "002" }
json
application/json
Example Responses
{ "listOfAccount": [ { "fecCode": 0, "accountBranchId": 0, "accountType": "accountType", "accountSuffix": 0, "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "recordId": 0, "accountAlias": "accountAlias", "validFlag": true, "updateUserId": "updateUserId", "updateDate": "2024-08-25T15:00:00Z", "insertTokenId": "insertTokenId", "insertUserId": "insertUserId", "insertDate": "2024-08-25T15:00:00Z", "updateTokenId": "updateTokenId", "iban": "iban", "accountOrderFlag": true, "currencyCode": "currencyCode" } ] }
json
application/json

listCardAccountByShadowCardNumber

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

Retrieves a list of card accounts associated with a given shadow card number. The method uses the lifecycle service proxy to fetch accounts and maps them to CardAccount objects, including details such as account alias, branch, suffix, type, IBAN, currency, validity, and audit information (insert/update user, token, and date).

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

listCardAccountByShadowCardNumber › Request Body

ListCardAccountByShadowCardNumberRequest
shadowCardNumber
​string | null

Shadow Card Number - [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

listCardAccountByShadowCardNumber › Responses

Success

ListCardAccountByShadowCardNumberResponse
​array | null

List Of Account - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/listCardAccountByShadowCardNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/listCardAccountByShadowCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "channel": "002" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "channel": "002" }
json
application/json
Example Responses
{ "listOfAccount": [ { "fecCode": 0, "accountBranchId": 0, "accountType": "accountType", "accountSuffix": 0, "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "recordId": 0, "accountAlias": "accountAlias", "validFlag": true, "updateUserId": "updateUserId", "updateDate": "2024-08-25T15:00:00Z", "insertTokenId": "insertTokenId", "insertUserId": "insertUserId", "insertDate": "2024-08-25T15:00:00Z", "updateTokenId": "updateTokenId", "iban": "iban", "accountOrderFlag": true, "currencyCode": "currencyCode" } ] }
json
application/json

recreateCustomerCardAccount

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

Recreates all card accounts for a customer's credit card. Accepts a list of card account details (account number, suffix, type, alias, branch, FEC code, IBAN, record ID, and currency code) and sets their ValidFlag to true. The service replaces existing accounts for the given ShadowCardNumber with the provided list through the lifecycle service.

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

recreateCustomerCardAccount › Request Body

RecreateCustomerCardAccountsRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

​array | null

Card Account List - [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

recreateCustomerCardAccount › Responses

Success

No data returned
POST/IntegrationDigitalChannelCredit/credit/api/recreateCustomerCardAccount
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/recreateCustomerCardAccount \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "cardAccountList": [ { "fecCode": 0, "accountBranchId": 0, "accountType": "accountType", "accountSuffix": 0, "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "recordId": 0, "accountAlias": "accountAlias", "validFlag": true, "updateUserId": "updateUserId", "updateDate": "2024-08-25T15:00:00Z", "insertTokenId": "insertTokenId", "insertUserId": "insertUserId", "insertDate": "2024-08-25T15:00:00Z", "updateTokenId": "updateTokenId", "iban": "iban", "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "channel": "002" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "cardAccountList": [ { "fecCode": 0, "accountBranchId": 0, "accountType": "accountType", "accountSuffix": 0, "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "recordId": 0, "accountAlias": "accountAlias", "validFlag": true, "updateUserId": "updateUserId", "updateDate": "2024-08-25T15:00:00Z", "insertTokenId": "insertTokenId", "insertUserId": "insertUserId", "insertDate": "2024-08-25T15:00:00Z", "updateTokenId": "updateTokenId", "iban": "iban", "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "channel": "002" }
json
application/json
Example Responses
No example specified for this content type

CustomersCash advance