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 Account
Merchant Account - Update
Updates details of an existing merchant account. Helpful in updating merchant details such as email, contact details, or other configuration details like webhook, routing algorithm etc
POST
/
accounts
/
{account_id}
Copy
Ask AI
HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/accounts/{account_id}")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"merchant_id\": \"merchant_abc\",\n \"merchant_name\": \"merchant_name\"\n}")
.asString();
Copy
Ask AI
{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"merchant_name": "NewAge Retailer",
"return_url": "https://www.example.com/success",
"enable_payment_response_hash": true,
"payment_response_hash_key": "xkkdf909012sdjki2dkh5sdf",
"redirect_to_merchant_with_http_post": true,
"merchant_details": {
"primary_contact_person": "John Doe",
"primary_phone": "999999999",
"primary_email": "johndoe@test.com",
"secondary_contact_person": "John Doe2",
"secondary_phone": "999999988",
"secondary_email": "johndoe2@test.com",
"website": "www.example.com",
"about_business": "Online Retail with a wide selection of organic products for North America",
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
}
},
"webhook_details": {
"webhook_version": "1.0.2",
"webhook_username": "ekart_retail",
"webhook_password": "ekart@123",
"webhook_url": "www.ekart.com/webhooks",
"payment_created_enabled": true,
"payment_succeeded_enabled": true,
"payment_failed_enabled": true,
"payment_statuses_enabled": [
"succeeded",
"failed",
"partially_captured",
"requires_merchant_action"
],
"refund_statuses_enabled": [
"success",
"failure"
],
"payout_statuses_enabled": [
"success",
"failed"
]
},
"payout_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"merchant_connector_id": "<string>"
}
},
"sub_merchants_enabled": false,
"parent_merchant_id": "xkkdf909012sdjki2dkh5sdf",
"publishable_key": "AH3423bkjbkjdsfbkj",
"metadata": {},
"locker_id": "locker_abc123",
"primary_business_details": [
{
"country": "AF",
"business": "food"
}
],
"frm_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"merchant_connector_id": "<string>"
}
},
"organization_id": "org_q98uSGAYbjEwqs0mJwnz",
"is_recon_enabled": true,
"default_profile": "<string>",
"recon_status": "not_requested",
"pm_collect_link_config": {
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>",
"allowed_domains": [
"<string>"
],
"enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]"
},
"product_type": "orchestration",
"merchant_account_type": "standard"
}
Authorizations
Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.
Path Parameters
The unique identifier for the merchant account
Body
application/json
Response
200
application/json
Merchant Account Updated
The response is of type object
.
Was this page helpful?
Copy
Ask AI
HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/accounts/{account_id}")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"merchant_id\": \"merchant_abc\",\n \"merchant_name\": \"merchant_name\"\n}")
.asString();
Copy
Ask AI
{
"merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
"merchant_name": "NewAge Retailer",
"return_url": "https://www.example.com/success",
"enable_payment_response_hash": true,
"payment_response_hash_key": "xkkdf909012sdjki2dkh5sdf",
"redirect_to_merchant_with_http_post": true,
"merchant_details": {
"primary_contact_person": "John Doe",
"primary_phone": "999999999",
"primary_email": "johndoe@test.com",
"secondary_contact_person": "John Doe2",
"secondary_phone": "999999988",
"secondary_email": "johndoe2@test.com",
"website": "www.example.com",
"about_business": "Online Retail with a wide selection of organic products for North America",
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe"
}
},
"webhook_details": {
"webhook_version": "1.0.2",
"webhook_username": "ekart_retail",
"webhook_password": "ekart@123",
"webhook_url": "www.ekart.com/webhooks",
"payment_created_enabled": true,
"payment_succeeded_enabled": true,
"payment_failed_enabled": true,
"payment_statuses_enabled": [
"succeeded",
"failed",
"partially_captured",
"requires_merchant_action"
],
"refund_statuses_enabled": [
"success",
"failure"
],
"payout_statuses_enabled": [
"success",
"failed"
]
},
"payout_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"merchant_connector_id": "<string>"
}
},
"sub_merchants_enabled": false,
"parent_merchant_id": "xkkdf909012sdjki2dkh5sdf",
"publishable_key": "AH3423bkjbkjdsfbkj",
"metadata": {},
"locker_id": "locker_abc123",
"primary_business_details": [
{
"country": "AF",
"business": "food"
}
],
"frm_routing_algorithm": {
"type": "single",
"data": {
"connector": "authipay",
"merchant_connector_id": "<string>"
}
},
"organization_id": "org_q98uSGAYbjEwqs0mJwnz",
"is_recon_enabled": true,
"default_profile": "<string>",
"recon_status": "not_requested",
"pm_collect_link_config": {
"logo": "https://hyperswitch.io/favicon.ico",
"merchant_name": "Hyperswitch",
"theme": "#4285F4",
"domain_name": "<string>",
"allowed_domains": [
"<string>"
],
"enabled_payment_methods": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]"
},
"product_type": "orchestration",
"merchant_account_type": "standard"
}
Assistant
Responses are generated using AI and may contain mistakes.