Business Profile
Profile - Retrieve
Get Started
Essentials
API Reference
- Payments
- Payment Methods
- Customers
- Mandates
- Refunds
- Disputes
- Payouts
- Event
- Poll
- Blocklist
- Routing
- Relay
- Schemas
Admin API based
- Organization
- Merchant Account
- Business Profile
- API Key
- Merchant Connector Account
- GSM (Global Status Mapping)
- Event
Business Profile
Profile - Retrieve
Retrieve existing profile
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": {},
"enable_button_only_on_form_ready": true,
"payment_form_header_text": "<string>",
"payment_form_label_type": "above",
"show_card_terms": "always",
"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": {
"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,
"is_debit_routing_enabled": true,
"merchant_business_country": "AF"
}
Authorizations
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
The unique identifier for the merchant account
The unique identifier for the profile
Response
200
application/json
Profile Updated
The response is of type object
.
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": {},
"enable_button_only_on_form_ready": true,
"payment_form_header_text": "<string>",
"payment_form_label_type": "above",
"show_card_terms": "always",
"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": {
"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,
"is_debit_routing_enabled": true,
"merchant_business_country": "AF"
}