Penny Docs
Merchants

Upload Merchant Image

PUT
/v1/households/{household_id}/merchants/{merchant_id}/image

Uploads or replaces a merchant's custom image and returns its display URL. The custom image takes precedence over any default merchant image.

Send a JPEG, PNG, or WebP image as the multipart file field, up to 5 MiB (5,242,880 bytes) and 25 million decoded pixels across all frames.

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
merchant_id*Merchant Id

Request Body

multipart/form-data

file*File
Formatbinary

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/merchants/string/image" \  -F file="string"
{  "image_url": "https://cdn.penny.finance/merchants/blue-bottle-coffee.png"}

Delete Merchant Image DELETE

Removes a merchant's custom image so imageurl falls back to defaultimageurl, which may be null. Returns 204 with no response body on success, or noimage if…

List Tags GET

Lists all active household tags with their colors and visible transaction counts. The response is not paginated and includes unused tags. Deleted tags are…