POST /v1/terminal/onboarding_links
Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
Servers
- https://api.stripe.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
link_options |
Object | Yes |
Specific fields needed to generate the desired link type. |
link_options.apple_terms_and_conditions |
Object | No | |
link_options.apple_terms_and_conditions.merchant_display_name |
String | Yes | |
link_options.apple_terms_and_conditions.allow_relinking |
Boolean | No | |
on_behalf_of |
String | No |
Stripe account ID to generate the link for. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
link_type |
String | Yes |
The type of link being generated. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.