On this page
createStripeOnboardingLink
mutation · in the family Organization structure
What it does
Get the Stripe onboarding link — where the owner completes the payments-account paperwork.
Mint an EPHEMERAL Stripe-hosted onboarding link for the org's connected account. Unprovisioned refuses CONFLICT/REF_STATE; a processor refusal maps CONFLICT/RECONCILE (retryable — the stored ref and the processor disagree). Requires the unrestricted capability. No revision — this mutates NOTHING on the record.
Careful
The link is short-lived and personal to your account setup.
Who may call it
Capability area: Organization structure — Opening and closing organizations and facilities — the legal and physical structure of your group.
- Owner
- System Administrator
- An API key whose scope allows
api:createStripeOnboardingLink
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
StripeOnboardingLink StripeOnboardingLink! — An EPHEMERAL Stripe-hosted onboarding link. The merchant completes Stripe-owned requirement collection there (the Standard shape — platform-supplied ToS refuses structurally, probed live).
Example request
mutation ExampleCreateStripeOnboardingLink($id: ID!) {
createStripeOnboardingLink(id: $id) {
url
expiresAt
}
}Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.
Example response
{
"data": {
"createStripeOnboardingLink": {
"url": "https://example.com/hook",
"expiresAt": 1
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": {
"name": "genesis",
"number": 0
},
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)NOT_FOUND/*— That record could not be found. (NOT_FOUND)CONFLICT/*— The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)VALIDATION/VERSION_REQUIRED— The request did not say which app version it came from. (VALIDATION)