POST
/
account
/
{account_id}
/
business_profile
/
{profile_id}
curl --request POST \
  --url https://sandbox.hyperswitch.io/account/{account_id}/business_profile/{profile_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "profile_name": "shoe_business"
}'
{
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "profile_id": "pro_abcdefghijklmnopqrstuvwxyz",
  "profile_name": "<string>",
  "return_url": "https://www.example.com/success",
  "enable_payment_response_hash": true,
  "payment_response_hash_key": "<string>",
  "redirect_to_merchant_with_http_post": true,
  "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
  },
  "metadata": {},
  "routing_algorithm": {},
  "intent_fulfillment_time": 900,
  "frm_routing_algorithm": {},
  "payout_routing_algorithm": {
    "type": "single",
    "data": {
      "connector": "adyenplatform",
      "merchant_connector_id": "<string>"
    }
  },
  "applepay_verified_domains": [
    "<string>"
  ],
  "session_expiry": 900,
  "payment_link_config": "<any>",
  "authentication_connector_details": {
    "authentication_connectors": [
      "threedsecureio"
    ],
    "three_ds_requestor_url": "<string>"
  },
  "use_billing_as_payment_method_billing": true,
  "extended_card_info_config": {
    "public_key": "<string>",
    "ttl_in_secs": 3600
  },
  "collect_shipping_details_from_wallet_connector": true,
  "collect_billing_details_from_wallet_connector": true,
  "is_connector_agnostic_mit_enabled": true,
  "payout_link_config": {
    "logo": "https://hyperswitch.io/favicon.ico",
    "merchant_name": "Hyperswitch",
    "theme": "#4285F4",
    "domain_name": "<string>"
  }
}

Authorizations

api-key
string
headerrequired

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

account_id
string
required

The unique identifier for the merchant account

profile_id
string
required

The unique identifier for the business profile

Body

application/json
profile_name
string | null

The name of business profile

return_url
string | null

The URL to redirect after the completion of the operation

enable_payment_response_hash
boolean | null
default: true

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

webhook_details
object
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.

routing_algorithm
object | null

The routing algorithm to be used for routing payments to desired connectors

intent_fulfillment_time
integer | null

Will be used to determine the time till which your payment will be active once the payment session starts

frm_routing_algorithm
object | null

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

payout_routing_algorithm
object

Routing Algorithm kind

applepay_verified_domains
string[] | null

Verified applepay domains for a particular profile

session_expiry
integer | null

Client Secret Default expiry for all payments created under this business profile

payment_link_config
object
authentication_connector_details
object
use_billing_as_payment_method_billing
boolean | null

Whether to use the billing details passed when creating the intent as payment method billing

collect_shipping_details_from_wallet_connector
boolean | null
default: false

A boolean value to indicate if customer shipping details needs to be collected from wallet connector (Eg. Apple pay, Google pay etc)

collect_billing_details_from_wallet_connector
boolean | null
default: false

A boolean value to indicate if customer billing details needs to be collected from wallet connector (Eg. Apple pay, Google pay etc)

is_connector_agnostic_mit_enabled
boolean | null

Indicates if the MIT (merchant initiated transaction) payments can be made connector agnostic, i.e., MITs may be processed through different connector than CIT (customer initiated transaction) based on the routing rules. If set to false, MIT will go through the same connector as the CIT.

payout_link_config
object

Object for GenericLinkUiConfig

Response

200 - application/json
merchant_id
string
required

The identifier for Merchant Account

profile_id
string
required

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

profile_name
string
required

Name of the business profile

return_url
string | null

The URL to redirect after the completion of the operation

enable_payment_response_hash
boolean
default: truerequired

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

webhook_details
object
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.

routing_algorithm
object | null

The routing algorithm to be used for routing payments to desired connectors

intent_fulfillment_time
integer | null

Will be used to determine the time till which your payment will be active once the payment session starts

frm_routing_algorithm
object | null

The routing algorithm to be used to process the incoming request from merchant to outgoing payment processor or payment method. The default is 'Custom'

payout_routing_algorithm
object

Routing Algorithm kind

applepay_verified_domains
string[] | null

Verified applepay domains for a particular profile

session_expiry
integer | null

Client Secret Default expiry for all payments created under this business profile

payment_link_config
any | null

Default Payment Link config for all payment links created under this business profile

authentication_connector_details
object
use_billing_as_payment_method_billing
boolean | null
extended_card_info_config
object
collect_shipping_details_from_wallet_connector
boolean | null
default: false

A boolean value to indicate if customer shipping details needs to be collected from wallet connector (Eg. Apple pay, Google pay etc)

collect_billing_details_from_wallet_connector
boolean | null
default: false

A boolean value to indicate if customer billing details needs to be collected from wallet connector (Eg. Apple pay, Google pay etc)

is_connector_agnostic_mit_enabled
boolean | null

Indicates if the MIT (merchant initiated transaction) payments can be made connector agnostic, i.e., MITs may be processed through different connector than CIT (customer initiated transaction) based on the routing rules. If set to false, MIT will go through the same connector as the CIT.

payout_link_config
object

Object for GenericLinkUiConfig

Business Profile - CreateBusiness Profile - Retrieve