Organization - Create

POST /organization

Create a new organization.

Example request (cURL)

Create organization (cURL)
curl --request POST \
  --url https://sandbox.hyperswitch.io/organization \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "organization_name": "organization_abc"
}
'

Success response (200)

{
  "organization_id": "org_q98uSGAYbjEwqs0mJwnz",
  "modified_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "organization_name": "<string>",
  "organization_details": {},
  "metadata": {},
  "organization_type": "standard"
}

Authorizations

  • Header: api-key (string) — required Admin API keys allow you to perform privileged actions such as creating a merchant account and Merchant Connector account.

Request body (application/json)

  • organization_name (string) — required Name of the organization

  • organization_details (object) — optional Details about the organization

  • metadata (object) — optional Metadata is useful for storing additional, unstructured information on an object.

Response schema (application/json)

  • organization_id (string) — required The unique identifier for the Organization Required string length: 1 - 64 Example: "org_q98uSGAYbjEwqs0mJwnz"

  • modified_at (string, date-time) — required

  • created_at (string, date-time) — required

  • organization_name (string | null) Name of the Organization

  • organization_details (object) Details about the organization

  • metadata (object) Metadata is useful for storing additional, unstructured information on an object.

  • organization_type (enum) Available options:

    • standard

    • platform

Links

  • Documentation: https://api-reference.hyperswitch.io/introduction

  • Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

  • Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

Edit this page: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/organization/organization--create.mdx Raise an issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/organization/organization--create

PreviousorganizationNextdisputes