extensions / Commerce extension
POST
/api/projects/{project_id}/sales/payment-services/{service_id}/stripe/connectConnect Stripe
Creates or reuses a merchant-owned Stripe Connect account for a project payment service and returns an onboarding link.
POST
Authentication
- Requirement
- Required
- Credential type
- Bearer API key
- Scopes
- Not specified
Permissions
- Requests are scoped to the target project_id. API-key requests must use a key with an active connection to that project.
Headers
| Name | Required | Type | Details |
|---|---|---|---|
Authorization | Yes | Not specified | Description: Bearer credential used to authenticate the request. |
Path Parameters
| Name | Required | Type | Details |
|---|---|---|---|
project_id | Yes | Not specified | Description: Target project identifier. |
service_id | Yes | Not specified | Description: Identifier for service. |
Query Parameters
Request Body
Schema: StripeConnectRequest
| Field | Required | Type | Details |
|---|---|---|---|
return_url | Yes | string | Description: Text value. |
refresh_url | Yes | string | Description: Text value. |
Response Body
Example 200 response
json
{
"account_id": 1,
"migration": "string",
"onboarding_url": "string"
}Errors
400 bad_request500 internal_server_errorAvailability
- Available in
- v0.1.0
- Available since
- v0.1.0
- Implementation
- Available
- Deprecation
- Not specified
- Rate limits
- Not specified