GET
/
account
/
{account_id}
/
business_profile
/
{profile_id}
curl --request GET \
  --url https://sandbox.hyperswitch.io/account/{account_id}/business_profile/{profile_id} \
  --header 'api-key: <api-key>'
{
  "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": {
    "theme": "#4E6ADD",
    "logo": "https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg",
    "seller_name": "hyperswitch",
    "sdk_layout": "accordion",
    "display_sdk_only": true,
    "enabled_saved_payment_method": true,
    "hide_card_nickname_field": true,
    "show_card_form_by_default": true,
    "transaction_details": [
      {
        "key": "Policy-Number",
        "value": "297472368473924",
        "ui_configuration": {
          "position": 5,
          "is_key_bold": true,
          "is_value_bold": true
        }
      }
    ],
    "background_image": {
      "url": "https://hyperswitch.io/favicon.ico",
      "position": "left",
      "size": {
        "Variants": "cover"
      }
    },
    "details_layout": "layout1",
    "payment_button_text": "<string>",
    "custom_message_for_card_terms": "<string>",
    "payment_button_colour": "<string>",
    "skip_status_screen": true,
    "payment_button_text_colour": "<string>",
    "background_colour": "<string>",
    "sdk_ui_rules": {},
    "payment_link_ui_rules": {},
    "domain_name": "<string>",
    "business_specific_configs": {},
    "allowed_domains": [
      "<string>"
    ],
    "branding_visibility": true
  },
  "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": 900
  },
  "collect_shipping_details_from_wallet_connector": false,
  "collect_billing_details_from_wallet_connector": false,
  "always_collect_shipping_details_from_wallet_connector": false,
  "always_collect_billing_details_from_wallet_connector": false,
  "is_connector_agnostic_mit_enabled": true,
  "payout_link_config": {
    "logo": "https://hyperswitch.io/favicon.ico",
    "merchant_name": "Hyperswitch",
    "theme": "#4285F4",
    "domain_name": "<string>",
    "allowed_domains": [
      "<string>"
    ],
    "form_layout": "tabs",
    "payout_test_mode": false
  },
  "outgoing_webhook_custom_http_headers": {},
  "tax_connector_id": "<string>",
  "is_tax_connector_enabled": true,
  "is_network_tokenization_enabled": false,
  "is_auto_retries_enabled": false,
  "max_auto_retries_enabled": 123,
  "always_request_extended_authorization": true,
  "is_click_to_pay_enabled": false,
  "authentication_product_ids": {},
  "card_testing_guard_config": {
    "card_ip_blocking_status": "enabled",
    "card_ip_blocking_threshold": 123,
    "guest_user_card_blocking_status": "enabled",
    "guest_user_card_blocking_threshold": 123,
    "customer_id_blocking_status": "enabled",
    "customer_id_blocking_threshold": 123,
    "card_testing_guard_expiry": 123
  },
  "is_clear_pan_retries_enabled": true,
  "force_3ds_challenge": true
}

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

​
profile_id
string
required

The unique identifier for the profile

Response

200
application/json
Profile Updated
​
merchant_id
string
required

The identifier for Merchant Account

Maximum length: 64
Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

​
profile_id
string
required

The identifier for profile. This must be used for creating merchant accounts, payments and payouts

Maximum length: 64
Example:

"pro_abcdefghijklmnopqrstuvwxyz"

​
profile_name
string
required

Name of the profile

Maximum length: 64
​
enable_payment_response_hash
boolean
default:true
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

​
is_tax_connector_enabled
boolean
required

Indicates if tax_calculator connector is enabled or not. If set to true tax_connector_id will be checked.

​
is_network_tokenization_enabled
boolean
default:false
required

Indicates if network tokenization is enabled or not.

Example:

false

​
is_auto_retries_enabled
boolean
default:false
required

Indicates if is_auto_retries_enabled is enabled or not.

Example:

false

​
is_click_to_pay_enabled
boolean
default:false
required

Indicates if click to pay is enabled or not.

Example:

false

​
is_clear_pan_retries_enabled
boolean
required

Indicates if clear pan retries is enabled or not.

​
force_3ds_challenge
boolean
required

Indicates if 3ds challenge is forced

​
return_url
string | null

The URL to redirect after the completion of the operation

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.

​
webhook_details
object
​
metadata
object | null

Metadata is useful for storing additional, unstructured 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

Example:

900

​
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 Apple Pay domains for a particular profile

​
session_expiry
integer | null

Client Secret Default expiry for all payments created under this profile

Example:

900

​
payment_link_config
object
​
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 only if it is required field for connector (Eg. Apple Pay, Google Pay etc)

Example:

false

​
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 only if it is required field for connector (Eg. Apple Pay, Google Pay etc)

Example:

false

​
always_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 irrespective of connector required fields (Eg. Apple pay, Google pay etc)

Example:

false

​
always_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 irrespective of connector required fields (Eg. Apple pay, Google pay etc)

Example:

false

​
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

​
outgoing_webhook_custom_http_headers
object | null

These key-value pairs are sent as additional custom headers in the outgoing webhook request.

​
tax_connector_id
string | null

Merchant Connector id to be stored for tax_calculator connector

​
max_auto_retries_enabled
integer | null

Maximum number of auto retries allowed for a payment

​
always_request_extended_authorization
boolean | null

Bool indicating if extended authentication must be requested for all payments

​
authentication_product_ids
object | null

Product authentication ids

​
card_testing_guard_config
object
Profile - UpdateProfile - Delete