PIN and card security

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

Service that generates a card PIN

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/setCardPin

Sets the PIN for a specified card. It checks card status before updating the PIN, ensuring no issues with the customer’s card status before processing the request.

Part of:

Journey 01 · Launching a new card product — step 5, Activate and set the PIN
Journey 01 · Launching a new card product — step 4, Activate, PIN, transact

Service that generates a card PIN › Request Body

SetCardPinRequest

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]

encryptedPin

string | null

Encrypted Pin - [Optional]

Service that enables changing the card PIN

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/changeCardPin

Changes the PIN of a credit card. Validates the card status to ensure it is neither under configuration nor with payment issues. Uses current PIN and new PIN, calls the Card PIN service, and returns the encrypted PIN, change status, success flag, and verification result.

Part of:

Journey 02 · Managing a card product — step 3, PIN and verification

Service that enables changing the card PIN › Request Body

ChangeCardPinRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

currentCardPin

string | null

Current Card Pin - [Optional]

newCardPin

string | null

New Card Pin - [Optional]

Service that enables changing the card PIN › Responses

Success

ChangeCardPinResponse

success

boolean · required

Success - [Optional]

verified

boolean · required

Verified - [Optional]

changed

boolean · required

Changed - [Optional]

encryptedPin

string | null

Encrypted Pin - [Optional]

Service that verifies the correctness of the card PIN

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/verifyCardPin

Verifies the entered PIN against the stored one for the provided card, checking for validity and exceeding attempt counts.

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

VerifyCardPinRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

clearCardNumber

string | null

Clear Card Number - [Optional]

clearPin

string | null

Clear Pin - [Optional]

Service that verifies the correctness 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]

Service that validates the card’s PIN using an encrypted PIN block

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/verifyRsaPin

Verifies the RSA pin for a given card, including the option to use a static salt for enhanced security.

Service that validates the card’s PIN using an encrypted PIN block › Request Body

VerifyRsaPinRequest

operationDate

string · date-time · required

Operation Date - [Optional]

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

ePB

string | null

E P B - [Optional]

Service that validates the card’s PIN using an encrypted PIN block › Responses

Success

VerifyRsaPinResponse

verified

boolean · required

Verified - [Optional]

lastTryCount

integer · int32 · required

Last Try Count - [Optional]

tryCountExceed

boolean · required

Try Count Exceed - [Optional]

responseCode

integer · int32 · required

Response Code - [Optional]

responseDescription

string | null

Response Description - [Optional]

Service that validates the card’s PIN using an encrypted PIN block

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/verifyRsaPinWithStaticSalt

Verifies the RSA pin for a given card, including the option to use a static salt for enhanced security.

Service that validates the card’s PIN using an encrypted PIN block › Request Body

VerifyRsaPinWithStaticSaltRequest

operationDate

string · date-time · required

Operation Date - [Optional]

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

ePB

string | null

E P B - [Optional]

staticSalt

string | null

Static Salt - [Optional]

Service that validates the card’s PIN using an encrypted PIN block › Responses

Success

VerifyRsaPinWithStaticSaltResponse

verified

boolean · required

Verified - [Optional]

lastTryCount

integer · int32 · required

Last Try Count - [Optional]

tryCountExceed

boolean · required

Try Count Exceed - [Optional]

responseCode

integer · int32 · required

Response Code - [Optional]

responseDescription

string | null

Response Description - [Optional]

POST/credit/api/verifyRsaPinWithStaticSalt

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/verifyRsaPinWithStaticSalt \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "ePB": "ePB",
  "operationDate": "2024-08-25T15:00:00Z",
  "staticSalt": "staticSalt"
}'

Example Request Body

{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "ePB": "ePB",
  "operationDate": "2024-08-25T15:00:00Z",
  "staticSalt": "staticSalt"
}

json

Example Responses

{
  "verified": true,
  "lastTryCount": 0,
  "tryCountExceed": true,
  "responseCode": 0,
  "responseDescription": "responseDescription"
}

json

application/json

Service that generates the card’s PIN using an encrypted PIN block

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/setRsaPin

Sets a new RSA Pin for the card. It validates the card status and performs the RSA Pin update operation for a customer, providing encrypted pin and relevant response information.

Service that generates the card’s PIN using an encrypted PIN block › Request Body

SetRsaPinRequest

operationDate

string · date-time · required

Operation Date - [Optional]

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

ePB

string | null

E P B - [Optional]

