Get merchant onboarding link

Production Environment

GET

/api/1/partner/merchant/{id}/onboarding-link

Merchants

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

string <uuid>

required

Merchant ID (UUID)

Query Params

returnUrl

string <uri>

required

URL to redirect to once merchant has completed onboarding

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

🟢200OK

application/json

OK response

Body

url

string

required

expiresAt

string

required

Example

{
  "url": "https://connect.stripe.com/setup/c/acct_1LmZQr2fwpTOCBRL/1xDBJQzfb4u6",
  "expiresAt": "2025-03-03T16:26:28.192Z"
}

🟠401Unauthorized

🟠404Record Not Found

Modified at 2025-03-03 16:34:00