PIN and card security
Set and change a PIN, manage the try counter, and generate or verify the card verification values.
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
setCardPinViaSMS › Request Body
channelThree-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.
mobilePhoneNumberMobile Phone Number - [Optional]
cardNumberLastFourDigitsCard Number Last Four Digits - [Optional]
clearPinClear Pin - [Optional]
bankKeyBank Key - [Optional]
setCardPinViaSMS › Responses
Success
successSuccess
errorCodeError Code
customerNumberCustomer Number
errorTextError Text - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
isSetCardPinViaSMSControl › Request Body
mobilePhoneNumberMobile Phone Number - [Optional]
cardNumberLastFourDigitsCard Number Last Four Digits - [Optional]
isSetCardPinViaSMSControl › Responses
Success
isHaveAnyCardIs Have Any Card
customerNumberCustomer Number
shadowCardNumberShadow Card Number - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getClearPanByShadow › Responses
Success
clearPanClear Pan - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardInfoByClearPan › Responses
Success
customerNumberCustomer Number
expiryDateExpiry Date
mainCustomerNumberMain Customer Number
hashCardNumberHash Card Number - [Optional]
encryptedCardNumberEncrypted Card Number - [Optional]
maskedCardNumberMasked Card Number - [Optional]
binBin - [Optional]
shadowCardNumberShadow Card Number - [Optional]
cardSeqNumberCard Seq Number - [Optional]
statusCodeStatus Code - [Optional]
statusReasonCodeStatus Reason Code - [Optional]
clearPanClear Pan - [Optional]
cardTypeCard Type - [Optional]
productNumberProduct Number - [Optional]
cardRefNumberCard Ref Number - [Optional]
maskedPanAlternativeMasked Pan Alternative - [Optional]
mainCardRefNumberMain Card Ref Number - [Optional]
ownerSearchNameOwner Search Name - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
setCreditCardPin › Request Body
channelThree-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.
shadowCardNumberShadow Card Number - [Optional]
clearPinClear Pin - [Optional]
setCreditCardPin › Responses
Success
successSuccess
errorCodeError Code
errorTextError Text - [Optional]
encryptedPinencrypted Pin - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
verifyCreditCardPin › Request Body
channelThree-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.
shadowCardNumberShadow Card Number - [Optional]
clearPinClear Pin - [Optional]
verifyCreditCardPin › Responses
Success
verifiedVerified
lastTryCountlast Try Count
tryCountExceedtry Count Exceed
errorTextError Text - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getEncryptDataBlock › Responses
Success
encryptedDataBlockEncrypted Data Block - [Optional]
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.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
decryptDataBlock › Responses
Success
clearDataBlockClear Data Block - [Optional]