Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      Service that lists card applicationspostService that returns the application information for a card based on its Shadow Card NumberpostService that changes the card application statuspost
    Card issuance and personalisation
      Service that lists the products a customer is eligible for, based on customer numberpostService for creating a Individual Bank Cardpost/debit/api/createIndividualSupplementaryCardpostService for creating a Corporate Bank Cardpost/debit/api/createDummyCorporateCardpostService for creating a Virtual CardpostService that lists cards currently in the printing processpostService that cancels card issuance based on the Shadow Card Numberpost
    Card lifecycle
      List tenant debit cards for a customerpostService that lists Shadow and Masked card information based on the customer’s Tenant informationpostService that allows updating the status information of a cardpostService that lists detailed card informationpostService that lists detailed card informationpostService that retrieves card informationpostCard renewal servicepostService that updates a card to a renewable status and performs card renewalpostService that checks the existence of a card based on the open card numberpostService for adding Debit Card logspost
    No-name cards
      Service for creating a No Name card applicationpostService that cancels a No Name card applicationpostService that updates a No Name card applicationpostService that activates a No Name cardpostService that creates a card via No Name ApplicationpostService that receives a No Name card application and creates the cardpostNo Name Card renewal servicepostService that performs card renewal via 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 associated with a cardpostService that changes the customer’s associated branchpostService that changes the customer’s associated branchpostService that lists customer numbers by branchpost
    Customers
      Service that lists corporate cards of a individual customerpostService that retrieves customer asset informationpostService that returns whether the customer is flagged as riskypostService that lists customer card informationpost
    Account linking
      Service that links an account to a cardpost/debit/api/detachCardAccountpost/debit/api/detachCardAccountByAccountNumberpostService that updates the account linked to a cardpostService that lists card account information based on account numberpostService that lists card account information based on Shadow Card NumberpostService that updates the account linked to a cardpost/debit/api/saveCardAccountCurrencyConversionpost/debit/api/getCardAccountCurrencyConversionpost
Transactions
    Service that lists Bank Card transaction details based on UTIDpostService that lists Bank Card transaction details based on UTIDpostService that lists all transactions related to a cardpost/debit/api/updateTransactionForBNPLpostService that lists Digital Slip preferences based on a given UTIDpostService that lists authorization transactions within a given date rangepostService that lists customer debit transactions based on request criteriapost
Limits and controls
    Card and customer limits
      Service that lists available e-commerce limit informationpost
    Operation limits
      Service that lists parameter-based limit values defined on a cardpostService that lists customized limits or parameter-based limit details defined on a cardpostService that customizes the transaction limit of a cardpostService that removes customized limits defined for a cardpostService that lists customized or parameter-based limit details defined for the customerpostService that customizes the customer’s transaction limitpostService that removes customizable limits defined for a customerpostService that lists parameter-based limit values defined for the customerpost
    Permissions and restrictions
      Service that lists restrictions defined on a cardpostService that adds or removes restrictions on a cardpost/debit/api/saveCardBnplPermissionpostService that updates Digital Slip delivery preferencespostService that lists Digital Slip preferencespost
Security
    PIN and card security
      Service that generates a card PINpostService that enables changing the card’s PINpostService that validates the accuracy of the card PINpostService that validates the card PIN using an encrypted PIN blockpostService that generates the card PIN using an encrypted PIN blockpostService that changes the card’s PIN using an encrypted PIN blockpostService that increases the PIN retry counterpostService that validates the card PIN using an encrypted PIN blockpostCVV validation servicepostCVV validation servicepostCVV generation servicepostService that lists the card PIN transaction historypostService that resets the CVV retry counter on a cardpost
Platform
    Platform operations
      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
Debit Digital Channels Integration
Debit 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 generates a card PIN

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/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.

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]

POST/debit/api/setCardPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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", "success": true }
json
application/json

Service that enables changing the card’s PIN

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/changeCardPin

