Everest Card โ€” API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • 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

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
/IntegrationDigitalChannelDebit/debit/api/attachCardAccount

Attaches a debit card to an account using details like IBAN, account number, branch, suffix, type, and alias. Returns the record ID of the attachment.

Part of:

  • Journey 01 ยท Launching a new card product โ€” step 3, Link more accounts

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]

fxAutoConversionFlag
โ€‹boolean

Fx Auto Conversion Flag

channel
โ€‹string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

currencyCode
โ€‹string | null

Currency Code - [Optional]

accountOrder
โ€‹integerย ยทย int32

Account Order - [Optional]

attachCardAccount โ€บ Responses

Success

AttachCardAccountResponse
recordId
โ€‹integerย ยทย int64ย ยทย required

Record Id

POST/IntegrationDigitalChannelDebit/debit/api/attachCardAccount
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/attachCardAccount \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "fecCode": 0, "accountBranchId": 0, "accountType": "V", "accountSuffix": 0, "accountNumber": 456789, "shadowCardNumber": "1202262320000394985", "accountAlias": "t-test", "accountOrderFlag": true, "currencyCode": "949", "channel": "005" }'
Example Request Body
{ "fecCode": 0, "accountBranchId": 0, "accountType": "V", "accountSuffix": 0, "accountNumber": 456789, "shadowCardNumber": "1202262320000394985", "accountAlias": "t-test", "accountOrderFlag": true, "currencyCode": "949", "channel": "005" }
json
application/json
Example Responses
{ "recordId": 0 }
json
application/json

detachCardAccount

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/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

Channel

shadowCardNumber
โ€‹string | null

Shadow Card Number

detachCardAccount โ€บ Responses

Success

DetachCardAccountResponse
recordId
โ€‹integerย ยทย int64ย ยทย required

Record Id

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

detachCardAccountByAccountNumber

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/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

Channel

detachCardAccountByAccountNumber โ€บ Responses

Success

DetachCardAccountByAccountNumberResponse
listOfRemovedRecordId
โ€‹array | null

List Of Removed Record Id

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

modifyCardAccount

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/modifyCardAccount

Modifies an existing card account linked to a shadow card. Updates account details including alias, branch, suffix, type, IBAN, FEC code, and order flag. Returns the updated record ID.

modifyCardAccount โ€บ 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

modifyCardAccount โ€บ Request Body

ModifyCardAccountRequest
recordId
โ€‹integerย ยทย int64

Record Id - [Optional]

accountType
โ€‹string | null

Account Type - [Optional]

accountNumber
โ€‹integerย ยทย int64

Account Number - [Optional]

shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

accountAlias
โ€‹string | null

Account Alias - [Optional]

accountOrderFlag
โ€‹boolean

Account Order Flag - [Optional]

channel
โ€‹string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

accountOrder
โ€‹integerย ยทย int32

Account Order - [Optional]

fxAutoConversionFlag
โ€‹boolean

Fx Auto Conversion Flag

modifyCardAccount โ€บ Responses

Success

ModifyCardAccountResponse
recordId
โ€‹integerย ยทย int64ย ยทย required

Record Id

POST/IntegrationDigitalChannelDebit/debit/api/modifyCardAccount
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/modifyCardAccount \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "recordId": 0, "accountType": "accountType", "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "accountAlias": "accountAlias", "accountOrderFlag": true, "channel": "channel", "accountOrder": 0, "fxAutoConversionFlag": true }'
Example Request Body
{ "recordId": 0, "accountType": "accountType", "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "accountAlias": "accountAlias", "accountOrderFlag": true, "channel": "channel", "accountOrder": 0, "fxAutoConversionFlag": true }
json
application/json
Example Responses
{ "recordId": 0 }
json
application/json

listCardAccountByAccountNumber

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/listCardAccountByAccountNumber

Lists all card-linked accounts for a given account number. Returns details including account alias, branch, suffix, type, IBAN, FEC code, insert/update info, validity, and currency code.

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]

listCardAccountByAccountNumber โ€บ Responses

Success

ListCardAccountByAccountNumberResponse
โ€‹array | null

List Of Account - [Optional]

POST/IntegrationDigitalChannelDebit/debit/api/listCardAccountByAccountNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/listCardAccountByAccountNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "accountNumber": 0 }'
Example Request Body
{ "accountNumber": 0 }
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", "accountOrderFlag": true, "iban": "iban", "currencyCode": "currencyCode", "accountOrder": 0, "fxAutoConversionFlag": true } ] }
json
application/json

listCardAccountByShadowCardNumber

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/listCardAccountByShadowCardNumber

