Manage Cards and Accounts

Manage Credit Cards

Below are the action codes for managing credit cards.

SET_RESET_ACTIVATE_CARD

Use this action code to set, reset, or activate a card.

{
  'objectId': '9e23db7d-9c6a-4da3-b812-7bb1580d155a',
  'otpPurpose': 'CHANGE_PIN'
}

{}

Request Headers

Headers	Data Type	Description
`UserId`	string	The unique identifier of the user. For example, `a5a1c639-52ca-4146-a8e4-92fdabe304af`.

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`objectId`	string	Mandatory	The unique identifier of the object.
`otpPurpose`	string	Mandatory	The purpose of the OTP. For example, `CHANGE_PIN`.

SUBMIT_OTP

Use this action code to submit the received OTP. This OTP can be reused for setting a PIN, activating a card, and for any other cases where we need an OTP flow.

{
  'otp': 'xx23',
  'reason': 'SET_PIN'
}

{}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`otp`	integer	Mandatory	The masked OTP.
`reason`	string	Optional	The reason of the OTP.

ACTIVATE_CARD

Use this action code to activate a card.

{
'cardID': '41296a2e-f08c-4e50-80d1-9b6e62ee4805',
'action': 'activate'
}

{}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`cardId`	string	Mandatory	The card ID required to activate a card.
`action`	string	Mandatory	The action to take on the card ID. Here, it is `activate`.

VIEW_CARDS_LIST

Use this action item to view the list of all cards added to an account.

{
'accountId': 'acc123456'
'UserId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af'
}

{
  "cardId":"41296a2e-f08c-4e50-80d1-9b6e62ee4805",
  "outstandingAmount":58800.59,
  "expirationDate":"2029-04-23 05:30:00.0",
  "maskedCardNumber":"999989xxxxxx2600",
  "cardHolderName":"Akash Emi Sarin",
  "cardStatus":"UNFREEZE",
  "network":"VISA",
  "isPrimary":true,
  "productName":"KVB HONOUR CREDIT CARD",
  "productType":"RETAIL_CREDIT_CARD",
  "productVariant":"HONOUR",
  "productVariantName":"KVB Honour Card",
  "cardCreationDate":"2024-04-23 11:46:51.297",
  "cardHotlistedDate":null,
  "cardClosureDate":null,
  "cardHotlistedReason":null,
  "type":"PHYSICAL"
}

Request Parameters

Parameter	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique identifier of an account.
`UserId`	string	Mandatory	The unique identifier of a user.

Response Parameters

Parameters	Data Type	Description
`cardId`	string	The unique identifier of a card.
`outstandingAmount`	bigdecimal	The total outstanding amount of a card.
`expirationDate`	string	The card expiry date.
`maskedCardNumber`	integer	The masked card number.
`cardHolderName`	string	The cardholder's name.
`cardStatus`	string	The card status.
`network`	string	The card network. For example, `VISA`.
`isPrimary`	string	Indicates whether the card is primary. Possible values: `true`: This a primary. `false`: This is not a primary card.
`productName`	string	The card name. For example, `KVB HONOUR CREDIT CARD`.
`productType`	string	The card type. Here, it is `RETAIL_CREDIT_CARD`.
`productVariant`	string	The card variant. Here, it is `HONOUR`.
`productVariantName`	string	The card variant name. Here, it is `KVB Honour Card`.
`cardCreationDate`	string	The card creation date.
`cardHotlistedDate`	string	The card's hotlist date.
`cardClosureDate`	string	The card closure date.
`cardHotlistedReason`	string	The reason for hotlisting the card.
`type`	string	The card type. Possible values: `Physical`: The card is physical. `Virtual`: The card is virtual.

VIEW_CARD_SPENDING_LIMIT

Use this action code to view the spending limit of a card.

{
'accountId': 'acc123456',
'cardId': '41296a2e-f08c-4e50-80d1-9b6e62ee4805',
'UserId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af'
}

