v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Program accrual rates

Configure program accrual rates

Configure accrual rates at the program level.

post/v1/programs/{programId}/accrual-type-rates

Path parameters

programIdinteger required

Example:6912345

Program ID

Request body

transaction_category_idinteger required

Transaction category ID

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

WITHDRAWAL_INTEREST — Interest on a withdrawal
BILLPAYMENT_INTEREST — Interest on a bill payment
OVERDRAFT_INTEREST — Interest on an overdraft
FINANCIAL_TAX — Financial tax
REFINANCING — Refinancing charge
OVERDUE — Overdue charge
FINE — Overdue fine

period_to_calculatestring 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.

default_ratenumber double

Rate used to calculate the accrual when the account is not overdue.

Notes:

If you don't provide a value for this field, you must provide a value for rate_if_overdue.
If you provide a value for default_rate, but not rate_if_overdue, then the Pismo platform only calculates the interest if the account is not overdue. If you provide a value for rate_if_overdue, but not default_rate, then the platform only calculates the interest when the account is overdue. If you want the platform to calculate the interest in both cases, you must provide values for both fields.

rate_if_overduenumber double

Rate used to calculate the accrual when the account is overdue.

Notes:

If you don't provide a value for this field, you must provide a value for default_rate.
If you provide a value for default_rate, but not rate_if_overdue, then the Pismo platform only calculates the interest if the account is not overdue. If you provide a value for rate_if_overdue, but not default_rate, then the platform only calculates the interest when the account is overdue. If you want the platform to calculate the interest in both cases, you must provide values for both fields.

validity_to_calculate'IMMEDIATE' | 'DUEDATE' required

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.

Example request

{
  "transaction_category_id": 1237456,
  "accrual_type": "WITHDRAWAL_INTEREST",
  "default_rate": 2,
  "rate_if_overdue": 3,
  "validity_to_calculate": "IMMEDIATE",
  "ranges": [
    {
      "amount_due_lower_limit": 4000,
      "default_rate": 2,
      "rate_if_overdue": 3
    }
  ]
}

Response

transaction_category_idinteger required

Transaction category ID

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

WITHDRAWAL_INTEREST — Interest on a withdrawal
BILLPAYMENT_INTEREST — Interest on a bill payment
OVERDRAFT_INTEREST — Interest on an overdraft
FINANCIAL_TAX — Financial tax
REFINANCING — Refinancing charge
OVERDUE — Overdue charge
FINE — Overdue fine

period_to_calculatestring 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.

validity_to_calculate'IMMEDIATE' | 'DUEDATE' required

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.

default_ratenumber double

Rate used to calculate the accrual when the account is not overdue.

Notes:

If you don't provide a value for this field, you must provide a value for rate_if_overdue.
If you provide a value for default_rate, but not rate_if_overdue, then the Pismo platform only calculates the interest if the account is not overdue. If you provide a value for rate_if_overdue, but not default_rate, then the platform only calculates the interest when the account is overdue. If you want the platform to calculate the interest in both cases, you must provide values for both fields.

rate_if_overduenumber double

Rate used to calculate the accrual when the account is overdue.

Notes:

If you don't provide a value for this field, you must provide a value for default_rate.
If you provide a value for default_rate, but not rate_if_overdue, then the Pismo platform only calculates the interest if the account is not overdue. If you provide a value for rate_if_overdue, but not default_rate, then the platform only calculates the interest when the account is overdue. If you want the platform to calculate the interest in both cases, you must provide values for both fields.

created_atstring date-time required

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

deleted_atstring

Date deleted, format = yyyy-mm-ddThh:mm:ssZ

accrual_type_rate_idinteger

Account accrual type rate ID

Example response

{
  "transaction_category_id": 1237456,
  "accrual_type": "WITHDRAWAL_INTEREST",
  "validity_to_calculate": "IMMEDIATE",
  "default_rate": 2,
  "rate_if_overdue": 3,
  "ranges": [
    {
      "amount_due_lower_limit": 4000,
      "default_rate": 2,
      "rate_if_overdue": 3
    }
  ],
  "created_at": "2024-09-12T16:46:16.43663522",
  "deleted_at": "2023-10-10T10:50:18.212Z",
  "accrual_type_rate_id": 1237456
}