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

Instalments

Split a purchase or a cash advance across a repayment schedule, then track, settle early or cancel the plan.


Service that lists installment transactions eligible for early closure for the given customer and card

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

Service that lists installment transactions eligible for early closure for the given customer and card.

Service that lists installment transactions eligible for early closure for the given customer and card › Request Body

GetEarlyCloseCandidateListRequest
customerNumber
​integer · int64 · required

Customer Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that lists installment transactions eligible for early closure for the given customer and card › Responses

Success

GetEarlyCloseCandidateListResponse
​array | null

List Of Early Close Candidate Row - [Optional]

POST/credit/api/getEarlyCloseCandidateList
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getEarlyCloseCandidateList \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "customerNumber": 0 }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "customerNumber": 0 }
json
Example Responses
{ "listOfEarlyCloseCandidateRow": [ { "customerNumber": 0, "shadowCardNumber": "shadowCardNumber", "trnDate": "2024-08-25T15:00:00Z", "authorizationNumber": "authorizationNumber", "utid": "utid", "totalInstallmentAmount": 0, "totalCapitalAmount": 0, "totalInstallmentProfitAmount": 0, "totalTaxAmount": 0, "installmentCount": 0, "deferringMonthCount": 0, "remainingInstallmentAmount": 0, "remainingCapitalAmount": 0, "remainingInstallmentProfitAmount": 0, "remainingTaxAmount": 0, "remainingInstallmentCount": 0 } ] }
json
application/json

Performs early closure for a given card and transaction

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

Performs early closure of a credit card installment. Returns the early release log record ID and the shadow card number.

Performs early closure for a given card and transaction › Request Body

DoEarlyCloseRequest
feeAmount
​number · double · required

Fee Amount - [Optional]

earlyReleaseType
​integer · int32 · required

Early Release Type - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

utid
​string | null

Utid - [Optional]

Performs early closure for a given card and transaction › Responses

Success

DoEarlyCloseResponse
erLogRecordId
​integer · int64 · required

Er Log Record Id - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

POST/credit/api/doEarlyClose
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doEarlyClose \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "utid": "utid", "feeAmount": 0, "earlyReleaseType": 0 }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "utid": "utid", "feeAmount": 0, "earlyReleaseType": 0 }
json
Example Responses
{ "shadowCardNumber": "shadowCardNumber", "erLogRecordId": 0 }
json
application/json

Service that returns min/max installment counts applicable to the transaction for a given UTID

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

Retrieves the installment counts and limits for a credit card transaction identified by UTID. Returns minimum and maximum installment counts, deferring month limits, MCC-based limits, profile-based limits, and transaction details (amount, date, description). Adjusts MaxInstallmentCount and MaxDeferringMonthCount if the transaction occurs in an emergency city.

Service that returns min/max installment counts applicable to the transaction for a given UTID › Request Body

GetInstallmentCountsByUtidRequest
Utid
​string | null

Utid - [Optional]

Service that returns min/max installment counts applicable to the transaction for a given UTID › Responses

Success

GetInstallmentCountsByUtidResponse
Amount
​number · double · required

Amount - [Optional]

Date
​string · date-time · required

Date - [Optional]

MinInstallmentCount
​integer | null · int32

Min Installment Count - [Optional]

MaxInstallmentCount
​integer | null · int32

Max Installment Count - [Optional]

MinDeferringMonthCount
​integer | null · int32

Min Deferring Month Count - [Optional]

MaxDeferringMonthCount
​integer | null · int32

Max Deferring Month Count - [Optional]

InstallmentCountLimit
​integer | null · int32

Installment Count Limit - [Optional]

InstallmentCountMccGroupLimit
​integer | null · int32

Installment Count Mcc Group Limit - [Optional]

InstallmentCountMccLimit
​integer | null · int32

Installment Count Mcc Limit - [Optional]

InstallmentProfileDeferringLimit
​integer | null · int32

Installment Profile Deferring Limit - [Optional]

InstallmentProfileInstallmentLimit
​integer | null · int32

Installment Profile Installment Limit - [Optional]

MccDefinitionInstallmentLimit
​integer | null · int32

Mcc Definition Installment Limit - [Optional]

Description
​string | null

Description - [Optional]

POST/credit/api/getInstallmentCountsByUtid
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getInstallmentCountsByUtid \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "Utid": "Utid" }'
Example Request Body
{ "Utid": "Utid" }
json
Example Responses
{ "MinInstallmentCount": 0, "MaxInstallmentCount": 0, "MinDeferringMonthCount": 0, "MaxDeferringMonthCount": 0, "InstallmentCountLimit": 0, "InstallmentCountMccGroupLimit": 0, "InstallmentCountMccLimit": 0, "InstallmentProfileDeferringLimit": 0, "InstallmentProfileInstallmentLimit": 0, "MccDefinitionInstallmentLimit": 0, "Amount": 0, "Date": "2024-08-25T15:00:00Z", "Description": "Description" }
json
application/json

Service that returns interest/profit share rates and amounts for installment ranges for a cash-advance request

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

Retrieves cash installment parameters for a given shadow card and transaction amount. Returns a list of installment options including minimum and maximum installment counts, transaction amount limits, profit rates, and fees. Requires a valid ShadowCardNumber.

Part of:

  • Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)

  • Journey 03 · Enabling additional capabilities — step 2, Same services, debit card

Service that returns interest/profit share rates and amounts for installment ranges for a cash-advance request › Request Body

GetCashInstallmentParameterRequest
transactionAmount
​number · double · required

Transaction Amount - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

accountNumber
​string | null

Account Number - [Optional]

channelId
​string | null

Channel Id - [Optional]

Service that returns interest/profit share rates and amounts for installment ranges for a cash-advance request › Responses

Success

GetCashInstallmentParameterResponse
​array | null

