Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Cards
    Card applications
      Service that returns application information of a renewed card based on Shadow Card NumberpostService that updates card application statuspost
    Card issuance and personalisation
      Individual Credit Card creation servicepostIndividual Supplementary Credit Card creation servicepostCorporate Dummy Credit Card creation servicepostCorporate Credit Card creation servicepostVirtual Credit Card creation servicepostService that lists eligible products by customer numberpostService that validates main customer existence before listing eligible productspostNo Name Card creation servicepostService that cancels card issuance based on the Shadow Card NumberpostService that lists cards currently in the emboss processpost
    Card lifecycle
      List credit cards for a customer or accountpostCard renewal servicepostService that lists memo entries defined for the cardpostService that allows updating the card’s statuspostService that updates the status of all cards owned by the customerpostService that updates a card to a renewable status and performs card renewalpost/credit/api/getRenewCountByShadowCardNumberpostService that retrieves detailed credit card information based on card datapostService that lists cards by customer’s Tenant informationpostService that returns masked and shadow card information along with card statuspostService that lists cards by customer’s Tenant and product informationpost/credit/api/getCardListNewpost
    No-name cards
      Service that activates a No Name 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 renewalpostService that cancels a No Name card applicationpost
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 branch informationpostService that returns branch-assigned customer informationpost
    Customers
      Service that lists commercial cards of a retail customerpostService that lists the customer’s card informationpost
    Account linking
      Service that links an account to a cardpost/credit/api/detachCardAccountpost/credit/api/detachCardAccountByAccountNumberpostService 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
Transactions
    Service that processes payment transactionspostPayment cancellation servicepostService that queries fee information for payment transactionspostService that returns transaction details by given UTIDpostService that lists all successful/unsuccessful customer transactionspostService that lists authorization transactionspostService that lists credit card period, authorization, and pending installment transactionspostService that lists in-period (current cycle) transactionspostService that lists in-period card transactions and due installmentspostService that lists authorization transactions.postService that lists Digital Slip preferences by given UTIDpost
    Cash advance
      Cash advance calculation servicepostCash advance servicepostService that cancels a cash-advance transactionpostService that lists cash advances eligible for cancellationpost
Limits and controls
    Card and customer limits
      Service that performs card limit decreasepostService that performs card limit increasepostService that rolls back the last limit change performed on a cardpostCard limit reset servicepostService that updates automatic limit-increase settings for a cardpostService that displays total customer limit informationpostService that retrieves credit card limit details for the given card informationpostService that lists available limits of the cardpostService that displays available customer limit based on customer datapostService that decreases corporete card limitspostService that increases corporate card limitspostService that updates limits of retail cardspostService that performs customer limit decreasepostService that updates virtual credit card limitspost
    Operation limits
      Service that lists customized or parameter-based limit details defined on the cardpostService that customizes the card’s transaction limitpostService that removes customized limits defined for a cardpostService that lists parameter-based limit values defined on the cardpostService that lists customized or parameter-based limit details defined for the customerpostService that customizes customer transaction limitspostService 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 applied to the cardpostService that adds or removes card restrictionspostService that updates Digital Slip delivery preferencespostService that lists Digital Slip preferencespost
Instalments
    Service that lists installment transactions eligible for early closure for the given customer and cardpostPerforms early closure for a given card and transactionpostService that returns min/max installment counts applicable to the transaction for a given UTIDpostService that returns interest/profit share rates and amounts for installment ranges for a cash-advance requestpostService that returns interest/profit share rates and amounts for all possible installment options for a cash-advance requestpostService that returns interest/profit share rates and amounts based on selected installment count for a cash-advance requestpostInstallment cash advance servicepostService that fully or partially closes installment cash advancespostService that lists installment cash advances eligible for cancellationpostService that lists early-closed installment cash advancespostService that returns early-closed installment cash advance detailspostEarly closure of installment cash advance servicepostService that cancels an installment transaction that was previously closed earlypostService that lists all pending installmentspostService that returns details of a pending installment transactionpostService that returns total interest/profit share and fee amounts for all pending installments of a cardpostService that receives a manual installment requestpostManual installment simulation servicepostService that returns installment options applicable to a transaction for a given UTIDpostEarly installment closure reversal servicepostService that returns manual installment cancellation listpostService that lists installments eligible for early closure based on selected criteriapostSimulation service showing how interest/profit differences are refunded in early installment closurepostService that closes pending installmentspostPost-installment request cancellation servicepost
