Merchant Connector - Retrieve

Retrieve a Merchant Connector for a merchant account.

HTTP request

GET /account/{account_id}/connectors/{merchant_connector_id}

Example cURL:

cURL
curl --request GET \
  --url https://sandbox.hyperswitch.io/account/{account_id}/connectors/{merchant_connector_id} \
  --header 'api-key: <api-key>'

Success response (200)

Content-Type: application/json

Example response:

Response (application/json)
{
  "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

Response schema (selected fields)

  • connector_type (enum, required) Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking. 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

  • connector_name (enum, required) Available options include (partial list): 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

  • merchant_connector_id (string, required) — Unique ID of the merchant connector account Example: "mca_5apGeP94tMts6rg3U3kR"

  • profile_id (string, required) — Identifier for the profile; if not provided, default will be chosen from merchant account (max length: 64)

  • status (enum, required) — inactive or active

  • connector_label (string | null) — A unique label to identify the connector account created under a profile Example: "stripe_US_travel"

  • connector_account_details (object) — Connector account specific details

  • payment_methods_enabled (object[] | null) — Details about enabled payment methods (see example in response)

  • connector_webhook_details (object) — Webhook secrets and details

  • metadata (object) — Additional unstructured information

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

  • disabled (boolean | null, default: false) — Indicates if connector is disabled

  • frm_configs (object[] | null) — Contains the frm configs for the merchant connector

  • business_country (enum) — Country code (ISO alpha-2). Example: AF (full list of codes supported)

  • business_label (string | null) — Deprecated: the business label to which the connector account is attached. Use profile_id instead. Example: "travel"

  • business_sub_label (string | null) — Deprecated: business sublabel. Use profile_id instead. Example: "chase"

  • applepay_verified_domains (string[] | null) — Verified domains for Apple Pay

  • pm_auth_config (object) — Payment method auth configuration

  • additional_merchant_data (object) — Additional merchant-specific data. Example child:

    • open_banking_recipient_data.connector_recipient_id (string)

  • connector_wallets_details (object) — Details for wallet integrations (apple_pay_combined, apple_pay, amazon_pay, samsung_pay, paze, google_pay)

Examples & Notes

  • The API key must be sent in the header named api-key.

  • The example response includes nested objects such as connector_account_details, payment_methods_enabled, and connector_wallets_details — check these fields to configure connector-specific behavior.

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/merchant-connector-account/merchant-connector--retrieve.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/merchant-connector-account/merchant-connector--retrieve

Related:

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

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

PreviousCustomers - List