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 lifecycle

Move a card through its states after issuance — status changes, replacement, renewal, blocking and closure.


getBasicCardInformationByPan

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

Retrieves basic card information for a given PAN (Primary Account Number). Accepts GetBasicCardInformationByPanRequest containing Pan. Returns GetBasicCardInformationByPanResponse with Bin, Psn (card sequence number), CardType, MaskedCardNumber, EncryptedCardNumber, HashCardNumber, ShadowCardNumber, and CustomerNumber.

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

getBasicCardInformationByPan › Request Body

GetBasicCardInformationByPanRequest
pan
​string | null

Pan - [Optional]

getBasicCardInformationByPan › Responses

Success

GetBasicCardInformationByPanResponse
customerNumber
​integer · int64 · required

Customer Number

bin
​string | null

Bin - [Optional]

psn
​string | null

Psn - [Optional]

cardType
​string | null

Card Type - [Optional]

encryptedCardNumber
​string | null

Encrypted Card Number - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

hashCardNumber
​string | null

Hash Card Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

POST/Integrationcorebanking/Indoor/api/getBasicCardInformationByPan
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getBasicCardInformationByPan \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "pan": "pan" }'
Example Request Body
{ "pan": "pan" }
json
application/json
Example Responses
{ "bin": "bin", "psn": "psn", "cardType": "cardType", "encryptedCardNumber": "encryptedCardNumber", "maskedCardNumber": "maskedCardNumber", "hashCardNumber": "hashCardNumber", "shadowCardNumber": "shadowCardNumber", "customerNumber": 0 }
json
application/json

getDebitCardInfo

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

Retrieves detailed debit card information for a given ShadowCardNumber. Accepts GetDebitCardInfoRequest with ShadowCardNumber. Calls _intRepository.GetSearchByCustomernumberCardnumber() and _debitManagementServiceProxy.ListCardAccountByShadowCardNumber() to retrieve card details. Returns GetDebitCardInfoResponse containing DebitCardModel with properties such as Barcode, BranchCode, CardStatusCode, MaskedCardNumber, CustomerNumber, VirtualFlag, SupplementaryCardFlag, and a list of CardAccountInfo including AccountNumber, AccountType, AccountBranchId, AccountOrderFlag, and FecCode.

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

getDebitCardInfo › Request Body

GetDebitCardInfoRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

getDebitCardInfo › Responses

Success

GetDebitCardInfoResponse
​object

Card Info - [Optional]

POST/Integrationcorebanking/Indoor/api/getDebitCardInfo
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getDebitCardInfo \ --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
{ "cardInfo": { "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "customerNumber": 0, "mainCustomerNumber": 0, "relatedCardRefNumber": "relatedCardRefNumber", "supplementaryCardFlag": true, "cardRefCurrentCardFlag": true, "branchCode": 0, "branchName": "branchName", "ownerName": "ownerName", "ownerSecondName": "ownerSecondName", "ownerSurname": "ownerSurname", "embossName": "embossName", "productNumber": "productNumber", "cardStatusCode": "cardStatusCode", "cardStatusDscr": "cardStatusDscr", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonDscr": "cardStatusReasonDscr", "virtualFlag": true, "productName": "productName", "productShortName": "productShortName", "emvFlag": true, "magneticStripeFlag": true, "contactlessFlag": true, "rewardEarningFlag": true, "cardBrand": "cardBrand", "cardBrandDescription": "cardBrandDescription", "cardDeliveryType": "cardDeliveryType", "expiryDateStr": "expiryDateStr", "provisionStatusFlag": true, "digitalCardFlag": true, "insertDate": "2024-08-25T15:00:00Z", "cvv2RetryCount": 0, "pinRetryCount": 0, "barcode": "barcode", "fromShadowCardNumber": "fromShadowCardNumber", "toShadowCardNumber": "toShadowCardNumber", "requestDate": "2024-08-25T15:00:00Z", "requestChannel": "requestChannel", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "cardStatusChangeDate": "2024-08-25T15:00:00Z", "lastTrnDate": "2024-08-25T15:00:00Z", "firstPinSetDate": "2024-08-25T15:00:00Z", "lastPinChangeDate": "2024-08-25T15:00:00Z", "deliveryAddress": "deliveryAddress", "sendingBranchCode": 0, "sendingAddressType": "sendingAddressType", "cardAccountInfoList": [ { "accountNumber": 0, "accountType": "accountType", "accountBranchId": 0, "accountOrderFlag": true, "fecCode": 0 } ] } }
json
application/json

changeDebitCardStatus

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

