Get Started
Essentials
Payments Core APIs
- Setup Instructions
- Payment Flows
- Payments
- Payment Methods
- Customers
- Mandates
- Refunds
- Disputes
- Payouts
Account management APIs
- Organization
- Merchant Account
- Business Profile
- API Key
- Merchant Connector Account
- GSM (Global Status Mapping)
Other APIs
- Event
- Poll
- Blocklist
- Routing
- Relay
- Schemas
Merchant Connector Account
Merchant connector create
POST
/
accounts
/
{account_id}
/
connectors
Copy
Ask AI
HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/accounts/{account_id}/connectors")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connector_account_details\": {\n \"api_key\": \"{{adyen-api-key}}\",\n \"auth_type\": \"BodyKey\",\n \"key1\": \"{{adyen_merchant_account}}\"\n },\n \"connector_label\": \"EU_adyen\",\n \"connector_name\": \"adyen\",\n \"connector_type\": \"payment_processor\"\n}")
.asString();
Copy
Ask AI
{
"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": false,
"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",
"business_country": "AF",
"business_label": "travel",
"business_sub_label": "chase",
"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": {}
}
}
Authorizations
Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Path Parameters
The unique identifier for the merchant 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."
Was this page helpful?
Copy
Ask AI
HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/accounts/{account_id}/connectors")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connector_account_details\": {\n \"api_key\": \"{{adyen-api-key}}\",\n \"auth_type\": \"BodyKey\",\n \"key1\": \"{{adyen_merchant_account}}\"\n },\n \"connector_label\": \"EU_adyen\",\n \"connector_name\": \"adyen\",\n \"connector_type\": \"payment_processor\"\n}")
.asString();
Copy
Ask AI
{
"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": false,
"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",
"business_country": "AF",
"business_label": "travel",
"business_sub_label": "chase",
"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": {}
}
}
Assistant
Responses are generated using AI and may contain mistakes.