Collect Deposit (Customer Portal)

Changed on

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.

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

Query parameters

company_uidstring required
estimate_uidstring required

Response

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

Changes