Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card issuance and personalisation
      getApplicableProductsByCustomerNumberpostcreateIndividualDebitCardpostcreateCorporateDebitCardpostreplaceDebitCardpostcancelDebitEmbossByShadowCardNumberpostgetPendingCardEmbossListpostcancelEmbossByShadowCardNumberpost
    Card lifecycle
      getBasicCardInformationByPanpostgetDebitCardInfopostchangeDebitCardStatuspostchangeDebitCardBranchpostattachDebitCardAccountpostgetDebitCardLogDataListByShadowCardNumberpostgetCreditCardLogDataListByShadowCardNumberpostgetCardByCardNumberpostgetSecureCardByPanpostgetCardByShadowCardNumberpost
Customers and accounts
    Customers
      getAssetByShadowCardNumberpostgetCustomerDetailpostcreateCustomerpostupdateCustomerpost
    Account linking
      accountStatuspost
Transactions
    getCreditTransactionListpostgetPaymentAndCashadvanceInformationByCriteriaspostgetDebitTransactionAllpostgetAuthorizationListByBegindateEnddatepostgetDbttransactionByCardrefCustomernumpost
Limits and controls
    Card and customer limits
      changeCreditCardLimitDecreasepostchangeCreditCardLimitIncreasepostchangeCustomerLimitDecreasepostchangeCustomerLimitIncreasepost
    Operation limits
      getCustomerOperationLimitpostsetCustomerOperationLimitpostremoveCustomerOperationLimitpostsetCardOperationLimitpostgetCardOperationLimitpostremoveCardOperationLimitpost
    Permissions and restrictions
      getCardRestrictionpost
Billing and statements
    Collections and legal follow-up
      getCardDelinquencyInfoByCustomerNumberpostcreateFollowUpByMainCustomerNumberpostaddToLegalFollowUppost
    Debt payment
      getAutoPaymentQueuepost
    Statements and billing
      getDelinquencyInterestAmountpostsetStatementDocumentIdpostsetStatementDocumentOnlypostgetCardStatementCutoffReportpost
Security
    PIN and card security
      setCardPinViaSMSpostisSetCardPinViaSMSControlpostgetClearPanByShadowpostgetCardInfoByClearPanpostsetCreditCardPinpostverifyCreditCardPinpostgetEncryptDataBlockpostdecryptDataBlockpost
Disputes
    Disputes and chargebacks
      createDisputeCasepostcancelDisputeCasepostaddDocumentByCaseNumberpostgetDisputeListpostgetDisputeReasonDefListpost
Rewards
    Campaigns and rewards
      executeCampaignTransactionpostgetDebitCardForRewardByBankpost
Platform
    Platform operations
      healthCheckpostrefreshCachepost
    Reference data
      getCardTypeByBinpostgetProductByShadowCardNumberpostgetAvailableCardStatusListpostgetEmbossReasonSubDefByValidFlagpostgetAvailableEmbossReasonListpostgetMccGroupAllpostgetTrnStatusAllpostgetBinDomesticByBinpostgetApplicableProductspostgetMccDefinitionGroupbyMccMccdescriptionpostgetNetworkTypeDefByValidFlagpostgetResponseCodeDefByValidFlagpostgetResponseReasonCodeDefByValidFlagpostgetTrnCodeDefByValidFlagpostgetTrnCodeMatrixByValidFlagpost
SchemasError codesChannels
powered by Zudoku
Ana Bankacılık Iletisim Servisi Ripper istikameti
Ana Bankacılık Iletisim Servisi Ripper istikameti

Card issuance and personalisation

Create individual, corporate and virtual cards, and check which products a customer is eligible to hold before you issue.


getApplicableProductsByCustomerNumber

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getApplicableProductsByCustomerNumber

Retrieves applicable card products for a specific customer. Supports Debit and Credit cards, filtering by customer number, main customer number, and optional product group code. Maps cached card products to GetApplicableProductsItem including ProductName, ProductNumber, Brand, ProductShortName, DigitalAbility, TenantId, and CardAnnualFeeAmount for Credit cards. Returns results as GetApplicableProductsByCustomerNumberResponse with Debit and Credit lists. Prepaid card support is planned but not implemented.

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

getApplicableProductsByCustomerNumber › Request Body

