Calculate and capture the next contractual rate reset and notice

POST/facilities/{id}/rate-resets

Path parameters

idstringRequired

Headers

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.

Body parameters

effective_datestring · dateRequired

A business date, YYYY-MM-DD

initial_noticebooleanRequired

operating_calendarobject or nullOptional

2 child attributes

closedarray of string · dateRequired

weekdaysarray of integersRequired

payment_datestring · dateRequired

A business date, YYYY-MM-DD

Returns

200 OK

cancelledbooleanOptional

decisionobject or nullOptional

4 child attributes

actorstringRequired

approvebooleanRequired

atstring · date-timeRequired

reasonstringRequired

makerstringRequired

recorded_atstring · date-timeRequired

valueobjectRequired

29 child attributes

at_consummationbooleanOptional

closing_idstringOptional

consummation_datestring · dateRequired

A business date, YYYY-MM-DD

contract_idstringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

earliest_deliverystring · dateRequired

A business date, YYYY-MM-DD

effective_datestring · dateRequired

A business date, YYYY-MM-DD

escrow_payment_amountintegerRequired

estimatedbooleanOptional

first_installmentintegerRequired

idstringRequired

initial_noticebooleanRequired

latest_deliverystring · dateRequired

A business date, YYYY-MM-DD

new_payment_amountintegerRequired

new_rate_bpsintegerRequired

Rounded half up from NewRateNanos

new_rate_nanosintegerRequired

notice_datestring · dateRequired

A business date, YYYY-MM-DD

notice_rulestringRequired

observationobjectRequired

Observation rates are billionths of an annual fraction: 53,300,000 means 5.33%.

8 child attributes

effective_datestring · dateRequired

A business date, YYYY-MM-DD

evidence_sha256stringRequired

idstringRequired

indexstringRequired

published_atstring · date-timeRequired

rate_nanosintegerRequired

sourcestringRequired

supersedesstringOptional

old_payment_amountintegerRequired

old_rate_bpsintegerRequired

Whole basis points, for readers of them

old_rate_nanosintegerRequired

The contract rates, exact

operating_calendarobjectRequired

2 child attributes

closedarray of string · dateRequired

weekdaysarray of integersRequired

payment_datestring · dateRequired

A business date, YYYY-MM-DD

principal_amountintegerRequired

remaining_monthsintegerRequired

target_idstringRequired

target_kindstringRequired

termsobjectRequired

17 child attributes

ceiling_bpsintegerRequired

evidence_sha256stringRequired

first_resetstring · dateRequired

A business date, YYYY-MM-DD

floor_bpsintegerRequired

frequency_daysintegerRequired

frequency_monthsintegerRequired

indexstringRequired

lifetime_cap_bpsintegerRequired

lookback_daysintegerRequired

margin_bpsintegerRequired

max_age_daysintegerRequired

notice_daysintegerRequired

notice_rulestringRequired

periodic_cap_bpsintegerRequired

roundingstringRequired

rounding_bpsintegerRequired

Whole basis points; superseded by RoundingNanos when set

rounding_nanosintegerOptional

The rounding step in nanos: 1,250,000 is an eighth of a percent (12.5 bp)

Errors

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

400401403404409412413422424429500503