v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

Merchant Connector Account

Merchant Connector - List

List Merchant Connector Details for the merchant

get/account/{account_id}/connectors

Path parameters

account_idstring required

The unique identifier for the merchant account

Response

Merchant Connector list retrieved successfully

Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.

connector_labelstring nullable

A unique label to identify the connector account created under a profile

merchant_connector_idstring required

Unique ID of the merchant connector account

profile_idstring required

Identifier for the profile, if not provided default will be chosen from merchant account

test_modeboolean nullable

A boolean value to indicate if the connector is in Test mode. By default, its value is false.

disabledboolean nullable

A boolean value to indicate if the connector is disabled. By default, its value is false.

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_labelstring nullable

The business label to which the connector account is attached. To be deprecated soon. Use the 'profile_id' instead

business_sub_labelstring nullable

The business sublabel to which the connector account is attached. To be deprecated soon. Use the 'profile_id' instead

applepay_verified_domainsstring[] nullable

identifier for the verified domains of a particular connector account

pm_auth_configobject nullable

status'inactive' | 'active' required

Example response

[
  {
    "connector_label": "stripe_US_travel",
    "merchant_connector_id": "mca_5apGeP94tMts6rg3U3kR",
    "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
      }
    ],
    "business_label": "travel",
    "business_sub_label": "chase"
  }
]