Cash Installment Parameter List - [Optional]

POST/credit/api/getCashInstallmentParameter
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCashInstallmentParameter \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "accountNumber": "accountNumber", "transactionAmount": 0, "channelId": "channelId" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "accountNumber": "accountNumber", "transactionAmount": 0, "channelId": "channelId" }
json
Example Responses
{ "cashInstallmentParameterList": [ { "minInstallmentCount": 0, "maxInstallmentCount": 0, "minTrnAmount": 0, "maxTrnAmount": 0, "profitRate": 0, "feeAmount": 0 } ] }
json
application/json

Service that returns interest/profit share rates and amounts for all possible installment options for a cash-advance request

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

Simulates cash installments for all possible installment counts, providing a detailed breakdown of the total amount, installment amounts, profit, fees, and the remaining balance for each installment count.

Part of:

  • Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)

  • Journey 03 · Enabling additional capabilities — step 2, Same services, debit card

Service that returns interest/profit share rates and amounts for all possible installment options for a cash-advance request › Request Body

SimulateCashInstallmentForAllRequest
transactionAmount
​number · double · required

Transaction Amount - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

accountNumber
​string | null

Account Number - [Optional]

channelId
​string | null

Channel Id - [Optional]

Service that returns interest/profit share rates and amounts for all possible installment options for a cash-advance request › Responses

Success

SimulateCashInstallmentForAllResponse
​array | null

Cash Installment Simulate List - [Optional]

POST/credit/api/simulateCashInstallmentForAll
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/simulateCashInstallmentForAll \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "accountNumber": "accountNumber", "transactionAmount": 0, "channelId": "channelId" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "accountNumber": "accountNumber", "transactionAmount": 0, "channelId": "channelId" }
json
Example Responses
{ "cashInstallmentSimulateList": [ { "totalAmount": 0, "totalProfitAmount": 0, "totalBsmvAmount": 0, "totalKkdfAmount": 0, "insterestRate": 0, "firstInstallAmount": 0, "installmentAmount": 0, "installmentDate": "2024-08-25T15:00:00Z", "installmentCount": 0, "installmentList": [ { "installmentNumber": 0, "installmentDate": "2024-08-25T15:00:00Z", "installmentAmount": 0, "installmentCapitalAmount": 0, "installmentProfitAmount": 0, "installmentBsmvAmount": 0, "installmentKkdfAmount": 0, "remainingTotalAmount": 0, "remainingCapitalAmount": 0, "remainingProfitAmount": 0, "remainingBsmvAmount": 0, "remainingKkdfAmount": 0 } ] } ] }
json
application/json

Service that returns interest/profit share rates and amounts based on selected installment count for a cash-advance request

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

Simulates the cash installment process for a given card, calculating the installment amounts, profit, and other associated fees based on the requested installment count and transaction amount.

Service that returns interest/profit share rates and amounts based on selected installment count for a cash-advance request › Request Body

SimulateCashInstallmentRequest
transactionAmount
​number · double · required

Transaction Amount - [Optional]

installmentCount
​integer · int32 · required

Installment Count - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

accountNumber
​string | null

Account Number - [Optional]

channelId
​string | null

Channel Id - [Optional]

Service that returns interest/profit share rates and amounts based on selected installment count for a cash-advance request › Responses

Success

SimulateCashInstallmentResponse
​object

Cash Installment Simulate Item - [Optional]

POST/credit/api/simulateCashInstallment
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/simulateCashInstallment \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "accountNumber": "accountNumber", "transactionAmount": 0, "installmentCount": 0, "channelId": "channelId" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "accountNumber": "accountNumber", "transactionAmount": 0, "installmentCount": 0, "channelId": "channelId" }
json
Example Responses
{ "cashInstallmentSimulateItem": { "totalAmount": 0, "totalProfitAmount": 0, "totalBsmvAmount": 0, "totalKkdfAmount": 0, "insterestRate": 0, "firstInstallAmount": 0, "installmentAmount": 0, "installmentDate": "2024-08-25T15:00:00Z", "installmentCount": 0, "installmentList": [ { "installmentNumber": 0, "installmentDate": "2024-08-25T15:00:00Z", "installmentAmount": 0, "installmentCapitalAmount": 0, "installmentProfitAmount": 0, "installmentBsmvAmount": 0, "installmentKkdfAmount": 0, "remainingTotalAmount": 0, "remainingCapitalAmount": 0, "remainingProfitAmount": 0, "remainingBsmvAmount": 0, "remainingKkdfAmount": 0 } ] } }
json
application/json

Installment cash advance service

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

Processes a cash installment payment (early release). Returns transaction ID, authorization number, UTID, and RRN.

Part of:

  • Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)

  • Journey 03 · Enabling additional capabilities — step 2, Same services, debit card

Installment cash advance service › Request Body

DoCashInstallmentRequest
transactionAmount
​number · double · required

Transaction Amount - [Optional]

installmentCount
​integer · int32 · required

Installment Count - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

accountNumber
​string | null

Account Number - [Optional]

referenceNumber
​string | null

Reference Number - [Optional]

channelId
​string | null

Channel Id - [Optional]

Installment cash advance service › Responses

Success

DoCashInstallmentResponse
isSuccess
​boolean · required

Is Success - [Optional]

feeAmount
​number · double · required

Fee Amount - [Optional]

uTID
​string | null

U T I D - [Optional]

authCode
​string | null

Auth Code - [Optional]

responseCode
​string | null

Response Code - [Optional]

responseReasonCode
​string | null

Response Reason Code - [Optional]

reasonDescription
​string | null

Reason Description - [Optional]

rrn
​string | null

Rrn - [Optional]

