Create an Onboarding Link | Sample

4 body fields

expandarray<string>optional

Specifies which fields in the response should be expanded.

link_optionsobjectrequired

Specific fields needed to generate the desired link type.

link_typestringrequired

The type of link being generated.

Allowed:apple_terms_and_conditions

on_behalf_ofstringoptional

Stripe account ID to generate the link for.

2 status codes

200Successful response.

link_optionsobjectrequired

Link type options associated with the current onboarding link object.

link_typestringrequired

The type of link being generated.

Allowed:apple_terms_and_conditions

objectstringrequired

Allowed:terminal.onboarding_link

on_behalf_ofstringoptional

Stripe account ID to generate the link for.

redirect_urlstringrequired

The link passed back to the user for their onboarding.

defaultError response.

errorobjectrequired

Error handling

Any other status is an error: Error response.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.onboardingLinks.create({
  linkOptions: "https://api.example.com/v1",
  linkType: "https://api.example.com/v1",
  expand: [],
  onBehalfOf: "example",
});

{
  "link_options": {
    "apple_terms_and_conditions": {
      "allow_relinking": true,
      "merchant_display_name": "Example Name"
    }
  },
  "link_type": "apple_terms_and_conditions",
  "object": "terminal.onboarding_link",
  "on_behalf_of": "example_value",
  "redirect_url": "https://example.com"
}

Request

Response

Errors