Corgi BankDocumentation
OpenAPI

Settle final interest and pay the remaining balance to the same owner's account

POST/accounts/{id}/closure

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

actorstringRequired
payout_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payout_methodstringOptional
reasonstringRequired

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

actorstringRequired
closing_fee_amountintegerRequired
datestring · dateRequired

A business date, YYYY-MM-DD

fee_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

interest_amountintegerRequired
interest_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

official_check_idstringOptional
payout_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payout_amountintegerRequired
payout_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payout_methodstringRequired
principal_amountintegerRequired
reasonstringRequired
remittance_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

remitted_amountintegerRequired
rounding_adjustmentstringRequired
withheld_amountintegerRequired
withholding_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

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

400401403404409412413422424429500503

to move to open esc to close