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

Collections and legal follow-up

Follow up arrears — delinquency state, collection detail and the legal process behind an unpaid balance.


getCardDelinquencyInfoByCustomerNumber

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

Retrieves the delinquency information for a customer, including digital card limit, overall customer limit, delinquency days, period, status, deficient payment counter, statement remaining amount, and day counts after limit changes.

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

getCardDelinquencyInfoByCustomerNumber › Request Body

GetCardDelinquencyInfoByCustomerNumberRequest
mainCustomerNumber
​integer · int64

Main Customer Number - [Optional]

getCardDelinquencyInfoByCustomerNumber › Responses

Success

GetCardDelinquencyInfoByCustomerNumberResponse
digitalCardLimit
​number · double · required

Digital Card Limit

customerLimit
​number · double · required

Customer Limit

delinquencyDayCount
​integer · int32 · required

Delinquency Day Count

statementRemainAmount
​number · double · required

Statement Remain Amount

delinquencyPeriod
​integer · int32 · required

Delinquency Period

newDeficientPaymentCounter
​integer · int32 · required

New Deficient Payment Counter

dayCoutAfterLimitIncrease
​integer · int32 · required

Day Cout After Limit Increase

dayCoutAfterLimitDecrease
​integer · int32 · required

Day Cout After Limit Decrease

delinquencyStatus
​string | null

Delinquency Status - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCardDelinquencyInfoByCustomerNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardDelinquencyInfoByCustomerNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "mainCustomerNumber": 0 }'
Example Request Body
{ "mainCustomerNumber": 0 }
json
application/json
Example Responses
{ "digitalCardLimit": 0, "customerLimit": 0, "delinquencyStatus": "delinquencyStatus", "delinquencyDayCount": 0, "statementRemainAmount": 0, "delinquencyPeriod": 0, "newDeficientPaymentCounter": 0, "dayCoutAfterLimitIncrease": 0, "dayCoutAfterLimitDecrease": 0 }
json
application/json

getCreditCardCollectionInfoByCardRefNumber

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

Retrieves collection-related information for a credit card using its MainCardRefNumber. Validates the card and customer existence, fetches delinquency information, and returns details including delinquency days, limit, and remaining statement amount.

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

getCreditCardCollectionInfoByCardRefNumber › Request Body

GetCreditCardCollectionInfoByCardRefNumberRequest
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
mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

getCreditCardCollectionInfoByCardRefNumber › Responses

Success

GetCreditCardCollectionInfoByCardRefNumberResponse
​array | null