Billing and statements
    Collections and legal follow-up
      Service that returns customer delinquency informationpostService that lists the debt and payment details of supplementary cards linked to the selected primary cardpostService that lists all debt and payment information for the customers cardspost/credit/api/getCreditCardCollectionTransactionListByDatepostService that returns product-based debt information for the customerpost
    Debt payment
      Service that checks the existence of a credit card for debt paymentpostCard payment servicepostCredit card payment reversal servicepostService that lists payments eligible for reversalpostService that captures Automatic Payment Instructions for credit cardspostService that displays auto-payment account information for a given cardpost
    Statements and billing
      Service that returns summary information on statements (statement debt, minimum due, cut-off date, due date, etc.)postService that lists transactions belonging to the statement detailspostService that returns statement delivery preferences (email, SMS, mail) of all primary credit cards for the specified customerpostService that lists card statementspostService that returns the last statement information of the cardpostService that returns the last statement information of the cardpostService that returns summary statement information for the selected periodpostService that returns summary statement information for the selected periodpostService that updates credit card statement delivery frequencypostService that lists how many times the statement period has been changedpostService that calculates the next statement cut-off periodspostService that retrieves statement period information based on product numberpostService that updates credit card statement delivery preferencepostService that retrieves statement delivery address detailspostGet Card Financial Info By Card Ref NumberpostGet Statement Period Change Infopost
Security
    PIN and card security
      Service that generates a card PINpostService that enables changing the card PINpostService that verifies the correctness of the card PINpostService that validates the card’s PIN using an encrypted PIN blockpostService that validates the card’s PIN using an encrypted PIN blockpostService that generates the card’s PIN using an encrypted PIN blockpostService that increases the PIN retry counterpostService that changes a card’s PIN using an encrypted PIN blockpostService that validates the card’s verification code (CVV)postCVV generation servicepostService that validates the card’s verification code (CVV) using partial informationpostService that resets the CVV retry counter on a cardpost
Disputes
    Disputes and chargebacks
      Used to initiate spending disputes from multiple customer channelspostUsed in an ongoing dispute process when the customer withdraws their dispute requestpostUsed when an ongoing dispute case requires adding a new document to the case recordpostGet Dispute ListpostService that returns the list of dispute reasons available when creating a new dispute case via Create Dispute Casepost
Rewards
    Campaigns and rewards
      Service that calculates transaction start and end dates based on valid statement dates for a given customer number and request source (Customer or System)post
Platform
    Platform operations
      Method that checks whether the service is operationalpostRefresh Cachepost
    Reference data
      Service that lists permissible status transitions for a cardpost
SchemasError codes
powered by Zudoku
Credit Digital Channels Integration
Credit Digital Channels Integration

Card issuance and personalisation

Create individual, corporate and virtual cards, and check which products a customer is eligible to hold before you issue.


Individual Credit Card creation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/createIndividualCard

Creates a new individual credit card for a customer. Supports digital and physical cards, multiple accounts, addresses, auto payment, permissions, and optional card miscellaneous options. Returns card reference, shadow card number, masked card number, and sensitive card data if applicable.

Part of:

  • Journey 01 · Launching a new card product — step 4, Issue the card

Individual Credit Card creation service › Request Body

CreateIndividualCardRequest
customerNumber
​integer · int64 · required

Customer Number - [Optional]

branchCode
​integer · int32 · required

Branch Code - [Optional]

statementPostFlag
​boolean · required

Statement Post Flag - [Optional]

statementSmsSendFlag
​boolean · required

Statement Sms Send Flag - [Optional]

statementEmailSendFlag
​boolean · required

Statement Email Send Flag - [Optional]

cardLimitValue
​number · double · required

Card Limit Value - [Optional]

authorizationSmsSendFlag
​boolean · required

Authorization Sms Send Flag - [Optional]

autoLimitIncreaseFlag
​boolean · required

Auto Limit Increase Flag - [Optional]

autoPaymentFlag
​boolean · required

Auto Payment Flag - [Optional]

channel
​string | null

Channel - [Optional]

productNumber
​string | null

Product Number - [Optional]

nameOnCard
​string | null

Name On Card - [Optional]

secondNameOnCard
​string | null

Second Name On Card - [Optional]

cardDeliveryType
​string | null

Card Delivery Type - [Optional]

cardSendAddressType
​string | null

Card Send Address Type - [Optional]

cardDeliveryBranchCode
​integer | null · int32

Card Delivery Branch Code - [Optional]

