Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card issuance and personalisation
      Service that lists eligible products by customer numberpostIndividual Debit Card creation servicepostCorporate Debit Card creation servicepostDebit card renewal servicepostService that cancels debit card issuance based on the Shadow Card NumberpostService that lists cards currently in the printing processpostService that cancels card issuance based on the Shadow Card Number according to the related domainpost
    Card lifecycle
      Service that lists card details based on an open card numberpostService that retrieves debit card informationpostService that updates the status information of a debit cardpostService that changes the branch associated with a debit cardpostService that links an account to a cardpostService that lists debit card log information based on the provided Shadow Card NumberpostService that lists credit card log information based on the provided Shadow Card NumberpostService that lists card details based on an open card numberpostService that displays secure card information based on an open card numberpostService that lists card information based on the Shadow Card Numberpost
Customers and accounts
    Customers
      Service that lists card information based on the provided Shadow Card NumberpostService that lists detailed customer informationpost/Indoor/api/createCustomerpost/Indoor/api/updateCustomerpost
    Account linking
      Service that displays the account statuspost
Transactions
    Service that lists all credit card transactionspostService that lists customer’s payment and cash-advance information based on specified criteriapostService that lists all debit card transactionspostService that lists authorization transactions within the specified date rangepostService that lists in-period debit transactionspost
Limits and controls
    Card and customer limits
      Service that performs credit card limit decreasepostService that performs credit card limit increasepostService that performs customer limit decreasepostService that performs customer limit increasepost
    Operation limits
      Service that lists customized or parameter-based limit details defined for the customerpostService that customizes the customers transaction limitpostService that removes customizable limits defined for a customerpostService that customizes the transaction limit of a cardpostService that lists customized or parameter-based limit details defined on the cardpostService that removes customized limits defined for a cardpost
    Permissions and restrictions
      Service that lists restrictions defined on the cardpost
Billing and statements
    Collections and legal follow-up
      Service that returns customer delinquency informationpostService that closes customer cards based on customer number and forwards the customer to the Legal Follow-Up queuepostService that marks the customer as Legal Follow-Uppost
    Debt payment
      Service that lists the automatic payment instruction queuepost
    Statements and billing
      Service that displays late interest/profit share amountpostService that updates the customers card statement document ID and sends a notificationpostService that updates the customers card statement document ID without sending a notificationpostService that returns Cutoff statement detail list using customer card informationpost
Security
    PIN and card security
      Service that enables PIN creation via SMS for the cardpostService that enables creating the PIN via SMSpostService that displays open PIN information for the given Shadow Card NumberpostService that lists card information based on the provided open PINpostService that generates a card PINpostService that verifies the accuracy of the card PINpostService that retrieves the encrypted data blockpostService that decrypts the data blockpost
Disputes
    Disputes and chargebacks
      Used to initiate spending disputes from various customer interaction channelspostUsed in an ongoing dispute process when the customer withdraws the dispute requestpostUsed when an ongoing dispute case requires adding a new document to the case recordpostUsed to view registered case transactions and their statuses presented to the customerpostService that returns available dispute reasons used when creating a new dispute case via Create Dispute Casepost
Rewards
    Campaigns and rewards
      Service that performs financial maintenance for the customer and applies or cancels campaign discountspostService that returns shadow and masked card numbers for the given customer numberpost
Platform
    Platform operations
      Method that checks whether the service is operationalpostRefresh Cachepost
    Reference data
      Service that lists card types based on the provided BIN numberpostService that lists product information for a card based on Shadow Card NumberpostService that lists statuses of available cardspostService that lists valid card issuance reasonspostService that lists card issuance reasons available for printingpostService that lists all MCC group informationpostService that lists all transaction status informationpostService that lists local card information based on the provided BINpostService that lists eligible productspostService that lists all MCC information with descriptionspostService that lists valid network typespostService that lists valid response codespostService that lists valid response reason codespostService that lists valid transaction codespostService that lists valid Trn Code Matrix informationpost
SchemasError codes
powered by Zudoku
Ana Bankacılık Iletisim Servisi Ripper istikameti
Ana Bankacılık Iletisim Servisi Ripper istikameti

PIN and card security

Set and change a PIN, manage the try counter, and generate or verify the card verification values.


Service that enables PIN creation via SMS for the card

POST
https://devcard.sim-ant.com/SandBox/Integrationcorebanking
/Indoor/api/setCardPinViaSMS

Attempts to set a card PIN via SMS by sending a notification through the notification service. Uses the provided channel, tenant ID, template code, customer number, recipient, and parameters to send the PIN information. Returns true if the SMS is sent successfully, otherwise false and logs the error.

Service that enables PIN creation via SMS for the card › Request Body

SetCardPinViaSMSRequest
channel
​string | null

Channel - [Optional]

mobilePhoneNumber
​string | null

Mobile Phone Number - [Optional]

cardNumberLastFourDigits
​string | null

Card Number Last Four Digits - [Optional]

clearPin
​string | null

Clear Pin - [Optional]

bankKey
​string | null

Bank Key - [Optional]

Service that enables PIN creation via SMS for the card › Responses

