Skip to main content
PATCH
/
partners
/
merchants
/
{merchant_id}
Update Merchant
curl --request PATCH \
  --url https://api-pacb-uat.eximpe.com/partners/merchants/{merchant_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "company_details": {
    "legal_name": "Shakti Logistics & Exports Pvt Ltd",
    "brand_name": "ShaktiXpress",
    "registration_number": "IN09DEL2021PTC987654",
    "international_org_type": "Private Limited Company",
    "tax_id": "29AABCT1234D1Z9",
    "website": "https://www.shaktiexpress.in",
    "monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
    "business_category": "E-commerce (physical goods & cross-border shipping)",
    "business_mode": "b2b",
    "description_of_products_and_services": "ShaktiXpress provides export logistics and warehousing services for textile machinery and automotive components across Asia and Europe.",
    "agreement_details": "Master Logistics Agreement valid until 2027-12-31",
    "communication_address": "Plot No. 56, Electronic City Phase 1",
    "communication_city": "Bengaluru",
    "communication_state": "Karnataka",
    "communication_country": "India",
    "communication_pincode": "560100",
    "same_as_registered_address": false,
    "registered_address": "7th Floor, Sagar Tech Plaza, Andheri-Kurla Road",
    "registered_city": "Mumbai",
    "registered_state": "Maharashtra",
    "registered_country": "India",
    "registered_pincode": "400072",
    "hs_codes": [
      "85234910",
      "84715000"
    ]
  },
  "settlement_details": {
    "bank_account_number": "5087654321123456",
    "bank_account_name": "Shakti Logistics & Exports Pvt Ltd",
    "bank_swift_code": "HDFCINBBXXX",
    "bank_name": "HDFC Bank Ltd.",
    "bank_branch_name": "Andheri East Branch",
    "bank_address": "Unit 3A, Ground Floor, Hiranandani Business Park, Powai",
    "bank_city": "Mumbai",
    "bank_state": "Maharashtra",
    "bank_country": "India",
    "bank_pincode": "400076",
    "routing_number": "HDFC0000001"
  }
}
'
{
  "success": true,
  "message": "Merchant updated successfully",
  "data": {
    "merchant_id": "3604346598",
    "updated_fields": [
      "company_details",
      "settlement_details"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The Update Merchant endpoint allows Payment Aggregators (PSPs) to update an existing sub-merchant’s company details, settlement information, contact details, and business information. This is a partial update (PATCH) — only include the fields you want to change. Fields not included in the request will remain unchanged. Important: Updates are only allowed when the sub-merchant is in PENDING or CHANGES_REQUESTED status. Merchants in other statuses (APPROVED, IN_REVIEW, REJECTED) cannot be edited.

​
Request Parameters

The request structure mirrors the Create Merchant endpoint. All fields are optional for partial updates.

​
Parameter Definitions

​
Top-level

NameTypeRequiredDescription
company_detailsobjectNoCompany and contact details to update. See Company Details
settlement_detailsobjectNoBank account details to update. See Settlement Details

​
Company Details

All fields from the Create Merchant are accepted, but none are required. Only include fields you want to change. Key fields:
NameTypeDescriptionConstraints
emailstringContact email.RFC 5322 email format
phone_numberstringContact phone number.E.164 format (e.g., +919876543210)
legal_namestringLegal name of the company.Max 255 chars
brand_namestringBrand/trade name.Max 255 chars
websitestringCompany website URL.Must include https:// prefix
international_org_typestringType of organization.Same enum as Create
monthly_avg_transaction_volumestringTransaction volume range.Same enum as Create
business_categorystringBusiness category.Same values as Create
business_category_otherstringRequired when category includes “Other”.
business_modestringMode of business.Enum: b2b, b2c, marketplace
mccstringMerchant Category Codes.Comma-separated 4-digit codes
For the complete field reference, see Create Merchant — Company Details.

​
Settlement Details

All fields from the Create Merchant are accepted. Only include fields you want to change.

​
Examples

{
  "company_details": {
    "brand_name": "AcmeTech Global",
    "website": "https://acmetech-global.com",
    "business_category": "Digital goods / software / downloads,SaaS / subscriptions / recurring billing",
    "monthly_avg_transaction_volume": "BETWEEN_50_K_AND_100_K",
    "description_of_products_and_services": "Updated: Enterprise SaaS platform for supply chain management"
  }
}

​
Response Examples

{
  "success": true,
  "message": "Sub-merchant updated successfully",
  "data": {
    "id": "6182929449",
    "company_details": {
      "legal_name": "Acme Technologies Pvt Ltd",
      "brand_name": "AcmeTech Global",
      "email": "[email protected]",
      "phone_number": "+919876500000",
      "registration_number": "U72200MH2020PTC123456",
      "international_org_type": "Private Limited Company",
      "tax_id": "AACCA1234A",
      "website": "https://acmetech-global.com",
      "monthly_avg_transaction_volume": "BETWEEN_50_K_AND_100_K",
      "communication_address": "Tower A, Techpark, Whitefield",
      "communication_city": "Bangalore",
      "communication_state": "Karnataka",
      "communication_country": "India",
      "communication_pincode": "560066",
      "same_as_registered_address": true,
      "registered_address": "Tower A, Techpark, Whitefield",
      "registered_city": "Bangalore",
      "registered_state": "Karnataka",
      "registered_country": "India",
      "registered_pincode": "560066",
      "business_category": "Digital goods / software / downloads,SaaS / subscriptions / recurring billing",
      "business_category_other": null,
      "business_mode": "b2b",
      "hs_codes": [],
      "description_of_products_and_services": "Updated: Enterprise SaaS platform for supply chain management",
      "agreement_details": null
    },
    "settlement_details": {
      "bank_account_number": "9876543210123456",
      "bank_account_name": "AcmeTech Global Pvt Ltd",
      "bank_swift_code": "ABORINBB",
      "bank_name": "RBL Bank",
      "bank_branch_name": "BKC Branch",
      "bank_address": "One BKC, Bandra Kurla Complex",
      "bank_city": "Mumbai",
      "bank_state": "Maharashtra",
      "bank_country": "India",
      "bank_pincode": "400051",
      "routing_number": "RATN0000001",
      "settlement_currency": "USD"
    },
    "kyc_status": "PENDING",
    "created_at": "2026-04-28T06:30:00.000000Z",
    "last_updated_at": "2026-04-28T09:15:00.000000Z"
  }
}

​
Error Codes

CodeMessageDescription
ERR_MERCHANT_001Validation errorRequest validation failed — check details for field-level errors

​
Implementation Notes

​
Editable Statuses

Only sub-merchants in these statuses can be updated:
  • PENDING — Initial state after creation
  • CHANGES_REQUESTED — After review, when additional information is needed
Sub-merchants in APPROVED, IN_REVIEW, or REJECTED status will return a validation error.

​
Partial Updates

This endpoint supports partial updates — only send the fields you want to change. Omitted fields retain their current values.

​
Address Handling

When same_as_registered_address is set to true, communication address fields are automatically copied from registered address fields. If you update registered address fields and want communication to match, include same_as_registered_address: true.

​
Validation

All the same validations from the Create Merchant endpoint apply:
  • website must include https:// prefix
  • phone_number must be E.164 format
  • business_category, business_mode, international_org_type, monthly_avg_transaction_volume must use valid enum values
  • mcc must be comma-separated 4-digit codes
  • business_category_other is required when category includes “Other”

Authorizations

​
X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

​
X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

​
X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Path Parameters

​
merchant_id
string
required

The ID of the merchant to update.

Body

application/json

Merchant update request - only include fields to update

Request body for updating merchant - only include fields to update

​
company_details
object

Company details to update

​
settlement_details
object

Settlement details to update

Response

Merchant updated successfully.

​
success
boolean
required

Indicates if the request was successful

​
message
string
required

Response message

​
data
object
required

Contains the updated merchant fields