Get Account Interest

Returns the interest on a savings account: interest accrued and not yet posted, total earned and posted, withholding tax deducted, and the individual interest postings and tax deductions, optionally within a date range.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Interest

application/json

Interest

Bodyapplication/json

Example

{
  "nuban": "0000000206",
  "interestAccrued": 120.5,
  "totalInterestEarned": 4120.5,
  "totalInterestPosted": 4000,
  "totalWithholdingTaxDeducted": 400,
  "interestPostings": [
    {
      "transactionId": 501,
      "date": "2026-10-31",
      "amount": 350
    }
  ],
  "withholdingTaxDeductions": [
    {
      "transactionId": 502,
      "date": "2026-10-31",
      "amount": 35
    }
  ]
}

🟠400Validation failed

🟠401The merchant's account has not been granted this operation,

🟠404Not found

🔴500The request could not be completed

Request

Request Code Samples

Responses