Merchant Account - KV Status

POST /accounts/{account_id}/kv

Description: Enable or disable KV mode for a Merchant Account.

Request (cURL)

Disable KV for Merchant — cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/accounts/{account_id}/kv \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "kv_enabled": "false"
}
'

Response (200)

Example response
{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "kv_enabled": true
}

Authorizations

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

Path parameters

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

Body (application/json)

  • kv_enabled (boolean) — required Status of KV for the specific merchant. Example: true

Response (200 — application/json)

KV mode is enabled/disabled for Merchant Account.

  • merchant_id (string) — required The identifier for the Merchant Account. Maximum length: 255 Example: "y3oqhf46pyzuxjbcn2giaqnb44"

  • kv_enabled (boolean) — required Status of KV for the specific merchant. Example: true


Was this page helpful? Yes / No

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