POST/credit/api/doCashInstallment
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doCashInstallment \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "accountNumber": "accountNumber", "referenceNumber": "referenceNumber", "transactionAmount": 0, "installmentCount": 0, "channelId": "channelId" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "accountNumber": "accountNumber", "referenceNumber": "referenceNumber", "transactionAmount": 0, "installmentCount": 0, "channelId": "channelId" }
json
Example Responses
{ "uTID": "uTID", "authCode": "authCode", "responseCode": "responseCode", "responseReasonCode": "responseReasonCode", "reasonDescription": "reasonDescription", "isSuccess": true, "feeAmount": 0, "rrn": "rrn" }
json
application/json

Service that fully or partially closes installment cash advances

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

Reverses a cash installment transaction using the provided amount, shadow card number, UTID, and reference number.

Part of:

  • Journey 03 · Enabling additional capabilities — step 2, Installment cash (IPP)

Service that fully or partially closes installment cash advances › Request Body

ReverseCashInstallmentRequest
amount
​number · double · required

Amount - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

uTID
​string | null

U T I D - [Optional]

referenceNumber
​string | null

Reference Number - [Optional]

Service that fully or partially closes installment cash advances › Responses

Success

ReverseCashInstallmentResponse
isSuccess
​boolean · required

Is Success - [Optional]

uTID
​string | null

U T I D - [Optional]

authCode
​string | null

Auth Code - [Optional]

responseReasonCode
​string | null

Response Reason Code - [Optional]

POST/credit/api/reverseCashInstallment
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/reverseCashInstallment \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "amount": 0, "shadowCardNumber": "shadowCardNumber", "uTID": "uTID", "referenceNumber": "referenceNumber" }'
Example Request Body
{ "amount": 0, "shadowCardNumber": "shadowCardNumber", "uTID": "uTID", "referenceNumber": "referenceNumber" }
json
Example Responses
{ "uTID": "uTID", "authCode": "authCode", "responseReasonCode": "responseReasonCode", "isSuccess": true }
json
application/json

Service that lists installment cash advances eligible for cancellation

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

Retrieves a list of cancellable cash installments for a given shadow card number, including transaction details and card master information.

Service that lists installment cash advances eligible for cancellation › Request Body

GetCancelableCashInstallmentListRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that lists installment cash advances eligible for cancellation › Responses

Success

GetCancelableCashInstallmentListResponse
​array | null

List Of Cash Installment - [Optional]

POST/credit/api/getCancelableCashInstallmentList
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCancelableCashInstallmentList \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "listOfCashInstallment": [ { "cardRefNumber": "cardRefNumber", "customerNumber": 0, "mainCardRefNumber": "mainCardRefNumber", "mainCustomerNumber": 0, "shadowCardNumber": "shadowCardNumber", "trnAmount": 0, "trnDescription": "trnDescription", "utid": "utid", "trnDate": "2024-08-25T15:00:00Z" } ] }
json
application/json

Service that lists early-closed installment cash advances

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

Retrieves cash installment transactions available for early release for a given ShadowCardNumber. Returns a list of transactions with details including total installment amount, installment count, fees, profit, taxes (Bsmv, Kkdf, interest), remaining installment capital, and a breakdown of each installment in DetailList with dates, amounts, and flags.

Service that lists early-closed installment cash advances › Request Body

GetEarlyReleaseCashInstallmentsRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that lists early-closed installment cash advances › Responses

Success

GetEarlyReleaseCashInstallmentsResponse
​array | null

Transaction List - [Optional]

