PUT
/
merchants
/
onboard
/
{merchant_onboarding_id}
curl --request PUT \
  --url https://sandbox-api.violet.io/v1/merchants/onboard/{merchant_onboarding_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Violet-App-Id: <x-violet-app-id>' \
  --header 'X-Violet-App-Secret: <x-violet-app-secret>' \
  --header 'X-Violet-Token: <x-violet-token>' \
  --data '{
  "channelMerchantId": "<string>",
  "payoutAccountDetails": {
    "paymentProvider": "STRIPE",
    "primary": true,
    "metadata": {}
  },
  "commissionRateDetails": {
    "commission_rate": 123,
    "commission_rate_locked": true
  }
}'
{
  "merchant_onboarding_id": 123,
  "channel_merchant_id": "<string>",
  "app_id": 123,
  "payout_details": {
    "payment_provider": "STRIPE",
    "payment_provider_account_id": "<string>",
    "payment_provider_metadata": {}
  },
  "commission_details": {
    "commission_rate": 123,
    "commission_rate_locked": true
  },
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z"
}

Headers

X-Violet-Token
string
required
X-Violet-App-Secret
string
required
X-Violet-App-Id
integer
required

Path Parameters

merchant_onboarding_id
integer
required

Body

application/json

Response

default - application/json

default response

The response is of type object.