Get Violet Connect URLs

This API lets you generate pre-formatted Violet Connect URLs that merchants can use to complete specific onboarding steps. You can request URLs for individual steps like setting up payouts, configuring commission rates, or creating a Stripe Express Account — or fetch all available onboarding links at once.

Use the step query parameter to retrieve a link for a specific part of the Violet Connect flow:

• PAYOUTS

• COMMISSION_RATE

• CREATE_STRIPE_EXPRESS_ACCOUNT

If no step is provided, the API will return URLs for all steps. You can also pass an optional state parameter to include custom state information in the returned links.

This endpoint is especially useful when you want to send merchants directly into a specific part of onboarding, like immediately prompting them to select a banking country to create a Stripe Express Account.

Get pre-formatted links for Violet Connect onboarding for a given merchant

get

Path parameters

merchant_idinteger · int32Required

Query parameters

stepstringOptional

statestringOptional

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /v1/merchants/{merchant_id}/violet_connect_urls HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

default

default response

[
  {
    "step": "PAYOUTS",
    "url": "text"
  }
]