Skip to content

Update Stripe Connection

POST/web/v1/workspaces/{workspaceId}/stripe/connections/updateJWT

Updates an existing Stripe connection. Only the fields provided in the request body are updated; omitted fields remain unchanged.

Authentication

Auth Chain: WEB Chain — requires Authorization: Bearer <jwt> Requires workspace:manage permission. These headers are injected by the system (frontend does nothing): X-PORTAL-ACCESS-CODE (Nginx), X-Request-Id (Gateway)

Request Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID
connectionBizIdstringYesbodyBusiness ID of the connection to update
connectionNamestringNobodyUpdated display name
connectionDescriptionstringNobodyUpdated description
stripeAccountIdstringNobodyUpdated Stripe account ID
apiKeystringNobodyUpdated Stripe API secret key
webhookSecretstringNobodyUpdated Stripe webhook signing secret
partnerEndpointstringNobodyUpdated partner callback endpoint URL
configJsonstringNobodyUpdated configuration JSON string

Success Response

Success200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "sc_abc123",
    "tenantBizId": "tn_xyz789",
    "connectionName": "Updated Stripe Connection",
    "connectionDescription": "Updated description",
    "stripeAccountId": "acct_1234567890",
    "partnerEndpoint": "https://partner.example.com/webhook",
    "configJson": null,
    "status": 1,
    "statusName": "ACTIVE",
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T01:00:00Z"
  }
}

Error Responses

Unauthorized401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}
Not Found404
{
  "success": false,
  "code": "4040",
  "message": "Stripe tenant connection not found"
}

Notes

  • Only provided fields are updated; omitted fields retain their current values.
  • Sensitive fields (apiKey, webhookSecret) are re-encrypted when updated.
  • Requires the workspace:manage permission on the target workspace.

Internal Documentation