Connector Account - Update

Update a Merchant Connector (Connector Account).

HTTP Request

PUT /v2/connector-accounts/{id}

Authorization

Header: api-key (string, required) Admin API keys allow privileged actions such as creating merchant and connector accounts.

Path Parameters

id (integer, required) — The unique identifier for the Merchant Connector

Request Body (application/json)

Create or update a Merchant Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc.

Top-level fields:

connector_type (enum, required) — Type of the Connector. Available options: 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) — inactive or active.
merchant_id (string, required) — Identifier for the Merchant Account. Required string length: 1 - 64. Example: "y3oqhf46pyzuxjbcn2giaqnb44".
connector_label (string | null) — Unique label to identify the connector account (if not passed, defaults to connector_name_profile_name). Example: "stripe_US_travel".
connector_account_details (object) — Connector account specific details.
payment_methods_enabled (object[] | null) — Details about payment methods to enable for this merchant connector account.
connector_webhook_details (object) — Webhook-related details (e.g., merchant_secret, additional_secret).
metadata (object) — Up to 50 keys; key names up to 40 chars, values up to 500 chars.
disabled (boolean | null) — default: false. Example: false.
frm_configs (object[] | null) — FRM configs for the merchant connector (example shown below).
pm_auth_config (object) — Relates MCA records to chosen auth services, based on payment_method and pmt.
additional_merchant_data (object) — Additional merchant-specific data (showchild attributes).
connector_wallets_details (object) — Wallets details for the connector (apple_pay, google_pay, etc.).
feature_metadata (object) — Feature metadata for merchant connector account.

Example request (cURL):

Enable card payment method (curl)

curl --request PUT \
  --url https://sandbox.hyperswitch.io/v2/connector-accounts/{id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "disabled": false
}
'

Example frm_configs value (stringified JSON):

"\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"

Response (200 application/json)

Merchant Connector Updated — returns the updated connector account object. Top-level response fields:

connector_type (enum, required) — same options as request.
connector_name (enum, required) — connector implementation name (see list below).
id (string, required) — Unique ID of the merchant connector account. Example: "mca_5apGeP94tMts6rg3U3kR".
profile_id (string, required) — Identifier for the profile (max length 64).
payment_methods_enabled (object[]) — Details about payment methods enabled.
status (enum, required) — inactive or active.
connector_label (string | null) — Unique label. Example: "stripe_US_travel".
connector_account_details (object) — Connector-specific details.
connector_webhook_details (object) — Webhook details (merchant_secret, additional_secret).
metadata (object) — Metadata stored on the object.
disabled (boolean | null) — default: false.
frm_configs (object[] | null) — FRM configs (string shown above as example).
applepay_verified_domains (string[] | null) — Verified domains for Apple Pay.
pm_auth_config (object) — PM auth config details.
additional_merchant_data (object) — Additional merchant data (showchild attributes).
connector_wallets_details (object) — Wallets details (apple_pay, google_pay, etc.).
feature_metadata (object) — Feature metadata for the merchant connector account.

Example successful response (truncated):

200 JSON response

{
  "connector_type": "payment_processor",
  "connector_name": "authipay",
  "id": "mca_5apGeP94tMts6rg3U3kR",
  "profile_id": "<string>",
  "payment_methods_enabled": [
    {
      "payment_method_type": "card",
      "payment_method_subtypes": [
        {
          "payment_method_type": "ach",
          "payment_experience": "redirect_to_url",
          "card_networks": ["Visa"],
          "accepted_currencies": {
            "type": "enable_only",
            "list": ["AED"]
          },
          "accepted_countries": {
            "type": "enable_only",
            "list": ["AF"]
          },
          "minimum_amount": 123,
          "maximum_amount": 123,
          "recurring_enabled": false,
          "installment_payment_enabled": true
        }
      ]
    }
  ],
  "status": "inactive",
  "connector_label": "stripe_US_travel",
  "connector_account_details": {
    "connector_account_details": {},
    "metadata": {}
  },
  "connector_webhook_details": {
    "merchant_secret": "12345678900987654321",
    "additional_secret": "12345678900987654321"
  },
  "metadata": {},
  "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",
  "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": {}
  },
  "feature_metadata": {
    "revenue_recovery": {
      "max_retry_count": "15",
      "billing_connector_retry_threshold": "10",
      "billing_account_reference": "{ \"mca_vDSg5z6AxnisHq5dbJ6g\": \"stripe_123\", \"mca_vDSg5z6AumisHqh4x5m1\": \"adyen_123\" }"
    }
  }
}

connector_name — Available options

Click to expand the full list of connector_name values

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

Good afternoon