Merchant Connector - Update

Update (create/modify) a Merchant Connector for a merchant account. The connector can be a payment processor, facilitator, acquirer, or specialized services (Fraud, Accounting, etc).

Endpoint POST /account/{account_id}/connectors/{merchant_connector_id}

Try it (cURL)

Enable card payment method
curl --request POST \
  --url https://sandbox.hyperswitch.io/account/{account_id}/connectors/{merchant_connector_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "test_mode": false,
  "disabled": false
}
'

Responses

  • 200 application/json — Merchant Connector Updated

Example response (200)

{
  "connector_type": "payment_processor",
  "connector_name": "authipay",
  "merchant_connector_id": "mca_5apGeP94tMts6rg3U3kR",
  "profile_id": "<string>",
  "status": "inactive",
  "connector_label": "stripe_US_travel",
  "connector_account_details": {
    "connector_account_details": {},
    "metadata": {}
  },
  "payment_methods_enabled": [
    {
      "accepted_countries": {
        "list": [
          "FR",
          "DE",
          "IN"
        ],
        "type": "disable_only"
      },
      "accepted_currencies": {
        "list": [
          "USD",
          "EUR"
        ],
        "type": "enable_only"
      },
      "installment_payment_enabled": true,
      "maximum_amount": 68607706,
      "minimum_amount": 1,
      "payment_method": "wallet",
      "payment_method_issuers": [
        "labore magna ipsum",
        "aute"
      ],
      "payment_method_types": [
        "upi_collect",
        "upi_intent"
      ],
      "payment_schemes": [
        "Discover",
        "Discover"
      ],
      "recurring_enabled": true
    }
  ],
  "connector_webhook_details": {
    "merchant_secret": "12345678900987654321",
    "additional_secret": "12345678900987654321"
  },
  "metadata": {},
  "test_mode": false,
  "disabled": false,
  "frm_configs": "\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n",
  "business_country": "AF",
  "business_label": "travel",
  "business_sub_label": "chase",
  "applepay_verified_domains": [
    "<string>"
  ],
  "pm_auth_config": {},
  "additional_merchant_data": {
    "open_banking_recipient_data": {
      "connector_recipient_id": "<string>"
    }
  },
  "connector_wallets_details": {
    "apple_pay_combined": {},
    "apple_pay": {},
    "amazon_pay": {},
    "samsung_pay": {},
    "paze": {},
    "google_pay": {}
  }
}

Authorizations

  • api-key (string, header, 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

  • merchant_connector_id (string, required) — The unique identifier for the Merchant Connector

Body (application/json) Create or update a Merchant Connector for the merchant account. Fields:

  • connector_type (enum, required) — Type of the Connector for the financial use case. Examples:

    • payment_processor

    • payment_vas

    • fin_operations

    • fiz_operations

    • networks

    • banking_entities

    • non_banking_finance

    • payout_processor

    • payment_method_auth

    • authentication_processor

    • tax_processor

    • billing_processor

    • vault_processor

  • status (enum, required) — Available options: inactive, active

  • connector_label (string | null) — Unique label to identify this connector account in Hyperswitch dashboard and reports (e.g. "stripe_US_travel")

  • connector_account_details (object) — Connector account specific details

  • payment_methods_enabled (object[] | null) — Array of objects describing payment methods enabled for this merchant connector. Example:

  • connector_webhook_details (object) — Webhook secrets and related details

  • metadata (object) — Unstructured metadata

  • test_mode (boolean | null, default: false) — Whether the connector is in Test mode

  • disabled (boolean | null, default: false) — Whether the connector is disabled

  • frm_configs (object[] | null) — Fraud/FRM configs for the merchant connector (example included in response)

  • pm_auth_config (object) — Maps MCA records to chosen auth services based on payment_method and pmt

  • additional_merchant_data (object) — Additional merchant-specific data

  • connector_wallets_details (object) — Details for wallets (apple_pay, google_pay, amazon_pay, etc.)

Response (200) — application/json Merchant Connector Updated. Response fields mirror many of the input fields and include identifiers and configurations.

Notable response fields:

  • connector_type (enum) — same options as body

  • connector_name (enum) — Connector name (many possible values)

  • merchant_connector_id (string) — Unique ID of the merchant connector account (e.g. "mca_5apGeP94tMts6rg3U3kR")

  • profile_id (string) — Identifier for the profile; default chosen if not provided (max length: 64)

  • status (enum) — inactive or active

  • connector_label (string | null) — Unique label for the connector account

  • connector_account_details (object)

  • payment_methods_enabled (object[] | null)

  • connector_webhook_details (object)

  • metadata (object)

  • test_mode (boolean | null)

  • disabled (boolean | null)

  • frm_configs (object[] | null)

  • business_country (enum) — Country code (ISO 3166-1 alpha-2)

  • business_label (string | null) — To be deprecated; use profile_id

  • business_sub_label (string | null) — To be deprecated; use profile_id

  • applepay_verified_domains (string[] | null)

  • pm_auth_config (object)

  • additional_merchant_data (object)

  • connector_wallets_details (object)

Expandable reference data

Connector names (available options)

authipay, adyenplatform, stripe_billing_test, phonypay, fauxpay, pretendpay, stripe_test, adyen_test, checkout_test, paypal_test, aci, adyen, affirm, airwallex, amazonpay, archipel, authorizedotnet, bambora, bamboraapac, bankofamerica, barclaycard, billwerk, bitpay, bluesnap, blackhawknetwork, calida, boku, braintree, breadpay, cardinal, cashtocode, celero, chargebee, checkbook, checkout, coinbase, coingate, custombilling, cryptopay, ctp_mastercard, ctp_visa, cybersource, datatrans, deutschebank, digitalvirgo, dlocal, dwolla, ebanx, elavon, facilitapay, finix, fiserv, fiservemea, fiuu, flexiti, forte, getnet, gigadat, globalpay, globepay, gocardless, gpayments, hipay, helcim, hyperswitch_vault, inespay, iatapay, itaubank, jpmorgan, juspaythreedsserver, klarna, loonio, mifinity, mollie, moneris, multisafepay, netcetera, nexinets, nexixpay, nmi, nomupay, noon, nordea, novalnet, nuvei, opennode, paybox, payload, payme, payone, paypal, paysafe, paystack, paytm, payu, peachpayments, payjustnow, payjustnowinstore, phonepe, placetopay, powertranz, prophetpay, rapyd, razorpay, recurly, redsys, santander, shift4, silverflow, square, stax, stripe, stripebilling, taxjar, threedsecureio, tesouro, tokenex, tokenio, trustpay, trustpayments, tsys, vgs, volt, wellsfargo, wise, worldline, worldpay, worldpayvantiv, worldpayxml, worldpaymodular, signifyd, plaid, riskified, xendit, zen, zift, zsl

Business country codes (ISO 3166-1 alpha-2)

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

  • Use api-key header for authentication.

  • Fields like business_label and business_sub_label are marked to be deprecated; prefer using profile_id.

  • All links and URLs are kept as in the original documentation.

Suggest edits or raise issues

  • Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/merchant-connector-account/merchant-connector--update.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/merchant-connector-account/merchant-connector--update

Related

  • Merchant Connector - Retrieve: https://api-reference.hyperswitch.io/v1/merchant-connector-account/merchant-connector--retrieve

  • Merchant Connector - Delete: https://api-reference.hyperswitch.io/v1/merchant-connector-account/merchant-connector--delete

PreviousPayment Method - RetrieveNextPayments complete authorize