GetApplicableProductsByCustomerNumberRequest
customerNumber
​integer · int64 · required

Customer Number

receiveCreditProducts
​boolean · required

Receive Credit Products

receiveDebitProducts
​boolean · required

Receive Debit Products

receivePrepaidProducts
​boolean · required

Receive Prepaid Products

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.

mainCustomerNumber
​integer | null · int64

Main Customer Number - [Optional]

​object

Filter - [Optional]

getApplicableProductsByCustomerNumber › Responses

Success

GetApplicableProductsByCustomerNumberResponse
​object

Debit - [Optional]

​object

Credit - [Optional]

​object

Prepaid - [Optional]

POST/Integrationcorebanking/Indoor/api/getApplicableProductsByCustomerNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getApplicableProductsByCustomerNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "customerNumber": 0, "mainCustomerNumber": 0, "filter": { "productGroupCode": "productGroupCode" }, "receiveCreditProducts": true, "receiveDebitProducts": true, "receivePrepaidProducts": true }'
Example Request Body
{ "channel": "channel", "customerNumber": 0, "mainCustomerNumber": 0, "filter": { "productGroupCode": "productGroupCode" }, "receiveCreditProducts": true, "receiveDebitProducts": true, "receivePrepaidProducts": true }
json
application/json
Example Responses
{ "debit": { "listOfProduct": [ { "productNumber": "productNumber", "productName": "productName", "productShortName": "productShortName", "brand": "brand", "digitalAbility": true, "tenantId": "tenantId", "cardAnnualFeeAmount": 0 } ] }, "credit": { "listOfProduct": [ { "productNumber": "productNumber", "productName": "productName", "productShortName": "productShortName", "brand": "brand", "digitalAbility": true, "tenantId": "tenantId", "cardAnnualFeeAmount": 0 } ] }, "prepaid": { "listOfProduct": [ { "productNumber": "productNumber", "productName": "productName", "productShortName": "productShortName", "brand": "brand", "digitalAbility": true, "tenantId": "tenantId", "cardAnnualFeeAmount": 0 } ] } }
json
application/json

createIndividualDebitCard

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/createIndividualDebitCard

Creates an individual debit card for a customer. If ProductNumber is not provided, automatically selects the primary product. Builds card address info, maps account list, sets card permissions, and calls CreateIndividualCard on the debit management service. Returns card identifiers and warnings.

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

createIndividualDebitCard › Request Body

CreateIndividualDebitCardRequest
digitalCard
​boolean · required

Digital Card

customerNumber
​integer · int64 · required

Customer Number

branchCode
​integer · int32 · required

Branch Code

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.

productNumber
​string | null

Product Number - [Optional]

mainCustomerNumber
​integer | null · int64

Main Customer Number - [Optional]

cardDeliveryType
​string | null

Card Delivery Type - [Optional]

cardSendAddressType
​string | null

Card Send Address Type - [Optional]

cardSendAddressId
​integer | null · int64

Card Send Address Id - [Optional]

cardDeliveryBranchCode
​integer | null · int32

Card Delivery Branch Code - [Optional]

enrollMasterpass
​boolean | null

Enroll Masterpass - [Optional]

​object

Permissions - [Optional]

​array | null

List Of Account - [Optional]

applicationDate
​string | null · date-time

Application Date - [Optional]

contractType
​string | null

Contract Type - [Optional]

contractVersionNumber
​string | null

Contract Version Number - [Optional]

virtualCardRelatedCardRefNumber
​string | null

Virtual Card Related Card Ref Number - [Optional]

nameOnCard
​string | null

Name On Card - [Optional]

createIndividualDebitCard › Responses

Success

CreateIndividualDebitCardResponse
recordId
​integer · int64 · required

Record Id

maskedCardNumber
​string | null

Masked Card Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

​object | null

Warnings - [Optional]

