Skip to content

Corgi BankDocumentation

OpenAPI

Atomically settle final interest, taxes and payout, then close

POST/ledger/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

feesarray of objectsOptional

3 child attributes

amountintegerRequired

kindstringRequired

waiver_min_balanceintegerRequired

payout_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

reasonstringRequired

remit_interestbooleanRequired

withholding_bpsintegerRequired

Returns

200 OK

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

keystringRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payout_amountintegerRequired

payout_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payout_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

principal_amountintegerRequired

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

Request

curl -X POST 'https://api.dev.bank.corgi.com/ledger/accounts/{id}/closure' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "actor": "string",
    "payout_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "reason": "string",
    "remit_interest": false,
    "withholding_bps": 0
  }'

Response200

{
  "closing_fee_amount": 10000,
  "date": "2026-09-17",
  "fee_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "interest_amount": 10000,
  "interest_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "key": "string",
  "ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "payout_amount": 10000,
  "payout_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "payout_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "principal_amount": 10000,
  "remittance_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "remitted_amount": 10000,
  "rounding_adjustment": "string",
  "withheld_amount": 10000,
  "withholding_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm"
}