Merchant Account - Retrieve

GET /accounts/{account_id}

Example request (cURL)

curl --request GET \
  --url https://sandbox.hyperswitch.io/accounts/{account_id} \
  --header 'api-key: <api-key>'

Example response — 200 application/json

{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "enable_payment_response_hash": true,
  "redirect_to_merchant_with_http_post": true,
  "primary_business_details": [
    {
      "country": "AF",
      "business": "food"
    }
  ],
  "organization_id": "org_q98uSGAYbjEwqs0mJwnz",
  "is_recon_enabled": true,
  "recon_status": "not_requested",
  "merchant_account_type": "standard",
  "merchant_name": "NewAge Retailer",
  "return_url": "https://www.example.com/success",
  "payment_response_hash_key": "xkkdf909012sdjki2dkh5sdf",
  "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"
  },
  "webhook_details": {
    "payment_statuses_enabled": [
      "succeeded",
      "failed",
      "partially_captured",
      "requires_merchant_action"
    ],
    "refund_statuses_enabled": [
      "success",
      "failure"
    ],
    "webhook_version": "1.0.2",
    "webhook_username": "ekart_retail",
    "webhook_password": "ekart@123",
    "webhook_url": "www.ekart.com/webhooks",
    "payment_created_enabled": true,
    "payment_succeeded_enabled": true,
    "payment_failed_enabled": true,
    "payout_statuses_enabled": [
      "success",
      "failed"
    ]
  },
  "payout_routing_algorithm": {
    "type": "single",
    "data": {
      "connector": "authipay",
      "merchant_connector_id": "<string>"
    }
  },
  "sub_merchants_enabled": false,
  "parent_merchant_id": "xkkdf909012sdjki2dkh5sdf",
  "publishable_key": "AH3423bkjbkjdsfbkj",
  "metadata": {},
  "locker_id": "locker_abc123",
  "frm_routing_algorithm": {
    "type": "single",
    "data": {
      "connector": "authipay",
      "merchant_connector_id": "<string>"
    }
  },
  "default_profile": "<string>",
  "pm_collect_link_config": {
    "allowed_domains": [
      "<string>"
    ],
    "enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]",
    "logo": "https://hyperswitch.io/favicon.ico",
    "merchant_name": "Hyperswitch",
    "theme": "#4285F4",
    "domain_name": "<string>"
  },
  "product_type": "orchestration"
}

Authorizations

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

Path parameters

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

Response (200) — Fields

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

  • enable_payment_response_hash (boolean, required, default: false) Indicates if payment response hash is enabled. Example: true

  • redirect_to_merchant_with_http_post (boolean, required, default: false) Indicates if redirect to merchant with HTTP POST is enabled. Example: true

  • primary_business_details (object[], required) Details about the primary business unit of the merchant account. Example element:

    • country (string)

    • business (string)

  • organization_id (string, required) Organization id merchant is associated with. String length: 1–64. Example: "org_q98uSGAYbjEwqs0mJwnz"

  • is_recon_enabled (boolean, required) Whether recon service is enabled (default: false).

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

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

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

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

  • payment_response_hash_key (string | null) Hash key used for signatures for webhooks and redirect responses. If not provided, generated automatically. Max length: 255. Example: "xkkdf909012sdjki2dkh5sdf"

  • merchant_details (object) Object containing merchant contact and business details. Includes:

    • primary_contact_person, primary_phone, primary_email

    • secondary_contact_person, secondary_phone, secondary_email

    • website, about_business, merchant_tax_registration_id

    • address (object): city, country, line1, line2, line3, zip, state, first_name, last_name, origin_zip

  • webhook_details (object) Webhook configuration, includes:

    • payment_statuses_enabled (array)

    • refund_statuses_enabled (array)

    • webhook_version, webhook_username, webhook_password, webhook_url

    • payment_created_enabled, payment_succeeded_enabled, payment_failed_enabled

    • payout_statuses_enabled (array)

  • payout_routing_algorithm (object) Routing algorithm for payouts. Example structure:

    • type (e.g., "single")

    • data: { connector, merchant_connector_id }

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

  • parent_merchant_id (string | null) Parent Merchant ID when merchant is a sub-merchant. Max length: 255.

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

  • metadata (object) Additional unstructured metadata.

  • locker_id (string | null) Identifier for vault used to store payment method information. Example: "locker_abc123"

  • frm_routing_algorithm (object) FRM routing algorithm (similar structure to payout_routing_algorithm).

  • default_profile (string | null) Default profile used for creating merchant accounts and payments. Max length: 64.

  • pm_collect_link_config (object) Generic link UI config. Fields:

    • allowed_domains (array of strings)

    • enabled_payment_methods (stringified JSON in example)

    • logo (string URL)

    • merchant_name (string)

    • theme (string color)

    • domain_name (string)

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

Related endpoints

  • Merchant Account — Create: /v1/merchant-account/merchant-account--create

  • Merchant Account — Update: /v1/merchant-account/merchant-account--update

Was this page helpful? (original feedback links removed)

PreviousProfile - CreateNextOrganization - Update