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

Card lifecycle

Move a card through its states after issuance — status changes, replacement, renewal, blocking and closure.


List tenant debit cards for a customer

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

Returns the list of debit cards for a customer filtered by tenant. Retrieves card data via GetCustomerDebitCardListByTenant, enriches results with account balance information from Core Banking, and determines pending replace status based on renewal flags. Performs request validation and returns GetCustomerDebitCardListByTenantIdResponse containing customer debit card details.

List tenant debit cards for a customer › Request Body

GetCustomerDebitCardListByTenantIdRequest
customerNumber
​integer | null · int64

Customer Number - [Optional]

tenantId
​string | null

Tenant Id - [Optional]

channel
​string | null

Channel - [Optional]

List tenant debit cards for a customer › Responses

Success

GetCustomerDebitCardListByTenantIdResponse
​array | null

Customer Debit Card List - [Optional]

POST/debit/api/getCustomerDebitCardListByTenantId
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCustomerDebitCardListByTenantId \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "customerNumber": 0, "tenantId": "tenantId", "channel": "channel" }'
Example Request Body
{ "customerNumber": 0, "tenantId": "tenantId", "channel": "channel" }
json
Example Responses
{ "customerDebitCardList": [ { "bin": "bin", "keyDerivationIndex": 0, "encryptedCardNumber": "encryptedCardNumber", "toShadowCardNumber": "toShadowCardNumber", "accountNumber": 0, "barcode": "barcode", "cardRenewStatus": "cardRenewStatus", "cardRenewSubStatus": "cardRenewSubStatus", "cardStatusCode": "cardStatusCode", "cardStatusCodeDesc": "cardStatusCodeDesc", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonCodeDesc": "cardStatusReasonCodeDesc", "customerNumber": 0, "digitalCardFlag": true, "firstPinSetDate": "2024-08-25T15:00:00Z", "mainCardRefNumber": "mainCardRefNumber", "maskedCardNumber": "maskedCardNumber", "noNameFlag": true, "productNumber": "productNumber", "productShortName": "productShortName", "shadowCardNumber": "shadowCardNumber", "usableBalance": 0, "currencyCode": "currencyCode", "pendingReplaceApplicationExists": true, "expiryDateStr": "expiryDateStr" } ] }
json
application/json

Service that lists Shadow and Masked card information based on the customer’s Tenant information

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

Returns the list of debit shadow cards for a customer filtered by tenant. Retrieves shadow card information via GetCustomerDebitShadowCardsByTenant and returns card type, masked and shadow card numbers, product details, and card status information after request validation.

Service that lists Shadow and Masked card information based on the customer’s Tenant information › Request Body

GetCustomerDebitShadowCardsByTenantIdRequest
customerNumber
​integer | null · int64

Customer Number - [Optional]

tenantId
​string | null

Tenant Id - [Optional]

channel
​string | null

Channel - [Optional]

Service that lists Shadow and Masked card information based on the customer’s Tenant information › Responses

Success

GetCustomerDebitShadowCardsByTenantIdResponse
​array | null

Customer Debit Shadow Card List - [Optional]

POST/debit/api/getCustomerDebitShadowCardsByTenantId
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCustomerDebitShadowCardsByTenantId \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "customerNumber": 0, "tenantId": "tenantId", "channel": "channel" }'
Example Request Body
{ "customerNumber": 0, "tenantId": "tenantId", "channel": "channel" }
json
Example Responses
{ "customerDebitShadowCardList": [ { "cardType": "cardType", "customerNumber": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "productNumber": "productNumber", "productShortName": "productShortName", "cardStatusCode": "cardStatusCode", "cardStatusCodeDesc": "cardStatusCodeDesc", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonCodeDesc": "cardStatusReasonCodeDesc" } ] }
json
application/json

Service that allows updating the status information of a card

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

Changes the status of a debit card using status code, reason, and optional transaction information. Returns whether the card status is active after the change.

Service that allows updating the status information of a card › Request Body

ChangeCardStatusRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

statusCode
​string | null

Status Code - [Optional]

statusReasonCode
​string | null

Status Reason Code - [Optional]

channel
​string | null

Channel - [Optional]

transactionId
​string | null

Transaction Id - [Optional]

closeRequestDate
​string | null · date-time

Close Request Date - [Optional]

Service that allows updating the status information of a card › Responses

Success

ChangeCardStatusResponse
toStatusActive
​boolean · required

To Status Active - [Optional]

POST/debit/api/changeCardStatus
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/changeCardStatus \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "statusCode": "statusCode", "statusReasonCode": "statusReasonCode", "channel": "channel", "transactionId": "transactionId", "closeRequestDate": "2024-08-25T15:00:00Z" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "statusCode": "statusCode", "statusReasonCode": "statusReasonCode", "channel": "channel", "transactionId": "transactionId", "closeRequestDate": "2024-08-25T15:00:00Z" }
json
Example Responses
{ "toStatusActive": true }
json
application/json

Service that lists detailed card information

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

Retrieves the list of debit cards based on multiple filters such as ShadowCardNumber, CustomerNumber, MainCustomerNumber, Barcode, AccountNumber, BranchCode, CustomerNameSurname, IdentificationNumber, and CourierStatus. Supports corporate cards, active cards, and digital card flags. Returns a list of DebitCardModel including card details, sensitive data when applicable, account information via ListCardAccountByShadowCardNumber, card status logs, delivery information, and PIN setup status. Uses _dcidRepository.GetSearchByCustomernumberCardnumber for searching, _dbtServiceProxy for account and permission operations, _customerServiceProxy for card and PAN retrieval, and GetSensitiveData for retrieving sensitive card data such as CVV2.

Service that lists detailed card information › Request Body

GetCardListRequest
isCorporateAllCardList
​boolean · required

Is Corporate All Card List - [Optional]

customerNumber
​integer | null · int64

Customer Number - [Optional]

mainCustomerNumber
​integer | null · int64

Main Customer Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

barcode
​string | null

Barcode - [Optional]

accountNumber
​integer | null · int64

Account Number - [Optional]

cardNumber
​string | null

Card Number - [Optional]

purpose
​string | null

Purpose - [Optional]

channelCode
​string | null

Channel Code - [Optional]

tenantId
​string | null

Tenant Id - [Optional]

branchCode
​integer | null · int32

Branch Code - [Optional]

customerNameSurname
​string | null

Customer Name Surname - [Optional]

identificationNumber
​string | null

Identification Number - [Optional]

courierStatus
​string | null

Courier Status - [Optional]

Service that lists detailed card information › Responses

Success

GetCardListResponse
​array | null

List Of Card - [Optional]

POST/debit/api/getCardList
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCardList \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "customerNumber": 0, "mainCustomerNumber": 0, "shadowCardNumber": "shadowCardNumber", "barcode": "barcode", "accountNumber": 0, "cardNumber": "cardNumber", "purpose": "purpose", "channelCode": "channelCode", "tenantId": "tenantId", "isCorporateAllCardList": true, "branchCode": 0, "customerNameSurname": "customerNameSurname", "identificationNumber": "identificationNumber", "courierStatus": "courierStatus" }'
Example Request Body
{ "customerNumber": 0, "mainCustomerNumber": 0, "shadowCardNumber": "shadowCardNumber", "barcode": "barcode", "accountNumber": 0, "cardNumber": "cardNumber", "purpose": "purpose", "channelCode": "channelCode", "tenantId": "tenantId", "isCorporateAllCardList": true, "branchCode": 0, "customerNameSurname": "customerNameSurname", "identificationNumber": "identificationNumber", "courierStatus": "courierStatus" }
json
Example Responses
{ "listOfCard": [ { "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "customerNumber": 0, "mainCustomerNumber": 0, "relatedCardRefNumber": "relatedCardRefNumber", "supplementaryCardFlag": true, "cardRefCurrentCardFlag": true, "branchCode": 0, "branchName": "branchName", "ownerName": "ownerName", "ownerSecondName": "ownerSecondName", "ownerSurname": "ownerSurname", "embossName": "embossName", "productNumber": "productNumber", "productSegmentCode": "productSegmentCode", "cardStatusCode": "cardStatusCode", "cardStatusDscr": "cardStatusDscr", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonDscr": "cardStatusReasonDscr", "virtualFlag": true, "productName": "productName", "productShortName": "productShortName", "tenantId": "tenantId", "emvFlag": true, "magneticStripeFlag": true, "contactlessFlag": true, "rewardEarningFlag": true, "cardBrand": "cardBrand", "cardBrandDescription": "cardBrandDescription", "cardDeliveryType": "cardDeliveryType", "expiryDateStr": "expiryDateStr", "provisionStatusFlag": true, "digitalCardFlag": true, "insertDate": "2024-08-25T15:00:00Z", "cvv2RetryCount": 0, "pinRetryCount": 0, "barcode": "barcode", "fromShadowCardNumber": "fromShadowCardNumber", "toShadowCardNumber": "toShadowCardNumber", "requestDate": "2024-08-25T15:00:00Z", "requestChannel": "requestChannel", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "cardStatusChangeDate": "2024-08-25T15:00:00Z", "firstTrnDate": "2024-08-25T15:00:00Z", "lastTrnDate": "2024-08-25T15:00:00Z", "firstPinSetDate": "2024-08-25T15:00:00Z", "lastPinSetDate": "2024-08-25T15:00:00Z", "lastPinChangeDate": "2024-08-25T15:00:00Z", "deliveryAddress": "deliveryAddress", "isFirstPinSet": "isFirstPinSet", "sendingBranchCode": "sendingBranchCode", "sendingAddressType": "sendingAddressType", "productGroupCode": "productGroupCode", "productGroupDescription": "productGroupDescription", "fromMaskedCardNumber": "fromMaskedCardNumber", "toMaskedCardNumber": "toMaskedCardNumber", "disabledFlag": true, "cardAccountInfoList": [ { "accountNumber": 0, "cardAccountType": "cardAccountType", "accountType": "accountType", "accountSubType": "accountSubType", "accountBranchId": 0, "accountOrderFlag": true, "fecCode": 0, "currencyCode": "currencyCode", "balance": 0, "usableBalance": 0, "iBAN": "iBAN", "errorDescription": "errorDescription" } ], "sensitiveData": { "pan": "pan", "cvv2": "cvv2" }, "pendingReplaceApplicationExists": true, "pinStatus": "pinStatus", "cardStatusChangeChannel": "cardStatusChangeChannel", "securityFlag": true, "citizenshipNumber": "citizenshipNumber", "taxNumber": "taxNumber", "customerNameSurname": "customerNameSurname", "cardSeqNumber": 0, "isDelivered": true } ] }
json
application/json

Service that lists detailed card information

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

Retrieves the list of debit cards based on multiple filters such as ShadowCardNumber, CustomerNumber, MainCustomerNumber, Barcode, AccountNumber, BranchCode, CustomerNameSurname, IdentificationNumber, and CourierStatus. Supports corporate cards, active cards, and digital card flags. Returns a list of DebitCardModel including card details, sensitive data when applicable, account information via ListCardAccountByShadowCardNumber, card status logs, delivery information, and PIN setup status. Uses _dcidRepository.GetSearchByCustomernumberCardnumber for searching, _dbtServiceProxy for account and permission operations, _customerServiceProxy for card and PAN retrieval, and GetSensitiveData for retrieving sensitive card data such as CVV2.

Service that lists detailed card information › Request Body

GetCardListRequest
isCorporateAllCardList
​boolean · required

Is Corporate All Card List - [Optional]

customerNumber
​integer | null · int64

Customer Number - [Optional]

mainCustomerNumber
​integer | null · int64

Main Customer Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

barcode
​string | null

Barcode - [Optional]

accountNumber
​integer | null · int64

Account Number - [Optional]

cardNumber
​string | null

Card Number - [Optional]

purpose
​string | null

Purpose - [Optional]

channelCode
​string | null

Channel Code - [Optional]

tenantId
​string | null

Tenant Id - [Optional]

branchCode
​integer | null · int32

Branch Code - [Optional]

customerNameSurname
​string | null

Customer Name Surname - [Optional]

identificationNumber
​string | null

Identification Number - [Optional]

courierStatus
​string | null

Courier Status - [Optional]

Service that lists detailed card information › Responses

Success

GetCardListResponse
​array | null

List Of Card - [Optional]

POST/debit/api/getCardListNew
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCardListNew \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "customerNumber": 0, "mainCustomerNumber": 0, "shadowCardNumber": "shadowCardNumber", "barcode": "barcode", "accountNumber": 0, "cardNumber": "cardNumber", "purpose": "purpose", "channelCode": "channelCode", "tenantId": "tenantId", "isCorporateAllCardList": true, "branchCode": 0, "customerNameSurname": "customerNameSurname", "identificationNumber": "identificationNumber", "courierStatus": "courierStatus" }'
Example Request Body
{ "customerNumber": 0, "mainCustomerNumber": 0, "shadowCardNumber": "shadowCardNumber", "barcode": "barcode", "accountNumber": 0, "cardNumber": "cardNumber", "purpose": "purpose", "channelCode": "channelCode", "tenantId": "tenantId", "isCorporateAllCardList": true, "branchCode": 0, "customerNameSurname": "customerNameSurname", "identificationNumber": "identificationNumber", "courierStatus": "courierStatus" }
json
Example Responses
{ "listOfCard": [ { "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "customerNumber": 0, "mainCustomerNumber": 0, "relatedCardRefNumber": "relatedCardRefNumber", "supplementaryCardFlag": true, "cardRefCurrentCardFlag": true, "branchCode": 0, "branchName": "branchName", "ownerName": "ownerName", "ownerSecondName": "ownerSecondName", "ownerSurname": "ownerSurname", "embossName": "embossName", "productNumber": "productNumber", "productSegmentCode": "productSegmentCode", "cardStatusCode": "cardStatusCode", "cardStatusDscr": "cardStatusDscr", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonDscr": "cardStatusReasonDscr", "virtualFlag": true, "productName": "productName", "productShortName": "productShortName", "tenantId": "tenantId", "emvFlag": true, "magneticStripeFlag": true, "contactlessFlag": true, "rewardEarningFlag": true, "cardBrand": "cardBrand", "cardBrandDescription": "cardBrandDescription", "cardDeliveryType": "cardDeliveryType", "expiryDateStr": "expiryDateStr", "provisionStatusFlag": true, "digitalCardFlag": true, "insertDate": "2024-08-25T15:00:00Z", "cvv2RetryCount": 0, "pinRetryCount": 0, "barcode": "barcode", "fromShadowCardNumber": "fromShadowCardNumber", "toShadowCardNumber": "toShadowCardNumber", "requestDate": "2024-08-25T15:00:00Z", "requestChannel": "requestChannel", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "cardStatusChangeDate": "2024-08-25T15:00:00Z", "firstTrnDate": "2024-08-25T15:00:00Z", "lastTrnDate": "2024-08-25T15:00:00Z", "firstPinSetDate": "2024-08-25T15:00:00Z", "lastPinSetDate": "2024-08-25T15:00:00Z", "lastPinChangeDate": "2024-08-25T15:00:00Z", "deliveryAddress": "deliveryAddress", "isFirstPinSet": "isFirstPinSet", "sendingBranchCode": "sendingBranchCode", "sendingAddressType": "sendingAddressType", "productGroupCode": "productGroupCode", "productGroupDescription": "productGroupDescription", "fromMaskedCardNumber": "fromMaskedCardNumber", "toMaskedCardNumber": "toMaskedCardNumber", "disabledFlag": true, "cardAccountInfoList": [ { "accountNumber": 0, "cardAccountType": "cardAccountType", "accountType": "accountType", "accountSubType": "accountSubType", "accountBranchId": 0, "accountOrderFlag": true, "fecCode": 0, "currencyCode": "currencyCode", "balance": 0, "usableBalance": 0, "iBAN": "iBAN", "errorDescription": "errorDescription" } ], "sensitiveData": { "pan": "pan", "cvv2": "cvv2" }, "pendingReplaceApplicationExists": true, "pinStatus": "pinStatus", "cardStatusChangeChannel": "cardStatusChangeChannel", "securityFlag": true, "citizenshipNumber": "citizenshipNumber", "taxNumber": "taxNumber", "customerNameSurname": "customerNameSurname", "cardSeqNumber": 0, "isDelivered": true } ] }
json
application/json

Service that retrieves card information

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

Retrieves detailed information for a debit card using either the CardNumber (PAN) or ShadowCardNumber. Includes card metadata (status, branch, product, owner, expiry, virtual/digital flags, embossing info, sensitive data) and the list of attached accounts with account balances, usable balances, IBAN, currency, account type/subtype, and error info if fetching fails.
Uses _customerServiceProxy to map PAN to ShadowCardNumber, _dcidRepository for card search, and _coreBankingIntegrationOutdoor for account info.

Service that retrieves card information › Request Body

GetCardInfoRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardNumber
​string | null

Card Number - [Optional]

Service that retrieves card information › Responses

Success

GetCardInfoResponse
​object

Card Info - [Optional]

POST/debit/api/getCardInfo
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getCardInfo \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "cardNumber": "cardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "cardNumber": "cardNumber" }
json
Example Responses
{ "cardInfo": { "shadowCardNumber": "shadowCardNumber", "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "customerNumber": 0, "mainCustomerNumber": 0, "relatedCardRefNumber": "relatedCardRefNumber", "supplementaryCardFlag": true, "cardRefCurrentCardFlag": true, "branchCode": 0, "branchName": "branchName", "ownerName": "ownerName", "ownerSecondName": "ownerSecondName", "ownerSurname": "ownerSurname", "embossName": "embossName", "productNumber": "productNumber", "productSegmentCode": "productSegmentCode", "cardStatusCode": "cardStatusCode", "cardStatusDscr": "cardStatusDscr", "cardStatusReasonCode": "cardStatusReasonCode", "cardStatusReasonDscr": "cardStatusReasonDscr", "virtualFlag": true, "productName": "productName", "productShortName": "productShortName", "tenantId": "tenantId", "emvFlag": true, "magneticStripeFlag": true, "contactlessFlag": true, "rewardEarningFlag": true, "cardBrand": "cardBrand", "cardBrandDescription": "cardBrandDescription", "cardDeliveryType": "cardDeliveryType", "expiryDateStr": "expiryDateStr", "provisionStatusFlag": true, "digitalCardFlag": true, "insertDate": "2024-08-25T15:00:00Z", "cvv2RetryCount": 0, "pinRetryCount": 0, "barcode": "barcode", "fromShadowCardNumber": "fromShadowCardNumber", "toShadowCardNumber": "toShadowCardNumber", "requestDate": "2024-08-25T15:00:00Z", "requestChannel": "requestChannel", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "cardStatusChangeDate": "2024-08-25T15:00:00Z", "firstTrnDate": "2024-08-25T15:00:00Z", "lastTrnDate": "2024-08-25T15:00:00Z", "firstPinSetDate": "2024-08-25T15:00:00Z", "lastPinSetDate": "2024-08-25T15:00:00Z", "lastPinChangeDate": "2024-08-25T15:00:00Z", "deliveryAddress": "deliveryAddress", "isFirstPinSet": "isFirstPinSet", "sendingBranchCode": "sendingBranchCode", "sendingAddressType": "sendingAddressType", "productGroupCode": "productGroupCode", "productGroupDescription": "productGroupDescription", "fromMaskedCardNumber": "fromMaskedCardNumber", "toMaskedCardNumber": "toMaskedCardNumber", "disabledFlag": true, "cardAccountInfoList": [ { "accountNumber": 0, "cardAccountType": "cardAccountType", "accountType": "accountType", "accountSubType": "accountSubType", "accountBranchId": 0, "accountOrderFlag": true, "fecCode": 0, "currencyCode": "currencyCode", "balance": 0, "usableBalance": 0, "iBAN": "iBAN", "errorDescription": "errorDescription" } ], "sensitiveData": { "pan": "pan", "cvv2": "cvv2" }, "pendingReplaceApplicationExists": true, "pinStatus": "pinStatus", "cardStatusChangeChannel": "cardStatusChangeChannel", "securityFlag": true, "citizenshipNumber": "citizenshipNumber", "taxNumber": "taxNumber", "customerNameSurname": "customerNameSurname", "cardSeqNumber": 0, "isDelivered": true } }
json
application/json

Card renewal service

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

Replaces an existing card with a new one. Accepts details such as card emboss reason, product number, delivery information, and optional permissions. Returns the new card information, including masked number, shadow card number, and any warnings.

Card renewal service › Request Body

ReplaceCardRequest
deliveryBranchCode
​integer · int32 · required

Delivery Branch Code - [Optional]

channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

embossName
​string | null

Emboss Name - [Optional]

deliveryType
​string | null

Delivery Type - [Optional]

deliveryAddressType
​string | null

Delivery Address Type - [Optional]

cardEmbossReason
​string | null

Card Emboss Reason - [Optional]

cardEmbossSubReason
​string | null

Card Emboss Sub Reason - [Optional]

productNumber
​string | null

Product Number - [Optional]

cardSendAddressId
​integer | null · int64

Card Send Address Id - [Optional]

enrollMasterpass
​boolean | null

Enroll Masterpass - [Optional]

​object

Permissions - [Optional]

Card renewal service › Responses

Success

ReplaceCardResponse
newCardGenerated
​boolean · required

New Card Generated - [Optional]

productChanged
​boolean · required

Product Changed - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

​object | null

Warnings - [Optional]

POST/debit/api/replaceCard
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/replaceCard \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "embossName": "embossName", "deliveryType": "deliveryType", "deliveryBranchCode": 0, "deliveryAddressType": "deliveryAddressType", "cardEmbossReason": "cardEmbossReason", "cardEmbossSubReason": "cardEmbossSubReason", "productNumber": "productNumber", "cardSendAddressId": 0, "enrollMasterpass": true, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true } }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "embossName": "embossName", "deliveryType": "deliveryType", "deliveryBranchCode": 0, "deliveryAddressType": "deliveryAddressType", "cardEmbossReason": "cardEmbossReason", "cardEmbossSubReason": "cardEmbossSubReason", "productNumber": "productNumber", "cardSendAddressId": 0, "enrollMasterpass": true, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true } }
json
Example Responses
{ "shadowCardNumber": "shadowCardNumber", "newCardGenerated": true, "productChanged": true, "maskedCardNumber": "maskedCardNumber", "cardRefNumber": "cardRefNumber", "warnings": { "key": "string" } }
json
application/json