POST/credit/api/getEarlyReleaseCashInstallments
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseCashInstallments \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "transactionList": [ { "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "utid": "utid", "transactionDate": "2024-08-25T15:00:00Z", "transactionAmount": 0, "installmentCount": 0, "totalFeeAmount": 0, "installmentProfitRate": 0, "totalInstallmentAmount": 0, "remainingInstallmentCount": 0, "remainingInstallmentCapitalAmount": 0, "earlyReleaseTotalAmount": 0, "earlyReleaseInterestAmount": 0, "earlyReleaseTotalTaxAmount": 0, "earlyReleaseBsmvAmount": 0, "earlyReleaseKkdfAmount": 0, "detailList": [ { "installmentNumber": 0, "installmentDate": "2024-08-25T15:00:00Z", "installmentAmount": 0, "installmentCapitalAmount": 0, "installmentProfitAmount": 0, "installmentBsmvAmount": 0, "installmentKkdfAmount": 0, "statementFlag": true, "moveCurrentFlag": true } ] } ] }
json
application/json

Service that returns early-closed installment cash advance details

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

Service that returns early-closed installment cash advance details.

Service that returns early-closed installment cash advance details › Request Body

GetEarlyReleaseCashInstallmentRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

utid
​string | null

Utid - [Optional]

Service that returns early-closed installment cash advance details › Responses

Success

GetEarlyReleaseCashInstallmentResponse
transactionDate
​string · date-time · required

Transaction Date - [Optional]

transactionAmount
​number · double · required

Transaction Amount - [Optional]

installmentCount
​integer · int32 · required

Installment Count - [Optional]

totalFeeAmount
​number · double · required

Total Fee Amount - [Optional]

installmentProfitRate
​number · double · required

Installment Profit Rate - [Optional]

totalInstallmentAmount
​number · double · required

Total Installment Amount - [Optional]

remainingInstallmentCount
​integer · int32 · required

Remaining Installment Count - [Optional]

remainingInstallmentCapitalAmount
​number · double · required

Remaining Installment Capital Amount - [Optional]

earlyReleaseTotalAmount
​number · double · required

Early Release Total Amount - [Optional]

earlyReleaseInterestAmount
​number · double · required

Early Release Interest Amount - [Optional]

earlyReleaseTotalTaxAmount
​number · double · required

Early Release Total Tax Amount - [Optional]

earlyReleaseBsmvAmount
​number · double · required

Early Release Bsmv Amount - [Optional]

earlyReleaseKkdfAmount
​number · double · required

Early Release Kkdf Amount - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

utid
​string | null

Utid - [Optional]

POST/credit/api/getEarlyReleaseCashInstallment
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseCashInstallment \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "utid": "utid" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "utid": "utid" }
json
Example Responses
{ "shadowCardNumber": "shadowCardNumber", "mainCardRefNumber": "mainCardRefNumber", "utid": "utid", "transactionDate": "2024-08-25T15:00:00Z", "transactionAmount": 0, "installmentCount": 0, "totalFeeAmount": 0, "installmentProfitRate": 0, "totalInstallmentAmount": 0, "remainingInstallmentCount": 0, "remainingInstallmentCapitalAmount": 0, "earlyReleaseTotalAmount": 0, "earlyReleaseInterestAmount": 0, "earlyReleaseTotalTaxAmount": 0, "earlyReleaseBsmvAmount": 0, "earlyReleaseKkdfAmount": 0 }
json
application/json

Early closure of installment cash advance service

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

Processes an early release cash installment payment. Returns UTID, transaction ID, authorization number, and RRN.

Early closure of installment cash advance service › Request Body

DoCashInstallmentEarlyReleasePaymentRequest
accountNumber
​integer · int32 · required

Account Number - [Optional]

amount
​number · double · required

Amount - [Optional]

clientReferenceNumber
​integer · int64 · required

Client Reference Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

channel
​string | null

Channel - [Optional]

currencyCode
​string | null

Currency Code - [Optional]

cashInstallmentUtid
​string | null

Cash Installment Utid - [Optional]

Early closure of installment cash advance service › Responses

Success

DoCashInstallmentEarlyReleasePaymentResponse
trnId
​integer · int64 · required

Trn Id - [Optional]

utid
​string | null

Utid - [Optional]

rrn
​string | null

Rrn - [Optional]

authorizationNumber
​string | null

Authorization Number - [Optional]

POST/credit/api/doCashInstallmentEarlyReleasePayment
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/doCashInstallmentEarlyReleasePayment \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "accountNumber": 0, "amount": 0, "clientReferenceNumber": 0, "shadowCardNumber": "shadowCardNumber", "channel": "channel", "currencyCode": "currencyCode", "cashInstallmentUtid": "cashInstallmentUtid" }'
Example Request Body
{ "accountNumber": 0, "amount": 0, "clientReferenceNumber": 0, "shadowCardNumber": "shadowCardNumber", "channel": "channel", "currencyCode": "currencyCode", "cashInstallmentUtid": "cashInstallmentUtid" }
json
Example Responses
{ "utid": "utid", "trnId": 0, "rrn": "rrn", "authorizationNumber": "authorizationNumber" }
json
application/json

Service that cancels an installment transaction that was previously closed early

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

Cancels an early release cash installment payment for a credit card. Calls the transaction management service to reverse the payment using transaction ID, amount, currency, card reference, and other identifiers. Returns the transaction ID of the cancellation.

Service that cancels an installment transaction that was previously closed early › Request Body

CancelCashInstallEarlyReleasePaymentRequest
clientReferenceNumber
​integer · int64 · required

Client Reference Number - [Optional]

trnId
​integer | null · int64

Trn Id - [Optional]

amount
​number | null · double

Amount - [Optional]

currencyCode
​string | null

Currency Code - [Optional]

cardRefNumber
​string | null

Card Ref Number - [Optional]

mainCustomerNumber
​integer | null · int64

Main Customer Number - [Optional]

trnDate
​string | null · date-time

Trn Date - [Optional]

channel
​string | null

Channel - [Optional]

cashInstallmentUtid
​string | null

Cash Installment Utid - [Optional]

Service that cancels an installment transaction that was previously closed early › Responses

Success

CancelCashInstallEarlyReleasePaymentResponse
trnId
​integer · int64 · required

Trn Id - [Optional]

POST/credit/api/cancelCashInstallEarlyReleasePayment
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/cancelCashInstallEarlyReleasePayment \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "trnId": 0, "amount": 0, "currencyCode": "currencyCode", "clientReferenceNumber": 0, "cardRefNumber": "cardRefNumber", "mainCustomerNumber": 0, "trnDate": "2024-08-25T15:00:00Z", "channel": "channel", "cashInstallmentUtid": "cashInstallmentUtid" }'
Example Request Body
{ "trnId": 0, "amount": 0, "currencyCode": "currencyCode", "clientReferenceNumber": 0, "cardRefNumber": "cardRefNumber", "mainCustomerNumber": 0, "trnDate": "2024-08-25T15:00:00Z", "channel": "channel", "cashInstallmentUtid": "cashInstallmentUtid" }
json
Example Responses
{ "trnId": 0 }
json
application/json

Service that lists all pending installments

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

Retrieves all waiting (pending) credit card installments for a given shadow card number. Returns both summary and detailed installment information grouped by statement date.

Part of:

  • Journey 03 · Enabling additional capabilities — step 3, Track waiting installments

Service that lists all pending installments › Request Body

GetAllWaitingInstallmentsRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that lists all pending installments › Responses

Success

GetAllWaitingInstallmentsResponse
​array | null

Result

