Manage Repayments and EMIs

Manage Repayments

Below are the action codes to manage repayments.

INITIATE_PAYMENT_NETBANKING

Use this action code to initiate a payment via Netbanking.

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

{}

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.
`txnAmt`	string	Mandatory	The Transaction amount.

INITIATE_PAYMENT_PG

Use this action code to initiate a payment via a Payment Gateway.

{
  'userId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af',
  'accountId': '53754f86-290a-4216-8eec-7024307be322',
  'amountType': 'OTHER',
  'amount': '10',
  'bankId': '470',
  'redirectUrl': 'https://creditkvbqa.tab.kitecash.in/home',
  'requestId': '88dc06ff-8b9a-4344-9678-69ad0de00dbf'
}

{}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`UserId`	string	Mandatory	The unique identifier of a user.
`accountId`	string	Mandatory	The unique ID of an account.
`amountType`	string	Optional	The type of the amount.
`amount`	string	Mandatory	The repayment amount.
`bankId`	string	Mandatory	The bank ID.
`redirectUrl`	string	Optional	The redirect URL.
`requestId`	string	Optional	The request ID.

FETCH_PAYMENT_STATUS

Use this action code to fetch the status of a payment.

{
  'userId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af',
  'bankName': 'ABC',
  'productType': '',
  'paymentGateway': '',
  'accountId': '53754f86-290a-4216-8eec-7024307be322'
}

