Connector Account - Retrieve

Retrieve a Merchant Connector account by ID.

Endpoint

GET /v2/connector-accounts/{id}

Request example

cURL

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

Response example (200)

application/json

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

Authorizations

Header: api-key (string) — required

Admin API keys allow privileged actions such as creating a merchant account and Connector account.

Path parameters

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

Response

Status: 200 application/json Description: Merchant Connector retrieved successfully

The response contains the Merchant Connector object. Key fields:

connector_type (string, required) Type of the Connector for the financial use case.
connector_name (string, required) Name of the connector.
id (string, required) Unique ID of the merchant connector account. Example: "mca_5apGeP94tMts6rg3U3kR"
profile_id (string, required) Identifier for the profile. Maximum length: 64
payment_methods_enabled (object[]) — required Details about payment methods enabled for this merchant connector account.
status (string, required) Connector account status. Options: inactive, 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 and nested metadata
connector_webhook_details (object) Webhook secrets and related details (e.g., merchant_secret, additional_secret)
metadata (object) Unstructured additional information on the object
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
applepay_verified_domains (string[] | null) Identifiers for verified domains for Apple Pay for this connector account
pm_auth_config (object) Relates MCA records to chosen auth services, based on payment_method and pmt
additional_merchant_data (object) e.g., open_banking_recipient_data with connector_recipient_id
connector_wallets_details (object) Details for wallets like apple_pay, google_pay, amazon_pay, samsung_pay, paze, apple_pay_combined
feature_metadata (object) Feature-specific metadata. Example:
- revenue_recovery: { max_retry_count, billing_connector_retry_threshold, billing_account_reference }

Good afternoon