Success

SetCardPinViaSMSResponse
success
​boolean · required

Success - [Optional]

errorCode
​integer · int32 · required

Error Code - [Optional]

customerNumber
​integer · int64 · required

Customer Number - [Optional]

errorText
​string | null

Error Text - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

POST/Indoor/api/setCardPinViaSMS
curl https://devcard.sim-ant.com/SandBox/Integrationcorebanking/Indoor/api/setCardPinViaSMS \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastFourDigits": "cardNumberLastFourDigits", "clearPin": "clearPin", "bankKey": "bankKey" }'
Example Request Body
{ "channel": "channel", "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastFourDigits": "cardNumberLastFourDigits", "clearPin": "clearPin", "bankKey": "bankKey" }
json
Example Responses
{ "success": true, "errorCode": 0, "errorText": "errorText", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber" }
json
application/json

Service that enables creating the PIN via SMS

POST
https://devcard.sim-ant.com/SandBox/Integrationcorebanking
/Indoor/api/isSetCardPinViaSMSControl

Checks if a customer has any card eligible for PIN change via SMS and allows setting a new PIN for credit, debit, or prepaid cards. Validates mobile number, card last four digits, clear PIN, and bank key.

Service that enables creating the PIN via SMS › Request Body

IsSetCardPinViaSMSControlRequest
mobilePhoneNumber
​string | null

Mobile Phone Number - [Optional]

cardNumberLastFourDigits
​string | null

Card Number Last Four Digits - [Optional]

Service that enables creating the PIN via SMS › Responses

Success

IsSetCardPinViaSMSControlResponse
isHaveAnyCard
​boolean · required

Is Have Any Card - [Optional]

customerNumber
​integer · int64 · required

Customer Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

POST/Indoor/api/isSetCardPinViaSMSControl
curl https://devcard.sim-ant.com/SandBox/Integrationcorebanking/Indoor/api/isSetCardPinViaSMSControl \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastFourDigits": "cardNumberLastFourDigits" }'
Example Request Body
{ "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastFourDigits": "cardNumberLastFourDigits" }
json
Example Responses
{ "isHaveAnyCard": true, "customerNumber": 0, "shadowCardNumber": "shadowCardNumber" }
json
application/json

Service that displays open PIN information for the given Shadow Card Number

POST
https://devcard.sim-ant.com/SandBox/Integrationcorebanking
/Indoor/api/getClearPanByShadow

Resolves the clear PAN (Primary Account Number) from a given shadow card number. Accepts GetClearPanByShadowRequest with ShadowCardNumber and returns GetClearPanByShadowResponse containing ClearPan. Internally calls _cisServiceProxy.GetCardInfoByShadowCardNumber(). Also provides GetCardInfoByClearPan which retrieves detailed card information by ClearPan, returning GetCardInfoByClearPanResponse with properties like Bin, CardRefNumber, ProductNumber, CardSeqNumber, CardType, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ShadowCardNumber, StatusCode, and StatusReasonCode.

Service that displays open PIN information for the given Shadow Card Number › Request Body

GetClearPanByShadowRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that displays open PIN information for the given Shadow Card Number › Responses

Success

GetClearPanByShadowResponse
clearPan
​string | null

Clear Pan - [Optional]

POST/Indoor/api/getClearPanByShadow
curl https://devcard.sim-ant.com/SandBox/Integrationcorebanking/Indoor/api/getClearPanByShadow \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "clearPan": "clearPan" }
json
application/json

Service that lists card information based on the provided open PIN

POST
https://devcard.sim-ant.com/SandBox/Integrationcorebanking
/Indoor/api/getCardInfoByClearPan

Retrieves card information for a given clear PAN (primary account number). Accepts GetCardInfoByClearPanRequest with ClearPan. Returns GetCardInfoByClearPanResponse containing Bin, CardRefNumber, ProductNumber, CardSeqNumber, CardType, ClearPan, CustomerNumber, EncryptedCardNumber, ExpiryDate, HashCardNumber, MainCardRefNumber, MainCustomerNumber, MaskedCardNumber, MaskedPanAlternative, OwnerSearchName, ShadowCardNumber, StatusCode, and StatusReasonCode.

Service that lists card information based on the provided open PIN › Request Body

GetCardInfoByClearPanRequest
clearPan
​string | null

Clear Pan - [Optional]

Service that lists card information based on the provided open PIN › Responses

Success

GetCardInfoByClearPanResponse
customerNumber
​integer · int64 · required

Customer Number - [Optional]

expiryDate
​string · date-time · required

Expiry Date - [Optional]

mainCustomerNumber
​integer · int64 · required

Main Customer Number - [Optional]

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]

clearPan
​string | null