POST/credit/api/getAllWaitingInstallments
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getAllWaitingInstallments \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "result": [ { "details": [ { "utid": "utid", "recordId": 0, "trnCodeMatrixId": "trnCodeMatrixId", "statementDate": "2024-08-25T15:00:00Z", "installmentAmount": 0, "amount": 0, "trnAmount": 0, "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "maskedCardNumber": "maskedCardNumber", "creditCardStatementTransactionTypeIsBorrow": true, "creditCardStatementTransactionTypeIsLoan": true, "domesticAmount": 0, "installmentCurrencyCode": "installmentCurrencyCode", "currencyCode": "currencyCode", "trnCurrencyCode": "trnCurrencyCode", "totalPointEarned": 0, "installmentNumber": 0, "mCCCode": "mCCCode", "mCCDescription": "mCCDescription", "mCCGroupCode": "mCCGroupCode", "mCCGroupDescription": "mCCGroupDescription", "originalAmount": 0, "totalInstallmentCount": 0, "transactionCode": "transactionCode", "transactionDate": "2024-08-25T15:00:00Z", "transactionDescription": "transactionDescription", "productNumber": "productNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "trnEffect": "trnEffect", "channelType": "channelType", "remainInstallmentAmount": 0, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "supplementaryCardFlag": true, "erOrderedFlag": true, "digitalSlipFlag": true, "digitalSlipValue": "digitalSlipValue", "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription", "authorizationNumber": "authorizationNumber", "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "panEntryMode": "panEntryMode", "panEntryModeDescription": "panEntryModeDescription", "merchantName": "merchantName", "merchantNumber": "merchantNumber" } ], "summary": { "statementDate": "2024-08-25T15:00:00Z", "totalInstallmentAmount": 0, "totalInstallmentBsmvAmount": 0, "totalInstallmentCapitalAmount": 0, "totalInstallmentFeeAmount": 0, "totalInstallmentKkdfAmount": 0, "totalInstallmentProfitAmount": 0 } } ] }
json
application/json

Service that returns details of a pending installment transaction

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

Retrieves the waiting (upcoming) installment details for a credit card. The service first validates the card using the shadow card number, then fetches the list of waiting installments, including transaction details, amounts, dates, MCC info, product info, reward info, and installment attributes. Supports both current and new repository methods for fetching waiting installment details. The response is mapped to CreditCardNextPeriodInstallmentModel, and transactions can also be mapped to CreditCardDetailTransactionItem for client consumption.

Part of:

  • Journey 03 · Enabling additional capabilities — step 3, Track waiting installments

Service that returns details of a pending installment transaction › Request Body

GetWaitingInstallmentDetailRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that returns details of a pending installment transaction › Responses

Success

CreditCardNextPeriodInstallmentModel
totalAmount
​number · double · required

Total Amount - [Optional]

​array | null

List Of Next Period Installment - [Optional]

currencyCode
​string | null

Currency Code - [Optional]

POST/credit/api/getWaitingInstallmentDetail
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getWaitingInstallmentDetail \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "listOfNextPeriodInstallment": [ { "statementDate": "2024-08-25T15:00:00Z", "totalAmount": 0, "listOfTransaction": [ { "remainingInstallAmount": 0, "utid": "utid", "authorizationNumber": "authorizationNumber", "panEntryMode": "panEntryMode", "panEntryModeDescription": "panEntryModeDescription", "rrn": "rrn", "amount": 0, "currencyCode": "currencyCode", "trnAmount": 0, "trnCurrencyCode": "trnCurrencyCode", "date": "2024-08-25T15:00:00Z", "description": "description", "earnedPoint": { "amount": 0, "rewardType": "rewardType", "rewardTypeDescription": "rewardTypeDescription" }, "isDeferrable": true, "isSplittableIntoInstallments": true, "totalInstallmentCount": 0, "currentInstallmentNumber": 0, "trnCodeMatrixId": "trnCodeMatrixId", "trnCodeMatrixDescription": "trnCodeMatrixDescription", "shadowCardNumber": "shadowCardNumber", "cardRefNumber": "cardRefNumber", "maskedCardNumber": "maskedCardNumber", "mainCardRefNumber": "mainCardRefNumber", "cardProductVirtualFlag": true, "cardProductDigitalFlag": true, "capitalRewardIndicator": "capitalRewardIndicator", "mcc": "mcc", "mccGroupCode": "mccGroupCode", "mCCGroupDescription": "mCCGroupDescription", "mccDescription": "mccDescription", "trnEffect": "trnEffect", "channelType": "channelType", "channelTypeDescription": "channelTypeDescription", "sourceNetwork": "sourceNetwork", "networkTypeDescription": "networkTypeDescription", "supplementaryCardFlag": true, "bkmUniqueMerchantId": "bkmUniqueMerchantId", "installOrderedFlag": true, "orderedInstallCount": 0, "orderedDeferCount": 0, "recordId": 0, "earlyReleaseOrderedFlag": true, "statementFlag": true, "digitalSlipFlag": true, "digitalSlipValue": "digitalSlipValue", "currentEodDate": "2024-08-25T15:00:00Z", "feeAmount": 0, "bsmvAmount": 0, "kkdfAmount": 0, "installmentFeeAmount": 0, "installmentProfitAmount": 0, "merchantName": "merchantName", "merchantNumber": "merchantNumber", "nextStatementDate": "2024-08-25T15:00:00Z", "nextDueDate": "2024-08-25T15:00:00Z" } ] } ], "totalAmount": 0, "currencyCode": "currencyCode" }
json
application/json

Service that returns total interest/profit share and fee amounts for all pending installments of a card

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

Retrieves a summary of waiting (upcoming) installments for a credit card. The service validates the card using the shadow card number, fetches the installment summary from the repository, and aggregates amounts by statement date, including total installment amount, fees, taxes (KKDF, BSMV), profit, and capital. The result is returned as a list of WaitingInstallmentSummaryInfo within GetWaitingInstallmentSummaryResponse.

Part of:

  • Journey 03 · Enabling additional capabilities — step 3, Track waiting installments

Service that returns total interest/profit share and fee amounts for all pending installments of a card › Request Body

GetWaitingInstallmentSummaryRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that returns total interest/profit share and fee amounts for all pending installments of a card › Responses

Success

GetWaitingInstallmentSummaryResponse
​array | null

List Waiting Installment Summary Info - [Optional]

POST/credit/api/getWaitingInstallmentSummary
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getWaitingInstallmentSummary \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "listWaitingInstallmentSummaryInfo": [ { "statementDate": "2024-08-25T15:00:00Z", "totalInstallmentAmount": 0, "totalInstallmentBsmvAmount": 0, "totalInstallmentCapitalAmount": 0, "totalInstallmentFeeAmount": 0, "totalInstallmentKkdfAmount": 0, "totalInstallmentProfitAmount": 0 } ] }
json
application/json

Service that receives a manual installment request

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

Places a manual installment order for a credit card transaction. It uses the transaction management service to create an installment order based on the shadow card number, transaction ID (UTID), installment count, and deferring month count. The response includes the InstallmentOrderRecordId for tracking.

Part of:

  • Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)

Service that receives a manual installment request › Request Body

ManuelInstallmentOrderRequest
installmentCount
​integer · int32 · required

Installment Count - [Optional]

deferringMonthCount
​integer · int32 · required

Deferring Month Count - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

utid
​string | null

Utid - [Optional]

channelType
​string | null

Channel Type - [Optional]

Service that receives a manual installment request › Responses

Success

ManuelInstallmentOrderResponse
installmentOrderRecordId
​integer · int64 · required

Installment Order Record Id - [Optional]

POST/credit/api/manuelInstallmentOrder
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/manuelInstallmentOrder \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "installmentCount": 0, "shadowCardNumber": "shadowCardNumber", "utid": "utid", "deferringMonthCount": 0, "channelType": "channelType" }'
Example Request Body
{ "installmentCount": 0, "shadowCardNumber": "shadowCardNumber", "utid": "utid", "deferringMonthCount": 0, "channelType": "channelType" }
json
Example Responses
{ "installmentOrderRecordId": 0 }
json
application/json