{
  "status": "SUCCESS",
  "message": "Your payment is successful"
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`UserId`	string	Mandatory	The unique identifier of a user.
`bankeName`	string	Mandatory	The name of the bank.
`productType`	string	Mandatory	The product type.
`paymentGateway`	string	Mandatory	The payment gateway used to make the repayment.
`accountId`	string	Mandatory	The unique ID of an account.

Response Parameters

Parameters	Data Type	Description
`status`	string	The status of the repayment.
`message`	string	The repayment message.

FETCH_ALL_REPAYMENTS

Use this action code to fetch all repayments of an account.

{
  'bankId': 'replace_with_bank_id',
  'accountId': 'replace_with_account_id',
  'startDate': '2019-08-13 00:00:00',
  'endDate': '2019-09-13 00:00:00'
}

{
  'bankId': 'replace_with_bank_id',
  'accountId': 'replace_with_account_id',
  'startDate': '2019-08-13 00:00:00',
  'endDate': '2019-09-13 00:00:00'
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`bankId`	string	Mandatory	The unique ID of a bank.
`accountId`	string	Mandatory	The unique ID of an account.
`startDate`	string	Mandatory	The start date to filter repayments.
`endDate`	string	Mandatory	The end date to filter repayments.

Response Parameters

Parameters	Data Type	Description
`bankID`	string	The unique ID of a bank.
`accountId`	string	The unique ID of an account.
`paymentDate`	string	The repayment date.
`currency`	string	The currency of the repayment.
`amount`	string	The repayment amount.
`referenceId`	string	The reference ID.
`paymentSource`	string	The payment source.
`sourceAccount`	string	The source account.

Manage EMIs

Below are the action codes to manage EMIs.

CONVERT_AMOUNT_TO_EMI

Use this action code to convert the outstanding balance to EMIs.

{
  'accountId': '202000004784',
  'emiTenure': '6',
  'transactionID': '102656693ac3ca6e0cdafbfe89ab99',
  'emiInterestRate': '12'
}

{
  "emiId": "202034sdfg"
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique ID of an account.
`emiTenure`	string	Mandatory	The EMI tenure.
`transactionID`	string	Mandatory	The transaction ID.
`emiInterestRate`	string	Mandatory	The EMI interest rate.

Response Parameters

Parameters	Data Type	Description
`emiId`	string	The created EMI ID.

VIEW_EMIS

Use this action code to get a list of all EMIs.

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

{
  "openingbalance":1000,
  "closingbalance":10000,
  "statementdate":"2022-11-21 00:00:00",
  "duedate":"2022-12-11 00:00:00",
  "creditlimit":100000,
  "availablecredit":90000,
  "pastdueamount":0,
  "purchases":9000,
  "interest":0,
  "fees":0,
  "openingdate":"2022-11-21 00:00:00",
  "closingdate":"2022-11-21 00:00:00",
  "createdtime":"2022-11-21 01:10:55",
  "transactions_array":[
    {
      "transactions_array":500,
      "transactiontype_array":"Dr",
      "transactiondescription_array":"Zomato"
    }
  ]
}

Request Parameters

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

Request Parameters

Parameters	Data Type	Description
`openingbalance`	string	The opening balance.
`closingbalance`	string	The closing balance.
`statementdate`	string	The statement date.
`statementdate`	string	The statement date.
`dueDate`	string	The due date.
`creditlimit`	object	The credit limit.
`availablecredit`	string	The available credit.
`pastdueamount`	string	The past due amount.
`purchases`	string	The purchases.
`interest`	string	The interest.
`fees`	string	The fees.
`openingdate`	string	The opening date.
`closingdate`	string	The closing date.
`createdtime`	string	The statement creation time.
`transactions_array`	object	The transaction array details.
`transactions_array[].transactions_array`	string	The transaction array.
`transactions_array[].transactiontype_array`	string	The transaction type.
`transactions_array[].transactiondescription_array`	string	The transaction description.

VIEW_EMI_DETAILS

Use this action code to view details of an ongoing EMI.

{
  'accountId': '{accountID}',
  'userId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af',
  'transactionList': '3511614893',
  'loanId': '26c32b29-76f1-447d-a087-0964c4f6ef7a',
  'statementId': '2407093450'
}

{
  "loanId":"2386627365",
  "loanAccountNumber":"239886874",
  "loanAmount":50000,
  "transactionDetails":[
    {
      "id":"3511614893",
      "description":"HPGurugramIND",
      "paymentDatetime":null,
      "settlementTimestamp":"2025-01-29T11:52:56Z",
      "amount":50000
    }
  ],
  "emiConversionDate":"2025-01-29T13:33:27Z",
  "emiBillingDate":"2025-02-10",
  "emiAmount":17085.06,
  "tenure":3,
  "interestRate":0.15,
  "schedules":[
    {
      "installmentNumber":1,
      "principalAmount":16460.06,
      "interestAmount":625.0,
      "date":"2025-02-10",
      "statementId":"2407093450"
    },
    {
      "installmentNumber":2,
      "principalAmount":16665.81,
      "interestAmount":419.25,
      "date":"2025-03-10",
      "statementId":"2407093451"
    },
    {
      "installmentNumber":3,
      "principalAmount":16874.13,
      "interestAmount":210.93,
      "date":"2025-04-10",
      "statementId":"2407093452"
    }
  ],
  "gst":0.18,
  "description":"HPGurugramIND",
  "foreclosureDate":null,
  "foreclosureFee":null,
  "foreclosureGst":null,
  "foreclosurePrincipal":null,
  "foreclosureAmount":null,
  "status":"ACTIVE"
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique ID of an account.
`UserId`	string	Mandatory	The unique identifier of a user.
`transactionList`	string	Optional	The transaction list.
`loanId`	string	Mandatory	The loan ID.
`statementId`	string	Mandatory	The statement ID.

Response Parameters

Parameters	Data Type	Description
`loanId`	string	The loan ID.
`loanAccountNumber`	string	The loan account number.
`loanAmount`	string	The loan amount.
`transactionDetails`	object	The transaction details.
`transactionDetails[].id`	string	The transaction ID.
`transactionDetails[].description`	string	The transaction description.
`transactionDetails[].paymentDatetime`	string	The transaction payment details.
`transactionDetails[].settlementTimestamp`	string	The timestamp of the settlement.
`transactionDetails[].amount`	string	The transaction amount.
`emiConversionDate`	string	The EMI conversion date.
`emiBillingDate`	string	The EMI billing date.
`emiAmount`	string	The EMI amount.
`tenure`	string	The EMI tenure.
`interestRate`	string	The interest rate on EMI.
`schedules`	object	The EMI schedule details.
`schedules[].installmentNumber`	string	The installment number.
`schedules[].principalAmount`	string	The principal amount.
`schedules[].interestAmount`	string	The interest amount.
`schedules[].date`	string	The EMI date.
`schedules[].statementId`	string	The statement ID.
`gst`	string	The GST.
`description`	string	The description.
`foreclosureDate`	string	The foreclosure date.
`foreclosureDate`	string	The foreclosure date.
`foreclosureFee`	string	The foreclosure fee.
`foreclosureGst`	string	The foreclosure GST.
`foreclosurePrincipal`	string	The foreclosure principal amount.
`foreclosureAmount`	string	The foreclosure amount.
`status`	string	The EMI status.

FETCH_EMI_TENURES

Use this action code to get a list of applicable tenures for the selected transactions.

{
  'accountId': '{accountID}',
  'userId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af',
  'transactionList': '3511614893',
  'emiPlanId': 'bb834dc1-0e56-4e93-b74e-fe41d005013d'
}

{
  "transactionDetails":[
    {
      "id":"3511614886",
      "description":"HPGurugramIND",
      "paymentDatetime":null,
      "settlementTimestamp":"2025-01-29T11:52:44Z",
      "amount":50000
    }
  ],
  "transactionId":[
    "3511614886"
  ],
  "settlementTimestamp":"2025-01-29T11:52:44Z",
  "paymentDatetime":null,
  "totalTransactionAmount":50000,
  "emiPlan":{
    "id":"bb834dc1-0e56-4e93-b74e-fe41d005013d",
    "processingFee":500.00,
    "processingFeeSGST":null,
    "processingFeeCGST":null,
    "processingFeeIGST":90.0000,
    "processingFeeUGST":null,
    "processingFeeGST":90.0000,
    "processingFeeCGSTPercentage":0.09,
    "processingFeeSGSTPercentage":0.09,
    "processingFeeUGSTPercentage":0,
    "processingFeeIGSTPercentage":0.18,
    "processingFeeGSTPercentage":0.18,
    "totalProcessingFee":590.0000,
    "tenure":[
      {
        "tenureId":"ac2da831-c907-46cd-a837-a7051d8318f2",
        "months":3,
        "annualInterestRate":0.15,
        "emiAmount":17085.06,
        "interestAmount":1255.18,
        "cgstInterestAmount":null,
        "sgstInterestAmount":null,
        "igstInterestAmount":225.9324,
        "ugstInterestAmount":null,
        "cgstInterestPercentage":0.09,
        "sgstInterestPercentage":0.09,
        "igstInterestPercentage":0.18,
        "ugstInterestPercentage":0,
        "gstInterestPercentage":0.18,
        "gstInterestAmount":225.9324,
        "totalInterestAmount":1481.11,
        "totalPayable":52071.11,
        "isAvailableLimitAdequate":false
      },
      {
        "tenureId":"a18152a8-563d-4109-86df-a04914f77ba7",
        "months":6,
        "annualInterestRate":0.15,
        "emiAmount":8701.69,
        "interestAmount":2210.14,
        "cgstInterestAmount":null,
        "sgstInterestAmount":null,
        "igstInterestAmount":397.8252,
        "ugstInterestAmount":null,
        "cgstInterestPercentage":0.09,
        "sgstInterestPercentage":0.09,
        "igstInterestPercentage":0.18,
        "ugstInterestPercentage":0,
        "gstInterestPercentage":0.18,
        "gstInterestAmount":397.8252,
        "totalInterestAmount":2607.97,
        "totalPayable":53197.97,
        "isAvailableLimitAdequate":false
      }
    ]
  },
  "description":"HPGurugramIND"
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique ID of an account.
`userId`	string	Mandatory	The unique identifier of a user.
`transactionList`	string	Optional	The transaction list.
`emiPlanId`	string	Mandatory	The EMI plan ID.

Response Parameters

Parameters	Data Type	Description
`transactionDetails`	object	The transaction details.
`transactionDetails[].id`	string	The transaction ID.
`transactionDetails[].description`	string	The transaction description.
`transactionDetails[].paymentDatetime`	string	The transaction payment date and time.
`transactionDetails[].settlementTimestamp`	string	The timestamp of the settlement.
`transactionDetails[].amount`	string	The transaction amount.
`transactionId`	string	The transaction ID.
`settlementTimestamp`	string	The timestamp of the settlement.
`paymentDatetime`	string	The transaction payment date and time.
`totalTransactionAmount`	string	The total transaction amount.
`emiPlan`	object	The EMI plan details.
`emiPlan[].id`	string	The EMI plan ID.
`emiPlan[].processingFee`	string	The EMI processing fee.
`emiPlan[].processingFeeSGST`	string	The EMI processing SGST fee.
`emiPlan[].processingFeeCGST`	string	The EMI processing CGST fee.
`emiPlan[].processingFeeIGST`	string	The EMI processing IGST fee.
`emiPlan[].processingFeeUGST`	string	The EMI processing UGST fee.
`emiPlan[].processingFeeGST`	string	The EMI processing GST fee.
`emiPlan[].processingFeeCGSTPercentage`	string	The EMI processing CGST fee percentage.
`emiPlan[].processingFeeSGSTPercentage`	string	The EMI processing SGST fee percentage.
`emiPlan[].processingFeeUGSTPercentage`	string	The EMI processing UGST fee percentage.
`emiPlan[].processingFeeIGSTPercentage`	string	The EMI processing IGST fee percentage.
`emiPlan[].processingFeeGSTPercentage`	string	The EMI processing GST fee percentage.
`emiPlan[].totalProcessingFee`	string	The EMI total processing fee.
`tenure`	object	The EMI tenure details.
`tenure[].tenureId`	string	The tenure ID.
`tenure[].months`	string	The tenure months.
`tenure[].annualInterestRate`	string	The annual interest rate.
`tenure[].emiAmount`	string	The EMI amount.
`tenure[].interestAmount`	string	The interest amount.
`tenure[].cgstInterestAmount`	string	CGST on the interest amount.
`tenure[].sgstInterestAmount`	string	SGST on the interest amount.
`tenure[].igstInterestAmount`	string	IGST on the interest amount.
`tenure[].ugstInterestAmount`	string	UGST on the interest amount.
`tenure[].cgstInterestPercentage`	string	CGST interest percentage on the amount.
`tenure[].sgstInterestPercentage`	string	SGST interest percentage on the amount.
`tenure[].igstInterestPercentage`	string	IGST interest percentage on the amount.
`tenure[].ugstInterestPercentage`	string	UGST interest percentage on the amount.
`tenure[].gstInterestPercentage`	string	GST interest percentage on the amount.
`tenure[].gstInterestAmount`	string	GST on the interest amount.
`tenure[].totalInterestAmount`	string	The total interest amount.
`tenure[].totalPayable`	string	The total payable amount.
`tenure[].isAvailableLimitAdequate`	string	Indicates whether the available limit is adequate.
`description`	string	The description.

FETCH_EMI_REPAYMENT_SCHEDULE

Use this action code to get an EMI repayment schedule.

{
  'accountId': 'replace_with_account_id',
  'emiId': 'replace_with_emi_id',
  'tenureId': 'replace_with_tenure_id',
  'amount': '50000',
  'userId': 'a5a1c639-52ca-4146-a8e4-92fdabe304af',
}

{
  "schedules":[
    {
      "installmentNumber":1,
      "date":"2025-02-10",
      "emiAmount":17085.06,
      "principalAmount":16460.06,
      "interestAmount":625.00,
      "interestRate":0.01,
      "outstandingAmount":33539.94
    },
    {
      "installmentNumber":2,
      "date":"2025-03-10",
      "emiAmount":17085.06,
      "principalAmount":16665.81,
      "interestAmount":419.25,
      "interestRate":0.01,
      "outstandingAmount":16874.13
    },
    {
      "installmentNumber":3,
      "date":"2025-04-10",
      "emiAmount":17085.06,
      "principalAmount":16874.13,
      "interestAmount":210.93,
      "interestRate":0.01,
      "outstandingAmount":0.00
    }
  ],
  "totalInterestAmount":1255.18,
  "totalInterestGST":0,
  "totalChargingAmount":51255.18
}

Request Parameters

Parameters	Data Type	Mandatory/Optional	Description
`accountId`	string	Mandatory	The unique ID of an account.
`emiId`	string	Mandatory	The EMI ID.
`tenureId`	string	Mandatory	The tenure ID.
`amount`	integer	Mandatory	The total EMI amount.
`userId`	string	Mandatory	The unique identifier of a user.

Response Parameters

Parameters	Data Type	Description
`schedules`	object	The EMI schedule details.
`schedules[].installmentNumber`	string	The installment number.
`schedules[].date`	string	The EMI date.
`schedules[].emiAmount`	string	The EMI amount.
`schedules[].principalAmount`	string	The principal amount.
`schedules[].interestAmount`	string	The interest amount.
`schedules[].interestRate`	string	The interest rate.
`schedules[].outstandingAmount`	string	The outstanding amount.
`totalInterestAmount`	string	The total interest amount.
`totalInterestGST`	string	GST on the total interest.
`totalChargingAmount`	string	The total charging amount.

↑