Get All Merchant Onboarding Records

Retrieve all merchant onboarding records.

get

Query parameters

pageinteger · int32OptionalDefault: 1

sizeinteger · int32OptionalDefault: 20

app_idinteger · int32Optional

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

200

Merchant Onboarding Record

application/json

totalElementsinteger · int64Optional

totalPagesinteger · int32Optional

sizeinteger · int32Optional

contentobject[]Optional

numberinteger · int32Optional

firstbooleanOptional

numberOfElementsinteger · int32Optional

lastbooleanOptional

emptybooleanOptional

get

/merchants/onboard

HTTPcURLJavaScriptPython

GET /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
Accept: */*

200

Merchant Onboarding Record

{
  "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.000+00:00",
      "date_last_modified": "2025-06-16T17:15:35.000+00:00"
    },
    {
      "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.000+00:00",
      "date_last_modified": "2025-06-16T17:15:47.000+00:00"
    }
  ],
  "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
}