Manual installment simulation service

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

Simulates a manual installment order for a credit card transaction. Returns projected installment details including installment amount, total payment amount, profit rate, and a breakdown of total PFT (Profit, BSMV, KKDF, and fees). The response includes a list of simulated installment records with installment number, capital amount, installment date, and remaining total amount.

Part of:

  • Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)

Manual installment simulation service › Request Body

ManuelInstallmentOrderSimulateRequest
installmentCount
​integer · int32 · required

Installment Count - [Optional]

deferringMonthCount
​integer · int32 · required

Deferring Month Count - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

utid
​string | null

Utid - [Optional]

Manual installment simulation service › Responses

Success

ManuelInstallmentOrderSimulateResponse
installmentAmount
​number · double · required

Installment Amount - [Optional]

profitRate
​number · double · required

Profit Rate - [Optional]

totalPaymentAmount
​number · double · required

Total Payment Amount - [Optional]

totalPFTAmount
​number · double · required

Total P F T Amount - [Optional]

installmentCount
​integer · int32 · required

Installment Count - [Optional]

deferringMonthCount
​integer · int32 · required

Deferring Month Count - [Optional]

​array | null

List Of Installment Record - [Optional]

POST/credit/api/manuelInstallmentOrderSimulate
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/manuelInstallmentOrderSimulate \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "installmentCount": 0, "shadowCardNumber": "shadowCardNumber", "utid": "utid", "deferringMonthCount": 0 }'
Example Request Body
{ "installmentCount": 0, "shadowCardNumber": "shadowCardNumber", "utid": "utid", "deferringMonthCount": 0 }
json
Example Responses
{ "installmentAmount": 0, "profitRate": 0, "totalPaymentAmount": 0, "totalPFTAmount": 0, "installmentCount": 0, "deferringMonthCount": 0, "listOfInstallmentRecord": [ { "installmentNumber": 0, "installmentAmount": 0, "installmentDate": "2024-08-25T15:00:00Z", "installmentCapitalAmount": 0, "remainingTotalAmount": 0 } ] }
json
application/json

Service that returns installment options applicable to a transaction for a given UTID

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

Retrieves the installment counts and limits for a credit card transaction identified by UTID using the new DCIC logic. Returns minimum and maximum installment counts, deferring month limits, MCC-based limits, profile-based limits, and transaction details (amount, date, description). Adjusts MaxInstallmentCount and MaxDeferringMonthCount if the transaction occurs in an emergency city. Unlike the previous version, this method fetches the installment info directly from the DCIC new repository without querying the full customer transaction details.

Part of:

  • Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)

Service that returns installment options applicable to a transaction for a given UTID › Request Body

GetInstallmentCountsByUtidRequest
Utid
​string | null

Utid - [Optional]

Service that returns installment options applicable to a transaction for a given UTID › Responses

Success

GetInstallmentCountsByUtidResponse
Amount
​number · double · required

Amount - [Optional]

Date
​string · date-time · required

Date - [Optional]

MinInstallmentCount
​integer | null · int32

Min Installment Count - [Optional]

MaxInstallmentCount
​integer | null · int32

Max Installment Count - [Optional]

MinDeferringMonthCount
​integer | null · int32

Min Deferring Month Count - [Optional]

MaxDeferringMonthCount
​integer | null · int32

Max Deferring Month Count - [Optional]

InstallmentCountLimit
​integer | null · int32

Installment Count Limit - [Optional]

InstallmentCountMccGroupLimit
​integer | null · int32

Installment Count Mcc Group Limit - [Optional]

InstallmentCountMccLimit
​integer | null · int32

Installment Count Mcc Limit - [Optional]

InstallmentProfileDeferringLimit
​integer | null · int32

Installment Profile Deferring Limit - [Optional]

InstallmentProfileInstallmentLimit
​integer | null · int32

Installment Profile Installment Limit - [Optional]

MccDefinitionInstallmentLimit
​integer | null · int32

Mcc Definition Installment Limit - [Optional]

Description
​string | null

Description - [Optional]