POST/Integrationcorebanking/Indoor/api/createIndividualDebitCard
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/createIndividualDebitCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "productNumber": "productNumber", "digitalCard": true, "customerNumber": 0, "mainCustomerNumber": 0, "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardSendAddressId": 0, "cardDeliveryBranchCode": 0, "enrollMasterpass": true, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true } ], "applicationDate": "2024-08-25T15:00:00Z", "contractType": "contractType", "contractVersionNumber": "contractVersionNumber", "virtualCardRelatedCardRefNumber": "virtualCardRelatedCardRefNumber", "nameOnCard": "nameOnCard" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "digitalCard": true, "customerNumber": 0, "mainCustomerNumber": 0, "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardSendAddressId": 0, "cardDeliveryBranchCode": 0, "enrollMasterpass": true, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true } ], "applicationDate": "2024-08-25T15:00:00Z", "contractType": "contractType", "contractVersionNumber": "contractVersionNumber", "virtualCardRelatedCardRefNumber": "virtualCardRelatedCardRefNumber", "nameOnCard": "nameOnCard" }
json
application/json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" } }
json
application/json

createCorporateDebitCard

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/createCorporateDebitCard

Creates a corporate debit card for a customer. Auto-selects ProductNumber if null. Sends customer details, branch info, card delivery type, permissions, accounts, and optional application date & name on card to _debitManagementServiceProxy.CreateCorporateCard. Returns CardRefNumber, MainCardRefNumber, MaskedCardNumber, ShadowCardNumber, RecordId, and Warnings.

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

createCorporateDebitCard › Request Body

CreateCorporateDebitCardRequest
customerNumber
​integer · int64 · required

Customer Number

mainCustomerNumber
​integer · int64 · required

Main Customer Number

branchCode
​integer · int32 · required

Branch Code

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.

productNumber
​string | null

Product Number - [Optional]

cardDeliveryType
​string | null

Card Delivery Type - [Optional]

cardSendAddressType
​string | null

Card Send Address Type - [Optional]

cardSendAddressId
​integer | null · int64

Card Send Address Id - [Optional]

cardDeliveryBranchCode
​integer | null · int32

Card Delivery Branch Code - [Optional]

​object

Permissions - [Optional]

​array | null

List Of Account - [Optional]

applicationDate
​string | null · date-time

Application Date - [Optional]

nameOnCard
​string | null

Name On Card - [Optional]

secondNameOnCard
​string | null

Second Name On Card

createCorporateDebitCard › Responses

Success

CreateCorporateDebitCardResponse
recordId
​integer · int64 · required

Record Id

maskedCardNumber
​string | null

Masked Card Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

​object | null

Warnings - [Optional]

POST/Integrationcorebanking/Indoor/api/createCorporateDebitCard
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/createCorporateDebitCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "mainCustomerNumber": 0, "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardSendAddressId": 0, "cardDeliveryBranchCode": 0, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true } ], "applicationDate": "2024-08-25T15:00:00Z", "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "mainCustomerNumber": 0, "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardSendAddressId": 0, "cardDeliveryBranchCode": 0, "permissions": { "eCommercePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true } ], "applicationDate": "2024-08-25T15:00:00Z", "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard" }
json
application/json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" } }
json
application/json

replaceDebitCard

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/replaceDebitCard

Replaces a debit card. Calls the debit management service to generate a new card or update product details for the specified debit card. Returns the new shadow card number, masked card number, card reference number, and flags indicating if a new card was generated or the product was changed.

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

replaceDebitCard › Request Body

ReplaceDebitCardRequest
deliveryBranchCode
​integer · int32 · required

Delivery Branch Code

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.

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

embossName
​string | null

Emboss Name - [Optional]

deliveryType
​string | null

Delivery Type - [Optional]

deliveryAddressType
​string | null

Delivery Address Type - [Optional]

cardEmbossReason
​string | null

Card Emboss Reason - [Optional]

cardEmbossSubReason
​string | null

Card Emboss Sub Reason - [Optional]

renewType
​string | null

Renew Type - [Optional]

productNumber
​string | null

Product Number - [Optional]

digitalCard
​boolean | null

Digital Card - [Optional]

​object

Permissions - [Optional]

replaceDebitCard › Responses

Success

ReplaceDebitCardResponse
newCardGenerated
​boolean · required

New Card Generated

productChanged
​boolean · required

Product Changed

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

