POST
/
v2
/
connector-accounts
curl --request POST \
  --url https://sandbox.hyperswitch.io/v2/connector-accounts \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "connector_account_details": {
    "api_key": "{{adyen-api-key}}",
    "auth_type": "BodyKey",
    "key1": "{{adyen_merchant_account}}"
  },
  "connector_label": "EU_adyen",
  "connector_name": "adyen",
  "connector_type": "payment_processor"
}'
{
  "connector_type": "payment_processor",
  "connector_name": "authipay",
  "connector_label": "stripe_US_travel",
  "id": "mca_5apGeP94tMts6rg3U3kR",
  "profile_id": "<string>",
  "connector_account_details": {
    "connector_account_details": {},
    "metadata": {}
  },
  "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
        }
      ]
    }
  ],
  "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": {},
  "status": "inactive",
  "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

​
api-key
string
header
required

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

Body

application/json

Create a new Merchant Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc."

​
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,
tax_processor,
billing_processor,
vault_processor
​
connector_name
enum<string>
required
Available options:
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,
bluecode,
boku,
braintree,
breadpay,
cashtocode,
celero,
chargebee,
checkbook,
checkout,
coinbase,
coingate,
custombilling,
cryptopay,
ctp_mastercard,
ctp_visa,
cybersource,
datatrans,
deutschebank,
digitalvirgo,
dlocal,
dwolla,
ebanx,
elavon,
facilitapay,
fiserv,
fiservemea,
fiuu,
flexiti,
forte,
getnet,
globalpay,
globepay,
gocardless,
gpayments,
hipay,
helcim,
hyperswitch_vault,
inespay,
iatapay,
itaubank,
jpmorgan,
juspaythreedsserver,
klarna,
mifinity,
mollie,
moneris,
multisafepay,
netcetera,
nexinets,
nexixpay,
nmi,
nomupay,
noon,
nordea,
novalnet,
nuvei,
opennode,
paybox,
payload,
payme,
payone,
paypal,
paysafe,
paystack,
paytm,
payu,
peachpayments,
phonepe,
placetopay,
powertranz,
prophetpay,
rapyd,
razorpay,
recurly,
redsys,
santander,
shift4,
silverflow,
square,
stax,
stripe,
stripebilling,
taxjar,
threedsecureio,
tokenio,
trustpay,
tsys,
vgs,
volt,
wellsfargo,
wise,
worldline,
worldpay,
worldpayvantiv,
worldpayxml,
signifyd,
plaid,
riskified,
xendit,
zen,
zsl
​
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

Details of all the payment methods enabled for the connector for the given merchant account

​
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, If not passed then if will take connector_name_profile_name. Eg: if your profile label is default, connector label can be stripe_default

Example:

"stripe_US_travel"

​
connector_account_details
object
​
connector_webhook_details
object
​
metadata
object | null

Metadata is useful for storing additional, unstructured information on an object.

​
disabled
boolean | null
default:false

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

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"

​
pm_auth_config
object | null

pm_auth_config will relate MCA records to their respective chosen auth services, based on payment_method and pmt

​
status
enum<string>
Available options:
inactive,
active
​
additional_merchant_data
object
​
connector_wallets_details
object
​
feature_metadata
object

Feature metadata for merchant connector account

Response

Merchant Connector Created

Response of creating a new Merchant Connector for the merchant account."

​
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,
tax_processor,
billing_processor,
vault_processor
​
connector_name
enum<string>
required
Available options:
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,
bluecode,
boku,
braintree,
breadpay,
cashtocode,
celero,
chargebee,
checkbook,
checkout,
coinbase,
coingate,
custombilling,
cryptopay,
ctp_mastercard,
ctp_visa,
cybersource,
datatrans,
deutschebank,
digitalvirgo,
dlocal,
dwolla,
ebanx,
elavon,
facilitapay,
fiserv,
fiservemea,
fiuu,
flexiti,
forte,
getnet,
globalpay,
globepay,
gocardless,
gpayments,
hipay,
helcim,
hyperswitch_vault,
inespay,
iatapay,
itaubank,
jpmorgan,
juspaythreedsserver,
klarna,
mifinity,
mollie,
moneris,
multisafepay,
netcetera,
nexinets,
nexixpay,
nmi,
nomupay,
noon,
nordea,
novalnet,
nuvei,
opennode,
paybox,
payload,
payme,
payone,
paypal,
paysafe,
paystack,
paytm,
payu,
peachpayments,
phonepe,
placetopay,
powertranz,
prophetpay,
rapyd,
razorpay,
recurly,
redsys,
santander,
shift4,
silverflow,
square,
stax,
stripe,
stripebilling,
taxjar,
threedsecureio,
tokenio,
trustpay,
tsys,
vgs,
volt,
wellsfargo,
wise,
worldline,
worldpay,
worldpayvantiv,
worldpayxml,
signifyd,
plaid,
riskified,
xendit,
zen,
zsl
​
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 containing the details about the payment methods that need to be enabled under this merchant connector account

​
status
enum<string>
required
Available 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_webhook_details
object
​
metadata
object | null

Metadata is useful for storing additional, unstructured information on an object.

​
disabled
boolean | null
default:false

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

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

identifier for the verified domains of a particular connector account

​
pm_auth_config
object | null

pm_auth_config will relate MCA records to their respective chosen auth services, based on payment_method and pmt

​
additional_merchant_data
object
​
connector_wallets_details
object
​
feature_metadata
object

Feature metadata for merchant connector account