Service that generates the card’s PIN using an encrypted PIN block › Responses

Success

SetRsaPinResponse

success

boolean · required

Success - [Optional]

encryptedPin

string | null

Encrypted Pin - [Optional]

responseCode

integer | null · int32

Response Code - [Optional]

responseDescription

string | null

Response Description - [Optional]

Service that increases the PIN retry counter

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/increasePinTryCount

Increments the PIN attempt counter for a given credit card. Takes a request containing the channel, the card's shadow number, and the increment value. Calls the underlying CRDPinServiceProxy to update the count.

Service that increases the PIN retry counter › Request Body

IncreasePinTryCountRequest

increaseCount

integer · int32 · required

Increase Count - [Optional]

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that increases the PIN retry counter › Responses

Success

No data returned

Service that changes a card’s PIN using an encrypted PIN block

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/changeRsaPin

Changes the RSA PIN for a credit card. Validates the customer and card status to ensure there are no payment issues or problematic configurations. Returns the encrypted PIN, success status, and response details from the RSA service.

Service that changes a card’s PIN using an encrypted PIN block › Request Body

ChangeRsaPinRequest

operationDateOfCurrent

string · date-time · required

Operation Date Of Current - [Optional]

operationDateOfNew

string · date-time · required

Operation Date Of New - [Optional]

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

currentEPB

string | null

Current E P B - [Optional]

newEPB

string | null

New E P B - [Optional]

Service that changes a card’s PIN using an encrypted PIN block › Responses

Success

ChangeRsaPinResponse

success

boolean · required

Success - [Optional]

encryptedPin

string | null

Encrypted Pin - [Optional]

responseCode

integer | null · int32

Response Code - [Optional]

responseDescription

string | null

Response Description - [Optional]

POST/credit/api/changeRsaPin

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeRsaPin \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "currentEPB": "currentEPB",
  "newEPB": "newEPB",
  "operationDateOfCurrent": "2024-08-25T15:00:00Z",
  "operationDateOfNew": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "currentEPB": "currentEPB",
  "newEPB": "newEPB",
  "operationDateOfCurrent": "2024-08-25T15:00:00Z",
  "operationDateOfNew": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "encryptedPin": "encryptedPin",
  "success": true,
  "responseCode": 0,
  "responseDescription": "responseDescription"
}

json

application/json

Service that validates the card’s verification code (CVV)

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/verifyCardVerificationValue

Verifies the provided card verification value (CVV) against the stored CVV for the given card.

Service that validates the card’s verification code (CVV) › Request Body

VerifyCardVerificationValueRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

verificationValue

string | null

Verification Value - [Optional]

Service that validates the card’s verification code (CVV) › Responses

Success

VerifyCardVerificationValueResponse

verified

boolean · required

Verified - [Optional]

CVV generation service

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/generateCardVV

Generates the Card Verification Value (CVV) for a given credit card using shadow card number, BIN, clear PAN, expiry date, and key derivation index. Returns the CVV and error information if any.

CVV generation service › Request Body

GenerateCardVVRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

keyDerivationIndex

integer | null · int32

Key Derivation Index - [Optional]

bin

string | null

Bin - [Optional]

expiryDateStr

string | null

Expiry Date Str - [Optional]

clearPan

string | null

Clear Pan - [Optional]

CVV generation service › Responses

Success

GenerateCardVVResponse

hasError

boolean · required

Has Error - [Optional]

errorText

string | null

Error Text - [Optional]

verificationValue

string | null

Verification Value - [Optional]

Service that validates the card’s verification code (CVV) using partial information

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/verifyPartialCardVerificationValue

Verifies the partial card verification value (CVV) based on the provided number of digits for the given card.

Part of:

Journey 02 · Managing a card product — step 3, PIN and verification

Service that validates the card’s verification code (CVV) using partial information › Request Body

VerifyPartialCardVerificationValueRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

digits

array | null

Digits - [Optional]

Service that validates the card’s verification code (CVV) using partial information › Responses

Success

VerifyPartialCardVerificationValueResponse

verified

boolean · required

Verified - [Optional]

Service that resets the CVV retry counter on a card

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit

/credit/api/resetCvvCounter

Resets the CVV (Card Verification Value) counter for a specified card, based on the provided shadow card number.

Service that resets the CVV retry counter on a card › Request Body

ResetCvvCounterRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that resets the CVV retry counter on a card › Responses

Success

No data returned

Statements and billing Disputes and chargebacks