Cancel interest terms before their effective date and accrual

POST/ledger/accounts/{id}/interest-plan/schedules/{schedule}/cancel

Path parameters

idstringRequired

schedulestringRequired

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

actorstringOptional

created_atstring · date-timeRequired

reasonstringRequired

200 OK

actorstringOptional

annual_rate_bpsintegerRequired

cancellationobject or nullOptional

3 child attributes

actorstringOptional

created_atstring · date-timeRequired

reasonstringRequired

created_atstring · date-timeRequired

day_countstringRequired

effective_datestring · dateRequired

A business date, YYYY-MM-DD

idstringRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

source_refstringRequired

statusstringRequired

tieringobject or nullOptional

2 child attributes

methodstringRequired

Whole_balance (Reg DD method A) or marginal (method B)

tiersarray of objectsRequired

2 child attributes

annual_rate_bpsintegerRequired

minimum_balance_minorintegerRequired

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503