POST
/
accounts
/
{account_id}
/
connectors
/
{connector_id}
curl --request POST \
  --url https://sandbox.hyperswitch.io/accounts/{account_id}/connectors/{connector_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "connector_type": "fiz_operations",
  "payment_methods_enabled": [
    {
      "payment_method": "card"
    }
  ]
}'
{
  "connector_type": "payment_processor",
  "connector_name": "adyenplatform",
  "connector_label": "stripe_US_travel",
  "merchant_connector_id": "mca_5apGeP94tMts6rg3U3kR",
  "profile_id": "<string>",
  "connector_account_details": {
    "connector_account_details": {},
    "metadata": {}
  },
  "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
    }
  ],
  "connector_webhook_details": {
    "merchant_secret": "12345678900987654321",
    "additional_secret": "12345678900987654321"
  },
  "metadata": {},
  "test_mode": true,
  "disabled": true,
  "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": "<any>",
  "status": "inactive"
}

Authorizations

api-key
string
headerrequired

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.

Path Parameters

account_id
string
required

The unique identifier for the merchant account

connector_id
integer
required

The unique identifier for the Merchant Connector

Body

application/json
connector_type
enum<string>
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
connector_label
string | null

This is an unique label you can generate and pass in order to identify this connector account on your Hyperswitch dashboard and reports. Eg: if your profile label is default, connector label can be stripe_default

connector_account_details
object
payment_methods_enabled
object[] | null

An object containing the details about the payment methods that need to be enabled under this merchant connector account

connector_webhook_details
object
metadata
object | null

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

test_mode
boolean | null
default: false

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

disabled
boolean | null
default: false

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

frm_configs
object[] | null

Contains the frm configs for the merchant connector

pm_auth_config
any | null
status
enum<string>
required
Available options:
inactive,
active

Response

200 - application/json
connector_type
enum<string>
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
connector_name
enum<string>
required

A connector is an integration to fulfill payments

Available options:
adyenplatform,
phonypay,
fauxpay,
pretendpay,
stripe_test,
adyen_test,
checkout_test,
paypal_test,
aci,
adyen,
airwallex,
authorizedotnet,
bambora,
bankofamerica,
billwerk,
bitpay,
bluesnap,
boku,
braintree,
cashtocode,
checkout,
coinbase,
cryptopay,
cybersource,
dlocal,
ebanx,
fiserv,
forte,
globalpay,
globepay,
gocardless,
gpayments,
helcim,
iatapay,
klarna,
mifinity,
mollie,
multisafepay,
netcetera,
nexinets,
nmi,
noon,
nuvei,
opennode,
payme,
payone,
paypal,
payu,
placetopay,
powertranz,
prophetpay,
rapyd,
shift4,
square,
stax,
stripe,
threedsecureio,
trustpay,
tsys,
volt,
wise,
worldline,
worldpay,
signifyd,
plaid,
riskified,
zen,
zsl
connector_label
string | null

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

merchant_connector_id
string
required

Unique ID of the merchant connector account

profile_id
string | null

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

connector_account_details
object
payment_methods_enabled
object[] | null

An object containing the details about the payment methods that need to be enabled under this merchant connector account

connector_webhook_details
object
metadata
object | null

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

test_mode
boolean | null
default: false

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

disabled
boolean | null
default: false

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

frm_configs
object[] | null

Contains the frm configs for the merchant connector

business_country
enum<string>
Available options:
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 | null

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

business_sub_label
string | null

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

applepay_verified_domains
string[] | null

identifier for the verified domains of a particular connector account

pm_auth_config
any | null
status
enum<string>
required
Available options:
inactive,
active
Merchant Connector - RetrieveMerchant Connector - Delete