Penny Docs
Merchants

Get Merchant

GET
/v1/households/{household_id}/merchants/{merchant_id}

Retrieves an active household merchant with its website, resolved image URL, and transaction and recurring-series counts.

Returns merchant_not_found if the merchant is deleted or does not belong to this household.

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/households/string/merchants/string"
{  "id": "Mr9dL3xT6bQa",  "name": "Blue Bottle Coffee",  "website": "https://www.bluebottlecoffee.com/",  "image_url": "https://cdn.penny.finance/merchants/blue-bottle-coffee.png",  "default_image_url": "https://cdn.penny.finance/merchants/default-coffee.png",  "transaction_count": 18,  "recurring_transaction_count": 1}

Create Merchant POST

Creates a merchant in the household for use on transactions and recurring series. Returns the merchant with its resolved image URL and usage counts. The…

Delete Merchant DELETE

Deletes a merchant and clears its assignment from all associated transactions, including transactions on deleted accounts. The transactions themselves are…