Merchant Account - Retrieve

GET /v2/merchant-accounts/{id}

Retrieve a Merchant Account by its unique identifier.

cURL

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

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

Authorizations

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

Path parameters

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

Response (200 — application/json)

Merchant Account Retrieved — response fields:

  • 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, required) Available options: not_requested, requested, active, disabled

  • merchant_details (object) See the example response for child attributes (primary contact, phone, email, website, about_business, address, merchant_tax_registration_id)

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

  • product_type (enum) Available options: orchestration, vault, recon, recovery, cost_observability, dynamic_routing

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

PreviousCustomers - UpdateNextRouting - Retrieve Default Config