cardSendAddressId
​integer | null · int64

Card Send Address Id - [Optional]

​object

Permissions - [Optional]

​array | null

List Of Account - [Optional]

​object

Card Misc Option - [Optional]

enrollMasterpass
​boolean | null

Enroll Masterpass - [Optional]

contractType
​string | null

Contract Type - [Optional]

contractVersionNumber
​string | null

Contract Version Number - [Optional]

statementPeriod
​string | null

Statement Period - [Optional]

statementCurrencyCode
​string | null

Statement Currency Code - [Optional]

statementSendingAddressType
​string | null

Statement Sending Address Type - [Optional]

statementSendAddressId
​integer | null · int64

Statement Send Address Id - [Optional]

customerLimitValue
​number | null · double

Customer Limit Value - [Optional]

authorizationSmsSendMinimumAmount
​number | null · double

Authorization Sms Send Minimum Amount - [Optional]

autoInstallmentCount
​integer | null · int32

Auto Installment Count - [Optional]

autoDeferringMonthCount
​integer | null · int32

Auto Deferring Month Count - [Optional]

​object

Auto Payment Account - [Optional]

applicationChannel
​string | null

Application Channel - [Optional]

applicationId
​string | null

Application Id - [Optional]

applicationDate
​string | null · date-time

Application Date - [Optional]

applicationContractId
​string | null

Application Contract Id - [Optional]

Individual Credit Card creation service › Responses

Success

CreateIndividualCardResponse
recordId
​integer · int64 · required

Record Id - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

​object | null

Warnings - [Optional]

​object

Sensitive Card Data - [Optional]

POST/credit/api/createIndividualCard
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createIndividualCard \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardDeliveryBranchCode": 0, "cardSendAddressId": 0, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true, "internationalPurchasePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "cardMiscOption": { "optionType": "optionType", "optionValue": "optionValue" }, "enrollMasterpass": true, "contractType": "contractType", "contractVersionNumber": "contractVersionNumber", "statementPeriod": "statementPeriod", "statementCurrencyCode": "statementCurrencyCode", "statementSendingAddressType": "statementSendingAddressType", "statementPostFlag": true, "statementSmsSendFlag": true, "statementEmailSendFlag": true, "statementSendAddressId": 0, "cardLimitValue": 0, "customerLimitValue": 0, "authorizationSmsSendFlag": true, "authorizationSmsSendMinimumAmount": 0, "autoInstallmentCount": 0, "autoDeferringMonthCount": 0, "autoLimitIncreaseFlag": true, "autoPaymentFlag": true, "autoPaymentAccount": { "paymentType": "paymentType", "accountBranchId": 0, "accountSuffix": 0, "accountNumber": 0 }, "applicationChannel": "applicationChannel", "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardDeliveryBranchCode": 0, "cardSendAddressId": 0, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true, "internationalPurchasePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "cardMiscOption": { "optionType": "optionType", "optionValue": "optionValue" }, "enrollMasterpass": true, "contractType": "contractType", "contractVersionNumber": "contractVersionNumber", "statementPeriod": "statementPeriod", "statementCurrencyCode": "statementCurrencyCode", "statementSendingAddressType": "statementSendingAddressType", "statementPostFlag": true, "statementSmsSendFlag": true, "statementEmailSendFlag": true, "statementSendAddressId": 0, "cardLimitValue": 0, "customerLimitValue": 0, "authorizationSmsSendFlag": true, "authorizationSmsSendMinimumAmount": 0, "autoInstallmentCount": 0, "autoDeferringMonthCount": 0, "autoLimitIncreaseFlag": true, "autoPaymentFlag": true, "autoPaymentAccount": { "paymentType": "paymentType", "accountBranchId": 0, "accountSuffix": 0, "accountNumber": 0 }, "applicationChannel": "applicationChannel", "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }
json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" } }
json
application/json

Individual Supplementary Credit Card creation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/createIndividualSupplementaryCard

Creates a new individual supplementary credit card for a customer. Supports digital and physical cards, multiple accounts, addresses, auto payment, permissions, and optional card miscellaneous options. Returns card reference, shadow card number, masked card number, and sensitive card data if applicable.

Individual Supplementary Credit Card creation service › Request Body

CreateIndividualSupplementaryCardRequest
customerNumber
​integer · int64 · required

Customer Number

branchCode
​integer · int32 · required

Branch Code

cardLimitValue
​number · double · required

Card Limit Value

authorizationSmsSendFlag
​boolean · required

