PIN and card security

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

changeCardPin

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/changeCardPin

Changes the PIN of a prepaid card.

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

changeCardPin › Request Body

ChangeCardPinRequest

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]

currentCardPin

string | null

Current Card Pin - [Optional]

newCardPin

string | null

New Card Pin - [Optional]

changeCardPin › Responses

Success

ChangeCardPinResponse

encryptedPin

string | null

Encrypted Pin - [Optional]

changeRsaPin

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/changeRsaPin

Changes the RSA PIN for a prepaid card.

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

changeRsaPin › Request Body

ChangeRsaPinRequest

operationDate

string · date-time · required

Operation Date

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]

currentEPB

string | null

Current E P B - [Optional]

newEPB

string | null

New E P B - [Optional]

changeRsaPin › Responses

Success

ChangeRsaPinResponse

success

boolean · required

Success

encryptedPin

string | null

Encrypted Pin - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/changeRsaPin

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/changeRsaPin \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "currentEPB": "currentEPB",
  "newEPB": "newEPB",
  "operationDate": "2024-08-25T15:00:00Z"
}'

Example Request Body

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

json

application/json

Example Responses

{
  "encryptedPin": "encryptedPin",
  "success": true
}

json

application/json

generateCardVV

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/generateCardVV

Generates the card verification value (CVV) for a prepaid card.

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

generateCardVV › Request Body

GenerateCardVVRequest

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]

generateCardVV › Responses

Success

GenerateCardVVResponse

hasError

boolean · required

Has Error

errorText

string | null

Error Text - [Optional]

verificationValue

string | null

Verification Value - [Optional]

increasePinTryCount

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/increasePinTryCount

Increases the PIN try count for a prepaid card.

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

increasePinTryCount › Request Body

IncreasePinTryCountRequest

increaseCount

integer · int32 · required

Increase Count

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]

increasePinTryCount › Responses

Success

No data returned

resetCvvCounter

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/resetCvvCounter

Resets the CVV counter for a prepaid card.

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

resetCvvCounter › Request Body

ResetCvvCounterRequest

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]

resetCvvCounter › Responses

Success

No data returned

setCardPin

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/setCardPin

Sets the PIN for a prepaid card.

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

setCardPin › Request Body

SetCardPinRequest

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]

clearPin

string | null

Clear Pin - [Optional]

setCardPin › Responses

Success

SetCardPinResponse

encryptedPin

string | null

Encrypted Pin - [Optional]

verifyTerminalCardPin

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/verifyTerminalCardPin

Verifies the terminal-supplied PIN for a prepaid card.

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

verifyTerminalCardPin › Request Body

VerifyTerminalCardPinRequest

clearCardNumber

string | null

Clear Card Number - [Optional]

pinBlock

string | null

Pin Block - [Optional]

zpk

string | null

Zpk - [Optional]

tpk

string | null

Tpk - [Optional]

pinBlockFormat

string | null

Pin Block Format - [Optional]

verifyTerminalCardPin › Responses

Success

VerifyTerminalCardPinResponse

verified

boolean · required

Verified

verifyRsaPin

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/verifyRsaPin

Verifies the RSA PIN for a prepaid card.

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

verifyRsaPin › Request Body

VerifyRsaPinRequest

operationDate

string · date-time · required

Operation Date

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]

ePB

string | null

E P B - [Optional]

verifyRsaPin › Responses

Success

VerifyRsaPinResponse

verified

boolean · required

Verified

lastTryCount

integer · int32 · required

Last Try Count

tryCountExceed

boolean · required

Try Count Exceed

verifyPartialCardVerificationValue

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/verifyPartialCardVerificationValue

Partially verifies the card verification value (CVV) of a prepaid card.

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

verifyPartialCardVerificationValue › Request Body

VerifyPartialCardVerificationValueRequest

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]

digits

array | null

Digits - [Optional]

verifyPartialCardVerificationValue › Responses

Success

VerifyPartialCardVerificationValueResponse

verified

boolean · required

Verified

