Skip to main content
POST
/
v2
/
merchant-accounts
curl --request POST \
  --url https://sandbox.hyperswitch.io/v2/merchant-accounts \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --header 'api-key: <api-key>' \
  --data '
{
  "merchant_details": {
    "primary_contact_person": "John Doe",
    "primary_email": "[email protected]"
  },
  "merchant_name": "Cloth Store"
}
'
{
  "id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "merchant_name": "NewAge Retailer",
  "publishable_key": "AH3423bkjbkjdsfbkj",
  "organization_id": "org_q98uSGAYbjEwqs0mJwnz",
  "recon_status": "not_requested",
  "merchant_details": {
    "primary_contact_person": "John Doe",
    "primary_phone": "999999999",
    "primary_email": "[email protected]",
    "secondary_contact_person": "John Doe2",
    "secondary_phone": "999999988",
    "secondary_email": "[email protected]",
    "website": "www.example.com",
    "about_business": "Online Retail with a wide selection of organic products for North America",
    "address": {
      "city": "New York",
      "country": "AF",
      "line1": "123, King Street",
      "line2": "Powelson Avenue",
      "line3": "Bridgewater",
      "zip": "08807",
      "state": "New York",
      "first_name": "John",
      "last_name": "Doe",
      "origin_zip": "08807"
    },
    "merchant_tax_registration_id": "123456789"
  },
  "metadata": {},
  "product_type": "orchestration"
}

Authorizations

​
api-key
string
header
required

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account.

Headers

​
X-Organization-Id
string
required

Organization ID for which the merchant account has to be created.

Body

application/json
​
merchant_name
string
required

Name of the Merchant Account, This will be used as a prefix to generate the id

Maximum string length: 64
Example:

"NewAge Retailer"

​
merchant_details
object
​
metadata
object

Metadata is useful for storing additional, unstructured information about the merchant account.

​
product_type
enum<string>
Available options:
orchestration,
vault,
recon,
recovery,
cost_observability,
dynamic_routing

Response

Merchant Account Created

​
id
string
required

The identifier for the Merchant Account

Maximum string length: 64
Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

​
merchant_name
string
required

Name of the Merchant Account

Example:

"NewAge Retailer"

​
publishable_key
string
required

API key that will be used for server side API access

Example:

"AH3423bkjbkjdsfbkj"

​
organization_id
string
required

The id of the organization which the merchant is associated with

Required string length: 1 - 64
Example:

"org_q98uSGAYbjEwqs0mJwnz"

​
recon_status
enum<string>
required
Available options:
not_requested,
requested,
active,
disabled
​
merchant_details
object
​
metadata
object

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

​
product_type
enum<string>
Available options:
orchestration,
vault,
recon,
recovery,
cost_observability,
dynamic_routing