Authorization Sms Send Flag

channel
​string | null

Channel

productNumber
​string | null

Product Number

shadowCardNumber
​string | null

Shadow Card Number

nameOnCard
​string | null

Name On Card

secondNameOnCard
​string | null

Second Name On Card

cardDeliveryType
​string | null

Card Delivery Type

cardSendAddressType
​string | null

Card Send Address Type

cardDeliveryBranchCode
​integer | null · int32

Card Delivery Branch Code

cardSendAddressId
​integer | null · int64

Card Send Address Id

​object

Permissions

​array | null

List Of Account

​object

Card Misc Option

enrollMasterpass
​boolean | null

Enroll Masterpass

contractType
​string | null

Contract Type

contractVersionNumber
​string | null

Contract Version Number

authorizationSmsSendMinimumAmount
​number | null · double

Authorization Sms Send Minimum Amount

autoInstallmentCount
​integer | null · int32

Auto Installment Count

autoDeferringMonthCount
​integer | null · int32

Auto Deferring Month Count

applicationChannel
​string | null

Application Channel

applicationId
​string | null

Application Id

applicationDate
​string | null · date-time

Application Date

applicationContractId
​string | null

Application Contract Id

Individual Supplementary Credit Card creation service › Responses

Success

CreateIndividualSupplementaryCardResponse
recordId
​integer · int64 · required

Record Id

maskedCardNumber
​string | null

Masked Card Number

shadowCardNumber
​string | null

Shadow Card Number

cardRefNumber
​string | null

Card Ref Number

mainCardRefNumber
​string | null

Main Card Ref Number

​object | null

Warnings

​object

Sensitive Card Data

POST/credit/api/createIndividualSupplementaryCard
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createIndividualSupplementaryCard \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardDeliveryBranchCode": 0, "cardSendAddressId": 0, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true, "internationalPurchasePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "cardMiscOption": { "optionType": "optionType", "optionValue": "optionValue" }, "enrollMasterpass": true, "contractType": "contractType", "contractVersionNumber": "contractVersionNumber", "cardLimitValue": 0, "authorizationSmsSendFlag": true, "authorizationSmsSendMinimumAmount": 0, "autoInstallmentCount": 0, "autoDeferringMonthCount": 0, "applicationChannel": "applicationChannel", "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardDeliveryBranchCode": 0, "cardSendAddressId": 0, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true, "internationalPurchasePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "cardMiscOption": { "optionType": "optionType", "optionValue": "optionValue" }, "enrollMasterpass": true, "contractType": "contractType", "contractVersionNumber": "contractVersionNumber", "cardLimitValue": 0, "authorizationSmsSendFlag": true, "authorizationSmsSendMinimumAmount": 0, "autoInstallmentCount": 0, "autoDeferringMonthCount": 0, "applicationChannel": "applicationChannel", "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }
json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" } }
json
application/json

Corporate Dummy Credit Card creation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/createDummyCorporateCard

Creates a new dummy corporate credit card. Supports specifying addresses, accounts, statement preferences, card limits, virtual card relation, auto payment accounts, and permissions. Returns card reference, shadow numbers, masked card number, record ID, warnings, and sensitive card data if applicable.

Corporate Dummy Credit Card creation service › Request Body

CreateDummyCorporateCardRequest
customerNumber
​integer · int64 · required

Customer Number

branchCode
​integer · int32 · required

Branch Code

statementPostFlag
​boolean · required

Statement Post Flag

statementSmsSendFlag
​boolean · required

Statement Sms Send Flag

statementEmailSendFlag
​boolean · required

Statement Email Send Flag

cardLimitValue
​number · double · required

Card Limit Value

autoLimitIncreaseFlag
​boolean · required

Auto Limit Increase Flag

autoPaymentFlag
​boolean · required

Auto Payment Flag

channel
​string | null

Channel

productNumber
​string | null

Product Number

nameOnCard
​string | null

Name On Card

statementPeriod
​string | null

Statement Period

statementCurrencyCode
​string | null

Statement Currency Code

statementSendingAddressType
​string | null

Statement Sending Address Type

statementSendAddressId
​integer | null · int64

Statement Send Address Id

customerLimitValue
​number | null · double

Customer Limit Value

autoInstallmentCount
​integer | null · int32

Auto Installment Count

autoDeferringMonthCount
​integer | null · int32

Auto Deferring Month Count

​object

Auto Payment Account

applicationId
​string | null

Application Id

