Overview
Login
- Access
Onboarding
Merchants
- Merchant
- Configuration
- Onboarding
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Payments
- Payout Accounts
- Distributions
- Transfers
- Transfer Reversals
Events
- Webhooks
- Webhook Events
- Webhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Merchant Onboarding
Get All Merchant Onboarding Records
GET
/
merchants
/
onboard
Copy
Ask AI
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants/onboard \
--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>'
Copy
Ask AI
{
"content": [
{
"merchant_onboarding_id": 10000,
"channel_merchant_id": "ISHAN123456789",
"app_id": 11661,
"payout_details": {
"payment_provider": "STRIPE",
"payment_provider_account_id": "acc_123456789",
"payment_provider_metadata": {
"stripe_account_id": "acc_123456789"
}
},
"date_created": "2025-06-16T17:15:35.000Z",
"date_last_modified": "2025-06-16T17:15:35.000Z"
},
{
"merchant_onboarding_id": 10001,
"channel_merchant_id": "ISHAN222222222",
"app_id": 11661,
"payout_details": {
"payment_provider": "STRIPE",
"payment_provider_account_id": "acc_222222222",
"payment_provider_metadata": {
"stripe_account_id": "acc_222222222"
}
},
"date_created": "2025-06-16T17:15:47.000Z",
"date_last_modified": "2025-06-16T17:15:47.000Z"
}
],
"pageable": {
"page_number": 0,
"page_size": 2,
"sort": {
"unsorted": false,
"sorted": true,
"empty": false
},
"offset": 0,
"unpaged": false,
"paged": true
},
"total_elements": 5,
"total_pages": 3,
"last": false,
"first": true,
"number_of_elements": 2,
"size": 2,
"number": 0,
"sort": {
"unsorted": false,
"sorted": true,
"empty": false
},
"empty": false
}
Headers
Response
200 - application/json
Merchant Onboarding Record
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request GET \
--url https://sandbox-api.violet.io/v1/merchants/onboard \
--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>'
Copy
Ask AI
{
"content": [
{
"merchant_onboarding_id": 10000,
"channel_merchant_id": "ISHAN123456789",
"app_id": 11661,
"payout_details": {
"payment_provider": "STRIPE",
"payment_provider_account_id": "acc_123456789",
"payment_provider_metadata": {
"stripe_account_id": "acc_123456789"
}
},
"date_created": "2025-06-16T17:15:35.000Z",
"date_last_modified": "2025-06-16T17:15:35.000Z"
},
{
"merchant_onboarding_id": 10001,
"channel_merchant_id": "ISHAN222222222",
"app_id": 11661,
"payout_details": {
"payment_provider": "STRIPE",
"payment_provider_account_id": "acc_222222222",
"payment_provider_metadata": {
"stripe_account_id": "acc_222222222"
}
},
"date_created": "2025-06-16T17:15:47.000Z",
"date_last_modified": "2025-06-16T17:15:47.000Z"
}
],
"pageable": {
"page_number": 0,
"page_size": 2,
"sort": {
"unsorted": false,
"sorted": true,
"empty": false
},
"offset": 0,
"unpaged": false,
"paged": true
},
"total_elements": 5,
"total_pages": 3,
"last": false,
"first": true,
"number_of_elements": 2,
"size": 2,
"number": 0,
"sort": {
"unsorted": false,
"sorted": true,
"empty": false
},
"empty": false
}
Assistant
Responses are generated using AI and may contain mistakes.