get
https://cloud.zenoz.ai/v1/merchant/cocoon/setup-status
See how far a merchant has got in setting up card acceptance, step by step.
The status is worked out on every request from the merchant's actual keys, webhooks and payments. Nobody can mark a step done by hand.
Each step has a status of done, todo, blocked or not_applicable, and a completed_at date where known:
checkout_domains: an active publishable key with at least one allowed origin. Returnspublishable_key_prefix; the full key is shown only once, when created.secret_key: an active secret key pinned to the merchant.webhook: an enabled webhook endpoint for the merchant subscribed topayment.captured.test_payment: a successful payment on a test deployment. On production this isnot_applicableand includes asandbox_url.support_email: a customer-support email address set for the merchant or its tenant (the platform default does not count). Payment receipts use it. It does not count towardsummary.live_ready: everything needed to take real cards is in place. Otherwiseblocked, withblocked_codeandblocked_reasonfor the first blocker andblockers[]for all of them. Codes:not_live_deployment,merchant_not_active,card_pan_custody_disabled,compliance_not_published,acquirer_unavailable.
summary is one of:
not_started: no setup step is done.in_progress: some are done.ready: all setup steps andlive_readyare done. On a test deployment,readyalso applies when the only blocker isnot_live_deployment.blocked: all setup steps are done but the account or platform is not yet ready for live cards.
The response also gives this deployment's environment, livemode, script_url and fields_origin. It never contains key values or webhook signing secrets.
Merchant users see their own merchant; asking for another merchant gets a 404. Tenant owners, admins and members must pass merchantId for a merchant on their tenant; other tenants' merchants get a 404.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…