applicationDate
​string | null · date-time

Application Date

applicationContractId
​string | null

Application Contract Id

Corporate Dummy Credit Card creation service › Responses

Success

CreateDummyCorporateCardResponse
cardMasterRecordId
​integer · int64 · required

Card Master Record Id

secureCardMasterRecordId
​integer · int64 · required

Secure Card Master Record Id

cardRefNumber
​string | null

Card Ref Number

mainCardRefNumber
​string | null

Main Card Ref Number

shadowCardNumber
​string | null

Shadow Card Number

​object | null

Warnings

POST/credit/api/createDummyCorporateCard
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createDummyCorporateCard \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "nameOnCard": "nameOnCard", "branchCode": 0, "statementPeriod": "statementPeriod", "statementCurrencyCode": "statementCurrencyCode", "statementPostFlag": true, "statementSmsSendFlag": true, "statementEmailSendFlag": true, "statementSendingAddressType": "statementSendingAddressType", "statementSendAddressId": 0, "cardLimitValue": 0, "customerLimitValue": 0, "autoInstallmentCount": 0, "autoDeferringMonthCount": 0, "autoLimitIncreaseFlag": true, "autoPaymentFlag": true, "autoPaymentAccount": { "paymentType": "paymentType", "accountBranchId": 0, "accountSuffix": 0, "accountNumber": 0 }, "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "nameOnCard": "nameOnCard", "branchCode": 0, "statementPeriod": "statementPeriod", "statementCurrencyCode": "statementCurrencyCode", "statementPostFlag": true, "statementSmsSendFlag": true, "statementEmailSendFlag": true, "statementSendingAddressType": "statementSendingAddressType", "statementSendAddressId": 0, "cardLimitValue": 0, "customerLimitValue": 0, "autoInstallmentCount": 0, "autoDeferringMonthCount": 0, "autoLimitIncreaseFlag": true, "autoPaymentFlag": true, "autoPaymentAccount": { "paymentType": "paymentType", "accountBranchId": 0, "accountSuffix": 0, "accountNumber": 0 }, "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }
json
Example Responses
{ "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "shadowCardNumber": "shadowCardNumber", "cardMasterRecordId": 0, "secureCardMasterRecordId": 0, "warnings": { "key": "string" } }
json
application/json

Corporate Credit Card creation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/createCorporateCard

Creates a new corporate credit card. Supports specifying addresses, accounts, statement preferences, card limits, virtual card relation, auto payment accounts, and permissions. Returns card reference, shadow numbers, masked card number, record ID, warnings, and sensitive card data if applicable.

Corporate Credit Card creation service › Request Body

CreateCorporateCardRequest
customerNumber
​integer · int64 · required

Customer Number - [Optional]

branchCode
​integer · int32 · required

Branch Code - [Optional]

cardLimitValue
​number · double · required

Card Limit Value - [Optional]

authorizationSmsSendFlag
​boolean · required

Authorization Sms Send Flag - [Optional]

channel
​string | null

Channel - [Optional]

productNumber
​string | null

Product Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number

nameOnCard
​string | null

Name On Card - [Optional]

secondNameOnCard
​string | null

Second Name On Card - [Optional]

cardDeliveryType
​string | null

Card Delivery Type - [Optional]

cardSendAddressType
​string | null

Card Send Address Type - [Optional]

cardSendAddressId
​integer | null · int64

Card Send Address Id - [Optional]

cardDeliveryBranchCode
​integer | null · int32

Card Delivery Branch Code - [Optional]

enrollMasterpass
​boolean | null

Enroll Masterpass - [Optional]

​object

Permissions - [Optional]

​array | null

List Of Account - [Optional]

contractType
​string | null

Contract Type - [Optional]

contractVersionNumber
​string | null

Contract Version Number - [Optional]

authorizationSmsSendMinimumAmount
​number | null · double

Authorization Sms Send Minimum Amount - [Optional]

applicationChannel
​string | null

Application Channel - [Optional]

applicationId
​string | null

Application Id - [Optional]

applicationDate
​string | null · date-time

Application Date - [Optional]

applicationContractId
​string | null

Application Contract Id - [Optional]

Corporate Credit Card creation service › Responses

Success

CreateCorporateCardResponse
recordId
​integer · int64 · required

Record Id - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

mainShadowCardNumber
​string | null

Main Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

​object | null

Warnings - [Optional]

​object

Sensitive Card Data - [Optional]

POST/credit/api/createCorporateCard
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createCorporateCard \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardSendAddressId": 0, "cardDeliveryBranchCode": 0, "enrollMasterpass": true, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true, "internationalPurchasePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "contractType": "contractType", "contractVersionNumber": "contractVersionNumber", "cardLimitValue": 0, "authorizationSmsSendFlag": true, "authorizationSmsSendMinimumAmount": 0, "applicationChannel": "applicationChannel", "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }'
Example Request Body
{ "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "nameOnCard": "nameOnCard", "secondNameOnCard": "secondNameOnCard", "branchCode": 0, "cardDeliveryType": "cardDeliveryType", "cardSendAddressType": "cardSendAddressType", "cardSendAddressId": 0, "cardDeliveryBranchCode": 0, "enrollMasterpass": true, "permissions": { "eCommercePermitted": true, "mailOrderPermitted": true, "internationalPurchasePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "contractType": "contractType", "contractVersionNumber": "contractVersionNumber", "cardLimitValue": 0, "authorizationSmsSendFlag": true, "authorizationSmsSendMinimumAmount": 0, "applicationChannel": "applicationChannel", "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }
json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "mainShadowCardNumber": "mainShadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" } }
json
application/json

