Create additional accrual type configuration

Enables an additional configuration on an accrual type for a specific transaction category and period to calculate. Any additional configuration that you enable modifies the default accrual behavior.

Note: Pismo recommends you use this endpoint instead of Enable additional configurations on accrual types, which will eventually be deprecated. The new endpoint accepts all parameters in the request body, instead of in path parameters.

Available Configurations

Configurationvalue RequiredAllowed valuesAllowed values for period_to_calculate
ONCE_AFTER_TRANSACTION_DUE_DATENoN/AUNTIL_DUE_DATE, AFTER_DUE_DATE
GRACE_DAYS_UNTIL_DUE_DATE_STRATEGYYes1 or 2UNTIL_DUE_DATE

Configuration details

  • 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. The value field is not required for this configuration.

  • GRACE_DAYS_UNTIL_DUE_DATE_STRATEGY: This configuration defines the grace days strategy for accruals calculated up to the due date. You must set period_to_calculate to UNTIL_DUE_DATE. The value field is required. Accepted values are 1 or 2.

value behavior

  • The value field accepts an integer (1 or 2).
  • For configurations that do not require value (for example, ONCE_AFTER_TRANSACTION_DUE_DATE), you can omit the value parameter.
  • For configurations that require value (for example, GRACE_DAYS_UNTIL_DUE_DATE_STRATEGY), you must provide a valid positive integer.
  • If you need to make a new configuration mandatory with a value, contact your Pismo representative for help with that—you can't configure it using the API.

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 not divided by the interest rate period before it's applied.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Program ID

Body Params
int64
required

Transaction category ID

string
enum
required

Accrual type. The possible values at the program level are:

  • WITHDRAWAL_INTEREST—Withdrawal interest
  • BILLPAYMENT_INTEREST—Bill payment interest
  • OVERDRAFT_INTEREST—Overdraft interest
  • FINANCIAL_TAX—Financial tax
  • REFINANCING—Refinancing charge
  • OVERDUE—Overdue charge
  • FINE—Overdue fine
Allowed:
string
required

Period to calculate the accrual

UNTIL_DUE_DATE—The period extends from the transaction date plus one day to the due date. AFTER_DUE_DATE—The period extends from the due date plus one day to the current date.

Note: If an accrual needs to start at the transaction date and continue past the due date, then two accrual rates need to be created—one with UNTIL_DUE_DATE and another with AFTER_DUE_DATE.

string
enum
required

Accrual type configuration to enable

Allowed:
int32 | null

Value for the configuration, if applicable. Null if the configuration does not require a value. Allowed values are 1 or 2.

Responses

500

Internal server error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json