Profile - Connector Accounts List

Retrieve the list of connector accounts for a merchant profile.

Request

GET /v2/profiles/{id}/connector-accounts

cURL

curl
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/profiles/{id}/connector-accounts \
  --header 'X-Merchant-Id: <x-merchant-id>' \
  --header 'api-key: <api-key>'

Response (200)

application/json Merchant Connector list retrieved successfully

Example 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\" }"
      }
    }
  }
]

Authorization

  • api-key (header) — string — required Admin API keys allow privileged actions such as creating a merchant account and Connector account.

Headers

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

Path Parameters

  • id — string — required The unique identifier for the business profile.

Response 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 Connector identifier (examples include authipay, adyenplatform, stripe_test, paypal, etc.).

  • 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

  • payment_methods_enabled (object[]) — required An object array containing details about the payment methods enabled under this merchant connector account (see response example for structure).

  • 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-specific account details.

  • connector_webhook_details (object) Webhook-related secrets/details.

  • metadata (object) Metadata for storing additional, unstructured information.

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

  • frm_configs (object[] | null) Contains the FRM configs for the merchant connector. Example: "\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[] | null) Identifiers for the verified domains of a particular connector account.

  • pm_auth_config (object) Relates MCA records to their chosen auth services, based on payment_method and pmt.

  • additional_merchant_data (object) Additional merchant data (example shows open_banking_recipient_data.connector_recipient_id).

  • connector_wallets_details (object) Wallet-specific details (apple_pay_combined, apple_pay, amazon_pay, samsung_pay, paze, google_pay).

  • feature_metadata (object) Feature metadata for merchant connector account (example includes revenue_recovery settings).

Notes

  • Admin API key is required in the api-key header.

  • Include X-Merchant-Id header with the merchant profile ID.

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

PreviousPayments - CancelNextPayouts - Confirm