Merchant Account - Update

Update merchant account details.

POST /accounts/{account_id}

Request

Headers:

  • Content-Type: application/json

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

Path parameter:

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

Body (application/json)

Fields (selection):

  • merchant_id (string, required) — The identifier for the Merchant Account (max length: 64) Example: "y3oqhf46pyzuxjbcn2giaqnb44"

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

  • merchant_details (object) — Merchant contact, address and other details

  • return_url (string | null) — URL to redirect after completion (max length: 255) Example: "https://www.example.com/success"

  • webhook_details (object) — Webhook configuration

  • payout_routing_algorithm (object) — Payout routing configuration

    • Option 1

    • Option 2

    • Option 3

    • Option 4

    • Option 5

  • sub_merchants_enabled (boolean | null, default: false) — Whether merchant is a sub-merchant Example: false

  • parent_merchant_id (string | null) — Parent Merchant ID if this is a sub-merchant (max length: 255)

  • enable_payment_response_hash (boolean | null, default: false) — Enable payment response hash Example: true

  • payment_response_hash_key (string | null) — Hash key used for signatures for webhooks / redirect responses

  • redirect_to_merchant_with_http_post (boolean | null, default: false) — Enable redirect with HTTP POST Example: true

  • metadata (object) — Free-form metadata

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

  • locker_id (string | null) — Vault identifier for payment method storage Example: "locker_abc123"

  • primary_business_details (object[] | null) — Details about primary business unit(s)

  • frm_routing_algorithm (object) — FRM routing algorithm configuration

  • default_profile (string | null) — Default profile for creating merchant accounts and payments (max length: 64)

  • pm_collect_link_config (object) — GenericLinkUiConfig (allowed_domains, enabled_payment_methods, logo, merchant_name, theme, domain_name)

Example cURL request:

Response

Status: 200 — Merchant Account Updated Content-Type: application/json

Response fields (selection):

  • merchant_id (string) — Identifier for the Merchant Account (max length: 64) Example: "y3oqhf46pyzuxjbcn2giaqnb44"

  • enable_payment_response_hash (boolean, default:false) — Whether payment response hash is enabled

  • redirect_to_merchant_with_http_post (boolean, default:false)

  • primary_business_details (object[])

  • organization_id (string) — Organization id merchant is associated with (1–64 chars) Example: "org_q98uSGAYbjEwqs0mJwnz"

  • is_recon_enabled (boolean)

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

  • merchant_account_type (enum) — One of: standard, platform, connected

  • merchant_name (string | null)

  • return_url (string | null)

  • payment_response_hash_key (string | null) — If not provided, a value is auto-generated (max length: 255)

  • merchant_details (object)

  • webhook_details (object)

  • payout_routing_algorithm (object)

    • Option 1

    • Option 2

    • Option 3

    • Option 4

    • Option 5

  • sub_merchants_enabled (boolean | null, default:false)

  • parent_merchant_id (string | null)

  • publishable_key (string | null)

  • metadata (object)

  • locker_id (string | null)

  • frm_routing_algorithm (object)

    • Option 1

    • Option 2

    • Option 3

    • Option 4

    • Option 5

  • default_profile (string | null)

  • pm_collect_link_config (object)

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

Example 200 response:

If you need to edit this page or raise an issue, keep the original links:

  • Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/merchant-account/merchant-account--update.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/merchant-account/merchant-account--update

Related:

  • Merchant Account — Retrieve: https://api-reference.hyperswitch.io/v1/merchant-account/merchant-account--retrieve

  • Merchant Account — Delete: https://api-reference.hyperswitch.io/v1/merchant-account/merchant-account--delete

Previousmerchant-accountNextsubscriptions