Close an abandoned account into an exact state payable for separately evidenced outward remittance

POST/accounts/{id}/escheatments

Path parameters

idstringRequired

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.

operatorstringRequired

statestringOptional

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

created_atstring · date-timeRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

interest_amountintegerRequired

Interest accrued to the turnover and credited before it

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

last_activity_datestring · dateRequired

A business date, YYYY-MM-DD

notice_sent_atstring · dateRequired

A business date, YYYY-MM-DD

operatorstringRequired

statestringRequired

withheld_amountintegerRequired

Backup withholding taken from that interest

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

400401403404409412413422424429500503