Profile - Update

PUT /v2/profiles/{id}

Endpoint to update a profile.

cURL example

curl
curl --request PUT \
  --url https://sandbox.hyperswitch.io/v2/profiles/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Merchant-Id: <x-merchant-id>' \
  --header 'api-key: <api-key>' \
  --data '
{
  "enable_payment_response_hash": true,
  "redirect_to_merchant_with_http_post": false,
  "payment_link_config": {
    "display_sdk_only": false,
    "enabled_saved_payment_method": false,
    "hide_card_nickname_field": false,
    "show_card_form_by_default": true,
    "business_specific_configs": {
      "display_sdk_only": false,
      "enabled_saved_payment_method": false,
      "hide_card_nickname_field": false,
      "show_card_form_by_default": true
    }
  },
  "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,
  "payout_link_config": {
    "payout_test_mode": false
  },
  "is_click_to_pay_enabled": false,
  "split_txns_enabled": "skip"
}
'

Successful response (200)

Authorizations

  • api-key (header, required) — Admin API keys allow privileged actions (e.g., creating merchant and connector accounts).

Headers

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

  • api-key (string, required) — see Authorizations above.

  • Content-Type: application/json

Path parameters

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

Body parameters

Content type: application/json

  • profile_name (string, required) — The name of profile. Maximum length: 64.

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

  • enable_payment_response_hash (boolean | null) — default: true. Enable payment response hash. Example: true

  • payment_response_hash_key (string | null) — Hash key used for webhook and redirect signature. If not provided, generated automatically.

  • redirect_to_merchant_with_http_post (boolean | null) — default: false. If true, redirect to merchant with HTTP POST.

  • webhook_details (object) — See webhook attributes in response section (webhook_username, webhook_url, enabled statuses, etc.).

  • metadata (object) — Additional unstructured information.

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

  • order_fulfillment_time_origin (enum: "create" | "confirm")

  • applepay_verified_domains (string[] | null)

  • session_expiry (integer | null) — Default expiry for client secret. x >= 0. Example: 900

  • payment_link_config (object) — UI and payment link configuration.

  • authentication_connector_details (object) — Authentication connector configuration.

  • use_billing_as_payment_method_billing (boolean | null)

  • 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 can be processed through a different connector than CIT based on routing; if false, MIT uses same connector as CIT.

  • payout_link_config (object) — GenericLinkUiConfig for payouts.

  • outgoing_webhook_custom_http_headers (object) — Key-value pairs sent as custom headers in outgoing webhooks (recommendation: avoid more than four pairs).

  • tax_connector_id (string | null) — Merchant connector id for tax_calculator connector.

  • is_tax_connector_enabled (boolean) — If true, tax_connector_id will be checked.

  • is_network_tokenization_enabled (boolean)

  • is_click_to_pay_enabled (boolean) — default: false

  • authentication_product_ids (object)

  • card_testing_guard_config (object) — Card testing guard settings and thresholds.

  • is_clear_pan_retries_enabled (boolean | null)

  • is_debit_routing_enabled (boolean | null)

  • merchant_business_country (enum string) — Country code (see list).

  • is_iframe_redirection_enabled (boolean | null)

  • is_external_vault_enabled (boolean | null)

  • external_vault_connector_details (object)

  • merchant_category_code (string) — Example: "5411"

  • merchant_country_code (string)

  • split_txns_enabled (enum: "enable" | "skip") — default: skip

  • billing_processor_id (string | null)

  • is_l2_l3_enabled (boolean | null)

Response fields

200 application/json — Profile Updated

Key response attributes (types and descriptions mirror body fields; examples shown in the response example above):

  • merchant_id (string) — The identifier for Merchant Account.

  • id (string) — Identifier for profile; used for creating merchant accounts, payments and payouts.

  • profile_name (string)

  • enable_payment_response_hash (boolean)

  • redirect_to_merchant_with_http_post (boolean)

  • is_tax_connector_enabled (boolean)

  • is_network_tokenization_enabled (boolean)

  • is_click_to_pay_enabled (boolean)

  • is_clear_pan_retries_enabled (boolean)

  • split_txns_enabled (enum)

  • return_url (string | null)

  • payment_response_hash_key (string | null)

  • webhook_details (object)

  • metadata (object)

  • applepay_verified_domains (string[] | null)

  • session_expiry (integer)

  • payment_link_config (object)

  • authentication_connector_details (object)

  • use_billing_as_payment_method_billing (boolean | null)

  • extended_card_info_config (object)

  • collect_shipping_details_from_wallet_connector_if_required (boolean | null)

  • collect_billing_details_from_wallet_connector_if_required (boolean | null)

  • always_collect_shipping_details_from_wallet_connector (boolean | null)

  • always_collect_billing_details_from_wallet_connector (boolean | null)

  • is_connector_agnostic_mit_enabled (boolean | null)

  • payout_link_config (object)

  • outgoing_webhook_custom_http_headers (object)

  • order_fulfillment_time (integer | null)

  • order_fulfillment_time_origin (enum)

  • tax_connector_id (string | null)

  • should_collect_cvv_during_payment (boolean | null)

  • authentication_product_ids (object)

  • card_testing_guard_config (object)

  • is_debit_routing_enabled (boolean | null)

  • merchant_business_country (enum string)

  • is_iframe_redirection_enabled (boolean | null)

  • is_external_vault_enabled (boolean | null)

  • external_vault_connector_details (object)

  • merchant_category_code (string)

  • merchant_country_code (string)

  • revenue_recovery_retry_algorithm_type (enum: "monitoring" | "smart" | "cascading")

  • billing_processor_id (string | null)

  • is_l2_l3_enabled (boolean | null)

merchant_business_country — available country codes (click to expand)

AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US

Notes

  • Do not modify or remove query parameters in the provided URLs when using examples.

  • For webhook custom headers, it's recommended not to use more than four key-value pairs.

If you need the API specification in a different format or want individual field schemas extracted into separate example blocks, tell me which fields you want expanded.

PreviousprofileNextpayment-method-session