Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      Service that returns the application information for a card based on its Shadow Card Numberpost
    Card issuance and personalisation
      Service that creates an individual prepaid cardpostService that lists eligible products by customer numberpost
    Card lifecycle
      Service that retrieves detailed credit card information based on card datapostService that updates a card to a renewable status and performs card renewalpostService that allows modifying the card’s status informationpostCard renewal servicepostService that lists detailed card informationpost
    No-name cards
      No Name Card application creation servicepostService that cancels the No Name Card applicationpostService that updates the No Name Card applicationpostService that activates the No Name CardpostService that creates a card using the No Name applicationpostNo Name Card renewal servicepostService that renews the card using the No Name applicationpostService that updates a No Name card to a renewable status and performs card renewalpost
Customers and accounts
    Branch management
      Service that changes the branch to which the card is linkedpostService that changes the customer’s associated branchpostService that provides updating of the branch to which the customer is linkedpost
    Customers
      Service that retrieves customer asset informationpostService that retrieves the branch information the customer is associated withpost
Transactions
    Get Authorization List By Begindate EnddatepostGet Pddtransaction By Cardref CustomernumpostGet Prepaid Transaction AllpostService that lists Prepaid Card transaction details based on UTIDpostService that lists the digital slip preference based on the provided UTIDpost
Limits and controls
    Operation limits
      Service that lists the parametric limit values defined on the cardpostService that lists customized or parameter-based limit details defined for the customerpostService that lists customized limits or parametric limit details defined for the cardpostService that customizes customer transaction limitspostService that customizes the card’s transaction limitpostService that removes customizable limits defined for a customerpostService that removes the customized limits of the cardpostService that lists parameter-based limit values defined for the customerpost
    Permissions and restrictions
      Service that lists restrictions applied to the cardpostService that adds or removes card restrictionspost
Security
    PIN and card security
      Service that enables changing the card PINpostService that changes a card’s PIN using an encrypted PIN blockpostCVV generation servicepostService that increases the PIN retry counterpostService that resets the CVV retry counter on a cardpostService that generates a card PINpostVerify Terminal Card PinpostService that validates the card’s PIN using an encrypted PIN blockpostService that validates the card’s verification code (CVV) using partial informationpostService that validates the card’s verification code (CVV)postService that verifies the correctness of the card PINpostService that generates the card’s PIN using an encrypted PIN blockpostService that enables PIN creation for a card via SMSpostService that lists the card PIN transaction historypost
Platform
    Platform operations
      It is a method that checks whether the service is operationalpostRefresh Cachepost
    Reference data
      Service that retrieves the card type based on the BIN numberpost
SchemasError codes
powered by Zudoku
Prepaid Digital Channels Integration
Prepaid Digital Channels Integration

PIN and card security

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


Service that enables changing the card PIN

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/changeCardPin

Changes the PIN of a prepaid card.

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
encryptedPin
​string | null

Encrypted Pin - [Optional]

POST/prepaid/api/changeCardPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/changeCardPin \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "currentCardPin": "currentCardPin", "newCardPin": "newCardPin" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "currentCardPin": "currentCardPin", "newCardPin": "newCardPin" }
json
Example Responses
{ "encryptedPin": "encryptedPin" }
json
application/json

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

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/changeRsaPin

Changes the RSA PIN for a prepaid card.

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

ChangeRsaPinRequest
operationDate
​string · date-time · required

Operation Date - [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]

POST/prepaid/api/changeRsaPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/changeRsaPin \ --request POST \ --header 'Content-Type: application/json' \ --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
Example Responses
{ "encryptedPin": "encryptedPin", "success": true }
json
application/json

CVV generation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/generateCardVV

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

CVV generation service › Request Body

GenerateCardVVRequest
channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [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]

POST/prepaid/api/generateCardVV
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/generateCardVV \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "hasError": true, "errorText": "errorText", "verificationValue": "verificationValue" }
json
application/json

Service that increases the PIN retry counter

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/increasePinTryCount

Increases the PIN try count for a prepaid card.

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
POST/prepaid/api/increasePinTryCount
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/increasePinTryCount \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "increaseCount": 0 }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "increaseCount": 0 }
json
Example Responses
No example specified for this content type