Clear Pan - [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/Indoor/api/getCardInfoByClearPan
curl https://devcard.sim-ant.com/SandBox/Integrationcorebanking/Indoor/api/getCardInfoByClearPan \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "clearPan": "clearPan" }'
Example Request Body
{ "clearPan": "clearPan" }
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", "clearPan": "clearPan", "cardType": "cardType", "productNumber": "productNumber", "cardRefNumber": "cardRefNumber", "maskedPanAlternative": "maskedPanAlternative", "mainCardRefNumber": "mainCardRefNumber", "ownerSearchName": "ownerSearchName", "mainCustomerNumber": 0 }
json
application/json

Service that generates a card PIN

POST
https://devcard.sim-ant.com/SandBox/Integrationcorebanking
/Indoor/api/setCreditCardPin

Sets or verifies the PIN for a credit card. The SetCreditCardPin method first validates the card status of the customer and throws an exception if the card is in an invalid or problematic state. It then calls the credit PIN management service to set the PIN and returns the encrypted PIN and success flag. The VerifyCreditCardPin method verifies the provided PIN against the credit PIN management service and returns whether it is correct, along with remaining attempt counts and whether the try limit is exceeded.

Service that generates a card PIN › Request Body

SetCreditCardPinRequest
channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

clearPin
​string | null

Clear Pin - [Optional]

Service that generates a card PIN › Responses

Success

SetCardPinResponse
success
​boolean · required

Success - [Optional]

errorCode
​integer · int32 · required

Error Code - [Optional]

errorText
​string | null

Error Text - [Optional]

encryptedPin
​string | null

encrypted Pin - [Optional]

POST/Indoor/api/setCreditCardPin
curl https://devcard.sim-ant.com/SandBox/Integrationcorebanking/Indoor/api/setCreditCardPin \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "clearPin": "clearPin" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "clearPin": "clearPin" }
json
Example Responses
{ "success": true, "errorCode": 0, "errorText": "errorText", "encryptedPin": "encryptedPin" }
json
application/json

Service that verifies the accuracy of the card PIN

POST
https://devcard.sim-ant.com/SandBox/Integrationcorebanking
/Indoor/api/verifyCreditCardPin

Verifies the PIN of a credit card. The method takes the shadow card number, clear PIN, and channel as input, calls the underlying credit PIN management service, and returns whether the PIN is verified along with the remaining try count and whether the maximum try count has been exceeded.

Service that verifies the accuracy of the card PIN › Request Body

VerifyCreditCardPinRequest
channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

clearPin
​string | null

Clear Pin - [Optional]

Service that verifies the accuracy of the card PIN › Responses

Success

VerifyCardPinResponse
verified
​boolean · required

Verified - [Optional]

lastTryCount
​integer · int32 · required

last Try Count - [Optional]

tryCountExceed
​boolean · required

try Count Exceed - [Optional]

errorText
​string | null

Error Text - [Optional]

POST/Indoor/api/verifyCreditCardPin
curl https://devcard.sim-ant.com/SandBox/Integrationcorebanking/Indoor/api/verifyCreditCardPin \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "clearPin": "clearPin" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "clearPin": "clearPin" }
json
Example Responses
{ "verified": true, "lastTryCount": 0, "tryCountExceed": true, "errorText": "errorText" }
json
application/json

Service that retrieves the encrypted data block

POST
https://devcard.sim-ant.com/SandBox/Integrationcorebanking
/Indoor/api/getEncryptDataBlock

Encrypts a given data block using KMT service. Validates input DataBlock, retrieves encryption parameters from cache, calls _kmtServiceProxy.EncryptDataBlock() with KeyId, IV, and CBC mode, and returns GetEncryptDataBlockResponse containing EncryptedDataBlock.

Service that retrieves the encrypted data block › Request Body

GetEncryptDataBlockRequest
dataBlock
​string | null

Data Block - [Optional]

Service that retrieves the encrypted data block › Responses

Success

GetEncryptDataBlockResponse
encryptedDataBlock
​string | null

Encrypted Data Block - [Optional]

POST/Indoor/api/getEncryptDataBlock
curl https://devcard.sim-ant.com/SandBox/Integrationcorebanking/Indoor/api/getEncryptDataBlock \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "dataBlock": "dataBlock" }'
Example Request Body
{ "dataBlock": "dataBlock" }
json
Example Responses
{ "encryptedDataBlock": "encryptedDataBlock" }
json
application/json

Service that decrypts the data block

POST
https://devcard.sim-ant.com/SandBox/Integrationcorebanking
/Indoor/api/decryptDataBlock

Decrypts an encrypted data block using KMT service. Validates that EncryptDataBlock is not null or empty, retrieves encryption parameters from cache, calls DecryptDataBlock on KMT proxy with KeyId, IV, and CBC mode, and returns the clear data block.

Service that decrypts the data block › Request Body

DecryptDataBlockRequest
encryptDataBlock
​string | null

Encrypt Data Block - [Optional]

Service that decrypts the data block › Responses

Success

DecryptDataBlockResponse
clearDataBlock
​string | null

Clear Data Block - [Optional]

POST/Indoor/api/decryptDataBlock
curl https://devcard.sim-ant.com/SandBox/Integrationcorebanking/Indoor/api/decryptDataBlock \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "encryptDataBlock": "encryptDataBlock" }'
Example Request Body
{ "encryptDataBlock": "encryptDataBlock" }
json
Example Responses
{ "clearDataBlock": "clearDataBlock" }
json
application/json

Statements and billingDisputes and chargebacks