PIN and card security
Set and change a PIN, manage the try counter, and generate or verify the card verification values.
setCardPin
Sets or updates the PIN for a specific debit card. Accepts card reference number, channel, and new PIN details, and applies the changes to the card securely.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
setCardPin › 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]
setCardPin › Responses
Success
successSuccess
encryptedPinEncrypted Pin - [Optional]
changeCardPin
Changes the PIN of a debit card using the current PIN and returns the status including encrypted PIN, success, and verification flags.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCardPin › 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]
currentCardPinCurrent Card Pin - [Optional]
newCardPinNew Card Pin - [Optional]
changeCardPin › Responses
Success
successSuccess
verifiedVerified
changedChanged
encryptedPinEncrypted Pin - [Optional]
verifyCardPin
Verifies the PIN of a card. Used to confirm cardholder authorization in debit channels.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
verifyCardPin › 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]
clearCardNumberClear Card Number - [Optional]
clearPinClear Pin - [Optional]
verifyCardPin › Responses
Success
verifiedVerified
lastTryCountLast Try Count
tryCountExceedTry Count Exceed
verifyRsaPin
Verifies the RSA PIN for a card. Ensures secure cardholder authorization using RSA PIN.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
verifyRsaPin › 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]
ePBE P B - [Optional]
operationDateOperation Date - [Optional]
verifyRsaPin › Responses
Success
verifiedVerified
lastTryCountLast Try Count
tryCountExceedTry Count Exceed
responseCodeResponse Code
responseDescriptionResponse Description - [Optional]
setRsaPin
Sets the RSA PIN for a card. Used for secure PIN management in debit channels.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
setRsaPin › Request Body
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
shadowCardNumberRequired · NotNull — The card whose PIN is set.
ePBRequired · NotNull — The encrypted PIN block.
operationDateRequired · NotNull — The date the operation is stamped with.
setRsaPin › Responses
Success
successSuccess
encryptedPinEncrypted Pin - [Optional]
responseCodeResponse Code - [Optional]
responseDescriptionResponse Description - [Optional]
changeRsaPin
Changes the RSA PIN of a debit card using current and new encrypted PIN blocks. Returns encrypted PIN, success status, and response details.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeRsaPin › 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]
currentEPBCurrent E P B - [Optional]
newEPBNew E P B - [Optional]
operationDateOfCurrentOperation Date Of Current - [Optional]
operationDateOfNewOperation Date Of New - [Optional]
changeRsaPin › Responses
Success
successSuccess
encryptedPinEncrypted Pin - [Optional]
responseCodeResponse Code - [Optional]
responseDescriptionResponse Description - [Optional]
increasePinTryCount
Increases the PIN try count for a given debit card. Accepts a ShadowCardNumber, Channel, and IncreaseCount to increment the attempt counter via the debit PIN service proxy.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
increasePinTryCount › 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]
increaseCountIncrease Count - [Optional]
increasePinTryCount › Responses
Success
verifyRsaPinWithStaticSalt
Verifies the RSA PIN with a static salt. Provides additional security for cardholder authentication using salted RSA PIN.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
verifyRsaPinWithStaticSalt › 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]
ePBE P B - [Optional]
operationDateOperation Date - [Optional]
staticSaltStatic Salt - [Optional]
verifyRsaPinWithStaticSalt › Responses
Success
verifiedVerified
lastTryCountLast Try Count
tryCountExceedTry Count Exceed
responseCodeResponse Code
responseDescriptionResponse Description - [Optional]
verifyCVV
Verifies the CVV of a card. Used for cardholder validation during transactions.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
verifyCVV › Request Body
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
shadowCardNumberRequired · NotNull — The card whose CVV is being checked.
verificationValueRequired · NotNull · LengthNotEquals — The CVV to check. Exactly 3 characters; any other length is refused before the card is read.
verifyCVV › Responses
Success
verifiedWhether the CVV matched. A CVV that does not match is not an error — the call returns 200 with this false, and the card's failed-attempt counter goes up. The value is checked against the card's current expiry date and, failing that, against its previous one, so a CVV that still matches the old expiry verifies.
lastTryCountThe failed-attempt counter after this call. Zero when the CVV matched, because a match resets it.
tryCountExceedTrue when this call took the counter to the platform's maximum. The next call is refused with 10508 before the CVV is looked at, until the counter is reset.
verifyCVVPartial
Partially verifies the CVV of a card. Used when partial CVV verification is required for transaction purposes.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
verifyCVVPartial › Request Body
channelRequired · Enum · NotNull — Three-digit channel code. Must be a defined channel.
shadowCardNumberRequired · NotNull — The card whose CVV is being checked.
Required · NotBetween — The positions to check, as position/value pairs. Two or three pairs, no more and no fewer. Each position is 1 to 3 — the CVV is three digits — and each value is 0 to 9.
verifyCVVPartial › Responses
Success
verifiedVerified
lastTryCountLast Try Count
tryCountExceedTry Count Exceed
generateCVV
Generates the CVV (Card Verification Value) for a given shadow card. Returns the verification value along with any error information. Uses the underlying debit PIN service.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
generateCVV › Request Body
channelRequired · NotNull — Three-digit channel code.
shadowCardNumberRequired · NotNull — The card to generate a verification value for.
generateCVV › Responses
Success.
Not every failure is a 400. The generator reports several of its own — a key it cannot use, a value it cannot produce — by setting hasError with the reason in errorText, and the call still returns 200. Check hasError before reading verificationValue.
hasErrorHas Error
errorTextError Text - [Optional]
verificationValueVerification Value - [Optional]
getCardPinOperationHistory
Retrieves the PIN operation history for a debit card based on ShadowCardNumber. Returns a list of GetCardPinOperationHistory items including ChannelType, InsertDate, OperationResult, OperationResultDescription, OperationType, and OperationTypeDescription. Uses _dcidRepository.GetCardPinOperationHistory to fetch the data.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardPinOperationHistory › Request Body
shadowCardNumberShadow Card Number - [Optional]
getCardPinOperationHistory › Responses
Success
Get Card Pin Operation History List - [Optional]
resetCvvCounter
Resets the CVV attempt counter for a given shadow card. Accepts the channel and shadow card number as input. Used to allow further CVV attempts after limits are reached.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
resetCvvCounter › 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]
resetCvvCounter › Responses
Success