Changes the status of a debit card. Sends ShadowCardNumber, StatusCode, StatusReasonCode, Channel, and optional CloseRequestDate to _debitManagementServiceProxy.ChangeCardStatus. Returns an empty ChangeDebitCardStatusResponse.

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

changeDebitCardStatus › Request Body

ChangeDebitCardStatusRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

statusCode
​string | null

Status Code - [Optional]

statusReasonCode
​string | null

Status Reason Code - [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.

closeRequestDate
​string | null · date-time

Close Request Date - [Optional]

changeDebitCardStatus › Responses

Success

ChangeDebitCardStatusResponse
toStatusActive
​boolean · required

To Status Active

POST/Integrationcorebanking/Indoor/api/changeDebitCardStatus
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/changeDebitCardStatus \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "statusCode": "statusCode", "statusReasonCode": "statusReasonCode", "channel": "channel", "closeRequestDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "statusCode": "statusCode", "statusReasonCode": "statusReasonCode", "channel": "channel", "closeRequestDate": "2024-08-25T15:00:00Z" }
json
application/json
Example Responses
{ "toStatusActive": true }
json
application/json

changeDebitCardBranch

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

Changes the branch of a debit card. Sends ShadowCardNumber, TargetBranchCode, and Channel to _debitManagementServiceProxy.ChangeCardBranch. Returns IsSuccess, OldBranch, and NewBranch.

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

changeDebitCardBranch › Request Body

ChangeDebitCardBranchRequest
targetBranchCode
​integer · int32 · required

Target Branch Code

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.

changeDebitCardBranch › Responses

Success

ChangeDebitCardBranchResponse
isSuccess
​boolean · required

Is Success

oldBranch
​integer · int32 · required

Old Branch

newBranch
​integer · int32 · required

New Branch

POST/Integrationcorebanking/Indoor/api/changeDebitCardBranch
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/changeDebitCardBranch \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "targetBranchCode": 0, "channel": "channel" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "targetBranchCode": 0, "channel": "channel" }
json
application/json
Example Responses
{ "isSuccess": true, "oldBranch": 0, "newBranch": 0 }
json
application/json

attachDebitCardAccount

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

Attaches a debit card to a bank account using account details including branch, type, suffix, number, shadow card number, alias, and IBAN. Converts request and response between internal and service contracts.

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

attachDebitCardAccount › Request Body

AttachDebitCardAccountRequest
fecCode
​integer · int32 · required

Fec Code

accountBranchId
​integer · int32 · required

Account Branch Id

accountSuffix
​integer · int32 · required

Account Suffix

accountNumber
​integer · int64 · required

Account Number

accountOrderFlag
​boolean · required

Account Order Flag

accountType
​string | null

Account Type - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

accountAlias
​string | null

Account Alias - [Optional]

iban
​string | null

Iban - [Optional]

attachDebitCardAccount › Responses

Success

AttachDebitCardAccountResponse
recordId
​integer · int64 · required

Record Id

POST/Integrationcorebanking/Indoor/api/attachDebitCardAccount
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/attachDebitCardAccount \ --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 }'
Example Request Body
{ "fecCode": 0, "accountBranchId": 0, "accountType": "accountType", "accountSuffix": 0, "accountNumber": 0, "shadowCardNumber": "shadowCardNumber", "accountAlias": "accountAlias", "iban": "iban", "accountOrderFlag": true }
json
application/json
Example Responses
{ "recordId": 0 }
json
application/json

getDebitCardLogDataListByShadowCardNumber

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

Retrieves debit card log data for a given ShadowCardNumber. Accepts GetDebitCardLogDataListByShadowCardNumberRequest with ShadowCardNumber, CustomerNumber, LogCode, StartDate, and EndDate. Calls _debitManagementServiceProxy.GetCardLogDataListByShadowCardNumber() and maps results to CardLogData. Returns GetDebitCardLogDataListByShadowCardNumberResponse containing a list of CardLogData with properties such as CardRefNumber, ShadowCardNumber, MaskedCardNumber, CustomerNumber, LogCode, LogCodeDescription, OldValue, NewValue, CardLogDetail, InsertChannelId, InsertChannelDescription, InsertUserId, and InsertDate.

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

getDebitCardLogDataListByShadowCardNumber › Request Body

GetDebitCardLogDataListByShadowCardNumberRequest
customerNumber
​integer · int64 · required

Customer Number

startDate
​string · date-time · required

Start Date

endDate
​string · date-time · required

End Date

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

logCode
​string | null

Log Code - [Optional]

getDebitCardLogDataListByShadowCardNumber › Responses

Success

GetDebitCardLogDataListByShadowCardNumberResponse
​array | null

Card Log Data List - [Optional]

