Merchant Account - Update

Update Merchant Details.

PUT /v2/merchant-accounts/{id}

Request

Authorization

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

Path parameter

• id (string, required) — The unique identifier for the merchant account.

Body (application/json)

• merchant_name (string | null) — Name of the Merchant Account. Example: "NewAge Retailer"

• merchant_details (object) — See child attributes in API reference.

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

Example cURL

curl

curl --request PUT \
  --url https://sandbox.hyperswitch.io/v2/merchant-accounts/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "merchant_details": {
    "primary_contact_person": "John Doe",
    "primary_email": "[email protected]"
  }
}
'

Response

• 200 (application/json) — Merchant Account Updated

Example response:

Show example response (200)

response.json

{
  "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"
}

Schema notes / field details

• id (string) — The identifier for the Merchant Account. Max length: 64. Example: "y3oqhf46pyzuxjbcn2giaqnb44"

• merchant_name (string) — Name of the Merchant Account. Example: "NewAge Retailer"

• publishable_key (string) — API key for server-side API access. Example: "AH3423bkjbkjdsfbkj"

• organization_id (string) — ID of the organization associated with the merchant. Required length: 1 - 64. Example: "org_q98uSGAYbjEwqs0mJwnz"

• recon_status (enum) — One of: not_requested, requested, active, disabled

• merchant_details (object) — Contains merchant contact, address, tax id, etc.

• metadata (object) — Additional unstructured information.

• product_type (enum) — One of: orchestration, vault, recon, recovery, cost_observability, dynamic_routing

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

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

Was this page helpful? Yes / No