List Of Cards - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardCollectionInfoByCardRefNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardCollectionInfoByCardRefNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "002", "mainCardRefNumber": "mainCardRefNumber" }'
Example Request Body
{ "channel": "002", "mainCardRefNumber": "mainCardRefNumber" }
json
application/json
Example Responses
{ "listOfCards": [ { "branchCode": "branchCode", "branchName": "branchName", "productNumber": "productNumber", "productSegment": "productSegment", "productName": "productName", "subProductType": "subProductType", "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "delayDayCount": 0, "lastStatementMinAmount": 0, "guarantor": "guarantor", "lastPaymentAmount": 0, "lastPaymentDate": "2024-08-25T15:00:00Z", "statementDate": "2024-08-25T15:00:00Z", "totalDebit": 0, "statementTotalAmount": 0, "statementCurrencyCode": "statementCurrencyCode", "remainingMinimumPaymentAmount": 0, "statementDueDate": "2024-08-25T15:00:00Z", "totalAmount": 0, "totalAmountForCreditTransactions": 0, "totalAmountForDebitTransactions": 0, "customerLimit": 0, "cardOpeningDate": "2024-08-25T15:00:00Z", "transferedCardNumberText": "transferedCardNumberText", "cardStatusDescription": "cardStatusDescription", "delinquencyStatus": "delinquencyStatus", "statementRemainAmount": 0, "cardLimit": 0, "cardAvailableLimit": 0, "nextStatementDate": "2024-08-25T15:00:00Z", "minimumPaymentAmount": 0, "supplementaryCardFlag": true, "currentCardFlag": true, "hasCardAutoPayment": true, "autoPaymentAccountNumber": 0, "customerNumber": 0, "remainingDebt": 0, "delinquencyStartDate": "2024-08-25T15:00:00Z", "reconstructAmount": 0 } ] }
json
application/json

getCreditCardCollectionInfoByMainCustomerNumber

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

Retrieves collection-related information for all credit cards of a customer using their MainCustomerNumber. Validates the customer and card existence, fetches delinquency info, pending provisions, statement details, transaction amounts, and card limits. Returns a detailed list of CreditCardCollectionInfo for each main card, including debt, limits, delinquency, statement info, and auto-payment data.

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

getCreditCardCollectionInfoByMainCustomerNumber › Request Body

GetCreditCardCollectionInfoByMainCustomerNumberRequest
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
mainCustomerNumber
​integer · int64

Main Customer Number - [Optional]

branchCode
​string | null

Branch Code - [Optional]

getCreditCardCollectionInfoByMainCustomerNumber › Responses

Success

GetCreditCardCollectionInfoByMainCustomerNumberResponse
​array | null

List Of Cards - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardCollectionInfoByMainCustomerNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardCollectionInfoByMainCustomerNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "002", "mainCustomerNumber": 0, "branchCode": "branchCode" }'
Example Request Body
{ "channel": "002", "mainCustomerNumber": 0, "branchCode": "branchCode" }
json
application/json
Example Responses
{ "listOfCards": [ { "branchCode": "branchCode", "branchName": "branchName", "productNumber": "productNumber", "productSegment": "productSegment", "productName": "productName", "subProductType": "subProductType", "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "delayDayCount": 0, "lastStatementMinAmount": 0, "guarantor": "guarantor", "lastPaymentAmount": 0, "lastPaymentDate": "2024-08-25T15:00:00Z", "statementDate": "2024-08-25T15:00:00Z", "totalDebit": 0, "statementTotalAmount": 0, "statementCurrencyCode": "statementCurrencyCode", "remainingMinimumPaymentAmount": 0, "statementDueDate": "2024-08-25T15:00:00Z", "totalAmount": 0, "totalAmountForCreditTransactions": 0, "totalAmountForDebitTransactions": 0, "customerLimit": 0, "cardOpeningDate": "2024-08-25T15:00:00Z", "transferedCardNumberText": "transferedCardNumberText", "cardStatusDescription": "cardStatusDescription", "delinquencyStatus": "delinquencyStatus", "statementRemainAmount": 0, "cardLimit": 0, "cardAvailableLimit": 0, "nextStatementDate": "2024-08-25T15:00:00Z", "minimumPaymentAmount": 0, "supplementaryCardFlag": true, "currentCardFlag": true, "hasCardAutoPayment": true, "autoPaymentAccountNumber": 0, "customerNumber": 0, "remainingDebt": 0, "delinquencyStartDate": "2024-08-25T15:00:00Z", "reconstructAmount": 0 } ] }
json
application/json

getCreditCardCollectionTransactionListByDate

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

Get Credit Card Collection Transaction List By Date

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

getCreditCardCollectionTransactionListByDate › Request Body

GetCreditCardCollectionTransactionListByDateRequest
date
​string · date-time

Date

getCreditCardCollectionTransactionListByDate › Responses

Success

GetCreditCardCollectionTransactionListByDateResponse
​array | null

List Of Transactions

POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardCollectionTransactionListByDate
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardCollectionTransactionListByDate \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "date": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "date": "2024-08-25T15:00:00Z" }
json
application/json
Example Responses
{ "listOfTransactions": [ { "customerNumber": 0, "maskedCardNumber": "maskedCardNumber", "transactionNumber": "transactionNumber", "transactionType": "transactionType", "debitCreditIndicator": "debitCreditIndicator", "amount": 0 } ] }
json
application/json

getCreditCardPortfolioSummary

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

Retrieves a summary of the customer’s credit card portfolio using MainCustomerNumber. Validates input, fetches total credit card debt and card count, and converts total debt amount into USD and EUR using the latest exchange rates. Returns portfolio-level information including product details, total debt amounts in multiple currencies, statement currency, and number of credit cards.

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

getCreditCardPortfolioSummary › Request Body

GetCreditCardPortfolioSummaryRequest
mainCustomerNumber
​integer · int64

Main Customer Number - [Optional]

channelCode
​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

getCreditCardPortfolioSummary › Responses

Success

GetCreditCardPortfolioSummaryResponse
assets
​number · double · required

Assets

totalDebtAmount
​number · double · required

Total Debt Amount

cardCount
​integer · int32 · required

Card Count

totalDebtAmountUSD
​number · double · required

Total Debt Amount U S D

totalDebtAmountEUR
​number · double · required

Total Debt Amount E U R

productCode
​string | null

Product Code - [Optional]

productName
​string | null

Product Name - [Optional]

statementCurrency
​string | null

Statement Currency - [Optional]

POST/IntegrationDigitalChannelCredit/credit/api/getCreditCardPortfolioSummary
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCreditCardPortfolioSummary \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "mainCustomerNumber": 0, "channelCode": "002" }'
Example Request Body
{ "mainCustomerNumber": 0, "channelCode": "002" }
json
application/json
Example Responses
{ "productCode": "productCode", "productName": "productName", "assets": 0, "totalDebtAmount": 0, "cardCount": 0, "totalDebtAmountUSD": 0, "totalDebtAmountEUR": 0, "statementCurrency": "statementCurrency" }
json
application/json

InstalmentsDebt payment