Platform - Create

Create a platform account.

Endpoint

• Method: POST

• URL: https://sandbox.hyperswitch.io/user/create_platform

• Path: /user/create_platform

cURL

curl --request POST \
  --url https://sandbox.hyperswitch.io/user/create_platform \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_name": "organization_abc"
}
'

Authorization: Bearer authentication header of the form Bearer <token>, where <token> is your auth token. This header is required.

Request body

Content-Type: application/json

Schema:

• organization_name (string, required) — Maximum string length: 64 Example:

  "organization_abc"

Successful response (200)

Content-Type: application/json

Example:

{
  "merchant_account_type": "platform",
  "merchant_id": "merchant_abc",
  "org_id": "org_abc",
  "org_name": "organization_abc",
  "org_type": "platform"
}

Response fields

• org_id (string, required) — Required string length: 1 - 64 Example: "org_abc"

• org_type (enum, required) — Available options: standard, platform

• merchant_id (string, required) Example: "merchant_abc"

• merchant_account_type (enum, required) — Available options: standard, platform, connected

• org_name (string | null) Example: "organization_abc"

---

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/platform/platform--create.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/platform/platform--create