Virtual Credit Card creation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/createVirtualCard

Creates a virtual credit card for a customer. Supports Masterpass enrollment, end-of-day limit flag, and configurable limits. Returns card reference, shadow card number, masked card number, record ID, warnings, and sensitive card data including PAN, CVV, and expiry date.

Part of:

  • Journey 01 · Launching a new card product — step 4, Issue the card

Virtual Credit Card creation service › Request Body

CreateVirtualCardRequest
limit
​number · double · required

Limit - [Optional]

channel
​string | null

Channel - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

limitType
​string | null

Limit Type - [Optional]

endOfDayFlag
​boolean | null

End Of Day Flag - [Optional]

enrollMasterpass
​boolean | null

Enroll Masterpass - [Optional]

Virtual Credit Card creation service › Responses

Success

CreateVirtualCardResponse
recordId
​integer · int64 · required

Record Id - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

relatedCardRefNumber
​string | null

Related Card Ref Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

​object | null

Warnings - [Optional]

​object

Sensitive Card Data - [Optional]

POST/credit/api/createVirtualCard
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createVirtualCard \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "limitType": "limitType", "endOfDayFlag": true, "limit": 0, "enrollMasterpass": true }'
Example Request Body
{ "channel": "channel", "shadowCardNumber": "shadowCardNumber", "limitType": "limitType", "endOfDayFlag": true, "limit": 0, "enrollMasterpass": true }
json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "relatedCardRefNumber": "relatedCardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" } }
json
application/json

Service that lists eligible products by customer number

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/getApplicableProductsByCustomerNumber

Retrieves all credit card products applicable to a customer. Returns both product-level and customer asset-level information, including digital card capabilities, annual fees, and main card details.

Part of:

  • Journey 01 · Launching a new card product — step 2, Choose the product

Service that lists eligible products by customer number › Request Body

GetApplicableProductsByCustomerNumberRequest
customerNumber
​integer · int64 · required

Customer Number - [Optional]

channel
​string | null

Channel - [Optional]

mainCustomerNumber
​integer | null · int64

Main Customer Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

​object

Filter - [Optional]

Service that lists eligible products by customer number › Responses

Success

GetApplicableProductsByCustomerNumberResponse
​array | null

List Of Product - [Optional]

​array | null

List Of Asset - [Optional]

