Get Started [BETA]
Essentials [BETA]
Payments Core APIs [BETA]
- Payments
- Payment Methods
- Payment Method Session
- Customers
- Refunds
Account management APIs [BETA]
- Organization
- Merchant Account
- Profile
- Connector Account
- API Key
- Routing
Other APIs [BETA]
- Proxy
- Tokenization
Connector Account
Connector Account - Create
Creates a new Connector Account for the merchant account. The connector could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting etc.
POST
/
v2
/
connector-accounts
Copy
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"
}'
Copy
{
"connector_type": "payment_processor",
"connector_name": "adyenplatform",
"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": {},
"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
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."
Response
200
application/json
Merchant Connector Created
Response of creating a new Merchant Connector for the merchant account."
Copy
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"
}'
Copy
{
"connector_type": "payment_processor",
"connector_name": "adyenplatform",
"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": {},
"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\" }"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.