{
  "cardId":"0cad620c-ebd7-4b52-b079-7d351ec86c13",
  "domestic":{
    "online":{
      "perTransactionLimit":1000,
      "dailyTransactionAmount":2000,
      "dailyTransactionCount":10,
      "monthlyTransactionAmount":60000,
      "monthlyTransactionCount":300
    },
    "pos":{
      "perTransactionLimit":1000,
      "dailyTransactionAmount":2000,
      "dailyTransactionCount":10,
      "monthlyTransactionAmount":60000,
      "monthlyTransactionCount":300
    },
    "atm":{
      "perTransactionLimit":1000,
      "dailyTransactionAmount":2000,
      "dailyTransactionCount":10,
      "monthlyTransactionAmount":60000,
      "monthlyTransactionCount":300
    },
    "contactless":{
      "perTransactionLimit":1000,
      "dailyTransactionAmount":2000,
      "dailyTransactionCount":10,
      "monthlyTransactionAmount":60000,
      "monthlyTransactionCount":300
    }
  }
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique identifier of an account.
`cardId`	string	Mandatory	The unique identifier of a card you want to view the spending limit.
`UserId`	string	Mandatory	The unique identifier of a user.

Response Parameters

Parameters	Data Type	Description
`cardId`	string	The unique identifier of a card.
`domestic`	object	The domestic spending limit details.
`domestic[].online`	object	The domestic online spending limit details.
`domestic[].online[].perTransactionLimit`	integer	The single transaction limit.
`domestic[].online[].dailyTransactionAmount`	integer	The card's daily transaction amount.
`domestic[].online[].dailyTransactionCount`	integer	The card's daily transaction count.
`domestic[].online[].monthlyTransactionAmount`	integer	The card's monthly transaction amount.
`domestic[].online[].monthlyTransactionCount`	integer	The card's monthly transaction count.
`domestic[].pos`	object	The domestic spending limit on POS devices details.
`domestic[].pos[].perTransactionLimit`	integer	The single transaction limit on a POS device.
`domestic[].pos[].dailyTransactionAmount`	integer	The card's daily transaction amount on a POS device.
`domestic[].pos[].dailyTransactionCount`	integer	The card's daily transaction count on a POS device.
`domestic[].pos[].monthlyTransactionAmount`	integer	The card's monthly transaction amount on a POS device.
`domestic[].pos[].monthlyTransactionCount`	integer	The card's monthly transaction count on a POS device.
`domestic[].atm`	object	The ATM spending limit details.
`domestic[].atm[].perTransactionLimit`	integer	The single transaction limit on an ATM.
`domestic[].atm[].dailyTransactionAmount`	integer	The card's daily transaction amount on an ATM.
`domestic[].atm[].dailyTransactionCount`	integer	The card's daily transaction count on an ATM.
`domestic[].atm[].monthlyTransactionAmount`	integer	The card's monthly transaction amount on an ATM.
`domestic[].atm[].monthlyTransactionCount`	integer	The card's monthly transaction counts on an ATM.
`domestic[].contactless`	object	The contactless spending limit details.
`domestic[].contactless[].perTransactionLimit`	integer	The single contactless transaction limit.
`domestic[].contactless[].dailyTransactionAmount`	integer	The contactless transaction amount daily limit.
`domestic[].contactless[].dailyTransactionCount`	integer	The contactless transaction daily limit count.
`domestic[].contactless[].monthlyTransactionAmount`	integer	The contactless transaction monthly limit amount.
`domestic[].contactless[].monthlyTransactionCount`	integer	The contactless transaction monthly limit count.

CHANGE_SPENDING_LIMITS

Use this endpoint to change the spending limit of a card.

{
  'accountId': '202000004782',
  'userId': '9824c2dc-65ac-417a-a11c-43e47e8dfa7a',
  'domestic': {
    'online': {
      'perTransactionLimit': '2000',
      'dailyLimit': '91000',
      'enabled': 'true'
    },
    'pos': {
      'perTransactionLimit': '2000',
      'dailyLimit': '91000',
      'enabled': 'true'
    },
    'atm': {
      'perTransactionLimit': '2000',
      'dailyLimit': '91000',
      'enabled': 'true'
    },
    'contactless': {
      'perTransactionLimit': '2000',
      'dailyLimit': '91000',
      'enabled': 'true'
    }
  }
}

{}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique identifier of an account.
`UserId`	string	Mandatory	The unique identifier of a user.
`domestic`	object	Optional	The domestic spending limit details.
`domestic[].online`	object	Optional	The domestic online spending limit details.
`domestic[].online[].perTransactionLimit`	integer	Optional	The single transaction limit.
`domestic[].online[].dailyLimit`	integer	Optional	The card's daily limit.
`domestic[].online[].enabled`	boolean	Optional	Indicates whether the card is enabled for domestic online transactions. Possible values: `true`: Enabled for domestic transactions `false`: Disabled for domestic transactions.
`domestic[].pos`	object	Optional	The domestic spending limit on POS devices details.
`domestic[].pos[].perTransactionLimit`	integer	Optional	The single transaction limit on a POS device.
`domestic[].pos[].dailyLimit`	integer	Optional	The card's daily limit on a POS device.
`domestic[].pos[].enabled`	boolean	Optional	Indicates whether the card is enabled for domestic transactions on a POS device. Possible values: `true`: Enabled for domestic transactions on a POS device. `false`: Disabled for domestic transactions on a POS device.
`domestic[].atm`	object	Optional	The ATM spending limit details.
`domestic[].atm[].perTransactionLimit`	integer	Optional	The single transaction limit on an ATM.
`domestic[].atm[].dailyLimit`	integer	Optional	The card's daily limit on an ATM.
`domestic[].atm[].enabled`	boolean	Optional	Indicates whether the card is enabled for domestic transactions on an ATM. Possible values: `true`: Enabled for domestic transactions on an ATM. `false`: Disabled for domestic transactions on an ATM.
`domestic[].contactless`	object	Optional	The contactless spending limit details.
`domestic[].contactless[].perTransactionLimit`	integer	Optional	The single contactless transaction limit.
`domestic[].contactless[].dailyLimit`	integer	Optional	The contactless transaction daily limit.
`domestic[].contactless[].enabled`	boolean	Optional	Indicates whether the card is enabled for contactless domestic transactions. Possible values: `true`: Enabled for contactless domestic transactions. `false`: Disabled for contactless domestic transactions.

FREEZE_UNFREEZE_CARD

Use this action code to freeze or unfreeze a card.

{
  'userId': '9824c2dc-65ac-417a-a11c-43e47e8dfa7a',
  'cardId': '9e23db7d-9c6a-4da3-b812-7bb1580d155a',
  'status': 'FREEZE'
}

{}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`UserId`	string	Mandatory	The unique identifier of a user.
`cardId`	string	Mandatory	The unique identifier of a card.
`status`	string	Optional	The status of a card. For example, `FREEZE`

BLOCK_CARD

Use this action code to block a card.

{
  'userId': '9824c2dc-65ac-417a-a11c-43e47e8dfa7a',
  'cardId': '9e23db7d-9c6a-4da3-b812-7bb1580d155a',
  'status': 'BLOCKED',
  'reason': 'LOST/STOLEN/DAMAGED'
}

{}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`UserId`	string	Mandatory	The unique identifier of a user.
`cardId`	string	Mandatory	The unique identifier of a card.
`status`	string	Optional	The status of a card. For example, `BLOCKED`
`reason`	string	Optional	The reason to block a card.

REPLACE_CARD

Use this action code to replace a card.

{
  'oldCardId': '83f1492f-d00a-4417-bfbf-7de7e13507f9'
}

{
  "newcardId": "83f1492f-d00a-4417-bfbf-7de7e13507f9"
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`oldCardId`	string	Mandatory	The old card ID.

Response Parameters

Parameters	Data Type	Mandatory/Optional	Description
`newcardId`	string	Mandatory	The new card ID.

Manage User Accounts

Below are the action codes for managing user accounts.

VIEW_ACCOUNTS_LIST

Use this action code to view the list of accounts.

{
  'userId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af',
}

{
  "userId":"1f27d20f-b09a-437a-85b4-c70036bb6b57",
  "maskedMobileNumber":"70xxxx1041",
  "accountData":{
    "items":[
      {
        "productName":"KVB HONOUR CREDIT CARD",
        "productType":"RETAIL_CREDIT_CARD",
        "productVariant":"HONOUR",
        "productVariantName":"KVB Honour Card",
        "accountId":"170e13ec-9e4f-4547-a414-183cb2fb059a",
        "programId":"1abbb249-27c6-4ec5-b492-75d147e61ada"
      }
    ],
    "isLastPage":true,
    "pageNumber":0,
    "currentPageSize":1,
    "perPageSize":5,
    "totalItems":1,
    "totalPages":1
  }
}

Request Parameters

Header	Data Type	Mandatory/Optional	Description
`UserId`	string	Mandatory	The unique identifier of a user.

Response Parameters

Parameters	Data Type	Description
`userId`	string	The unique identifier of the user.
`maskedMobileNumber`	string	The masked mobile number of the user.
`accountData`	object	The account details
`items`	object	The card details added to the account.
`accountData[].items[].productName`	string	The card name. For example, `Nyka HONOUR CREDIT CARD`.
`accountData[].items[].productType`	string	The card type. Here, it is `RETAIL_CREDIT_CARD`.
`accountData[].items[].productVariant`	string	The card variant. Here, it is `HONOUR`.
`accountData[].items[].productVariantName`	string	The card variant name. Here, it is `Nyka Honour Card`.
`accountData[].items[].accountId`	string	The unique identifier of the user account. For example, `170e13ec-9e4f-4547-a414-183cb2fb059a`.
`accountData[].items[].programId`	string	The program ID the card is added to. For example, `1abbb249-27c6-4ec5-b492-75d147e61ada`.
`accountData[].isLastPage`	string	Determines whether this is the last page of the response. Possible values: `true` `false`
`accountData[].pageNumber`	integer	The current page number.
`accountData[].currentPageSize`	integer	The amount of data present on the current page.
`accountData[].perPageSize`		The amount of data allowed on the current page.
`accountData[].totalItems`	integer	The total amount of data present in the request.
`accountData[].totalPages`	integer	The total number of pages present in the request.

VIEW_ACCOUNT_DETAILS

Use this action code to view the list of accounts.

{
  'accountId': 'replace_with_account_id',
  'userId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af'
}

{
  "userId":"a5a1c639-52ca-4146-a8e4-92fdabe304af",
  "id":"53754f86-290a-4216-8eec-7024307be322",
  "accountNumber":"239886874",
  "type":"DOMESTIC",
  "enterpriseId":null,
  "status":"ACTIVE",
  "subStatus":"NORMAL",
  "npaStatus":"IN_ACTIVE",
  "npaInducedBy":null,
  "npaReason":null,
  "dueDateModifiedOn":null,
  "dueDateUpdateEnable":true,
  "programId":"d883fb9f-477c-4139-8cd1-204719b267ea",
  "creditLimit":100000.0,
  "availableCreditLimit":-590.0,
  "totalCreditLimit":100000.0,
  "maxCreditLimit":100000.0,
  "cashAdvanceLimit":40000.0,
  "availableCashAdvanceLimit":40000.0,
  "availableInstallmentLimit":0.0,
  "totalInstallmentCreditLimit":0.0,
  "availableSavingsAccountLimit":0.0,
  "totalOverDraftLimit":0.0,
  "overdraftLimit":0.0,
  "joiningFee":null,
  "annualFee":null,
  "cashAdvanceFee":null,
  "outstandingAmount":100590.0,
  "delinquencyStatus":"NOT PAST DUE",
  "dueDate":"10",
  "lastPaymentDate":null,
  "accountOpeningDate":"2025-01-29T11:47:07.658+00:00",
  "billingDate":"09-Feb-2025",
  "paymentDueDate":"10-Feb-2025",
  "delinquencyCycle":0,
  "delinquencyCycleDesc":"0 Days",
  "daysPastDue":0,
  "minimumAmountDue":null,
  "overdueAmount":0.00,
  "totalAmountDue":"0",
  "productType":"RETAIL_CREDIT_CARD",
  "productVariant":"HONOUR",
  "productVariantName":"KVB Honour Card",
  "currentStatementReferenceNo":"2407093450",
  "autoDebit":{
    "savingsAccountNumber":"12345676789",
    "type":"MAD",
    "status":"YES",
    "enterpriseType":null,
    "enterpriseStatus":null
  },
  "cardAutoRenewStatus":true,
  "cardAutoRenewReason":null,
  "branchId":"XYZ123",
  "nomineeRelationship":"BROTHER",
  "nomineeName":"Deepak Chauhan"
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique identifier of an account.
`UserId`	string	Mandatory	The unique identifier of a user.

Response Parameters

Parameters	Data Type	Description
`userId`	string	The unique identifier of the user.
`id`	string	The unique identifier.
`accountNumber`	string	The associated account number.
`type`	string	The account type.
`enterpriseId`	string	The unique identifier of an enterprise.
`status`	string	The account status.
`subStatus`	string	The account sub-status.
`npaStatus`	string	The NPA status of an account.
`npaInducedBy`	string	Indicates who induced the NPA on the account.
`npaReason`	string	The NPA's reason.
`dueDateModifiedOn`	string	The due date modified information.
`dueDateUpdateEnable`	string	Determines whether one can update the due date of an account.
`programId`	string	The program ID account is associated with.
`creditLimit`	string	The account's credit limit.
`availableCreditLimit`	string	The account's available credit limit.
`totalCreditLimit`	string	The account's total credit limit.
`maxCreditLimit`	string	The account's maximum credit limit.
`cashAdvanceLimit`	string	The account's cash advance limit.
`availableCashAdvanceLimit`	string	The account's available cash advance limit.
`availableInstallmentLimit`	string	The account's available installment limit.
`totalInstallmentCreditLimit`	string	The account's total installment limit.
`availableSavingsAccountLimit`	string	The account's available savings account limit.
`totalOverDraftLimit`	string	The account's total overdraft limit.
`overdraftLimit`	string	The account's overdraft limit.
`joiningFee`	string	The account's joining fee.
`annualFee`	string	The account's annual fee.
`cashAdvanceFee`	string	The account's cash advance fee.
`outstandingAmount`	string	The outstanding amount.
`delinquencyStatus`	string	The account's delinquency status.
`lastPaymentDate`	string	The account's last payment date.
`dueDate`	string	The due date of an account.
`accountOpeningDate`	string	The account opening date.
`billingDate`	string	The account billing date.
`paymentDueDate`	string	The account payment due date.
`delinquencyCycle`	string	The account delinquency cycle.
`delinquencyCycleDesc`	string	The account delinquency cycle description.
`daysPastDue`	string	The days past due of an account.
`minimumAmountDue`	string	The minimum amount due for an account.
`overdueAmount`	string	The overdue amount.
`totalAmountDue`	string	The total amount due.
`productType`	string	The card type.
`productVariant`	string	The card variant.
`productVariantName`	string	The card variant name.
`currentStatementReferenceNo`	string	The current statement reference number.
`autoDebit`	object	The auto-debit details.
`autoDebit[].savingsAccountNumber`	object	The savings account number for auto-debit.
`autoDebit[].type`	object	The auto-debit type.
`autoDebit[].status`	object	The auto-debit status.
`autoDebit[].enterpriseType`	object	The enterprise type.
`autoDebit[].enterpriseStatus`	object	The enterprise status.
`cardAutoRenewStatus`	string	The card's auto-renewal status.
`cardAutoRenewReason`	string	The card's auto-renewal reason.
`branchId`	string	The branch ID.
`nomineeRelationship`	string	The nominee's relationship.
`nomineeName`	string	The nominee's name.

↑