v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Additional accrual type configurations

Enable additional configurations on accrual types

Enable additional configurations on accrual types. Any additional configuration that you enable modifies the default accrual behavior.

Specify configurations to enable by listing them as an array in the configurations body parameter. The following configuration is available.

  • ONCE_AFTER_TRANSACTION_DUE_DATE: By default, accruals on transactions with this transaction category occur on a daily basis. If this additional configuration is enabled, then, for each transaction, the accrual is calculated only once on the transaction due date.

Note: Unlike other rates that you define using transaction categories or accrual type rates, when you enable the ONCE_AFTER_TRANSACTION_DUE_DATE configuration on an accrual type, the rate you define for that type is <i>not</i> divided by the interest rate period before it's applied.

post/v1/programs/{programId}/transaction-category-id/{transactionCategoryId}/accrual-type/{accrualType}/period-to-calculate/{periodToCalculate}/configurations

Path parameters

programIdinteger required
Example:6912345

Program ID

transactionCategoryIdinteger required
Example:2

Program transaction category ID

accrualType'WITHDRAWAL_INTEREST' | 'BILLPAYMENT_INTEREST' | 'OVERDRAFT_INTEREST' | 'FINANCIAL_TAX' | 'REFINANCING' | 'OVERDUE' | 'FINE' required
Example:WITHDRAWAL_INTEREST

Accrual type

periodToCalculate'UNTIL_DUE_DATE' | 'AFTER_DUE_DATE' required
Example:UNTIL_DUE_DATE

Period to calculate the accruals

Request body

configurationsstring[] required

Array of additional accrual type configurations

Response

Ok

configurationsstring[] required

Array of additional accrual type configurations