APIs
Sub-processorsAbout PismoContact us

Configure transaction accrual rates

post
https://sandbox.pismolabs.io/credit-cycle-configurations/v1/transactions/accrual-type-rates

Create accrual rates for a transaction. If you omit start_date, the endpoint uses the current date. If active rates already exist, you must set force_override=true.

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

Accrual type at the account level. The most commonly used values are:

  • WITHDRAWAL_INTEREST—Interest on a withdrawal
  • BILLPAYMENT_INTEREST—Interest on a bill payment
  • OVERDRAFT_INTEREST—Interest on an overdraft
  • FINANCIAL_TAX—Financial tax
float
required
0 to 100

Default rate, up to 3 integer and 6 fraction digits. Must be between 0 and 100.

string
enum
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.

Allowed:
number
required
0 to 100

Rate applied when overdue, up to 3 integer and 6 fraction digits. Must be between 0 and 100.

date

Start date. Cannot be in the past. Defaults to the current date when omitted. Format = YYYY-MM-DD.

int64
required

Transaction category ID

int64
required

Transaction ID

date

End date. Must be after start_date and not in the past. Format = YYYY-MM-DD.

boolean
Defaults to false

Should an existing active rate be deleted before creating the new one?

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?