Lists all accounts linked to a specific shadow card number. Returns account details including alias, branch, suffix, type, IBAN, FEC code, insert/update info, validity, and currency code.

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]

listCardAccountByShadowCardNumber โ€บ Responses

Success

ListCardAccountByShadowCardNumberResponse
โ€‹array | null

List Of Account - [Optional]

POST/IntegrationDigitalChannelDebit/debit/api/listCardAccountByShadowCardNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/listCardAccountByShadowCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
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", "accountOrderFlag": true, "iban": "iban", "currencyCode": "currencyCode", "accountOrder": 0, "fxAutoConversionFlag": true } ] }
json
application/json

recreateCustomerCardAccounts

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/recreateCustomerCardAccounts

Recreates all card accounts for a customer linked to a shadow card. Accepts a list of card accounts and replaces the existing ones, ensuring all accounts are valid. Used for batch updates or correcting account assignments.

recreateCustomerCardAccounts โ€บ 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

recreateCustomerCardAccounts โ€บ Request Body

RecreateCustomerCardAccountsRequest
shadowCardNumber
โ€‹string | null

Shadow Card Number - [Optional]

channel
โ€‹string | null

Three-digit channel code. Used for entitlement, limits and the audit trail. See the Channels page (sidebar, or from Get started) for the full code list.

โ€‹array | null

Card Account List - [Optional]

recreateCustomerCardAccounts โ€บ Responses

Success

No data returned
POST/IntegrationDigitalChannelDebit/debit/api/recreateCustomerCardAccounts
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/recreateCustomerCardAccounts \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "channel": "channel", "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", "accountOrderFlag": true, "iban": "iban", "currencyCode": "currencyCode", "accountOrder": 0, "fxAutoConversionFlag": true } ] }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "channel": "channel", "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", "accountOrderFlag": true, "iban": "iban", "currencyCode": "currencyCode", "accountOrder": 0, "fxAutoConversionFlag": true } ] }
json
application/json
Example Responses
No example specified for this content type

saveCardAccountCurrencyConversion

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/saveCardAccountCurrencyConversion

Save Card Account Currency Conversion

saveCardAccountCurrencyConversion โ€บ 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

saveCardAccountCurrencyConversion โ€บ Request Body

SaveCardAccountCurrencyConversionRequest
channel
โ€‹string | null

Channel

shadowCardNumber
โ€‹string | null

Shadow Card Number

accountNumber
โ€‹integerย ยทย int64

Account Number

fxAutoConversionFlag
โ€‹boolean

Fx Auto Conversion Flag

saveCardAccountCurrencyConversion โ€บ Responses

Success

SaveCardAccountCurrencyConversionResponse
accountNumber
โ€‹integerย ยทย int64ย ยทย required

Account Number

fxAutoConversionFlag
โ€‹booleanย ยทย required

Fx Auto Conversion Flag

shadowCardNumber
โ€‹string | null

Shadow Card Number

POST/IntegrationDigitalChannelDebit/debit/api/saveCardAccountCurrencyConversion
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/saveCardAccountCurrencyConversion \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "accountNumber": 0, "fxAutoConversionFlag": true }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "accountNumber": 0, "fxAutoConversionFlag": true }
json
application/json
Example Responses
{ "shadowCardNumber": "shadowCardNumber", "accountNumber": 0, "fxAutoConversionFlag": true }
json
application/json

getCardAccountCurrencyConversion

POST
https://everest-sandboxapi.dgpays.com/SandBox
/IntegrationDigitalChannelDebit/debit/api/getCardAccountCurrencyConversion

Get Card Account Currency Conversion

getCardAccountCurrencyConversion โ€บ 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

getCardAccountCurrencyConversion โ€บ Request Body

GetCardAccountCurrencyConversionRequest
channel
โ€‹string | null

Channel

shadowCardNumber
โ€‹string | null

Shadow Card Number

getCardAccountCurrencyConversion โ€บ Responses

Success

GetCardAccountCurrencyConversionResponse
fxAutoConversionFlag
โ€‹booleanย ยทย required

Fx Auto Conversion Flag

shadowCardNumber
โ€‹string | null

Shadow Card Number

accountNumber
โ€‹integer | nullย ยทย int64

Account Number

POST/IntegrationDigitalChannelDebit/debit/api/getCardAccountCurrencyConversion
curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCardAccountCurrencyConversion \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }
json
application/json
Example Responses
{ "shadowCardNumber": "shadowCardNumber", "accountNumber": 0, "fxAutoConversionFlag": true }
json
application/json

CustomersTransactions