---
title: "Collect Deposit (Customer Portal)"
method: GET
path: "/customer_portal/estimates/collect_deposit"
---

# Collect Deposit (Customer Portal)

`GET /customer_portal/estimates/collect_deposit`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/customer_portal/estimates/collect_deposit`
- Auth: API key in header `x-api-key`

Public, unauthenticated hosted payment page — not a JSON API. Renders (Stripe) or redirects (Square) to a hosted checkout page for the customer to pay their estimate deposit. On error, renders an HTML error page rather than returning a JSON error body.

## Query parameters

- `company_uid` string, required
- `estimate_uid` string, required

## Response `200`

200 — HTML payment page (Stripe), or a 3xx redirect to a hosted Square payment link.

## Other responses

- `400`: 400 — HTML error page (e.g. deposit disabled, estimate archived/canceled, already collected, no payment provider configured).

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/customer_portal/estimates/collect_deposit/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)