Service that resets the CVV retry counter on a card

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/resetCvvCounter

Resets the CVV counter for a prepaid card.

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
POST/prepaid/api/resetCvvCounter
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/resetCvvCounter \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
No example specified for this content type

Service that generates a card PIN

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/setCardPin

Sets the PIN for a prepaid card.

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
encryptedPin
​string | null

Encrypted Pin - [Optional]

POST/prepaid/api/setCardPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/setCardPin \ --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
{ "encryptedPin": "encryptedPin" }
json
application/json

Verify Terminal Card Pin

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/verifyTerminalCardPin

Verifies the terminal-supplied PIN for a prepaid card.

Verify Terminal Card Pin › 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]

Verify Terminal Card Pin › Responses

Success

VerifyTerminalCardPinResponse
verified
​boolean · required

Verified - [Optional]

POST/prepaid/api/verifyTerminalCardPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/verifyTerminalCardPin \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "clearCardNumber": "clearCardNumber", "pinBlock": "pinBlock", "zpk": "zpk", "tpk": "tpk", "pinBlockFormat": "pinBlockFormat" }'
Example Request Body
{ "clearCardNumber": "clearCardNumber", "pinBlock": "pinBlock", "zpk": "zpk", "tpk": "tpk", "pinBlockFormat": "pinBlockFormat" }
json
Example Responses
{ "verified": true }
json
application/json

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

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/verifyRsaPin

Verifies the RSA PIN for a prepaid card.

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]

POST/prepaid/api/verifyRsaPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/verifyRsaPin \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "ePB": "ePB", "operationDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "ePB": "ePB", "operationDate": "2024-08-25T15:00:00Z" }
json
Example Responses
{ "verified": true, "lastTryCount": 0, "tryCountExceed": true }
json
application/json

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

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/verifyPartialCardVerificationValue

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

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]

POST/prepaid/api/verifyPartialCardVerificationValue
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/verifyPartialCardVerificationValue \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "digits": [ {} ] }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "digits": [ {} ] }
json
Example Responses
{ "verified": true }
json
application/json

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

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/verifyCardVerificationValue

Verifies the card verification value (CVV) of a prepaid 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]

lastTryCount
​integer · int32 · required

Last Try Count - [Optional]

tryCountExceed
​boolean · required

Try Count Exceed - [Optional]

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

Service that verifies the correctness of the card PIN

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/verifyCardPin

Verifies the PIN of a prepaid card.

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]

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

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

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/setRsaPin

Sets the RSA PIN for a prepaid card.

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]

POST/prepaid/api/setRsaPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/setRsaPin \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "ePB": "ePB", "operationDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "ePB": "ePB", "operationDate": "2024-08-25T15:00:00Z" }
json
Example Responses
{ "encryptedPin": "encryptedPin", "success": true }
json
application/json

Service that enables PIN creation for a card via SMS

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/setCardPinViaSMS

Sets the PIN for a prepaid card via SMS.

Service that enables PIN creation for a card via SMS › 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]

Service that enables PIN creation for a card via SMS › 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/prepaid/api/setCardPinViaSMS
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/setCardPinViaSMS \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastSixDigits": "cardNumberLastSixDigits", "cVVLastTwoDigits": "cVVLastTwoDigits", "clearPin": "clearPin" }'
Example Request Body
{ "mobilePhoneNumber": "mobilePhoneNumber", "cardNumberLastSixDigits": "cardNumberLastSixDigits", "cVVLastTwoDigits": "cVVLastTwoDigits", "clearPin": "clearPin" }
json
Example Responses
{ "success": true, "errorCode": 0, "errorText": "errorText", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber" }
json
application/json

Service that lists the card PIN transaction history

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid
/prepaid/api/getCardPinOperationHistory

Retrieves the PIN operation history for a prepaid card.

Service that lists the card PIN transaction history › Request Body

GetCardPinOperationHistoryRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that lists the card PIN transaction history › Responses

Success

GetCardPinOperationHistoryResponse
​array | null

Get Card Pin Operation History List - [Optional]

POST/prepaid/api/getCardPinOperationHistory
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCardPinOperationHistory \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
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 restrictionsPlatform operations