GET
/
accounts
/
{account_id}
curl --request GET \
  --url https://sandbox.hyperswitch.io/accounts/{account_id} \
  --header 'api-key: <api-key>'
{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "merchant_name": "NewAge Retailer",
  "return_url": "https://www.example.com/success",
  "enable_payment_response_hash": true,
  "payment_response_hash_key": "xkkdf909012sdjki2dkh5sdf",
  "redirect_to_merchant_with_http_post": true,
  "merchant_details": {
    "primary_contact_person": "John Doe",
    "primary_phone": "999999999",
    "primary_email": "johndoe@test.com",
    "secondary_contact_person": "John Doe2",
    "secondary_phone": "999999988",
    "secondary_email": "johndoe2@test.com",
    "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"
    }
  },
  "webhook_details": {
    "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_routing_algorithm": {
    "type": "single",
    "data": {
      "connector": "adyenplatform",
      "merchant_connector_id": "<string>"
    }
  },
  "sub_merchants_enabled": false,
  "parent_merchant_id": "xkkdf909012sdjki2dkh5sdf",
  "publishable_key": "AH3423bkjbkjdsfbkj",
  "metadata": {},
  "locker_id": "locker_abc123",
  "primary_business_details": [
    {
      "country": "AF",
      "business": "food"
    }
  ],
  "frm_routing_algorithm": {
    "type": "single",
    "data": {
      "connector": "adyenplatform",
      "merchant_connector_id": "<string>"
    }
  },
  "organization_id": "org_q98uSGAYbjEwqs0mJwnz",
  "is_recon_enabled": true,
  "default_profile": "<string>",
  "recon_status": "not_requested",
  "pm_collect_link_config": {
    "logo": "https://hyperswitch.io/favicon.ico",
    "merchant_name": "Hyperswitch",
    "theme": "#4285F4",
    "domain_name": "<string>",
    "allowed_domains": [
      "<string>"
    ],
    "enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]"
  },
  "product_type": "orchestration"
}

Authorizations

​
api-key
string
header
required

Admin API keys allow you to perform some 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

Response

200
application/json
Merchant Account Retrieved
​
merchant_id
string
required

The identifier for the Merchant Account

Maximum length: 64
Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

​
enable_payment_response_hash
boolean
default:false
required

A boolean value to indicate if payment response hash needs to be enabled

Example:

true

​
redirect_to_merchant_with_http_post
boolean
default:false
required

A boolean value to indicate if redirect to merchant with http post needs to be enabled

Example:

true

​
primary_business_details
object[]
required

Details about the primary business unit of the merchant account

​
organization_id
string
required

The organization id merchant is associated with

Required string length: 1 - 64
Example:

"org_q98uSGAYbjEwqs0mJwnz"

​
is_recon_enabled
boolean
required

A boolean value to indicate if the merchant has recon service is enabled or not, by default value is false

​
recon_status
enum<string>
required
Available options:
not_requested,
requested,
active,
disabled
​
merchant_name
string | null

Name of the Merchant Account

Example:

"NewAge Retailer"

​
return_url
string | null

The URL to redirect after completion of the payment

Maximum length: 255
Example:

"https://www.example.com/success"

​
payment_response_hash_key
string | null

Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a value is automatically generated.

Maximum length: 255
Example:

"xkkdf909012sdjki2dkh5sdf"

​
merchant_details
object
​
webhook_details
object
​
payout_routing_algorithm
object

Routing Algorithm kind

​
sub_merchants_enabled
boolean | null
default:false

A boolean value to indicate if the merchant is a sub-merchant under a master or a parent merchant. By default, its value is false.

Example:

false

​
parent_merchant_id
string | null

Refers to the Parent Merchant ID if the merchant being created is a sub-merchant

Maximum length: 255
Example:

"xkkdf909012sdjki2dkh5sdf"

​
publishable_key
string | null

API key that will be used for server side API access

Example:

"AH3423bkjbkjdsfbkj"

​
metadata
object | null

Metadata is useful for storing additional, unstructured information on an object.

​
locker_id
string | null

An identifier for the vault used to store payment method information.

Example:

"locker_abc123"

​
frm_routing_algorithm
object

Routing Algorithm kind

​
default_profile
string | null

The default profile that must be used for creating merchant accounts and payments

Maximum length: 64
​
pm_collect_link_config
object

Object for GenericLinkUiConfig

​
product_type
enum<string>
Available options:
orchestration,
vault,
recon,
recovery,
cost_observability,
dynamic_routing