Profile - Retrieve
GET /account/{account_id}/business_profile/{profile_id}
Retrieve a business profile.
Try it (cURL)
curl --request GET \
--url https://sandbox.hyperswitch.io/account/{account_id}/business_profile/{profile_id} \
--header 'api-key: <api-key>'Example response (200 application/json)
{
"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, string, 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. 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 profile
Response (200 application/json) — Fields
Below are key response fields and descriptions.
merchant_id (string, required) — The identifier for Merchant Account (max length: 64). Example: "y3oqhf46pyzuxjbcn2giaqnb44"
profile_id (string, required) — The identifier for profile; used 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) — Whether payment response hash needs to be 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_auto_retries_enabled (boolean, required, default: false) — Indicates if auto retries are 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
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
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 for calculating signature for webhooks and redirect responses. If absent, a value is generated automatically.
webhook_details (object) — Webhook related configuration (see example response)
metadata (object) — Free-form metadata
routing_algorithm (object) — Routing algorithm used for routing payments
intent_fulfillment_time (integer | null) — Time (seconds) the payment is active once session starts. Example: 900
frm_routing_algorithm (object) — Routing algorithm for processing incoming merchant requests
payout_routing_algorithm (object) — Payout routing algorithm (see example response)
applepay_verified_domains (string[] | null) — Verified Apple Pay domains
session_expiry (integer | null) — Default client secret expiry for payments under this profile. Example: 900
payment_link_config (object) — Payment link UI/config options (see example)
authentication_connector_details (object) — Authentication connector configuration (see example)
use_billing_as_payment_method_billing (boolean | null)
extended_card_info_config (object) — Extended card info config (public_key, ttl_in_secs, etc.)
collect_shipping_details_from_wallet_connector (boolean | null, default: false)
collect_billing_details_from_wallet_connector (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 merchant-initiated transactions (MIT) may be processed through a different connector than customer-initiated transactions (CIT) 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 webhooks
tax_connector_id (string | null) — Merchant connector id 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) — If extended authentication must be requested for all payments
authentication_product_ids (object) — Product authentication ids
card_testing_guard_config (object) — Card testing guard configuration (thresholds, statuses, expiry)
is_debit_routing_enabled (boolean | null) — Indicates if debit routing is enabled
merchant_business_country (enum) — Merchant business country (ISO codes). Example: "AF"
acquirer_configs (object[] | null) — Acquirer configurations (see example)
is_iframe_redirection_enabled (boolean | null) — If redirection should open in an iframe. Example: false
merchant_category_code (string) — Merchant category code. Example: "5411"
merchant_country_code (string) — Merchant country code
dispute_polling_interval (integer | null) — Time interval (hours) for polling connector to check dispute statuses. Required range: x >= 0. Example: 2
is_manual_retry_enabled (boolean | null) — Indicates if manual retry for payment is enabled
always_enable_overcapture (boolean | null) — If overcapture must be requested for all payments
is_external_vault_enabled (enum) — "enable" or "skip"
external_vault_connector_details (object) — External vault config (vault_connector_id, vault_sdk, vault_token_selector)
billing_processor_id (string | null) — Merchant connector id for billing_processor connector
is_l2_l3_enabled (boolean | null) — Enable Level 2 and Level 3 processing data for card transactions
(See the example response above for nested object structures and sample values.)
Suggest edits or raise an issue on the docs repository:
Edit: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/business-profile/business-profile--retrieve.mdx
Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/business-profile/business-profile--retrieve
Related:
Profile - Update: https://api-reference.hyperswitch.io/v1/business-profile/business-profile--update
Profile - Delete: https://api-reference.hyperswitch.io/v1/business-profile/business-profile--delete