Merchant Connector - List

GET /account/{account_id}/connectors

Retrieve the list of merchant connector accounts for a merchant account.

cURL

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

Example Response (200)

application/json
[
  {
    "connector_type": "payment_processor",
    "connector_name": "authipay",
    "merchant_connector_id": "mca_5apGeP94tMts6rg3U3kR",
    "profile_id": "<string>",
    "status": "inactive",
    "connector_label": "stripe_US_travel",
    "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
      }
    ],
    "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": {}
  }
]

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.

Response

  • Status: 200

  • Content-Type: application/json

  • Description: Merchant Connector list retrieved successfully

Response fields:

  • connector_type (string, 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 (string, enum) — required Connector name. Examples include (non-exhaustive): authipay, adyenplatform, stripe_test, paypal, razorpay, stripe, worldpay, klarna, xendit, zift, ... (full list present in source)

Show full list of connector_name 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

  • 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. Maximum length: 64.

  • status (string, enum) — required inactive, active

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

  • payment_methods_enabled (object[] | null) Details about the payment methods enabled under this merchant connector account. Example:

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

  • disabled (boolean | null) — default: false Indicates if the connector is disabled. Example: false

  • frm_configs (object[] | null) Contains the FRM configs for the merchant connector. Example (string-encoded 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"

  • business_country (string, enum) ISO country code for the business. Examples include: AF, AX, AL, ... , US (full list present in source).

  • business_label (string | null) The business label to which the connector account is attached. To be deprecated soon; use profile_id instead. Example: "travel"

  • business_sub_label (string | null) The business sublabel to which the connector account is attached. To be deprecated soon; use profile_id instead. Example: "chase"

  • applepay_verified_domains (string[] | null) Identifiers for the verified domains of a particular connector account.

  • pm_auth_config (object) Payment method auth configuration object.

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

PreviousMandates customer mandates listNextPayment Method Session - Confirm a payment method session