Merchant Account - Profile List
GET /v2/merchant-accounts/{id}/profiles
Retrieve the list of profiles for a Merchant Account.
Authorizations
api-key (header, required) — Admin API keys allow privileged actions such as creating a merchant account and connector account.
Path parameters
id (string, required) — The unique identifier for the Merchant.
cURL
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/merchant-accounts/{id}/profiles \
--header 'api-key: <api-key>'Successful response (200, application/json)
[
{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"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_click_to_pay_enabled": false,
"is_clear_pan_retries_enabled": true,
"split_txns_enabled": "skip",
"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": {},
"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_if_required": false,
"collect_billing_details_from_wallet_connector_if_required": 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": {},
"order_fulfillment_time": 900,
"order_fulfillment_time_origin": "create",
"tax_connector_id": "<string>",
"should_collect_cvv_during_payment": 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",
"is_iframe_redirection_enabled": false,
"is_external_vault_enabled": true,
"external_vault_connector_details": {
"vault_connector_id": "<string>",
"vault_sdk": "vgs_sdk",
"vault_token_selector": [
{
"token_type": "card_number"
}
]
},
"merchant_category_code": "5411",
"merchant_country_code": "<string>",
"revenue_recovery_retry_algorithm_type": "monitoring",
"billing_processor_id": "<string>",
"is_l2_l3_enabled": true
}
]Response fields (selected)
merchant_id (string, required) — Identifier for Merchant Account. Max length: 64. Example: "y3oqhf46pyzuxjbcn2giaqnb44"
id (string, required) — Identifier for profile. Must be used when 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) — Whether payment response hash is enabled.
redirect_to_merchant_with_http_post (boolean, required, default: false) — Whether redirect to merchant with HTTP POST is enabled.
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.
is_click_to_pay_enabled (boolean, required, default: false) — Indicates if Click to Pay is enabled.
is_clear_pan_retries_enabled (boolean, required) — Indicates if clear PAN retries is enabled.
split_txns_enabled (enum, required, default: "skip") — Options: "enable", "skip".
return_url (string|null) — URL to redirect after operation completion. Max length: 255. Example: "https://www.example.com/success"
payment_response_hash_key (string|null) — Hash key used for calculating signature for webhooks and redirect responses. If not provided, generated automatically.
webhook_details (object) — Webhook configuration and enabled statuses.
metadata (object) — Free-form metadata.
applepay_verified_domains (string[]|null) — Verified Apple Pay domains for the profile.
session_expiry (integer|null) — Client Secret default expiry for payments under this profile. Example: 900
payment_link_config (object) — Payment link UI configuration.
authentication_connector_details (object) — Authentication connectors and related URLs.
use_billing_as_payment_method_billing (boolean|null)
extended_card_info_config (object) — Contains public_key and ttl_in_secs.
collect_shipping_details_from_wallet_connector_if_required (boolean|null, default: false)
collect_billing_details_from_wallet_connector_if_required (boolean|null, default: false)
always_collect_shipping_details_from_wallet_connector (boolean|null, default: false)
always_collect_billing_details_from_wallet_connector (boolean|null, default: false)
is_connector_agnostic_mit_enabled (boolean|null) — If true, MITs (merchant-initiated transactions) may be processed through a different connector than CIT (customer-initiated transaction) based on routing rules. If false, MIT uses same connector as CIT.
payout_link_config (object) — Generic link UI config for payouts.
outgoing_webhook_custom_http_headers (object) — Additional custom headers sent with outgoing webhook requests.
order_fulfillment_time (integer|null) — Time in seconds payments remain active once session starts. Required range: x >= 0. Example: 900
order_fulfillment_time_origin (enum) — Options: "create", "confirm"
tax_connector_id (string|null) — Merchant connector id for tax_calculator connector.
should_collect_cvv_during_payment (boolean|null) — Indicates whether CVV should be collected during payment.
authentication_product_ids (object) — Product authentication ids.
card_testing_guard_config (object) — Card testing guard configuration.
is_debit_routing_enabled (boolean|null) — Indicates if debit routing is enabled.
merchant_business_country (enum) — Merchant business country (ISO codes).
is_iframe_redirection_enabled (boolean|null) — If true, redirection should open in an iframe.
is_external_vault_enabled (boolean|null) — Indicates if external vault is enabled.
external_vault_connector_details (object) — Details for external vault connector.
merchant_category_code (string) — Example: "5411"
merchant_country_code (string) — Merchant country code wrapper type.
revenue_recovery_retry_algorithm_type (enum) — Options: "monitoring", "smart", "cascading"
billing_processor_id (string|null) — Merchant connector id for billing_processor connector.
is_l2_l3_enabled (boolean|null) — Flag to enable Level 2/Level 3 processing data for card transactions.
Useful links
Documentation: https://api-reference.hyperswitch.io/introduction
Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview
Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview
Source edit on GitHub: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/merchant-account/business-profile--list.mdx
Raise an issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/merchant-account/business-profile--list