POST/credit/api/getInstallmentCountsByUtidNew
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getInstallmentCountsByUtidNew \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "Utid": "Utid" }'
Example Request Body
{ "Utid": "Utid" }
json
Example Responses
{ "MinInstallmentCount": 0, "MaxInstallmentCount": 0, "MinDeferringMonthCount": 0, "MaxDeferringMonthCount": 0, "InstallmentCountLimit": 0, "InstallmentCountMccGroupLimit": 0, "InstallmentCountMccLimit": 0, "InstallmentProfileDeferringLimit": 0, "InstallmentProfileInstallmentLimit": 0, "MccDefinitionInstallmentLimit": 0, "Amount": 0, "Date": "2024-08-25T15:00:00Z", "Description": "Description" }
json
application/json

Early installment closure reversal service

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

Cancels an early release of an installment for a given card identified by ShadowCardNumber and UTID. Returns the number of affected rows as EffectedRowCount.

Early installment closure reversal service › Request Body

CancelInstallmentEarlyReleaseRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

utid
​string | null

Utid - [Optional]

Early installment closure reversal service › Responses

Success

CancelInstallmentEarlyReleaseResponse
effectedRowCount
​integer · int32 · required

Effected Row Count - [Optional]

POST/credit/api/cancelInstallmentEarlyRelease
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/cancelInstallmentEarlyRelease \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "utid": "utid" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "utid": "utid" }
json
Example Responses
{ "effectedRowCount": 0 }
json
application/json

Service that returns manual installment cancellation list

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

Retrieves the manual installment cancellation records for a given card reference number or shadow card number. Returns details such as installment count, amount, deferring month, fee and profit amounts, transaction source, merchant, processing flags, and relevant dates. Throws an error if both CardRefNumber and ShadowCardNumber are null. This method helps track manually canceled installments for credit card transactions.

Service that returns manual installment cancellation list › Request Body

GetManuelInstallmentCancelRecordsByCardRefNumberRequest
cardRefNumber
​string | null

Card Ref Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that returns manual installment cancellation list › Responses

Success

GetManuelInstallmentCancelRecordsByCardRefNumberResponse
​array | null

Manuel Installment Cancel Records - [Optional]

POST/credit/api/getManuelInstallmentCancelRecordsByCardRefNumber
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getManuelInstallmentCancelRecordsByCardRefNumber \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "cardRefNumber": "cardRefNumber", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "cardRefNumber": "cardRefNumber", "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "manuelInstallmentCancelRecords": [ { "CardRefNumber": "CardRefNumber", "Channel": "Channel", "DeferringDate": "2024-08-25T15:00:00Z", "DeferringMonth": 0, "FeeRate": 0, "FixedFeeAmount": 0, "InsertUserId": "InsertUserId", "InstallmentAmount": 0, "InstallmentCode": "InstallmentCode", "InstallmentCount": 0, "InstallmentProfitRate": 0, "InstallmentPriority": 0, "InstallmentProfitAmount": 0, "MaskedCardNumber": "MaskedCardNumber", "MerchantName": "MerchantName", "ProcessedDate": "2024-08-25T15:00:00Z", "ProcessedFlag": true, "RecordId": 0, "InstallmentTaxAmount": 0, "TrnAmount": 0, "TrnDate": "2024-08-25T15:00:00Z", "TrnSource": 0, "ValidFlag": true, "Utid": "Utid", "InstallmentOrderDate": "2024-08-25T15:00:00Z", "ShadowCardNumber": "ShadowCardNumber", "SupplementaryCardFlag": true } ] }
json
application/json

Service that lists installments eligible for early closure based on selected criteria

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

Retrieves available installments for early release based on criteria such as CardRefNumber, MainCardRefNumber, or ShadowCardNumber. Returns detailed installment information including remaining principal, fees, profit, taxes, installment counts, transaction details, merchant information, and totals. Supports subsequent simulation and release of early installments.

Part of:

  • Journey 03 · Enabling additional capabilities — step 4, Early settlement

Service that lists installments eligible for early closure based on selected criteria › Request Body

GetEarlyReleaseAvailableInstallmentsByCriteriasRequest
cardRefNumber
​string | null

Card Ref Number - [Optional]

mainCardRefNumber
​string | null

Main Card Ref Number - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

Service that lists installments eligible for early closure based on selected criteria › Responses

Success

GetEarlyReleaseAvailableInstallmentsByCriteriasResponse
​array | null

Installment Early Release Rows - [Optional]

POST/credit/api/getEarlyReleaseAvailableInstallmentsByCriterias
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getEarlyReleaseAvailableInstallmentsByCriterias \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "shadowCardNumber": "shadowCardNumber" }'
Example Request Body
{ "cardRefNumber": "cardRefNumber", "mainCardRefNumber": "mainCardRefNumber", "shadowCardNumber": "shadowCardNumber" }
json
Example Responses
{ "InstallmentEarlyReleaseRows": [ { "AuthorizationNumber": "AuthorizationNumber", "DeferringDay": 0, "DeferringFlag": true, "InstallmentCapitalAmount": 0, "InstallmentCount": 0, "InstallmentFeeAmount": 0, "InstallmentProfitAmount": 0, "InstallmentTax1Amount": 0, "InstallmentTax2Amount": 0, "MaskedCardNumber": "MaskedCardNumber", "MerchantName": "MerchantName", "RemainingCapitalAmount": 0, "RemainingFeeAmount": 0, "RemainingInstallmentAmount": 0, "RemainingInstallmentCount": 0, "RemainingInstallmentProfitAmount": 0, "RemainingInstallmentBsmvAmount": 0, "RemainingTax": 0, "Tax": 0, "RemainingInstallmentKkdfAmount": 0, "ShadowCardNumber": "ShadowCardNumber", "TotalCapitalAmount": 0, "TotalInstallmentAmount": 0, "TotalInstallmentProfitAmount": 0, "TotalInstallmentBsmvAmount": 0, "TotalInstallmentKkdfAmount": 0, "TotalFeeAmount": 0, "TrnDate": "2024-08-25T15:00:00Z", "TrnDescription": "TrnDescription", "TrnInstallmentType": "TrnInstallmentType", "Utid": "Utid", "RemainingTaxAndFeeAmount": 0, "TotalTaxAndFeeAmount": 0, "CurrentTaxAndFeeAmount": 0, "DeferringBsmvAmount": 0, "DeferringProfitAmount": 0, "DeferringKkdfAmount": 0, "TotalDeferringBsmvAmount": 0, "TotalDeferringProfitAmount": 0, "TotalDeferringKkdfAmount": 0, "RemainingDeferringBsmvAmount": 0, "RemainingDeferringProfitAmount": 0, "RemainingDeferringKkdfAmount": 0 } ] }
json
application/json

