Merchant Account

POST

accounts

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

object

country

enum<string>

business

string

frm_routing_algorithm

object

organization_id

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 \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "merchant_id": "merchant_abc"
}'

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.

Body

application/json

merchant_id

string

required

The identifier for the Merchant Account

Required string length: 1 - 64

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

Maximum length: 255

merchant_details.primary_phone

string | null

The merchant's primary phone number

Maximum length: 255

merchant_details.primary_email

string | null

The merchant's primary email address

Maximum length: 255

merchant_details.secondary_contact_person

string | null

The merchant's secondary contact name

Maximum length: 255

merchant_details.secondary_phone

string | null

The merchant's secondary phone number

Maximum length: 255

merchant_details.secondary_email

string | null

The merchant's secondary email address

Maximum length: 255

merchant_details.website

string | null

The business website of the merchant

Maximum length: 255

merchant_details.about_business

string | null

A brief description about merchant's business

Maximum length: 255

merchant_details.address

object

Address details

return_url

string | null

The URL to redirect after the completion of the operation

Maximum length: 255

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

Maximum length: 255

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 value is automatically generated.

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

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

publishable_key

string | null

API key that will be used for client side API access. A publishable key has to be always paired with a client_secret. A client_secret can be obtained by creating a payment with confirm set to false

locker_id

string | null

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

primary_business_details

object

frm_routing_algorithm

object | null

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

organization_id

string | null

The id of the organization to which the merchant belongs to, if not passed an organization is created

Required string length: 1 - 64

pm_collect_link_config

object

Object for GenericLinkUiConfig

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

pm_collect_link_config.logo

string | null

Merchant's display logo

Maximum length: 255

pm_collect_link_config.merchant_name

string | null

Custom merchant name for the link

Maximum length: 255

pm_collect_link_config.theme

string | null

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

Maximum length: 255

pm_collect_link_config.domain_name

string | null

Custom domain name to be used for hosting the link

Response

200 - application/json

merchant_id

string

required

The identifier for the Merchant Account

Maximum length: 64

enable_payment_response_hash

boolean

default: falserequired

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

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

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

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

return_url

string | null

The URL to redirect after completion of the payment

Maximum length: 255

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

merchant_details

object

merchant_details.primary_contact_person

string | null

The merchant's primary contact name

Maximum length: 255

merchant_details.primary_phone

string | null

The merchant's primary phone number

Maximum length: 255

merchant_details.primary_email

string | null

The merchant's primary email address

Maximum length: 255

merchant_details.secondary_contact_person

string | null

The merchant's secondary contact name

Maximum length: 255

merchant_details.secondary_phone

string | null

The merchant's secondary phone number

Maximum length: 255

merchant_details.secondary_email

string | null

The merchant's secondary email address

Maximum length: 255

merchant_details.website

string | null

The business website of the merchant

Maximum length: 255

merchant_details.about_business

string | null

A brief description about merchant's business

Maximum length: 255

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

Maximum length: 255

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.

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

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

pm_collect_link_config.logo

string | null

Merchant's display logo

Maximum length: 255

pm_collect_link_config.merchant_name

string | null

Custom merchant name for the link

Maximum length: 255

pm_collect_link_config.theme

string | null

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

Maximum length: 255

pm_collect_link_config.domain_name

string | null

Custom domain name to be used for hosting the link

Organization - Update Merchant Account - Retrieve

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

Payments

Payment Methods

Customers

Mandates

Refunds

Disputes

Organization

Business Profile

API Key

Merchant Connector Account

Payouts

Event

GSM (Global Status Mapping)

Poll

Blocklist

Routing

Relay

Schemas

Merchant Account - Create

Authorizations

Body

Response