Penny Docs
Accounts

Update Account

PUT
/v1/households/{household_id}/accounts/{account_id}

Updates the display-name override for a financial account and returns the updated account.

Set user_name to null to remove the override and use the account's default display name. The account must belong to the household and must not be deleted.

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

Replaces the account name override; omitted or null user_name clears it.

user_name?|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/households/string/accounts/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "Ac7kP2mN9qRs",  "mask": "4821",  "name": "Everyday Checking",  "type": "depository",  "current_balance": {    "amount": "68.42",    "currency": "USD"  },  "currency": "USD",  "household_id": "Hh4vK8pQ2sLm",  "user_name": "Daily spending",  "provider": "plaid",  "transaction_count": 184,  "is_closed": false,  "linked_at": "2019-08-24T14:15:22Z",  "last_synced_at": "2019-08-24T14:15:22Z",  "added_by_id": "Us2mH7qB5kLp",  "plaid": {    "item_id": "item_sandbox_8d4f1c2a",    "connection_status": "healthy",    "error_code": "ITEM_LOGIN_REQUIRED"  },  "image_url": "https://cdn.penny.finance/institutions/chase.png",  "default_image_url": "https://cdn.penny.finance/accounts/checking.png"}

Delete Account DELETE

Soft-deletes an account, removing it and its transactions from normal household views and reports. The account can be restored while its records are…

Close Account POST

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