Profile - Retrieve

GET /v2/profiles/{id}

Retrieve a profile by its unique identifier.

---

Request

cURL

curl

curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/profiles/{id} \
  --header 'X-Merchant-Id: <x-merchant-id>' \
  --header 'api-key: <api-key>'

Authorizations (required)

• api-key (header) — string Admin API keys allow you to perform privileged actions such as creating a merchant account and Connector account.

Headers

• X-Merchant-Id (string) — required Merchant ID of the profile.

• api-key (string) — required Admin API key.

Path Parameters

• id (string) — required The unique identifier for the profile.

---

Response

• 200 application/json — Profile Retrieved

Example response:

response.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. 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 is enabled.

• redirect_to_merchant_with_http_post (boolean, required, default: false) Whether to redirect to merchant with HTTP POST.

• is_tax_connector_enabled (boolean) Indicates if tax_calculator connector is enabled. If true, tax_connector_id will be checked.

• is_network_tokenization_enabled (boolean, default: false)

• is_click_to_pay_enabled (boolean, default: false)

• is_clear_pan_retries_enabled (boolean)

• split_txns_enabled (enum, default: skip) Options: enable, skip

• return_url (string|null) URL to redirect after completion. Max length: 255. Example: "https://www.example.com/success"

• payment_response_hash_key (string|null) Hash key used for webhook/redirect signatures. Auto-generated if not provided.

• webhook_details (object) Contains webhook configuration (payment_statuses_enabled, refund_statuses_enabled, webhook_version, webhook_url, etc.)

• metadata (object) Additional unstructured information.

• applepay_verified_domains (string[]|null)

• session_expiry (integer|null) Client secret default expiry in seconds. Example: 900

• payment_link_config (object) Payment link UI/config object (theme, logo, seller_name, sdk_layout, transaction_details, etc.)

• authentication_connector_details (object) Authentication connector configuration (authentication_connectors, three_ds_requestor_url, etc.)

• 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 may be processed through a different connector than CIT based on routing rules.

• payout_link_config (object) GenericLinkUiConfig (allowed_domains, logo, merchant_name, theme, form_layout, payout_test_mode, etc.)

• outgoing_webhook_custom_http_headers (object) Additional custom headers for outgoing webhook requests.

• order_fulfillment_time (integer|null) Time (in seconds) for which payment is active once session starts. Required range: x >= 0. Example: 900

• order_fulfillment_time_origin (enum) Options: create, confirm

• tax_connector_id (string|null)

• should_collect_cvv_during_payment (boolean|null)

• authentication_product_ids (object)

• card_testing_guard_config (object) Contains thresholds and statuses for card testing guard features.

• is_debit_routing_enabled (boolean|null)

• merchant_business_country (enum) ISO country code (many possible values; e.g., AF, IN, US, etc.).

• is_iframe_redirection_enabled (boolean|null)

• is_external_vault_enabled (boolean|null)

• external_vault_connector_details (object) Details for external vault (vault_connector_id, vault_sdk, vault_token_selector, etc.)

• merchant_category_code (string) — Example: "5411"

• merchant_country_code (string)

• revenue_recovery_retry_algorithm_type (enum) Options: monitoring, smart, cascading

• billing_processor_id (string|null)

• is_l2_l3_enabled (boolean|null) Enable Level 2 and Level 3 card processing data.

---

Was this page helpful?

• Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/profile/profile--retrieve.mdx

• Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/profile/profile--retrieve