Create Merchant Onboarding Record

Onboard Merchant details from the channel systems for Violet to consume during Violet Merchant onboarding

post

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

application/json

channelMerchantIdstringOptional

Responses

200

Merchant Onboarding Record

application/json

merchant_onboarding_idinteger · int64Optional

Unique identifier for this merchant onboarding record.

channel_merchant_idstringOptional

Unique identifier of this merchant in the channel’s systems.

app_idinteger · int32Optional

Identifier of the App in Violet that this external payout account is associated to.

date_createdstring · date-timeOptional

Time at which the object was created. In ISO-8601 format.

date_last_modifiedstring · date-timeOptional

Time at which the object was last modified. In ISO-8601 format.

post/merchants/onboard

HTTPcURLJavaScriptPython

POST /v1/merchants/onboard HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "channel_merchant_id": "chnl-test-01",
  "payout_details": {
    "payment_provider": "STRIPE",
    "payment_provider_metadata": {
      "stripe_account_id": "acct_123456789"
    }
  }
}

200

Merchant Onboarding Record

{
  "merchant_onboarding_id": 10006,
  "channel_merchant_id": "chnl-test-01",
  "app_id": 11026,
  "payout_details": {
    "payment_provider": "STRIPE",
    "payment_provider_account_id": "acct_123456789",
    "payment_provider_metadata": {
      "stripe_account_id": "acct_1RafLoGaeMLpjAlB"
    }
  },
  "date_created": "2025-06-17T06:46:35.307+00:00",
  "date_last_modified": "2025-06-17T06:46:35.307+00:00"
}