Skip to main content
POST
/
v2
/
organizations
Organization - Create
curl --request POST \
  --url https://sandbox.hyperswitch.io/v2/organizations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_name": "organization_abc"
}
'
{
  "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

​
Authorization
string
header
required

Format: admin-api-key=<admin-api-key>

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.

Body

application/json
​
organization_name
string
required

Name of the organization

​
organization_details
object

Details about the organization

​
metadata
object

Metadata is useful for storing additional, unstructured information on an object.

Response

Organization Created

​
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<string>
Available options:
standard,
platform