Service that updates a card to a renewable status and performs card renewal

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

Changes the status of a debit card and optionally replaces it with a new card, handling embossing, delivery, and permissions. Returns the updated status and replacement card details.

Service that updates a card to a renewable status and performs card renewal › Request Body

ChangeAndReplaceCardRequest
channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardStatusCode
​string | null

Card Status Code - [Optional]

cardStatusReasonCode
​string | null

Card Status Reason Code - [Optional]

closeRequestDate
​string | null · date-time

Close Request Date - [Optional]

​object

Replace Info - [Optional]

Service that updates a card to a renewable status and performs card renewal › Responses

Success

ChangeAndReplaceCardResponse
toStatusActive
​boolean · required

To Status Active - [Optional]

​object

Replace Result - [Optional]

POST/debit/api/changeAndReplaceCard
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/changeAndReplaceCard \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "cardStatusCode": "cardStatusCode", "cardStatusReasonCode": "cardStatusReasonCode", "closeRequestDate": "2024-08-25T15:00:00Z", "replaceInfo": { "deliveryType": "deliveryType", "deliveryAddressType": "deliveryAddressType", "deliveryBranchCode": 0, "embossName": "embossName", "cardEmbossReason": "cardEmbossReason", "cardEmbossSubReason": "cardEmbossSubReason", "productNumber": "productNumber", "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true }, "cardSendAddressId": 0 } }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "cardStatusCode": "cardStatusCode", "cardStatusReasonCode": "cardStatusReasonCode", "closeRequestDate": "2024-08-25T15:00:00Z", "replaceInfo": { "deliveryType": "deliveryType", "deliveryAddressType": "deliveryAddressType", "deliveryBranchCode": 0, "embossName": "embossName", "cardEmbossReason": "cardEmbossReason", "cardEmbossSubReason": "cardEmbossSubReason", "productNumber": "productNumber", "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true }, "cardSendAddressId": 0 } }
json
Example Responses
{ "toStatusActive": true, "replaceResult": { "shadowCardNumber": "shadowCardNumber", "newCardGenerated": true, "productChanged": true, "expiryDate": "2024-08-25T15:00:00Z", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber" } }
json
application/json

Service that checks the existence of a card based on the open card number

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

Checks whether a specific card exists in the system. Accepts a CardNumber and returns a flag (IsFound) along with the ServiceDomainId indicating where the card was found.

Service that checks the existence of a card based on the open card number › Request Body

IsCardFoundInRipperRequest
cardNumber
​string | null

Card Number - [Optional]

Service that checks the existence of a card based on the open card number › Responses

Success

IsCardFoundInRipperResponse
isFound
​boolean · required

Is Found - [Optional]

serviceDomainId
​string | null

Service Domain Id - [Optional]

POST/debit/api/isCardFoundIn
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/isCardFoundIn \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "cardNumber": "cardNumber" }'
Example Request Body
{ "cardNumber": "cardNumber" }
json
Example Responses
{ "isFound": true, "serviceDomainId": "serviceDomainId" }
json
application/json

Service for adding Debit Card logs

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

Adds a log entry for a debit card including details like old and new values, card reference, masked number, and validity flag.

Service for adding Debit Card logs › Request Body

AddDebitCardLogRequest
customerNumber
​integer · int64 · required

Customer Number - [Optional]

validFlag
​boolean · required

Valid Flag - [Optional]

channel
​string | null

Channel - [Optional]

logCode
​string | null

Log Code - [Optional]

cardLogDetail
​string | null

Card Log Detail - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

oldValue
​string | null

Old Value - [Optional]

newValue
​string | null

New Value - [Optional]

Service for adding Debit Card logs › Responses

Success

AddDebitCardLogResponse
recordId
​integer · int64 · required

Record Id - [Optional]

POST/debit/api/addDebitCardLog
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/addDebitCardLog \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "logCode": "logCode", "cardLogDetail": "cardLogDetail", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "customerNumber": 0, "validFlag": true, "oldValue": "oldValue", "newValue": "newValue" }'
Example Request Body
{ "channel": "channel", "logCode": "logCode", "cardLogDetail": "cardLogDetail", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "customerNumber": 0, "validFlag": true, "oldValue": "oldValue", "newValue": "newValue" }
json
Example Responses
{ "recordId": 0 }
json
application/json

Card issuance and personalisationNo-name cards