Merchant Account

POST

accounts

{account_id}

object

merchant_id

string

merchant_name

string

merchant_details

object

primary_contact_person

string

primary_phone

string

primary_email

string

secondary_contact_person

string

secondary_phone

string

secondary_email

string

website

string

about_business

string

address

object

city

string

country

enum<string>

line1

string

line2

string

line3

string

zip

string

state

string

first_name

string

last_name

string

return_url

string

webhook_details

object

webhook_version

string

webhook_username

string

webhook_password

string

webhook_url

string

payment_created_enabled

boolean

payment_succeeded_enabled

boolean

payment_failed_enabled

boolean

payout_routing_algorithm

Option 1 · object

type

enum<string>

data

object

connector

enum<string>

merchant_connector_id

string

sub_merchants_enabled

boolean

parent_merchant_id

string

enable_payment_response_hash

boolean

payment_response_hash_key

string

redirect_to_merchant_with_http_post

boolean

metadata

object

publishable_key

string

locker_id

string

primary_business_details

array

frm_routing_algorithm

object

default_profile

string

pm_collect_link_config

object

logo

string

merchant_name

string

theme

string

domain_name

string

allowed_domains

array

enabled_payment_methods

array

curl --request POST \
  --url https://sandbox.hyperswitch.io/accounts/{account_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "merchant_id": "merchant_abc",
  "merchant_name": "merchant_name"
}'

Authorizations

api-key

string

headerrequired

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

Body

application/json

merchant_id

string

required

The identifier for the Merchant Account

merchant_name

string | null

Name of the Merchant Account

merchant_details

object

merchant_details.primary_contact_person

string | null

The merchant's primary contact name

merchant_details.primary_phone

string | null

The merchant's primary phone number

merchant_details.primary_email

string | null

The merchant's primary email address

merchant_details.secondary_contact_person

string | null

The merchant's secondary contact name

merchant_details.secondary_phone

string | null

The merchant's secondary phone number

merchant_details.secondary_email

string | null

The merchant's secondary email address

merchant_details.website

string | null

The business website of the merchant

merchant_details.about_business

string | null

A brief description about merchant's business

merchant_details.address

object

Address details

return_url

string | null

The URL to redirect after the completion of the operation

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.

parent_merchant_id

string | null

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

enable_payment_response_hash

boolean | null

default: false

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

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 default value is used.

redirect_to_merchant_with_http_post

boolean | null

default: false

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

metadata

object | null

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

publishable_key

string | null

API key that will be used for server side API access

locker_id

string | null

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

primary_business_details

object[] | null

Details about the primary business unit of the merchant account

frm_routing_algorithm

object | null

The frm routing algorithm to be used for routing payments to desired FRM's

default_profile

string | null

The default business profile that must be used for creating merchant accounts and payments To unset this field, pass an empty string

pm_collect_link_config

object

Object for GenericLinkUiConfig

pm_collect_link_config.logo

string | null

Merchant's display logo

pm_collect_link_config.merchant_name

string | null

Custom merchant name for the link

pm_collect_link_config.theme

string | null

Primary color to be used in the form represented in hex format

pm_collect_link_config.domain_name

string | null

Custom domain name to be used for hosting the link

pm_collect_link_config.allowed_domains

string[]

required

A list of allowed domains (glob patterns) where this link can be embedded / opened from

pm_collect_link_config.enabled_payment_methods

object[]

required

List of payment methods shown on collect UI

Response

200 - application/json

merchant_id

string

required

The identifier for the Merchant Account

merchant_name

string | null

Name of the Merchant Account

return_url

string | null

The URL to redirect after completion of the payment

enable_payment_response_hash

boolean

default: falserequired

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

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 default value is used.

redirect_to_merchant_with_http_post

boolean

default: falserequired

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

merchant_details

object

merchant_details.primary_contact_person

string | null

The merchant's primary contact name

merchant_details.primary_phone

string | null

The merchant's primary phone number

merchant_details.primary_email

string | null

The merchant's primary email address

merchant_details.secondary_contact_person

string | null

The merchant's secondary contact name

merchant_details.secondary_phone

string | null

The merchant's secondary phone number

merchant_details.secondary_email

string | null

The merchant's secondary email address

merchant_details.website

string | null

The business website of the merchant

merchant_details.about_business

string | null

A brief description about merchant's business

merchant_details.address

object

Address details

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.

parent_merchant_id

string | null

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

publishable_key

string | null

API key that will be used for server side API access

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.

primary_business_details

object[]

required

Details about the primary business unit of the merchant account

frm_routing_algorithm

object

Routing Algorithm kind

organization_id

string

required

The organization id merchant is associated with

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

default_profile

string | null

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

recon_status

enum<string>

required

Available options:

not_requested,

requested,

active,

disabled

pm_collect_link_config

object

Object for GenericLinkUiConfig

pm_collect_link_config.logo

string | null

Merchant's display logo

pm_collect_link_config.merchant_name

string | null

Custom merchant name for the link

pm_collect_link_config.theme

string | null

Primary color to be used in the form represented in hex format

pm_collect_link_config.domain_name

string | null

Custom domain name to be used for hosting the link

pm_collect_link_config.allowed_domains

string[]

required

A list of allowed domains (glob patterns) where this link can be embedded / opened from

pm_collect_link_config.enabled_payment_methods

object[]

required

List of payment methods shown on collect UI

Merchant Account - Retrieve Merchant Account - Delete

curl --request POST \
  --url https://sandbox.hyperswitch.io/accounts/{account_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "merchant_id": "merchant_abc",
  "merchant_name": "merchant_name"
}'

Payments

Payment Methods

Customers

Mandates

Refunds

Disputes

Business Profile

API Key

Merchant Connector Account

Payouts

Event

GSM (Global Status Mapping)

Poll

Blocklist

Routing

Schemas

Merchant Account - Update

Authorizations

Path Parameters

Body

Response