Changes the PIN of a debit card using the current PIN and returns the status including encrypted PIN, success, and verification flags.

Service that enables changing the card’s 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’s 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]

POST/debit/api/changeCardPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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", "success": true, "verified": true, "changed": true }
json
application/json

Service that validates the accuracy of the card PIN

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/verifyCardPin

Verifies the PIN of a card. Used to confirm cardholder authorization in debit channels.

Service that validates the accuracy 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 validates the accuracy 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/debit/api/verifyCardPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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 validates the card PIN using an encrypted PIN block

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/verifyRsaPin

Verifies the RSA PIN for a card. Ensures secure cardholder authorization using RSA PIN.

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

VerifySecurePinRequest
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 PIN using an encrypted PIN block › Responses

Success

VerifySecurePinResponse
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/debit/api/verifyRsaPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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, "responseCode": 0, "responseDescription": "responseDescription" }
json
application/json

Service that generates the card PIN using an encrypted PIN block

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/setRsaPin

Sets the RSA PIN for a card. Used for secure PIN management in debit channels.

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

SetSecurePinRequest
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 PIN using an encrypted PIN block › Responses

Success

SetSecurePinResponse
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/debit/api/setRsaPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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, "responseCode": 0, "responseDescription": "responseDescription" }
json
application/json

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

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/changeRsaPin

Changes the RSA PIN of a debit card using current and new encrypted PIN blocks. Returns encrypted PIN, success status, and response details.

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

ChangeSecurePinRequest
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 the card’s PIN using an encrypted PIN block › Responses

Success

ChangeSecurePinResponse
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/debit/api/changeRsaPin
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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 increases the PIN retry counter

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/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.

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/debit/api/increasePinTryCount
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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 validates the card PIN using an encrypted PIN block

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/verifyRsaPinWithStaticSalt

Verifies the RSA PIN with a static salt. Provides additional security for cardholder authentication using salted RSA PIN.

Service that validates the card 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 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/debit/api/verifyRsaPinWithStaticSalt
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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

CVV validation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/verifyCVV

Verifies the CVV of a card. Used for cardholder validation during transactions.

CVV validation service › Request Body

VerifyCVVRequest
channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

verificationValue
​string | null

Verification Value - [Optional]

CVV validation service › Responses

Success

VerifyCVVResponse
verified
​boolean · required

Verified - [Optional]

lastTryCount
​integer · int32 · required

Last Try Count - [Optional]

tryCountExceed
​boolean · required

Try Count Exceed - [Optional]

POST/debit/api/verifyCVV
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/verifyCVV \ --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

CVV validation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/verifyCVVPartial

Partially verifies the CVV of a card. Used when partial CVV verification is required for transaction purposes.

CVV validation service › Request Body

VerifyCVVPartialRequest
channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

digits
​array | null

Digits - [Optional]

CVV validation service › Responses

Success

VerifyCVVPartialResponse
verified
​boolean · required

Verified - [Optional]

lastTryCount
​integer · int32 · required

Last Try Count - [Optional]

tryCountExceed
​boolean · required

Try Count Exceed - [Optional]

POST/debit/api/verifyCVVPartial
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/verifyCVVPartial \ --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, "lastTryCount": 0, "tryCountExceed": true }
json
application/json

CVV generation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/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.

CVV generation service › Request Body

GenerateCVVRequest
channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

CVV generation service › Responses

Success

GenerateCVVResponse
hasError
​boolean · required

Has Error - [Optional]

errorText
​string | null

Error Text - [Optional]

verificationValue
​string | null

Verification Value - [Optional]

POST/debit/api/generateCVV
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/generateCVV \ --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 lists the card PIN transaction history

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/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.

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/debit/api/getCardPinOperationHistory
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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

Service that resets the CVV retry counter on a card

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit
/debit/api/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.

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/debit/api/resetCvvCounter
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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

Permissions and restrictionsPlatform operations