Simulation service showing how interest/profit differences are refunded in early installment closure

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

Simulates the early release of an installment, providing details of the remaining balance, canceled fees and profit, early payment amount, and the total installment count.

Part of:

  • Journey 03 · Enabling additional capabilities — step 4, Early settlement

Simulation service showing how interest/profit differences are refunded in early installment closure › Request Body

SimulateInstallmentEarlyReleaseRequest
shadowCardNumber
​string | null

Shadow Card Number - [Optional]

utid
​string | null

Utid - [Optional]

Simulation service showing how interest/profit differences are refunded in early installment closure › Responses

Success

SimulateInstallmentEarlyReleaseResponse
CanceledFeeAndProfitAmount
​number · double · required

Canceled Fee And Profit Amount - [Optional]

ProfitAmount
​number · double · required

Profit Amount - [Optional]

FeeAmount
​number · double · required

Fee Amount - [Optional]

EarlyReleaseDeferringAmount
​number · double · required

Early Release Deferring Amount - [Optional]

TrnDate
​string · date-time · required

Trn Date - [Optional]

EarlyPaymentAmount
​number · double · required

Early Payment Amount - [Optional]

RemainingInstallmentCount
​integer · int32 · required

Remaining Installment Count - [Optional]

TotalInstallmentCount
​integer · int32 · required

Total Installment Count - [Optional]

AmountOfRemainingInstallment
​number · double · required

Amount Of Remaining Installment - [Optional]

SummaryRecordId
​integer · int64 · required

Summary Record Id - [Optional]

CanceledProfitAmount
​number · double · required

Canceled Profit Amount - [Optional]

CanceledKkdfAmount
​number · double · required

Canceled Kkdf Amount - [Optional]

CanceledBsmvAmount
​number · double · required

Canceled Bsmv Amount - [Optional]

CanceledFeeAmount
​number · double · required

Canceled Fee Amount - [Optional]

POST/credit/api/simulateInstallmentEarlyRelease
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/simulateInstallmentEarlyRelease \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "shadowCardNumber": "shadowCardNumber", "utid": "utid" }'
Example Request Body
{ "shadowCardNumber": "shadowCardNumber", "utid": "utid" }
json
Example Responses
{ "CanceledFeeAndProfitAmount": 0, "ProfitAmount": 0, "FeeAmount": 0, "EarlyReleaseDeferringAmount": 0, "TrnDate": "2024-08-25T15:00:00Z", "EarlyPaymentAmount": 0, "RemainingInstallmentCount": 0, "TotalInstallmentCount": 0, "AmountOfRemainingInstallment": 0, "SummaryRecordId": 0, "CanceledProfitAmount": 0, "CanceledKkdfAmount": 0, "CanceledBsmvAmount": 0, "CanceledFeeAmount": 0 }
json
application/json

Service that closes pending installments

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

Releases a pending installment for a credit card transaction. Accepts a UTID, early release type, and fee amount, and invokes the transaction management service to process the early release. Returns the ER log record ID and the associated ShadowCardNumber.

Part of:

  • Journey 03 · Enabling additional capabilities — step 4, Early settlement

Service that closes pending installments › Request Body

ReleasePendingInstallmentRequest
feeAmount
​number · double · required

Fee Amount - [Optional]

earlyReleaseType
​integer · int32 · required

Early Release Type - [Optional]

utid
​string | null

Utid - [Optional]

Service that closes pending installments › Responses

Success

ReleasePendingInstallmentResponse
erLogRecordId
​integer · int64 · required

Er Log Record Id - [Optional]

shadowCardNumber
​string | null

Shadow Card Number - [Optional]

POST/credit/api/releasePendingInstallment
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/releasePendingInstallment \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "utid": "utid", "feeAmount": 0, "earlyReleaseType": 0 }'
Example Request Body
{ "utid": "utid", "feeAmount": 0, "earlyReleaseType": 0 }
json
Example Responses
{ "shadowCardNumber": "shadowCardNumber", "erLogRecordId": 0 }
json
application/json

Post-installment request cancellation service

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

Cancels an existing installment transaction order identified by RecordId. Returns InstallmentOrderRecordId and Success flag indicating whether the cancellation succeeded.

Part of:

  • Journey 03 · Enabling additional capabilities — step 1, Purchase conversion (EPP)

Post-installment request cancellation service › Request Body

CancelInstallmentTransactionOrderRequest
recordId
​integer · int64 · required

Record Id - [Optional]

Post-installment request cancellation service › Responses

Success

CancelInstallmentTransactionOrderResponse
installmentOrderRecordId
​integer · int64 · required

Installment Order Record Id - [Optional]

success
​boolean · required

Success - [Optional]

POST/credit/api/cancelInstallmentTransactionOrder
curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/cancelInstallmentTransactionOrder \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "recordId": 0 }'
Example Request Body
{ "recordId": 0 }
json
Example Responses
{ "installmentOrderRecordId": 0, "success": true }
json
application/json

Permissions and restrictionsCollections and legal follow-up