v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Account accrual rates

List account accrual rates

Retrieves a list of accrual rates configured at the account level.

NOTE: This endpoint requires an account-specific access token. Getting an account token requires you to call Get OpenID access token with an external account ID. Tokens can expire quickly, which can result in an Unauthorized message.

get/v1/accounts/{accountId}/accrual-type-rates

Path parameters

accountIdinteger required

Example:6912345

Account ID

Query parameters

perPageinteger

Example:15

Items per page

pageinteger

Example:1

Page number

transactionCategoryIdinteger

Example:2

Program transaction category ID

accrualType'WITHDRAWAL_INTEREST' | 'BILLPAYMENT_INTEREST' | 'OVERDRAFT_INTEREST'

Example:WITHDRAWAL_INTEREST

Accrual type

periodToCalculate'UNTIL_DUE_DATE' | 'AFTER_DUE_DATE'

Example:UNTIL_DUE_DATE

Period to calculate the accruals

validityToCalculate'IMMEDIATE' | 'DUEDATE'

Example:IMMEDIATE

When the rate is used to calculate the accrual. The possible values are:

IMMEDIATE — The rate is used to calculate the next generated accruals.
DUEDATE — The rate is used to calculate accruals only after the next due date.

Response

current_pageinteger required

Current page number

per_pageinteger required

Number of items per page

total_itemsinteger required

Number of items

items_on_pageinteger required

Number of items on the current page

pagesinteger required

Number of pages

is_last_pageboolean

Set to true if this is the last page.

Example response

{
  "current_page": 1,
  "per_page": 10,
  "total_items": 50,
  "items_on_page": 10,
  "pages": 10,
  "items": [
    {
      "transaction_category_id": 1237456,
      "accrual_type": "WITHDRAWAL_INTEREST",
      "default_rate": 2,
      "rate_if_overdue": 3,
      "ranges": [
        {
          "amount_due_lower_limit": 4000,
          "default_rate": 2,
          "rate_if_overdue": 3
        }
      ],
      "validity_to_calculate": "IMMEDIATE",
      "account_accrual_type_rate_id": 1237456,
      "account_id": 6912345,
      "created_at": "2024-09-12T16:46:16.43663522",
      "deleted_at": "2023-10-10T10:50:18.212Z"
    }
  ]
}