Profile - List
Retrieves the list of business profiles for a merchant account.
Endpoint GET /account/{account_id}/business_profile
Example cURL
curl --request GET \
--url https://sandbox.hyperswitch.io/account/{account_id}/business_profile \
--header 'api-key: <api-key>'Response example (200)
[
{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"profile_id": "pro_abcdefghijklmnopqrstuvwxyz",
"profile_name": "<string>",
"enable_payment_response_hash": true,
"redirect_to_merchant_with_http_post": true,
"is_tax_connector_enabled": true,
"is_network_tokenization_enabled": false,
"is_auto_retries_enabled": false,
"is_click_to_pay_enabled": false,
"is_clear_pan_retries_enabled": true,
"force_3ds_challenge": true,
"is_pre_network_tokenization_enabled": false,
"return_url": "https://www.example.com/success",
"payment_response_hash_key": "<string>",
"webhook_details": {
"payment_statuses_enabled": [
"succeeded",
"failed",
"partially_captured",
"requires_merchant_action"
],
"refund_statuses_enabled": [
"success",
"failure"
],
"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_statuses_enabled": [
"success",
"failed"
]
},
"metadata": {},
"routing_algorithm": {},
"intent_fulfillment_time": 900,
"frm_routing_algorithm": {},
"payout_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"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>",
"custom_message_for_payment_method_types": [
{
"payment_method": "card",
"payment_method_types": [
{
"message": {
"display_mode": "custom",
"value": "Sample message"
},
"payment_method_type": "credit"
}
]
}
],
"payment_button_colour": "<string>",
"skip_status_screen": true,
"payment_button_text_colour": "<string>",
"background_colour": "<string>",
"sdk_ui_rules": {},
"payment_link_ui_rules": {},
"enable_button_only_on_form_ready": true,
"payment_form_header_text": "<string>",
"payment_form_label_type": "above",
"show_card_terms": "always",
"is_setup_mandate_flow": true,
"color_icon_card_cvc_error": "<string>",
"domain_name": "<string>",
"business_specific_configs": {},
"allowed_domains": [
"<string>"
],
"branding_visibility": true
},
"authentication_connector_details": {
"authentication_connectors": [
"threedsecureio"
],
"three_ds_requestor_url": "<string>",
"three_ds_requestor_app_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": {
"allowed_domains": [
"<string>"
],
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>",
"form_layout": "tabs",
"payout_test_mode": false
},
"outgoing_webhook_custom_http_headers": {},
"tax_connector_id": "<string>",
"max_auto_retries_enabled": 123,
"always_request_extended_authorization": true,
"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_debit_routing_enabled": true,
"merchant_business_country": "AF",
"acquirer_configs": [
{
"profile_acquirer_id": "pro_acq_LCRdERuylQvNQ4qh3QE0",
"acquirer_assigned_merchant_id": "M123456789",
"merchant_name": "NewAge Retailer",
"network": "VISA",
"acquirer_bin": "456789",
"acquirer_fraud_rate": 0.01,
"profile_id": "pro_ky0yNyOXXlA5hF8JzE5q",
"acquirer_ica": "401288"
}
],
"is_iframe_redirection_enabled": false,
"merchant_category_code": "5411",
"merchant_country_code": "<string>",
"dispute_polling_interval": 2,
"is_manual_retry_enabled": true,
"always_enable_overcapture": true,
"is_external_vault_enabled": "enable",
"external_vault_connector_details": {
"vault_connector_id": "<string>",
"vault_sdk": "vgs_sdk",
"vault_token_selector": [
{
"token_type": "card_number"
}
]
},
"billing_processor_id": "<string>",
"is_l2_l3_enabled": true
}
]Authorizations
api-key (header, required) — 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. Do not expose this key on a website or embed it in a mobile application.
Path Parameters
account_id (string, required) — Merchant Identifier
Response (200 — application/json) Profiles Retrieved — list of profile objects. Key fields returned in each profile object:
merchant_id (string, required) The identifier for Merchant Account. Max length: 64. Example: "y3oqhf46pyzuxjbcn2giaqnb44"
profile_id (string, required) Identifier for profile. Use this for creating merchant accounts, payments and payouts. Max length: 64. Example: "pro_abcdefghijklmnopqrstuvwxyz"
profile_name (string, required) Name of the profile. Max length: 64.
enable_payment_response_hash (boolean, required, default: true) Indicates if payment response hash needs to be enabled. Example: true
redirect_to_merchant_with_http_post (boolean, required, default: false) Indicates if redirect to merchant with HTTP POST is enabled. Example: true
is_tax_connector_enabled (boolean, required) Indicates if tax_calculator connector is enabled. If true, tax_connector_id will be checked.
is_network_tokenization_enabled (boolean, required, default: false) Indicates if network tokenization is enabled. Example: false
is_auto_retries_enabled (boolean, required, default: false) Indicates if auto retries are enabled. Example: false
is_click_to_pay_enabled (boolean, required, default: false) Indicates if click to pay is enabled. Example: false
is_clear_pan_retries_enabled (boolean, required) Indicates if clear PAN retries is enabled.
force_3ds_challenge (boolean, required) Indicates if 3DS challenge is forced.
is_pre_network_tokenization_enabled (boolean, required, default: false) Indicates if pre-network tokenization is enabled. Example: false
return_url (string | null) The URL to redirect after the completion of the operation. Max length: 255. Example: "https://www.example.com/success"
payment_response_hash_key (string | null) The hash key used for calculating signatures for webhooks and redirect responses. If not provided, a value is automatically generated.
webhook_details (object) Webhook configuration for the profile (see response example for fields such as payment_statuses_enabled, refund_statuses_enabled, webhook_url, webhook_username, webhook_password, webhook_version, payment_created_enabled, etc.)
metadata (object) Unstructured additional information on the object.
routing_algorithm (object) Routing algorithm used to route payments to desired connectors.
intent_fulfillment_time (integer | null) Time (in seconds) a payment remains active once session starts. Example: 900
frm_routing_algorithm (object) Routing algorithm used to process incoming merchant requests to outgoing payment processors/methods.
payout_routing_algorithm (object) Payout routing algorithm. Example structure shown in response example (type, data with connector and merchant_connector_id).
applepay_verified_domains (string[] | null) Verified Apple Pay domains for the profile.
session_expiry (integer | null) Client Secret default expiry for all payments created under this profile. Example: 900
payment_link_config (object) Payment Link / SDK UI configuration (theme, logo, seller_name, sdk_layout, transaction_details, allowed_domains, branding_visibility, etc.) — see response example.
authentication_connector_details (object) Authentication connector settings (authentication_connectors array, three_ds_requestor_url, three_ds_requestor_app_url).
use_billing_as_payment_method_billing (boolean | null)
extended_card_info_config (object) (public_key, ttl_in_secs)
collect_shipping_details_from_wallet_connector (boolean | null, default: false) Collect shipping details from wallet connector only if required for connector (e.g., Apple Pay, Google Pay). Example: false
collect_billing_details_from_wallet_connector (boolean | null, default: false) Collect billing details from wallet connector only if required. Example: false
always_collect_shipping_details_from_wallet_connector (boolean | null, default: false) Always collect shipping details from wallet connector regardless of connector requirements. Example: false
always_collect_billing_details_from_wallet_connector (boolean | null, default: false) Always collect billing details from wallet connector. Example: false
is_connector_agnostic_mit_enabled (boolean | null) If true, MIT (merchant initiated transaction) payments may be processed through a different connector than the CIT (customer initiated transaction) based on routing rules. If false, MIT will use the same connector as CIT.
payout_link_config (object) Generic link UI config for payouts (allowed_domains, logo, merchant_name, theme, form_layout, payout_test_mode, etc.)
outgoing_webhook_custom_http_headers (object) Custom headers sent with outgoing webhook requests.
tax_connector_id (string | null) Merchant connector id 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) Whether extended authentication must be requested for all payments.
authentication_product_ids (object) Product authentication ids.
card_testing_guard_config (object) Card testing guard settings (card_ip_blocking_status, thresholds, guest user blocking, customer_id blocking, expiry, etc.)
is_debit_routing_enabled (boolean | null) Indicates if debit routing is enabled.
merchant_business_country (enum) Country code for merchant business. See the full list below.
acquirer_configs (object[] | null) Array of acquirer config objects (profile_acquirer_id, acquirer_assigned_merchant_id, merchant_name, network, acquirer_bin, acquirer_fraud_rate, profile_id, acquirer_ica, etc.)
is_iframe_redirection_enabled (boolean | null) Indicates if redirection should open in an iframe. Example: false
merchant_category_code (string) Example: "5411"
merchant_country_code (string) Merchant country code (string wrapper with validation/conversion functionality).
dispute_polling_interval (integer | null) Time interval (in hours) for polling the connector to check dispute statuses. Required range: x >= 0. Example: 2
is_manual_retry_enabled (boolean | null) Indicates if manual retry for payments is enabled.
always_enable_overcapture (boolean | null) Whether overcapture must be requested for all payments.
is_external_vault_enabled (enum) Options: enable, skip
external_vault_connector_details (object) Details for external vault connector (vault_connector_id, vault_sdk, vault_token_selector array with token_type items, etc.)
billing_processor_id (string | null) Merchant connector id stored for billing_processor connector.
is_l2_l3_enabled (boolean | null) Flag to enable Level 2 and Level 3 processing data for card transactions.
Notes
Many fields are objects that contain additional child attributes. See the response example for nested structures (webhook_details, payment_link_config, payout_routing_algorithm, acquirer_configs, external_vault_connector_details, etc.).
Keep your api-key secure and never expose it on client-side applications.