Disconnect the workspace's Stripe account
Ends the workspace's use of its connected Stripe account so it can connect another with startPaymentsOnboarding. Workspace owners and admins only. Refused with 409 payments_in_use while a sent document that is still waiting for signatures has a payment field, or while money on any document is still in motion (an open PaymentIntent, or a payment on a document that did not complete whose refund is not yet requested); the response names up to five of those documents. Nothing is deleted at Stripe, and payments already taken keep the account they were taken on, so refunds still reach it. Returns the new state, which is not connected.
View as MarkdownAuthorization
bearer In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/payments/account"{ "configured": true, "connected": true, "chargesEnabled": true, "payoutsEnabled": true, "detailsSubmitted": true, "accountRef": "string", "accountLabel": "string", "disconnectedBy": "workspace"}Whether this workspace can take payments (EAS-119)
The workspace's Stripe Connect state. A workspace connects its own Standard Stripe account, and payments are charged directly on it, so the money goes to the workspace and not through Easerix. Pass refresh=1 to read the account back from Stripe first, which is how the settings page picks up a finished onboarding without waiting for a webhook. A document with a payment field can be sent only when chargesEnabled.
Connect (or resume connecting) the workspace's Stripe account
Creates the workspace's connected account on first use and returns a Stripe-hosted onboarding link. After disconnectPaymentsAccount it creates a new account (never the one that was disconnected). Workspace owners and admins only. Stripe returns the user to the settings page afterwards; the account is then read back with getPaymentsAccount?refresh=1.