Skip to main content
POST
/
vendor
/
payout-accounts
/
{id}
/
onboarding
curl -X POST 'http://localhost:9000/vendor/payout-accounts/pacc_01HXYZ/onboarding' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"context": {"refresh_url": "https://vendor.example.com/payouts", "return_url": "https://vendor.example.com/payouts"}}'

{
  "onboarding": {
    "id": "onb_01HXYZ",
    "data": { "url": "https://connect.stripe.com/setup/s/..." },
    "context": { "return_url": "https://vendor.example.com/payouts" },
    "created_at": "2026-01-15T10:00:00.000Z"
  }
}
Creates an onboarding session with the payout provider — for Stripe Connect, the returned data contains the hosted onboarding link.

​
Path parameters

​
id
string
required
The payout account’s ID.

​
Body parameters

​
data
object
Provider-specific data forwarded when creating the onboarding.
​
context
object
Provider-specific context (e.g. refresh_url and return_url for Stripe Connect).

​
Response

​
onboarding
object
curl -X POST 'http://localhost:9000/vendor/payout-accounts/pacc_01HXYZ/onboarding' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"context": {"refresh_url": "https://vendor.example.com/payouts", "return_url": "https://vendor.example.com/payouts"}}'

{
  "onboarding": {
    "id": "onb_01HXYZ",
    "data": { "url": "https://connect.stripe.com/setup/s/..." },
    "context": { "return_url": "https://vendor.example.com/payouts" },
    "created_at": "2026-01-15T10:00:00.000Z"
  }
}