---
title: "Merchant Connector - Retrieve"
method: GET
path: "/account/{account_id}/connectors/{merchant_connector_id}"
tags: ["Merchant Connector Account"]
---

# Merchant Connector - Retrieve

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

Retrieves details of a Connector account

## Path parameters

- `account_id` string, required
- `merchant_connector_id` string, required

## Response `200`

Merchant Connector retrieved successfully

- MerchantConnectorResponse — Response of creating a new Merchant Connector for the merchant account."
  - `connector_type` 'payment_processor' | 'payment_vas' | 'fin_operations' | 'fiz_operations' | 'networks' | 'banking_entities' | 'non_banking_finance' | 'payout_processor' | 'payment_method_auth' | 'authentication_processor' | 'tax_processor' | 'surcharge_processor' | 'billing_processor' | 'vault_processor', required — Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.
  - `connector_name` 'absa_sanlam' | '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' | 'cybersourcedecisionmanager' | 'datatrans' | 'deutschebank' | 'digitalvirgo' | 'dlocal' | 'dwolla' | 'ebanx' | 'envoy' | 'elavon' | 'facilitapay' | 'finix' | 'fiserv' | 'fiservemea' | 'fiservcommercehub' | 'fiuu' | 'flexiti' | 'forte' | 'getnet' | 'gigadat' | 'givepayments' | 'globalpay' | 'globepay' | 'gocardless' | 'gpayments' | 'hipay' | 'helcim' | 'hyperpg' | 'hyperswitch_vault' | 'interpayments' | 'inespay' | 'iatapay' | 'imerchantsolutions' | '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' | 'payconex' | 'payu' | 'peachpayments' | 'payjustnow' | 'payjustnowinstore' | 'phonepe' | 'placetopay' | 'powertranz' | 'prophetpay' | 'rapyd' | 'razorpay' | 'recurly' | 'redsys' | 'revolv3' | 'santander' | 'shift4' | 'silverflow' | 'square' | 'stax' | 'stripe' | 'stripebilling' | 'taxjar' | 'threedsecureio' | 'tesouro' | 'tokenex' | 'tokenio' | 'trustly' | 'truelayer' | 'trustpay' | 'trustpayments' | 'tsys' | 'tsys_transit' | 'vgs' | 'volt' | 'wellsfargo' | 'wise' | 'worldline' | 'worldpay' | 'worldpayvantiv' | 'worldpayxml' | 'worldpaymodular' | 'signifyd' | 'plaid' | 'riskified' | 'xendit' | 'zen' | 'zift' | 'zsl', required
  - `connector_label` string, nullable — A unique label to identify the connector account created under a profile
  - `merchant_connector_id` string, required — Unique ID of the merchant connector account
  - `profile_id` string, required — Identifier for the profile, if not provided default will be chosen from merchant account
  - `connector_account_details` MerchantConnectorDetails
    - `connector_account_details` object, nullable — Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object.
    - `metadata` object, nullable — Metadata is useful for storing additional, unstructured information on an object.
  - `payment_methods_enabled` PaymentMethodsEnabled[], nullable — An object containing the details about the payment methods that need to be enabled under this merchant connector account
    - `payment_method` 'card' | 'card_redirect' | 'pay_later' | 'wallet' | 'bank_redirect' | 'bank_transfer' | 'crypto' | 'bank_debit' | 'reward' | 'real_time_payment' | 'upi' | 'voucher' | 'gift_card' | 'open_banking' | 'mobile_payment' | 'network_token', required — Indicates the type of payment method. Eg: 'card', 'wallet', etc.
    - `payment_method_types` RequestPaymentMethodTypes[], nullable — Subtype of payment method
      - `payment_method_type` 'ach' | 'affirm' | 'afterpay_clearpay' | 'alfamart' | 'ali_pay' | 'ali_pay_hk' | 'alma' | 'amazon_pay' | 'paysera' | 'apple_pay' | 'atome' | 'bacs' | 'bancontact_card' | 'becs' | 'benefit' | 'bizum' | 'blik' | 'bluecode' | 'boleto' | 'bca_bank_transfer' | 'bni_va' | 'breadpay' | 'bri_va' | 'bhn_card_network' | 'card_redirect' | 'cimb_va' | 'classic' | 'credit' | 'crypto_currency' | 'cashapp' | 'dana' | 'danamon_va' | 'debit' | 'duit_now' | 'efecty' | 'eft' | 'eft_debit_order' | 'eps' | 'flexiti' | 'fps' | 'evoucher' | 'giropay' | 'givex' | 'google_pay' | 'go_pay' | 'gcash' | 'ideal' | 'interac' | 'indomaret' | 'klarna' | 'kakao_pay' | 'local_bank_redirect' | 'mandiri_va' | 'knet' | 'mb_way' | 'mobile_pay' | 'momo' | 'momo_atm' | 'multibanco' | 'online_banking_thailand' | 'online_banking_czech_republic' | 'online_banking_finland' | 'online_banking_fpx' | 'online_banking_poland' | 'online_banking_slovakia' | 'oxxo' | 'pago_efectivo' | 'permata_bank_transfer' | 'open_banking_uk' | 'pay_bright' | 'payjustnow' | 'paypal' | 'paze' | 'pix' | 'pix_key' | 'pix_emv' | 'pix_qr' | 'pix_automatico_qr' | 'pix_automatico_push' | 'pay_safe_card' | 'przelewy24' | 'prompt_pay' | 'pse' | 'qris' | 'red_compra' | 'red_pagos' | 'samsung_pay' | 'sepa' | 'sepa_bank_transfer' | 'sepa_guarenteed_debit' | 'skrill' | 'sofort' | 'swish' | 'touch_n_go' | 'trustly' | 'twint' | 'upi_collect' | 'upi_intent' | 'upi_qr' | 'vipps' | 'viet_qr' | 'venmo' | 'walley' | 'we_chat_pay' | 'seven_eleven' | 'lawson' | 'mini_stop' | 'family_mart' | 'seicomart' | 'pay_easy' | 'local_bank_transfer' | 'mifinity' | 'open_banking_pis' | 'direct_carrier_billing' | 'instant_bank_transfer' | 'instant_bank_transfer_finland' | 'instant_bank_transfer_poland' | 'revolut_pay' | 'indonesian_bank_transfer' | 'open_banking' | 'network_token', required — Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.
      - `payment_experience` 'redirect_to_url' | 'invoke_sdk_client' | 'display_qr_code' | 'one_click' | 'link_wallet' | 'invoke_payment_app' | 'display_wait_screen' | 'collect_otp' — To indicate the type of payment experience that the customer would go through
      - `card_networks` CardNetwork[], nullable
      - `accepted_currencies` union
        - object
          - `type` 'enable_only', required
          - `list` Currency[], required
        - object
          - `type` 'disable_only', required
          - `list` Currency[], required
        - object
          - `type` 'all_accepted', required
      - `accepted_countries` union — Object to filter the customer countries for which the payment method is displayed
        - object
          - `type` 'enable_only', required
          - `list` CountryAlpha2[], required
        - object
          - `type` 'disable_only', required
          - `list` CountryAlpha2[], required
        - object
          - `type` 'all_accepted', required
      - `minimum_amount` integer — This Unit struct represents MinorUnit in which core amount works
      - `maximum_amount` integer — This Unit struct represents MinorUnit in which core amount works
      - `recurring_enabled` boolean, nullable — Indicates whether the payment method supports recurring payments. Optional.
      - `installment_payment_enabled` boolean, nullable — Indicates whether the payment method is eligible for installment payments (e.g., EMI, BNPL). Optional.
  - `connector_webhook_details` MerchantConnectorWebhookDetails
    - `merchant_secret` string, required
    - `additional_secret` string, required
  - `metadata` object, nullable — Metadata is useful for storing additional, unstructured information on an object.
  - `test_mode` boolean, nullable — A boolean value to indicate if the connector is in Test mode. By default, its value is false.
  - `disabled` boolean, nullable — A boolean value to indicate if the connector is disabled. By default, its value is false.
  - `frm_configs` FrmConfigs[], nullable — Contains the frm configs for the merchant connector
    - `gateway` 'payment_processor' | 'payment_vas' | 'fin_operations' | 'fiz_operations' | 'networks' | 'banking_entities' | 'non_banking_finance' | 'payout_processor' | 'payment_method_auth' | 'authentication_processor' | 'tax_processor' | 'surcharge_processor' | 'billing_processor' | 'vault_processor', required — Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.
    - `payment_methods` FrmPaymentMethod[], required — payment methods that can be used in the payment
      - `payment_method` 'card' | 'card_redirect' | 'pay_later' | 'wallet' | 'bank_redirect' | 'bank_transfer' | 'crypto' | 'bank_debit' | 'reward' | 'real_time_payment' | 'upi' | 'voucher' | 'gift_card' | 'open_banking' | 'mobile_payment' | 'network_token', required — Indicates the type of payment method. Eg: 'card', 'wallet', etc.
      - `payment_method_types` FrmPaymentMethodType[], nullable — payment method types(credit, debit) that can be used in the payment. This field is deprecated. It has not been removed to provide backward compatibility.
        - `payment_method_type` 'ach' | 'affirm' | 'afterpay_clearpay' | 'alfamart' | 'ali_pay' | 'ali_pay_hk' | 'alma' | 'amazon_pay' | 'paysera' | 'apple_pay' | 'atome' | 'bacs' | 'bancontact_card' | 'becs' | 'benefit' | 'bizum' | 'blik' | 'bluecode' | 'boleto' | 'bca_bank_transfer' | 'bni_va' | 'breadpay' | 'bri_va' | 'bhn_card_network' | 'card_redirect' | 'cimb_va' | 'classic' | 'credit' | 'crypto_currency' | 'cashapp' | 'dana' | 'danamon_va' | 'debit' | 'duit_now' | 'efecty' | 'eft' | 'eft_debit_order' | 'eps' | 'flexiti' | 'fps' | 'evoucher' | 'giropay' | 'givex' | 'google_pay' | 'go_pay' | 'gcash' | 'ideal' | 'interac' | 'indomaret' | 'klarna' | 'kakao_pay' | 'local_bank_redirect' | 'mandiri_va' | 'knet' | 'mb_way' | 'mobile_pay' | 'momo' | 'momo_atm' | 'multibanco' | 'online_banking_thailand' | 'online_banking_czech_republic' | 'online_banking_finland' | 'online_banking_fpx' | 'online_banking_poland' | 'online_banking_slovakia' | 'oxxo' | 'pago_efectivo' | 'permata_bank_transfer' | 'open_banking_uk' | 'pay_bright' | 'payjustnow' | 'paypal' | 'paze' | 'pix' | 'pix_key' | 'pix_emv' | 'pix_qr' | 'pix_automatico_qr' | 'pix_automatico_push' | 'pay_safe_card' | 'przelewy24' | 'prompt_pay' | 'pse' | 'qris' | 'red_compra' | 'red_pagos' | 'samsung_pay' | 'sepa' | 'sepa_bank_transfer' | 'sepa_guarenteed_debit' | 'skrill' | 'sofort' | 'swish' | 'touch_n_go' | 'trustly' | 'twint' | 'upi_collect' | 'upi_intent' | 'upi_qr' | 'vipps' | 'viet_qr' | 'venmo' | 'walley' | 'we_chat_pay' | 'seven_eleven' | 'lawson' | 'mini_stop' | 'family_mart' | 'seicomart' | 'pay_easy' | 'local_bank_transfer' | 'mifinity' | 'open_banking_pis' | 'direct_carrier_billing' | 'instant_bank_transfer' | 'instant_bank_transfer_finland' | 'instant_bank_transfer_poland' | 'revolut_pay' | 'indonesian_bank_transfer' | 'open_banking' | 'network_token', required — Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.
        - `card_networks` 'Visa' | 'Mastercard' | 'AmericanExpress' | 'JCB' | 'DinersClub' | 'Discover' | 'CartesBancaires' | 'UnionPay' | 'Interac' | 'RuPay' | 'Maestro' | 'Star' | 'Pulse' | 'Accel' | 'Nyce' | 'Prop' | 'PrivateLabel' | 'Dinacard', required — Indicates the card network.
        - `flow` 'pre' | 'post', required
        - `action` 'cancel_txn' | 'auto_refund' | 'manual_review', required
      - `flow` 'pre' | 'post'
  - `business_country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'US'
  - `business_label` string, nullable — The business label to which the connector account is attached. To be deprecated soon. Use the 'profile_id' instead
  - `business_sub_label` string, nullable — The business sublabel to which the connector account is attached. To be deprecated soon. Use the 'profile_id' instead
  - `applepay_verified_domains` string[], nullable — identifier for the verified domains of a particular connector account
  - `pm_auth_config` object, nullable
  - `status` 'inactive' | 'active', required
  - `additional_merchant_data` AdditionalMerchantData
    - `open_banking_recipient_data` union, required
      - object
        - `connector_recipient_id` string, nullable, required
      - object
        - `wallet_id` string, nullable, required
      - object
        - `account_data` union, required
          - object
            - `iban` object, required — IBAN-based account for international transfers
              - …
          - object
            - `bacs` object, required — UK BACS payment system
              - …
          - object
            - `faster_payments` object, required — UK Faster Payments (instant transfers)
              - …
          - object
            - `sepa` object, required — SEPA payments (Euro zone)
              - …
          - object
            - `sepa_instant` object, required — SEPA Instant payments (10-second transfers)
              - …
          - object
            - `elixir` object, required — Polish Elixir payment system
              - …
          - object
            - `bankgiro` object, required — Swedish Bankgiro system
              - …
          - object
            - `plusgiro` object, required — Swedish Plusgiro system
              - …
  - `connector_wallets_details` ConnectorWalletDetails
    - `apple_pay_combined` object, nullable — This field contains the Apple Pay certificates and credentials for iOS and Web Apple Pay flow
    - `apple_pay` object, nullable — This field is for our legacy Apple Pay flow that contains the Apple Pay certificates and credentials for only iOS Apple Pay flow
    - `amazon_pay` object, nullable — This field contains the Amazon Pay certificates and credentials
    - `samsung_pay` object, nullable — This field contains the Samsung Pay certificates and credentials
    - `paze` object, nullable — This field contains the Paze certificates and credentials
    - `google_pay` object, nullable — This field contains the Google Pay certificates and credentials
  - `webhook_setup_capabilities` WebhookSetupCapabilities — Connector details for webhook configuration via hyperswitch API
    - `is_webhook_auto_configuration_supported` boolean, required — Indicates if the connector supports webhooks configuration via API
    - `requires_webhook_secret` boolean, nullable — Indicates whether a webhook secret must be collected from the merchant for verification
    - `config_type` union — Enum to represent the type of webhook configuration
      - 'AllEvents' — Standard webhook configuration supporting all events hyperswitch provides
      - object
        - `CustomEvents` 'payment_succeeded' | 'payment_failed' | 'payment_processing' | 'payment_cancelled' | 'payment_cancelled_post_capture' | 'payment_authorized' | 'payment_partially_authorized' | 'payment_captured' | 'payment_expired' | 'action_required' | 'refund_succeeded' | 'refund_failed' | 'dispute_opened' | 'dispute_expired' | 'dispute_accepted' | 'dispute_cancelled' | 'dispute_challenged' | 'dispute_won' | 'dispute_lost' | 'mandate_active' | 'mandate_revoked' | 'payout_success' | 'payout_failed' | 'payout_initiated' | 'payout_processing' | 'payout_cancelled' | 'payout_expired' | 'payout_reversed' | 'invoice_paid' | 'surcharge_payment_succeeded' | 'surcharge_refund_succeeded', required

## Other responses

- `401` — Unauthorized request
- `404` — Merchant Connector does not exist in records

---

[API](https://skmtc.net/hyperswitch/apis/dynamic-routing-openapi-3-0.md) · [All operations](https://skmtc.net/hyperswitch/apis/dynamic-routing-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hyperswitch/dynamic-routing-openapi-3-0/revisions/8fbf69ab2597/schema)