POST/credit/api/getApplicableProductsByCustomerNumber
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByCustomerNumber \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "customerNumber": 0, "mainCustomerNumber": 0, "shadowCardNumber": "shadowCardNumber", "filter": { "productGroupCode": "productGroupCode" } }'
Example Request Body
{ "channel": "channel", "customerNumber": 0, "mainCustomerNumber": 0, "shadowCardNumber": "shadowCardNumber", "filter": { "productGroupCode": "productGroupCode" } }
json
Example Responses
{ "listOfProduct": [ { "productNumber": "productNumber", "productName": "productName", "productShortName": "productShortName", "brand": "brand", "digitalAbility": true, "tenantId": "tenantId", "supplementaryCard": true, "mainCardInfo": { "currentCard": true, "cardRefNumber": "cardRefNumber", "cardStatusCode": "cardStatusCode", "cardStatusReasonCode": "cardStatusReasonCode", "customerNumber": 0, "digitalCard": true, "mainCardRefNumber": "mainCardRefNumber", "mainCustomerNumber": 0, "maskedCardNumber": "maskedCardNumber", "productNumber": "productNumber", "shadowCardNumber": "shadowCardNumber", "supplementaryCard": true, "statementCurrencyCode": "statementCurrencyCode", "statementPeriod": "statementPeriod", "statementPeriodDescription": "statementPeriodDescription", "nextStatementDate": "nextStatementDate" }, "cardAnnualFeeAmount": 0 } ], "listOfAsset": [ { "currentCard": true, "cardRefNumber": "cardRefNumber", "cardStatusCode": "cardStatusCode", "cardStatusReasonCode": "cardStatusReasonCode", "customerNumber": 0, "digitalCard": true, "mainCardRefNumber": "mainCardRefNumber", "mainCustomerNumber": 0, "maskedCardNumber": "maskedCardNumber", "productNumber": "productNumber", "shadowCardNumber": "shadowCardNumber", "supplementaryCard": true, "statementCurrencyCode": "statementCurrencyCode", "statementPeriod": "statementPeriod", "statementPeriodDescription": "statementPeriodDescription", "nextStatementDate": "nextStatementDate" } ] }
json
application/json

Service that validates main customer existence before listing eligible products

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/getApplicableProductsByMainCustomerPreControl

Checks applicable credit card products for a main customer before control. Returns a success flag indicating whether the pre-control check passed.

Service that validates main customer existence before listing eligible products › Request Body

GetApplicableProductsByMainCustomerRequest
mainCustomerNumber
​integer · int64 · required

Main Customer Number - [Optional]

channel
​string | null

Channel - [Optional]

​object

Filter - [Optional]

Service that validates main customer existence before listing eligible products › Responses

Success

GetApplicableProductsByMainCustomerResponse
isSuccess
​boolean · required

Is Success - [Optional]

POST/credit/api/getApplicableProductsByMainCustomerPreControl
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getApplicableProductsByMainCustomerPreControl \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "channel": "channel", "mainCustomerNumber": 0, "filter": { "productGroupCode": "productGroupCode" } }'
Example Request Body
{ "channel": "channel", "mainCustomerNumber": 0, "filter": { "productGroupCode": "productGroupCode" } }
json
Example Responses
{ "isSuccess": true }
json
application/json

No Name Card creation service

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/createNoNameCard

Creates a no-name credit card for a customer. Supports both digital and physical products, with configurable limits, permissions, accounts, and optional Masterpass enrollment. Returns card reference, shadow card number, masked card number, record ID, warnings, and sensitive card data if applicable.

No Name Card creation service › Request Body

CreateNoNameCardRequest
customerNumber
​integer · int64 · required

Customer Number - [Optional]

branchCode
​integer · int32 · required

Branch Code - [Optional]

cardLimitValue
​number · double · required

Card Limit Value - [Optional]

autoLimitIncreaseFlag
​boolean · required

Auto Limit Increase Flag - [Optional]

barcode
​string | null

Barcode - [Optional]

channel
​string | null

Channel - [Optional]

productNumber
​string | null

Product Number - [Optional]

mainCustomerNumber
​integer | null · int64

Main Customer Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

cardSendAddressType
​string | null

Card Send Address Type - [Optional]

enrollMasterpass
​boolean | null

Enroll Masterpass - [Optional]

​object

Permissions - [Optional]

​array | null

List Of Account - [Optional]

contractType
​string | null

Contract Type - [Optional]

statementPeriod
​string | null

Statement Period - [Optional]

statementCurrencyCode
​string | null

Statement Currency Code - [Optional]

customerLimitValue
​number | null · double

Customer Limit Value - [Optional]

applicationChannel
​string | null

Application Channel - [Optional]

applicationId
​string | null

Application Id - [Optional]

applicationDate
​string | null · date-time

Application Date - [Optional]

applicationContractId
​string | null

Application Contract Id - [Optional]

No Name Card creation service › Responses

Success

CreateNoNameCardResponse
recordId
​integer · int64 · required

Record Id - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

​object | null

Warnings - [Optional]

​object

Sensitive Card Data - [Optional]