POST/Integrationcorebanking/Indoor/api/getDebitCardLogDataListByShadowCardNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getDebitCardLogDataListByShadowCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "logCode": "logCode", "customerNumber": 0, "startDate": "2024-08-25T15:00:00Z", "endDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "logCode": "logCode", "customerNumber": 0, "startDate": "2024-08-25T15:00:00Z", "endDate": "2024-08-25T15:00:00Z" }
json
application/json
Example Responses
{ "cardLogDataList": [ { "cardRefNumber": "cardRefNumber", "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "customerNumber": 0, "logCode": "logCode", "logCodeDescription": "logCodeDescription", "oldValue": "oldValue", "newValue": "newValue", "cardLogDetail": "cardLogDetail", "insertChannelId": "insertChannelId", "insertChannelDescription": "insertChannelDescription", "insertUserId": "insertUserId", "insertDate": "2024-08-25T15:00:00Z" } ] }
json
application/json

getCreditCardLogDataListByShadowCardNumber

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

Retrieves credit card log data for a given shadow card number. Accepts GetCreditCardLogDataListByShadowCardNumberRequest with parameters ShadowCardNumber, CustomerNumber, LogCode, StartDate, and EndDate. Returns GetCreditCardLogDataListByShadowCardNumberResponse containing a list of CreditCardLogData items, each with CardRefNumber, ShadowCardNumber, MaskedCardNumber, CustomerNumber, OldValue, NewValue, CardLogDetail, InsertChannelId, InsertChannelDescription, LogCode, LogCodeDescription, InsertDate, and InsertUserId. Internally calls _crdIssuingServiceProxy.GetCardLogDataListByShadowCardNumber(). Validates StartDate, EndDate, and ShadowCardNumber before processing.

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

getCreditCardLogDataListByShadowCardNumber › Request Body

GetCreditCardLogDataListByShadowCardNumberRequest
customerNumber
​integer · int64 · required

Customer Number

startDate
​string · date-time · required

Start Date

endDate
​string · date-time · required

End Date

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

logCode
​string | null

Log Code - [Optional]

getCreditCardLogDataListByShadowCardNumber › Responses

Success

GetCreditCardLogDataListByShadowCardNumberResponse
​array | null

Card Log Data List - [Optional]

POST/Integrationcorebanking/Indoor/api/getCreditCardLogDataListByShadowCardNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getCreditCardLogDataListByShadowCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "shadowCardNumber": "shadowCardNumber", "logCode": "logCode", "customerNumber": 0, "startDate": "2024-08-25T15:00:00Z", "endDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "logCode": "logCode", "customerNumber": 0, "startDate": "2024-08-25T15:00:00Z", "endDate": "2024-08-25T15:00:00Z" }
json
application/json
Example Responses
{ "cardLogDataList": [ { "cardRefNumber": "cardRefNumber", "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "customerNumber": 0, "logCode": "logCode", "logCodeDescription": "logCodeDescription", "oldValue": "oldValue", "newValue": "newValue", "cardLogDetail": "cardLogDetail", "insertChannelId": "insertChannelId", "insertChannelDescription": "insertChannelDescription", "insertUserId": "insertUserId", "insertDate": "2024-08-25T15:00:00Z" } ] }
json
application/json

getCardByCardNumber

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

Retrieves detailed card information for a given card number (PAN) and optional PAN sequence number. Accepts GetCardByCardNumberRequest containing CardNumber and PanSequenceNumber. Returns GetCardByCardNumberResponse with Bin, CardNumber, CardRefNumber, CardSeqNumber, CardType, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ProductNumber, StatusCode, and StatusReasonCode.

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

getCardByCardNumber › Request Body

GetCardByCardNumberRequest
cardNumber
​string | null

Card Number - [Optional]

panSequenceNumber
​string | null

Pan Sequence Number - [Optional]

getCardByCardNumber › Responses

Success

GetCardByCardNumberResponse
customerNumber
​integer · int64 · required

Customer Number

expiryDate
​string · date-time · required

Expiry Date

mainCustomerNumber
​integer · int64 · required

Main Customer Number

hashCardNumber
​string | null

Hash Card Number - [Optional]

encryptedCardNumber
​string | null

Encrypted Card Number - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

bin
​string | null

Bin - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardSeqNumber
​string | null

Card Seq Number - [Optional]

statusCode
​string | null

Status Code - [Optional]

statusReasonCode
​string | null

Status Reason Code - [Optional]

cardNumber
​string | null

Card Number - [Optional]

cardType
​string | null

Card Type - [Optional]

productNumber
​string | null

Product Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

maskedPanAlternative
​string | null

Masked Pan Alternative - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

ownerSearchName
​string | null

Owner Search Name - [Optional]

POST/Integrationcorebanking/Indoor/api/getCardByCardNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getCardByCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "cardNumber": "cardNumber", "panSequenceNumber": "panSequenceNumber" }'
Example Request Body
{ "cardNumber": "cardNumber", "panSequenceNumber": "panSequenceNumber" }
json
application/json
Example Responses
{ "hashCardNumber": "hashCardNumber", "encryptedCardNumber": "encryptedCardNumber", "maskedCardNumber": "maskedCardNumber", "customerNumber": 0, "bin": "bin", "shadowCardNumber": "shadowCardNumber", "expiryDate": "2024-08-25T15:00:00Z", "cardSeqNumber": "cardSeqNumber", "statusCode": "statusCode", "statusReasonCode": "statusReasonCode", "cardNumber": "cardNumber", "cardType": "cardType", "productNumber": "productNumber", "cardRefNumber": "cardRefNumber", "maskedPanAlternative": "maskedPanAlternative", "mainCardRefNumber": "mainCardRefNumber", "ownerSearchName": "ownerSearchName", "mainCustomerNumber": 0 }
json
application/json

getSecureCardByPan

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

Retrieves secure card information using the PAN. The response includes encrypted card number, hashed card number, first six digits, first eight digits, last four digits, and a record ID.

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

getSecureCardByPan › Request Body

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

pan
​string | null

Pan - [Optional]

getSecureCardByPan › Responses

Success

GetSecureCardByPanResponse
encryptedCardNumber
​string | null

Encrypted Card Number - [Optional]

hashCardNumber
​string | null

Hash Card Number - [Optional]

firstEight
​string | null

First Eight - [Optional]

firstSix
​string | null

First Six - [Optional]

lastFour
​string | null

Last Four - [Optional]

recordId
​integer | null · int64

Record Id - [Optional]

POST/Integrationcorebanking/Indoor/api/getSecureCardByPan
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getSecureCardByPan \ --request POST \ --header 'Content-Type: application/json' \ --header 'evrst-ptrnid: x_request_id' \ --data '{ "channel": "channel", "pan": "pan" }'
Example Request Body
{ "channel": "channel", "pan": "pan" }
json
application/json
Example Responses
{ "encryptedCardNumber": "encryptedCardNumber", "hashCardNumber": "hashCardNumber", "firstEight": "firstEight", "firstSix": "firstSix", "lastFour": "lastFour", "recordId": 0 }
json
application/json

getCardByShadowCardNumber

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

Service that lists card information based on the Shadow Card Number.

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

getCardByShadowCardNumber › Request Body

GetCardByShadowCardNumberRequest
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]

getCardByShadowCardNumber › Responses

Success

GetCardByShadowCardNumberResponse
customerNumber
​integer · int64 · required

Customer Number

expiryDate
​string · date-time · required

Expiry Date

mainCustomerNumber
​integer · int64 · required

Main Customer Number

hashCardNumber
​string | null

Hash Card Number - [Optional]

encryptedCardNumber
​string | null

Encrypted Card Number - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

bin
​string | null

Bin - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardSeqNumber
​string | null

Card Seq Number - [Optional]

statusCode
​string | null

Status Code - [Optional]

statusReasonCode
​string | null

Status Reason Code - [Optional]

cardNumber
​string | null

Card Number - [Optional]

cardType
​string | null

Card Type - [Optional]

productNumber
​string | null

Product Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

maskedPanAlternative
​string | null

Masked Pan Alternative - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

ownerSearchName
​string | null

Owner Search Name - [Optional]

maskedPanSmart
​string | null

Masked Pan Smart - [Optional]

POST/Integrationcorebanking/Indoor/api/getCardByShadowCardNumber
curl https://everest-sandboxapi.dgpays.com/SandBox/Integrationcorebanking/Indoor/api/getCardByShadowCardNumber \ --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
{ "hashCardNumber": "hashCardNumber", "encryptedCardNumber": "encryptedCardNumber", "maskedCardNumber": "maskedCardNumber", "customerNumber": 0, "bin": "bin", "shadowCardNumber": "shadowCardNumber", "expiryDate": "2024-08-25T15:00:00Z", "cardSeqNumber": "cardSeqNumber", "statusCode": "statusCode", "statusReasonCode": "statusReasonCode", "cardNumber": "cardNumber", "cardType": "cardType", "productNumber": "productNumber", "cardRefNumber": "cardRefNumber", "maskedPanAlternative": "maskedPanAlternative", "mainCardRefNumber": "mainCardRefNumber", "ownerSearchName": "ownerSearchName", "mainCustomerNumber": 0, "maskedPanSmart": "maskedPanSmart" }
json
application/json

Card issuance and personalisationCustomers