POST/Integrationcorebanking/Indoor/api/replaceDebitCard
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/replaceDebitCard \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "embossName": "embossName", "deliveryType": "deliveryType", "deliveryBranchCode": 0, "deliveryAddressType": "deliveryAddressType", "cardEmbossReason": "cardEmbossReason", "cardEmbossSubReason": "cardEmbossSubReason", "renewType": "renewType", "productNumber": "productNumber", "digitalCard": true, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true } }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "embossName": "embossName", "deliveryType": "deliveryType", "deliveryBranchCode": 0, "deliveryAddressType": "deliveryAddressType", "cardEmbossReason": "cardEmbossReason", "cardEmbossSubReason": "cardEmbossSubReason", "renewType": "renewType", "productNumber": "productNumber", "digitalCard": true, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true } }
json
application/json
Example Responses
{ "shadowCardNumber": "shadowCardNumber", "newCardGenerated": true, "productChanged": true, "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber" }
json
application/json

cancelDebitEmbossByShadowCardNumber

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/cancelDebitEmbossByShadowCardNumber

Cancels a debit card embossing using the shadow card number. Validates the request for non-empty ShadowCardNumber and a valid Channel, then calls the internal debit management service to perform the cancellation. Logs success and failure events.

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

cancelDebitEmbossByShadowCardNumber › Request Body

CancelDebitEmbossByShadowCardNumberRequest
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.

cancelDebitEmbossByShadowCardNumber › Responses

Success

No data returned
POST/Integrationcorebanking/Indoor/api/cancelDebitEmbossByShadowCardNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/cancelDebitEmbossByShadowCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "channel": "channel" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "channel": "channel" }
json
application/json
Example Responses
No example specified for this content type

getPendingCardEmbossList

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/getPendingCardEmbossList

Retrieves pending card emboss information for a given shadow card number. Returns details including card sequence number, emboss date, application date, emboss reason code and description, sub reason code and description, emboss status, masked card number, product type code and description, shadow card number, and valid flag.

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

getPendingCardEmbossList › Request Body

GetPendingCardEmbossListRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

getPendingCardEmbossList › Responses

Success

GetPendingCardEmbossListResponse
cardSeqNumber
​integer | null · int32

Card Seq Number - [Optional]

embossDate
​string | null · date-time

Emboss Date - [Optional]

applicationDate
​string | null · date-time

Application Date - [Optional]

embossReasonCode
​string | null

Emboss Reason Code - [Optional]

embossReasonDescription
​string | null

Emboss Reason Description - [Optional]

embossReasonSubCode
​string | null

Emboss Reason Sub Code - [Optional]

embossReasonSubDesc
​string | null

Emboss Reason Sub Desc - [Optional]

embossStatus
​string | null

Emboss Status - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

productTypeCode
​string | null

Product Type Code - [Optional]

productTypeDescription
​string | null

Product Type Description - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

validFlag
​boolean | null

Valid Flag - [Optional]

POST/Integrationcorebanking/Indoor/api/getPendingCardEmbossList
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getPendingCardEmbossList \ --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
{ "cardSeqNumber": 0, "embossDate": "2024-08-25T15:00:00Z", "applicationDate": "2024-08-25T15:00:00Z", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "embossStatus": "embossStatus", "maskedCardNumber": "maskedCardNumber", "productTypeCode": "productTypeCode", "productTypeDescription": "productTypeDescription", "shadowCardNumber": "shadowCardNumber", "validFlag": true }
json
application/json

cancelEmbossByShadowCardNumber

POST
https://everest-sandboxapi.dgpays.com/SandBox
/Integrationcorebanking/Indoor/api/cancelEmbossByShadowCardNumber

Cancels an emboss operation for a card by its ShadowCardNumber. Determines the card type (Debit, Credit, Prepaid) and calls the appropriate cancel method. Debit cards are handled via CancelDebitEmbossByShadowCardNumber; Credit and Prepaid cards are not implemented. Validates ShadowCardNumber and Channel before processing.

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

cancelEmbossByShadowCardNumber › Request Body

CancelEmbossByShadowCardNumberRequest
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.

cancelEmbossByShadowCardNumber › Responses

Success

No data returned
POST/Integrationcorebanking/Indoor/api/cancelEmbossByShadowCardNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/cancelEmbossByShadowCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "channel": "channel" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "channel": "channel" }
json
application/json
Example Responses
No example specified for this content type

Card lifecycle