POST/credit/api/createNoNameCard
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/createNoNameCard \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "barcode": "barcode", "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "mainCustomerNumber": 0, "mainCardRefNumber": "mainCardRefNumber", "branchCode": 0, "cardSendAddressType": "cardSendAddressType", "enrollMasterpass": true, "permissions": { "eCommercePermitted": true, "mailorderPermitted": true, "internationalPurchasePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "contractType": "contractType", "statementPeriod": "statementPeriod", "statementCurrencyCode": "statementCurrencyCode", "cardLimitValue": 0, "customerLimitValue": 0, "autoLimitIncreaseFlag": true, "applicationChannel": "applicationChannel", "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }'
Example Request Body
{ "barcode": "barcode", "channel": "channel", "productNumber": "productNumber", "customerNumber": 0, "mainCustomerNumber": 0, "mainCardRefNumber": "mainCardRefNumber", "branchCode": 0, "cardSendAddressType": "cardSendAddressType", "enrollMasterpass": true, "permissions": { "eCommercePermitted": true, "mailorderPermitted": true, "internationalPurchasePermitted": true }, "listOfAccount": [ { "accountType": "accountType", "accountNumber": 0, "accountOrderFlag": true, "currencyCode": "currencyCode" } ], "contractType": "contractType", "statementPeriod": "statementPeriod", "statementCurrencyCode": "statementCurrencyCode", "cardLimitValue": 0, "customerLimitValue": 0, "autoLimitIncreaseFlag": true, "applicationChannel": "applicationChannel", "applicationId": "applicationId", "applicationDate": "2024-08-25T15:00:00Z", "applicationContractId": "applicationContractId" }
json
Example Responses
{ "recordId": 0, "maskedCardNumber": "maskedCardNumber", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "warnings": { "key": "string" }, "sensitiveCardData": { "pan": "pan", "expiryDateStr": "expiryDateStr", "cvv": "cvv" } }
json
application/json

Service that cancels card issuance based on the Shadow Card Number

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/cancelCardEmbossByShadowCardNumber

Cancels the embossing process of a credit card using the shadow card number. Validates input before calling the issuing service proxy. Logs the operation start, failure, and completion.

Service that cancels card issuance based on the Shadow Card Number › Request Body

CancelCardEmbossByShadowCardNumberRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

channel
​string | null

Channel - [Optional]

Service that cancels card issuance based on the Shadow Card Number › Responses

Success

No data returned
POST/credit/api/cancelCardEmbossByShadowCardNumber
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/cancelCardEmbossByShadowCardNumber \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "channel": "channel" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "channel": "channel" }
json
Example Responses
No example specified for this content type

Service that lists cards currently in the emboss process

POST
https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit
/credit/api/getPendingCardEmbossList

Retrieves the pending card embossing details for a given ShadowCardNumber. Returns information including card sequence number, emboss date, application date, emboss reason codes and descriptions, emboss status, masked card number, product type code and description, and validity flag. Validates the request to ensure ShadowCardNumber is not null or empty. Logs execution status and errors if the emboss retrieval fails.

Service that lists cards currently in the emboss process › Request Body

GetPendingCardEmbossListRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that lists cards currently in the emboss process › Responses

Success

GetPendingCardEmbossListResponse
cardSeqNumber
​integer | null · int32

Card Seq Number - [Optional]

embossDate
​string | null · date-time

Emboss Date - [Optional]

applicationDate
​string | null · date-time

Application Date - [Optional]

embossReasonCode
​string | null

Emboss Reason Code - [Optional]

embossReasonDescription
​string | null

Emboss Reason Description - [Optional]

embossReasonSubCode
​string | null

Emboss Reason Sub Code - [Optional]

embossReasonSubDesc
​string | null

Emboss Reason Sub Desc - [Optional]

embossStatus
​string | null

Emboss Status - [Optional]

maskedCardNumber
​string | null

Masked Card Number - [Optional]

productTypeCode
​string | null

Product Type Code - [Optional]

productTypeDescription
​string | null

Product Type Description - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

validFlag
​boolean | null

Valid Flag - [Optional]

POST/credit/api/getPendingCardEmbossList
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getPendingCardEmbossList \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "cardSeqNumber": 0, "embossDate": "2024-08-25T15:00:00Z", "applicationDate": "2024-08-25T15:00:00Z", "embossReasonCode": "embossReasonCode", "embossReasonDescription": "embossReasonDescription", "embossReasonSubCode": "embossReasonSubCode", "embossReasonSubDesc": "embossReasonSubDesc", "embossStatus": "embossStatus", "maskedCardNumber": "maskedCardNumber", "productTypeCode": "productTypeCode", "productTypeDescription": "productTypeDescription", "shadowCardNumber": "shadowCardNumber", "validFlag": true }
json
application/json

Card applicationsCard lifecycle