verifyCardVerificationValue

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/verifyCardVerificationValue

Verifies the card verification value (CVV) of a prepaid card.

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

verifyCardVerificationValue › Request Body

VerifyCardVerificationValueRequest

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]

verificationValue

string | null

Verification Value - [Optional]

verifyCardVerificationValue › Responses

Success

VerifyCardVerificationValueResponse

verified

boolean · required

Verified

lastTryCount

integer · int32 · required

Last Try Count

tryCountExceed

boolean · required

Try Count Exceed

verifyCardPin

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/verifyCardPin

Verifies the PIN of a prepaid card.

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

verifyCardPin › Request Body

VerifyCardPinRequest

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]

clearCardNumber

string | null

Clear Card Number - [Optional]

clearPin

string | null

Clear Pin - [Optional]

verifyCardPin › Responses

Success

VerifyCardPinResponse

verified

boolean · required

Verified

lastTryCount

integer · int32 · required

Last Try Count

tryCountExceed

boolean · required

Try Count Exceed

setRsaPin

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/setRsaPin

Sets the RSA PIN for a prepaid card.

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

setRsaPin › Request Body

SetRsaPinRequest

operationDate

string · date-time · required

Operation Date

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]

ePB

string | null

E P B - [Optional]

setRsaPin › Responses

Success

SetRsaPinResponse

success

boolean · required

Success

encryptedPin

string | null

Encrypted Pin - [Optional]

setCardPinViaSMS

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/setCardPinViaSMS

Sets the PIN for a prepaid card via SMS.

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

setCardPinViaSMS › Request Body

SetCardPinViaSMSRequest

mobilePhoneNumber

string | null

Mobile Phone Number - [Optional]

cardNumberLastSixDigits

string | null

Card Number Last Six Digits - [Optional]

cVVLastTwoDigits

string | null

C V V Last Two Digits - [Optional]

clearPin

string | null

Clear Pin - [Optional]

setCardPinViaSMS › Responses

Success

SetCardPinViaSMSResponse

success

boolean · required

Success

errorCode

integer · int32 · required

Error Code

customerNumber

integer · int64 · required

Customer Number

errorText

string | null

Error Text - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/setCardPinViaSMS

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/setCardPinViaSMS \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'evrst-ptrnid: x_request_id' \
  --data '{
  "mobilePhoneNumber": "mobilePhoneNumber",
  "cardNumberLastSixDigits": "cardNumberLastSixDigits",
  "cVVLastTwoDigits": "cVVLastTwoDigits",
  "clearPin": "clearPin"
}'

Example Request Body

{
  "mobilePhoneNumber": "mobilePhoneNumber",
  "cardNumberLastSixDigits": "cardNumberLastSixDigits",
  "cVVLastTwoDigits": "cVVLastTwoDigits",
  "clearPin": "clearPin"
}

json

application/json

Example Responses

{
  "success": true,
  "errorCode": 0,
  "errorText": "errorText",
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber"
}

json

application/json

getCardPinOperationHistory

POST

https://everest-sandboxapi.dgpays.com/SandBox

/IntegrationDigitalChannelPrepaid/prepaid/api/getCardPinOperationHistory

Retrieves the PIN operation history for a prepaid card.

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

getCardPinOperationHistory › Request Body

GetCardPinOperationHistoryRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

getCardPinOperationHistory › Responses

Success

GetCardPinOperationHistoryResponse

array | null

Get Card Pin Operation History List - [Optional]

POST/IntegrationDigitalChannelPrepaid/prepaid/api/getCardPinOperationHistory

curl https://everest-sandboxapi.dgpays.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCardPinOperationHistory \
  --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

{
  "getCardPinOperationHistoryList": [
    {
      "channelType": "channelType",
      "insertDate": "2024-08-25T15:00:00Z",
      "operationResult": "operationResult",
      "operationResultDescription": "operationResultDescription",
      "operationType": "operationType",
      "operationTypeDescription": "operationTypeDescription"
    }
  ]
}

json

application/json

Permissions and restrictions Platform operations