Penny Docs
Accounts

Close Account

POST
/v1/households/{household_id}/accounts/{account_id}/close

Marks an account as closed on closed_at while retaining its transaction history. The account remains in the account list, with a displayed balance of zero.

Historical balances are treated as zero from the closure date onward. This records the account's status in Penny; it does not close the account at the financial institution. Use the reopen endpoint to clear the closure date.

Authorization

PersonalApiToken
AuthorizationBearer <token>

Use your personal API token (penny_pat_…) as the bearer credential. Enter the token only; the client adds the Bearer prefix. Read-only tokens permit read requests. Read/write tokens remain limited by your current household membership and role. See https://penny.finance/docs/api#authentication for setup.

In: header

Path Parameters

household_id*Household Id
account_id*Account Id

Request Body

application/json

closed_at*Closed At
Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/households/string/accounts/string/close" \  -H "Content-Type: application/json" \  -d '{    "closed_at": "2019-08-24"  }'
Empty

Update Account PUT

Updates the display-name override for a financial account and returns the updated account. Set username to null to remove the override and use the account's…

Reopen Account POST

Clears an account's closure date so Penny displays its recorded balance again and stops zeroing its balance history from that date. The account must not be…