Create Merchant
curl --request POST \
--url https://api-pacb-uat.eximpe.com/partners/merchants/ \
--header 'Content-Type: application/json' \
--header 'X-API-Version: <api-key>' \
--header 'X-Client-ID: <api-key>' \
--header 'X-Client-Secret: <api-key>' \
--data '
{
"settlement_details": {
"bank_account_number": "6789123450987654",
"bank_account_name": "InnovateTech Solutions Private Limited",
"bank_swift_code": "CHASINUS33XXX",
"bank_name": "JPMorgan Chase Bank",
"bank_branch_name": "Financial District Branch",
"bank_address": "270 Park Avenue, New York",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10017",
"routing_number": "021000021"
},
"company_details": {
"legal_name": "InnovateTech Solutions Private Limited",
"brand_name": "InnovateTech",
"registration_number": "US-CORP-2024-IT789456",
"international_org_type": "Private Limited Company",
"tax_id": "94-8765432",
"website": "https://www.innovatetech.com",
"monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
"communication_address": "Suite 1200, 101 California Street",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94111",
"same_as_registered_address": false,
"registered_address": "1455 Market Street, Suite 1600",
"registered_city": "San Francisco",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94103",
"business_category": "E-commerce (physical goods & cross-border shipping)",
"business_mode": "b2b",
"hs_codes": [
"85234910",
"84715000"
],
"description_of_products_and_services": "InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.",
"agreement_details": "Master Service Agreement for Cloud Solutions dated 2024-03-15",
"email": "[email protected]",
"phone_number": "+919876543210"
}
}
'import requests
url = "https://api-pacb-uat.eximpe.com/partners/merchants/"
payload = {
"settlement_details": {
"bank_account_number": "6789123450987654",
"bank_account_name": "InnovateTech Solutions Private Limited",
"bank_swift_code": "CHASINUS33XXX",
"bank_name": "JPMorgan Chase Bank",
"bank_branch_name": "Financial District Branch",
"bank_address": "270 Park Avenue, New York",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10017",
"routing_number": "021000021"
},
"company_details": {
"legal_name": "InnovateTech Solutions Private Limited",
"brand_name": "InnovateTech",
"registration_number": "US-CORP-2024-IT789456",
"international_org_type": "Private Limited Company",
"tax_id": "94-8765432",
"website": "https://www.innovatetech.com",
"monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
"communication_address": "Suite 1200, 101 California Street",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94111",
"same_as_registered_address": False,
"registered_address": "1455 Market Street, Suite 1600",
"registered_city": "San Francisco",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94103",
"business_category": "E-commerce (physical goods & cross-border shipping)",
"business_mode": "b2b",
"hs_codes": ["85234910", "84715000"],
"description_of_products_and_services": "InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.",
"agreement_details": "Master Service Agreement for Cloud Solutions dated 2024-03-15",
"email": "[email protected]",
"phone_number": "+919876543210"
}
}
headers = {
"X-Client-ID": "<api-key>",
"X-Client-Secret": "<api-key>",
"X-API-Version": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Client-ID': '<api-key>',
'X-Client-Secret': '<api-key>',
'X-API-Version': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
settlement_details: {
bank_account_number: '6789123450987654',
bank_account_name: 'InnovateTech Solutions Private Limited',
bank_swift_code: 'CHASINUS33XXX',
bank_name: 'JPMorgan Chase Bank',
bank_branch_name: 'Financial District Branch',
bank_address: '270 Park Avenue, New York',
bank_city: 'New York',
bank_state: 'NY',
bank_country: 'United States',
bank_pincode: '10017',
routing_number: '021000021'
},
company_details: {
legal_name: 'InnovateTech Solutions Private Limited',
brand_name: 'InnovateTech',
registration_number: 'US-CORP-2024-IT789456',
international_org_type: 'Private Limited Company',
tax_id: '94-8765432',
website: 'https://www.innovatetech.com',
monthly_avg_transaction_volume: 'BETWEEN_20_K_AND_50_K',
communication_address: 'Suite 1200, 101 California Street',
communication_city: 'San Francisco',
communication_state: 'CA',
communication_country: 'United States',
communication_pincode: '94111',
same_as_registered_address: false,
registered_address: '1455 Market Street, Suite 1600',
registered_city: 'San Francisco',
registered_state: 'CA',
registered_country: 'United States',
registered_pincode: '94103',
business_category: 'E-commerce (physical goods & cross-border shipping)',
business_mode: 'b2b',
hs_codes: ['85234910', '84715000'],
description_of_products_and_services: 'InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.',
agreement_details: 'Master Service Agreement for Cloud Solutions dated 2024-03-15',
email: '[email protected]',
phone_number: '+919876543210'
}
})
};
fetch('https://api-pacb-uat.eximpe.com/partners/merchants/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-pacb-uat.eximpe.com/partners/merchants/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'settlement_details' => [
'bank_account_number' => '6789123450987654',
'bank_account_name' => 'InnovateTech Solutions Private Limited',
'bank_swift_code' => 'CHASINUS33XXX',
'bank_name' => 'JPMorgan Chase Bank',
'bank_branch_name' => 'Financial District Branch',
'bank_address' => '270 Park Avenue, New York',
'bank_city' => 'New York',
'bank_state' => 'NY',
'bank_country' => 'United States',
'bank_pincode' => '10017',
'routing_number' => '021000021'
],
'company_details' => [
'legal_name' => 'InnovateTech Solutions Private Limited',
'brand_name' => 'InnovateTech',
'registration_number' => 'US-CORP-2024-IT789456',
'international_org_type' => 'Private Limited Company',
'tax_id' => '94-8765432',
'website' => 'https://www.innovatetech.com',
'monthly_avg_transaction_volume' => 'BETWEEN_20_K_AND_50_K',
'communication_address' => 'Suite 1200, 101 California Street',
'communication_city' => 'San Francisco',
'communication_state' => 'CA',
'communication_country' => 'United States',
'communication_pincode' => '94111',
'same_as_registered_address' => false,
'registered_address' => '1455 Market Street, Suite 1600',
'registered_city' => 'San Francisco',
'registered_state' => 'CA',
'registered_country' => 'United States',
'registered_pincode' => '94103',
'business_category' => 'E-commerce (physical goods & cross-border shipping)',
'business_mode' => 'b2b',
'hs_codes' => [
'85234910',
'84715000'
],
'description_of_products_and_services' => 'InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.',
'agreement_details' => 'Master Service Agreement for Cloud Solutions dated 2024-03-15',
'email' => '[email protected]',
'phone_number' => '+919876543210'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Version: <api-key>",
"X-Client-ID: <api-key>",
"X-Client-Secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-pacb-uat.eximpe.com/partners/merchants/"
payload := strings.NewReader("{\n \"settlement_details\": {\n \"bank_account_number\": \"6789123450987654\",\n \"bank_account_name\": \"InnovateTech Solutions Private Limited\",\n \"bank_swift_code\": \"CHASINUS33XXX\",\n \"bank_name\": \"JPMorgan Chase Bank\",\n \"bank_branch_name\": \"Financial District Branch\",\n \"bank_address\": \"270 Park Avenue, New York\",\n \"bank_city\": \"New York\",\n \"bank_state\": \"NY\",\n \"bank_country\": \"United States\",\n \"bank_pincode\": \"10017\",\n \"routing_number\": \"021000021\"\n },\n \"company_details\": {\n \"legal_name\": \"InnovateTech Solutions Private Limited\",\n \"brand_name\": \"InnovateTech\",\n \"registration_number\": \"US-CORP-2024-IT789456\",\n \"international_org_type\": \"Private Limited Company\",\n \"tax_id\": \"94-8765432\",\n \"website\": \"https://www.innovatetech.com\",\n \"monthly_avg_transaction_volume\": \"BETWEEN_20_K_AND_50_K\",\n \"communication_address\": \"Suite 1200, 101 California Street\",\n \"communication_city\": \"San Francisco\",\n \"communication_state\": \"CA\",\n \"communication_country\": \"United States\",\n \"communication_pincode\": \"94111\",\n \"same_as_registered_address\": false,\n \"registered_address\": \"1455 Market Street, Suite 1600\",\n \"registered_city\": \"San Francisco\",\n \"registered_state\": \"CA\",\n \"registered_country\": \"United States\",\n \"registered_pincode\": \"94103\",\n \"business_category\": \"E-commerce (physical goods & cross-border shipping)\",\n \"business_mode\": \"b2b\",\n \"hs_codes\": [\n \"85234910\",\n \"84715000\"\n ],\n \"description_of_products_and_services\": \"InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.\",\n \"agreement_details\": \"Master Service Agreement for Cloud Solutions dated 2024-03-15\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"+919876543210\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Client-ID", "<api-key>")
req.Header.Add("X-Client-Secret", "<api-key>")
req.Header.Add("X-API-Version", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-pacb-uat.eximpe.com/partners/merchants/")
.header("X-Client-ID", "<api-key>")
.header("X-Client-Secret", "<api-key>")
.header("X-API-Version", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"settlement_details\": {\n \"bank_account_number\": \"6789123450987654\",\n \"bank_account_name\": \"InnovateTech Solutions Private Limited\",\n \"bank_swift_code\": \"CHASINUS33XXX\",\n \"bank_name\": \"JPMorgan Chase Bank\",\n \"bank_branch_name\": \"Financial District Branch\",\n \"bank_address\": \"270 Park Avenue, New York\",\n \"bank_city\": \"New York\",\n \"bank_state\": \"NY\",\n \"bank_country\": \"United States\",\n \"bank_pincode\": \"10017\",\n \"routing_number\": \"021000021\"\n },\n \"company_details\": {\n \"legal_name\": \"InnovateTech Solutions Private Limited\",\n \"brand_name\": \"InnovateTech\",\n \"registration_number\": \"US-CORP-2024-IT789456\",\n \"international_org_type\": \"Private Limited Company\",\n \"tax_id\": \"94-8765432\",\n \"website\": \"https://www.innovatetech.com\",\n \"monthly_avg_transaction_volume\": \"BETWEEN_20_K_AND_50_K\",\n \"communication_address\": \"Suite 1200, 101 California Street\",\n \"communication_city\": \"San Francisco\",\n \"communication_state\": \"CA\",\n \"communication_country\": \"United States\",\n \"communication_pincode\": \"94111\",\n \"same_as_registered_address\": false,\n \"registered_address\": \"1455 Market Street, Suite 1600\",\n \"registered_city\": \"San Francisco\",\n \"registered_state\": \"CA\",\n \"registered_country\": \"United States\",\n \"registered_pincode\": \"94103\",\n \"business_category\": \"E-commerce (physical goods & cross-border shipping)\",\n \"business_mode\": \"b2b\",\n \"hs_codes\": [\n \"85234910\",\n \"84715000\"\n ],\n \"description_of_products_and_services\": \"InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.\",\n \"agreement_details\": \"Master Service Agreement for Cloud Solutions dated 2024-03-15\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"+919876543210\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-pacb-uat.eximpe.com/partners/merchants/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["X-API-Version"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settlement_details\": {\n \"bank_account_number\": \"6789123450987654\",\n \"bank_account_name\": \"InnovateTech Solutions Private Limited\",\n \"bank_swift_code\": \"CHASINUS33XXX\",\n \"bank_name\": \"JPMorgan Chase Bank\",\n \"bank_branch_name\": \"Financial District Branch\",\n \"bank_address\": \"270 Park Avenue, New York\",\n \"bank_city\": \"New York\",\n \"bank_state\": \"NY\",\n \"bank_country\": \"United States\",\n \"bank_pincode\": \"10017\",\n \"routing_number\": \"021000021\"\n },\n \"company_details\": {\n \"legal_name\": \"InnovateTech Solutions Private Limited\",\n \"brand_name\": \"InnovateTech\",\n \"registration_number\": \"US-CORP-2024-IT789456\",\n \"international_org_type\": \"Private Limited Company\",\n \"tax_id\": \"94-8765432\",\n \"website\": \"https://www.innovatetech.com\",\n \"monthly_avg_transaction_volume\": \"BETWEEN_20_K_AND_50_K\",\n \"communication_address\": \"Suite 1200, 101 California Street\",\n \"communication_city\": \"San Francisco\",\n \"communication_state\": \"CA\",\n \"communication_country\": \"United States\",\n \"communication_pincode\": \"94111\",\n \"same_as_registered_address\": false,\n \"registered_address\": \"1455 Market Street, Suite 1600\",\n \"registered_city\": \"San Francisco\",\n \"registered_state\": \"CA\",\n \"registered_country\": \"United States\",\n \"registered_pincode\": \"94103\",\n \"business_category\": \"E-commerce (physical goods & cross-border shipping)\",\n \"business_mode\": \"b2b\",\n \"hs_codes\": [\n \"85234910\",\n \"84715000\"\n ],\n \"description_of_products_and_services\": \"InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.\",\n \"agreement_details\": \"Master Service Agreement for Cloud Solutions dated 2024-03-15\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"+919876543210\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Sub-merchant created successfully",
"data": {
"id": "6182929449",
"settlement_details": {
"bank_account_number": "9876543210",
"bank_account_name": "GlobalTech Solutions Inc.",
"bank_swift_code": "CHASUS33XXX",
"bank_name": "JPMorgan Chase Bank",
"bank_branch_name": "Corporate Banking Division",
"bank_address": "270 Park Avenue",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10017",
"routing_number": "021000021",
"settlement_currency": "USD"
},
"created_at": "2025-01-15T10:30:00.000000Z",
"company_details": {
"legal_name": "GlobalTech Solutions Inc.",
"brand_name": "GlobalTech",
"registration_number": "US-CORP-99887766",
"international_org_type": "Private Limited Company",
"tax_id": "94-1234567",
"website": "https://www.globaltech.io",
"monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
"communication_address": "500 Mission Street, Suite 2400",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94105",
"same_as_registered_address": false,
"registered_address": "1600 Amphitheatre Parkway",
"registered_city": "Mountain View",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94043",
"business_category": "E-commerce (physical goods & cross-border shipping)",
"business_mode": "b2b",
"hs_codes": [
"85234910",
"84715000"
],
"description_of_products_and_services": "GlobalTech provides cloud-native enterprise software, including AI-powered analytics platforms, CRM solutions, and infrastructure automation tools. We enable digital transformation for Fortune 500 companies through scalable and secure software systems.",
"agreement_details": "Master Service Agreement dated 2024-01-10 with Global Clients",
"email": "[email protected]",
"phone_number": "+919876543210",
"business_category_other": null
},
"last_updated_at": "2025-01-15T10:30:00.000000Z",
"kyc_status": "PENDING"
}
}{
"success": false,
"error": {
"code": 40000,
"message": "Invalid request",
"details": {
"settlement_details": {
"bank_account_number": "This field is required."
}
}
}
}{
"success": false,
"error": {
"code": "ERR_AUTH_003",
"message": "This endpoint is only accessible to PSP merchants",
"details": {
"authentication": "This endpoint is only accessible to PSP merchants."
}
}
}Merchant
Create Merchant
Create a new merchant with settlement and company details.
POST
/
partners
/
merchants
/
Create Merchant
curl --request POST \
--url https://api-pacb-uat.eximpe.com/partners/merchants/ \
--header 'Content-Type: application/json' \
--header 'X-API-Version: <api-key>' \
--header 'X-Client-ID: <api-key>' \
--header 'X-Client-Secret: <api-key>' \
--data '
{
"settlement_details": {
"bank_account_number": "6789123450987654",
"bank_account_name": "InnovateTech Solutions Private Limited",
"bank_swift_code": "CHASINUS33XXX",
"bank_name": "JPMorgan Chase Bank",
"bank_branch_name": "Financial District Branch",
"bank_address": "270 Park Avenue, New York",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10017",
"routing_number": "021000021"
},
"company_details": {
"legal_name": "InnovateTech Solutions Private Limited",
"brand_name": "InnovateTech",
"registration_number": "US-CORP-2024-IT789456",
"international_org_type": "Private Limited Company",
"tax_id": "94-8765432",
"website": "https://www.innovatetech.com",
"monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
"communication_address": "Suite 1200, 101 California Street",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94111",
"same_as_registered_address": false,
"registered_address": "1455 Market Street, Suite 1600",
"registered_city": "San Francisco",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94103",
"business_category": "E-commerce (physical goods & cross-border shipping)",
"business_mode": "b2b",
"hs_codes": [
"85234910",
"84715000"
],
"description_of_products_and_services": "InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.",
"agreement_details": "Master Service Agreement for Cloud Solutions dated 2024-03-15",
"email": "[email protected]",
"phone_number": "+919876543210"
}
}
'import requests
url = "https://api-pacb-uat.eximpe.com/partners/merchants/"
payload = {
"settlement_details": {
"bank_account_number": "6789123450987654",
"bank_account_name": "InnovateTech Solutions Private Limited",
"bank_swift_code": "CHASINUS33XXX",
"bank_name": "JPMorgan Chase Bank",
"bank_branch_name": "Financial District Branch",
"bank_address": "270 Park Avenue, New York",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10017",
"routing_number": "021000021"
},
"company_details": {
"legal_name": "InnovateTech Solutions Private Limited",
"brand_name": "InnovateTech",
"registration_number": "US-CORP-2024-IT789456",
"international_org_type": "Private Limited Company",
"tax_id": "94-8765432",
"website": "https://www.innovatetech.com",
"monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
"communication_address": "Suite 1200, 101 California Street",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94111",
"same_as_registered_address": False,
"registered_address": "1455 Market Street, Suite 1600",
"registered_city": "San Francisco",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94103",
"business_category": "E-commerce (physical goods & cross-border shipping)",
"business_mode": "b2b",
"hs_codes": ["85234910", "84715000"],
"description_of_products_and_services": "InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.",
"agreement_details": "Master Service Agreement for Cloud Solutions dated 2024-03-15",
"email": "[email protected]",
"phone_number": "+919876543210"
}
}
headers = {
"X-Client-ID": "<api-key>",
"X-Client-Secret": "<api-key>",
"X-API-Version": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Client-ID': '<api-key>',
'X-Client-Secret': '<api-key>',
'X-API-Version': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
settlement_details: {
bank_account_number: '6789123450987654',
bank_account_name: 'InnovateTech Solutions Private Limited',
bank_swift_code: 'CHASINUS33XXX',
bank_name: 'JPMorgan Chase Bank',
bank_branch_name: 'Financial District Branch',
bank_address: '270 Park Avenue, New York',
bank_city: 'New York',
bank_state: 'NY',
bank_country: 'United States',
bank_pincode: '10017',
routing_number: '021000021'
},
company_details: {
legal_name: 'InnovateTech Solutions Private Limited',
brand_name: 'InnovateTech',
registration_number: 'US-CORP-2024-IT789456',
international_org_type: 'Private Limited Company',
tax_id: '94-8765432',
website: 'https://www.innovatetech.com',
monthly_avg_transaction_volume: 'BETWEEN_20_K_AND_50_K',
communication_address: 'Suite 1200, 101 California Street',
communication_city: 'San Francisco',
communication_state: 'CA',
communication_country: 'United States',
communication_pincode: '94111',
same_as_registered_address: false,
registered_address: '1455 Market Street, Suite 1600',
registered_city: 'San Francisco',
registered_state: 'CA',
registered_country: 'United States',
registered_pincode: '94103',
business_category: 'E-commerce (physical goods & cross-border shipping)',
business_mode: 'b2b',
hs_codes: ['85234910', '84715000'],
description_of_products_and_services: 'InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.',
agreement_details: 'Master Service Agreement for Cloud Solutions dated 2024-03-15',
email: '[email protected]',
phone_number: '+919876543210'
}
})
};
fetch('https://api-pacb-uat.eximpe.com/partners/merchants/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-pacb-uat.eximpe.com/partners/merchants/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'settlement_details' => [
'bank_account_number' => '6789123450987654',
'bank_account_name' => 'InnovateTech Solutions Private Limited',
'bank_swift_code' => 'CHASINUS33XXX',
'bank_name' => 'JPMorgan Chase Bank',
'bank_branch_name' => 'Financial District Branch',
'bank_address' => '270 Park Avenue, New York',
'bank_city' => 'New York',
'bank_state' => 'NY',
'bank_country' => 'United States',
'bank_pincode' => '10017',
'routing_number' => '021000021'
],
'company_details' => [
'legal_name' => 'InnovateTech Solutions Private Limited',
'brand_name' => 'InnovateTech',
'registration_number' => 'US-CORP-2024-IT789456',
'international_org_type' => 'Private Limited Company',
'tax_id' => '94-8765432',
'website' => 'https://www.innovatetech.com',
'monthly_avg_transaction_volume' => 'BETWEEN_20_K_AND_50_K',
'communication_address' => 'Suite 1200, 101 California Street',
'communication_city' => 'San Francisco',
'communication_state' => 'CA',
'communication_country' => 'United States',
'communication_pincode' => '94111',
'same_as_registered_address' => false,
'registered_address' => '1455 Market Street, Suite 1600',
'registered_city' => 'San Francisco',
'registered_state' => 'CA',
'registered_country' => 'United States',
'registered_pincode' => '94103',
'business_category' => 'E-commerce (physical goods & cross-border shipping)',
'business_mode' => 'b2b',
'hs_codes' => [
'85234910',
'84715000'
],
'description_of_products_and_services' => 'InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.',
'agreement_details' => 'Master Service Agreement for Cloud Solutions dated 2024-03-15',
'email' => '[email protected]',
'phone_number' => '+919876543210'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Version: <api-key>",
"X-Client-ID: <api-key>",
"X-Client-Secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-pacb-uat.eximpe.com/partners/merchants/"
payload := strings.NewReader("{\n \"settlement_details\": {\n \"bank_account_number\": \"6789123450987654\",\n \"bank_account_name\": \"InnovateTech Solutions Private Limited\",\n \"bank_swift_code\": \"CHASINUS33XXX\",\n \"bank_name\": \"JPMorgan Chase Bank\",\n \"bank_branch_name\": \"Financial District Branch\",\n \"bank_address\": \"270 Park Avenue, New York\",\n \"bank_city\": \"New York\",\n \"bank_state\": \"NY\",\n \"bank_country\": \"United States\",\n \"bank_pincode\": \"10017\",\n \"routing_number\": \"021000021\"\n },\n \"company_details\": {\n \"legal_name\": \"InnovateTech Solutions Private Limited\",\n \"brand_name\": \"InnovateTech\",\n \"registration_number\": \"US-CORP-2024-IT789456\",\n \"international_org_type\": \"Private Limited Company\",\n \"tax_id\": \"94-8765432\",\n \"website\": \"https://www.innovatetech.com\",\n \"monthly_avg_transaction_volume\": \"BETWEEN_20_K_AND_50_K\",\n \"communication_address\": \"Suite 1200, 101 California Street\",\n \"communication_city\": \"San Francisco\",\n \"communication_state\": \"CA\",\n \"communication_country\": \"United States\",\n \"communication_pincode\": \"94111\",\n \"same_as_registered_address\": false,\n \"registered_address\": \"1455 Market Street, Suite 1600\",\n \"registered_city\": \"San Francisco\",\n \"registered_state\": \"CA\",\n \"registered_country\": \"United States\",\n \"registered_pincode\": \"94103\",\n \"business_category\": \"E-commerce (physical goods & cross-border shipping)\",\n \"business_mode\": \"b2b\",\n \"hs_codes\": [\n \"85234910\",\n \"84715000\"\n ],\n \"description_of_products_and_services\": \"InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.\",\n \"agreement_details\": \"Master Service Agreement for Cloud Solutions dated 2024-03-15\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"+919876543210\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Client-ID", "<api-key>")
req.Header.Add("X-Client-Secret", "<api-key>")
req.Header.Add("X-API-Version", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-pacb-uat.eximpe.com/partners/merchants/")
.header("X-Client-ID", "<api-key>")
.header("X-Client-Secret", "<api-key>")
.header("X-API-Version", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"settlement_details\": {\n \"bank_account_number\": \"6789123450987654\",\n \"bank_account_name\": \"InnovateTech Solutions Private Limited\",\n \"bank_swift_code\": \"CHASINUS33XXX\",\n \"bank_name\": \"JPMorgan Chase Bank\",\n \"bank_branch_name\": \"Financial District Branch\",\n \"bank_address\": \"270 Park Avenue, New York\",\n \"bank_city\": \"New York\",\n \"bank_state\": \"NY\",\n \"bank_country\": \"United States\",\n \"bank_pincode\": \"10017\",\n \"routing_number\": \"021000021\"\n },\n \"company_details\": {\n \"legal_name\": \"InnovateTech Solutions Private Limited\",\n \"brand_name\": \"InnovateTech\",\n \"registration_number\": \"US-CORP-2024-IT789456\",\n \"international_org_type\": \"Private Limited Company\",\n \"tax_id\": \"94-8765432\",\n \"website\": \"https://www.innovatetech.com\",\n \"monthly_avg_transaction_volume\": \"BETWEEN_20_K_AND_50_K\",\n \"communication_address\": \"Suite 1200, 101 California Street\",\n \"communication_city\": \"San Francisco\",\n \"communication_state\": \"CA\",\n \"communication_country\": \"United States\",\n \"communication_pincode\": \"94111\",\n \"same_as_registered_address\": false,\n \"registered_address\": \"1455 Market Street, Suite 1600\",\n \"registered_city\": \"San Francisco\",\n \"registered_state\": \"CA\",\n \"registered_country\": \"United States\",\n \"registered_pincode\": \"94103\",\n \"business_category\": \"E-commerce (physical goods & cross-border shipping)\",\n \"business_mode\": \"b2b\",\n \"hs_codes\": [\n \"85234910\",\n \"84715000\"\n ],\n \"description_of_products_and_services\": \"InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.\",\n \"agreement_details\": \"Master Service Agreement for Cloud Solutions dated 2024-03-15\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"+919876543210\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-pacb-uat.eximpe.com/partners/merchants/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["X-API-Version"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settlement_details\": {\n \"bank_account_number\": \"6789123450987654\",\n \"bank_account_name\": \"InnovateTech Solutions Private Limited\",\n \"bank_swift_code\": \"CHASINUS33XXX\",\n \"bank_name\": \"JPMorgan Chase Bank\",\n \"bank_branch_name\": \"Financial District Branch\",\n \"bank_address\": \"270 Park Avenue, New York\",\n \"bank_city\": \"New York\",\n \"bank_state\": \"NY\",\n \"bank_country\": \"United States\",\n \"bank_pincode\": \"10017\",\n \"routing_number\": \"021000021\"\n },\n \"company_details\": {\n \"legal_name\": \"InnovateTech Solutions Private Limited\",\n \"brand_name\": \"InnovateTech\",\n \"registration_number\": \"US-CORP-2024-IT789456\",\n \"international_org_type\": \"Private Limited Company\",\n \"tax_id\": \"94-8765432\",\n \"website\": \"https://www.innovatetech.com\",\n \"monthly_avg_transaction_volume\": \"BETWEEN_20_K_AND_50_K\",\n \"communication_address\": \"Suite 1200, 101 California Street\",\n \"communication_city\": \"San Francisco\",\n \"communication_state\": \"CA\",\n \"communication_country\": \"United States\",\n \"communication_pincode\": \"94111\",\n \"same_as_registered_address\": false,\n \"registered_address\": \"1455 Market Street, Suite 1600\",\n \"registered_city\": \"San Francisco\",\n \"registered_state\": \"CA\",\n \"registered_country\": \"United States\",\n \"registered_pincode\": \"94103\",\n \"business_category\": \"E-commerce (physical goods & cross-border shipping)\",\n \"business_mode\": \"b2b\",\n \"hs_codes\": [\n \"85234910\",\n \"84715000\"\n ],\n \"description_of_products_and_services\": \"InnovateTech provides cutting-edge cloud computing solutions, artificial intelligence platforms, and enterprise software systems. We specialize in machine learning algorithms, data analytics, and scalable cloud infrastructure for Fortune 500 companies.\",\n \"agreement_details\": \"Master Service Agreement for Cloud Solutions dated 2024-03-15\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"+919876543210\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Sub-merchant created successfully",
"data": {
"id": "6182929449",
"settlement_details": {
"bank_account_number": "9876543210",
"bank_account_name": "GlobalTech Solutions Inc.",
"bank_swift_code": "CHASUS33XXX",
"bank_name": "JPMorgan Chase Bank",
"bank_branch_name": "Corporate Banking Division",
"bank_address": "270 Park Avenue",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10017",
"routing_number": "021000021",
"settlement_currency": "USD"
},
"created_at": "2025-01-15T10:30:00.000000Z",
"company_details": {
"legal_name": "GlobalTech Solutions Inc.",
"brand_name": "GlobalTech",
"registration_number": "US-CORP-99887766",
"international_org_type": "Private Limited Company",
"tax_id": "94-1234567",
"website": "https://www.globaltech.io",
"monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
"communication_address": "500 Mission Street, Suite 2400",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94105",
"same_as_registered_address": false,
"registered_address": "1600 Amphitheatre Parkway",
"registered_city": "Mountain View",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94043",
"business_category": "E-commerce (physical goods & cross-border shipping)",
"business_mode": "b2b",
"hs_codes": [
"85234910",
"84715000"
],
"description_of_products_and_services": "GlobalTech provides cloud-native enterprise software, including AI-powered analytics platforms, CRM solutions, and infrastructure automation tools. We enable digital transformation for Fortune 500 companies through scalable and secure software systems.",
"agreement_details": "Master Service Agreement dated 2024-01-10 with Global Clients",
"email": "[email protected]",
"phone_number": "+919876543210",
"business_category_other": null
},
"last_updated_at": "2025-01-15T10:30:00.000000Z",
"kyc_status": "PENDING"
}
}{
"success": false,
"error": {
"code": 40000,
"message": "Invalid request",
"details": {
"settlement_details": {
"bank_account_number": "This field is required."
}
}
}
}{
"success": false,
"error": {
"code": "ERR_AUTH_003",
"message": "This endpoint is only accessible to PSP merchants",
"details": {
"authentication": "This endpoint is only accessible to PSP merchants."
}
}
}Overview
The Create Merchant endpoint allows Payment Aggregators (PSPs) to programmatically onboard sub-merchants. It creates a new merchant account with company details, settlement bank information, and contact details. After creation, the sub-merchant status depends on the environment:- Production: Status is set to
PENDING(requires approval) - Non-production: Status is set to
APPROVED(auto-approved for testing)
Request Parameters
Required Parameters
company_details: Company registration, business information, and contact detailssettlement_details: Bank account details for settlements
Parameter Definitions
Top-level
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
| company_details | object | Yes | Company, business, and contact details. | See Company Details |
| settlement_details | object | Yes | Bank account details for settlements. | See Settlement Details |
Company Details
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
| string | Yes | Contact email for the sub-merchant. | RFC 5322 email format | |
| phone_number | string | Yes | Contact phone number with country code. | E.164 format (e.g., +919876543210) |
| legal_name | string | Yes | Legal name of the company. | Max 255 chars |
| brand_name | string | Yes | Brand/trade name. | Max 255 chars |
| registration_number | string | Yes | Company registration number. | Alphanumeric with dashes |
| international_org_type | string | Yes | Type of organization. | Enum: Private Limited Company, Public Limited Company, Limited Liability Company, Joint Stock Company, Free Zone Company / Entity, Partnership / LLP, Sole Proprietorship, Other |
| tax_id | string | Yes | Tax identification number. | Alphanumeric with dashes |
| website | string | Yes | Company website URL. | Must include https:// prefix |
| monthly_avg_transaction_volume | string | Yes | Expected monthly transaction volume. | Enum: LESS_THAN_5_K, BETWEEN_5_K_AND_20_K, BETWEEN_20_K_AND_50_K, BETWEEN_50_K_AND_100_K, BETWEEN_100_K_AND_250_K, BETWEEN_250_K_AND_500_K, ABOVE_500_K |
| business_category | string | Yes | Business category (comma-separated for multiple). | Enum: E-commerce (physical goods & cross-border shipping), Digital goods / software / downloads, SaaS / subscriptions / recurring billing, Services (delivered cross-border), Marketplace / platform (multiple sellers), Other |
| business_category_other | string | Conditionally | Description when category includes “Other”. | Required if business_category includes Other |
| business_mode | string | Yes | Mode of business. | Enum: b2b, b2c, marketplace |
| description_of_products_and_services | string | Yes | Detailed description of products/services. | Max 1024 chars |
| mcc | string | No | Merchant Category Codes. | Comma-separated 4-digit codes (e.g., 5411,5812) |
| hs_codes | array | No | HS codes for goods traded. | Array of HS code strings |
| agreement_details | string | No | Agreement details with the merchant. | Max 1024 chars |
| registered_address | string | Yes | Registered office address. | Max 255 chars |
| registered_city | string | Yes | Registered office city. | Max 255 chars |
| registered_state | string | Yes | Registered office state/province. | Max 255 chars |
| registered_country | string | Yes | Registered office country. | Full country name (e.g., India, United States) |
| registered_pincode | string | Yes | Registered office postal code. | Max 20 chars |
| same_as_registered_address | boolean | Yes | Whether communication address matches registered. | true or false |
| communication_address | string | Conditionally | Communication address. | Required if same_as_registered_address is false |
| communication_city | string | Conditionally | Communication city. | Required if same_as_registered_address is false |
| communication_state | string | Conditionally | Communication state. | Required if same_as_registered_address is false |
| communication_country | string | Conditionally | Communication country. | Required if same_as_registered_address is false |
| communication_pincode | string | Conditionally | Communication postal code. | Required if same_as_registered_address is false |
- When
same_as_registered_addressistrue, communication address fields are auto-populated from registered address. - Multiple business categories can be comma-separated (e.g.,
"E-commerce (physical goods & cross-border shipping),SaaS / subscriptions / recurring billing").
Settlement Details
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
| bank_account_number | string | Yes | Bank account number. | Alphanumeric |
| bank_account_name | string | Yes | Name on the bank account. | Max 255 chars |
| bank_swift_code | string | Yes | SWIFT/BIC code. | Standard SWIFT format |
| bank_name | string | Yes | Name of the bank. | Max 255 chars |
| bank_branch_name | string | Yes | Branch name. | Max 255 chars |
| bank_address | string | Yes | Bank branch address. | Max 255 chars |
| bank_city | string | Yes | Bank city. | Max 255 chars |
| bank_state | string | Yes | Bank state/province. | Max 255 chars |
| bank_country | string | Yes | Bank country. | Full country name (e.g., India, United States) |
| bank_pincode | string | Yes | Bank postal code. | Max 20 chars |
| routing_number | string | Yes | Routing/IFSC number. | Alphanumeric |
Examples
{
"company_details": {
"email": "[email protected]",
"phone_number": "+919876543210",
"legal_name": "Acme Technologies Pvt Ltd",
"brand_name": "AcmeTech",
"registration_number": "U72200MH2020PTC123456",
"international_org_type": "Private Limited Company",
"tax_id": "AACCA1234A",
"website": "https://acmetech.com",
"monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
"business_category": "Digital goods / software / downloads",
"business_mode": "b2b",
"description_of_products_and_services": "Cloud-based enterprise resource planning software for mid-market companies",
"mcc": "5734",
"registered_address": "Tower A, Techpark, Whitefield",
"registered_city": "Bangalore",
"registered_state": "Karnataka",
"registered_country": "India",
"registered_pincode": "560066",
"same_as_registered_address": true,
"communication_address": "Tower A, Techpark, Whitefield",
"communication_city": "Bangalore",
"communication_state": "Karnataka",
"communication_country": "India",
"communication_pincode": "560066"
},
"settlement_details": {
"bank_account_number": "1234567890123456",
"bank_account_name": "Acme Technologies Pvt Ltd",
"bank_swift_code": "HDFCINBB",
"bank_name": "HDFC Bank",
"bank_branch_name": "Whitefield Branch",
"bank_address": "100 Feet Road, Whitefield",
"bank_city": "Bangalore",
"bank_state": "Karnataka",
"bank_country": "India",
"bank_pincode": "560066",
"routing_number": "HDFC0001234"
}
}
{
"company_details": {
"email": "[email protected]",
"phone_number": "+14155551234",
"legal_name": "GlobalShop Inc",
"brand_name": "GlobalShop",
"registration_number": "US-CORP-2024-GS789456",
"international_org_type": "Limited Liability Company",
"tax_id": "94-8765432",
"website": "https://globalshop.com",
"monthly_avg_transaction_volume": "BETWEEN_100_K_AND_250_K",
"business_category": "E-commerce (physical goods & cross-border shipping),SaaS / subscriptions / recurring billing",
"business_mode": "b2c",
"description_of_products_and_services": "Multi-category e-commerce platform selling electronics, apparel, and home goods with subscription box services",
"mcc": "5411,5812",
"hs_codes": ["85234910", "84715000"],
"agreement_details": "Master Service Agreement dated 2024-03-15",
"registered_address": "Suite 1200, 101 California Street",
"registered_city": "San Francisco",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94111",
"same_as_registered_address": false,
"communication_address": "1455 Market Street, Suite 1600",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94103"
},
"settlement_details": {
"bank_account_number": "6789123450987654",
"bank_account_name": "GlobalShop Inc",
"bank_swift_code": "CHASINUS33XXX",
"bank_name": "JPMorgan Chase Bank",
"bank_branch_name": "Financial District Branch",
"bank_address": "270 Park Avenue, New York",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10017",
"routing_number": "021000021"
}
}
{
"company_details": {
"email": "[email protected]",
"phone_number": "+971501234567",
"legal_name": "Innovate FZE",
"brand_name": "Innovate",
"registration_number": "FZ-2024-INV-001",
"international_org_type": "Free Zone Company / Entity",
"tax_id": "TRN100123456",
"website": "https://innovate.io",
"monthly_avg_transaction_volume": "BETWEEN_50_K_AND_100_K",
"business_category": "Other",
"business_category_other": "AI-powered supply chain optimization and logistics analytics platform",
"business_mode": "b2b",
"description_of_products_and_services": "AI-driven logistics optimization platform that helps enterprises reduce shipping costs and delivery times",
"mcc": "7372",
"registered_address": "Office 1205, Business Bay Tower",
"registered_city": "Dubai",
"registered_state": "Dubai",
"registered_country": "United Arab Emirates",
"registered_pincode": "00000",
"same_as_registered_address": true,
"communication_address": "Office 1205, Business Bay Tower",
"communication_city": "Dubai",
"communication_state": "Dubai",
"communication_country": "United Arab Emirates",
"communication_pincode": "00000"
},
"settlement_details": {
"bank_account_number": "AE070331234567890123456",
"bank_account_name": "Innovate FZE",
"bank_swift_code": "ABORAEADXXX",
"bank_name": "Arab Bank",
"bank_branch_name": "Dubai Main Branch",
"bank_address": "Sheikh Zayed Road, Dubai",
"bank_city": "Dubai",
"bank_state": "Dubai",
"bank_country": "United Arab Emirates",
"bank_pincode": "00000",
"routing_number": "ABOR0000001"
}
}
Response Examples
{
"success": true,
"message": "Sub-merchant created successfully",
"data": {
"id": "6182929449",
"company_details": {
"legal_name": "Acme Technologies Pvt Ltd",
"brand_name": "AcmeTech",
"email": "[email protected]",
"phone_number": "+919876543210",
"registration_number": "U72200MH2020PTC123456",
"international_org_type": "Private Limited Company",
"tax_id": "AACCA1234A",
"website": "https://acmetech.com",
"monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_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",
"business_category_other": null,
"business_mode": "b2b",
"hs_codes": [],
"description_of_products_and_services": "Cloud-based enterprise resource planning software for mid-market companies",
"agreement_details": null
},
"settlement_details": {
"bank_account_number": "1234567890123456",
"bank_account_name": "Acme Technologies Pvt Ltd",
"bank_swift_code": "HDFCINBB",
"bank_name": "HDFC Bank",
"bank_branch_name": "Whitefield Branch",
"bank_address": "100 Feet Road, Whitefield",
"bank_city": "Bangalore",
"bank_state": "Karnataka",
"bank_country": "India",
"bank_pincode": "560066",
"routing_number": "HDFC0001234",
"settlement_currency": "USD"
},
"kyc_status": "PENDING",
"created_at": "2026-04-28T06:30:00.000000Z",
"last_updated_at": "2026-04-28T06:30:00.000000Z"
}
}
{
"success": false,
"error": {
"code": "ERR_MERCHANT_001",
"message": "Validation error",
"details": {
"company_details": {
"monthly_avg_transaction_volume": "\"500\" is not a valid choice.",
"business_mode": "\"invalid\" is not a valid choice.",
"registered_country": "Invalid country name"
}
}
}
}
Error Codes
| Code | Message | Description |
|---|---|---|
| ERR_MERCHANT_001 | Validation error | Request validation failed — check details for field-level errors |
Implementation Notes
Merchant Status Flow
- PENDING → Created, awaiting approval
- IN_REVIEW → Under compliance review
- APPROVED → Active, can process payments
- CHANGES_REQUESTED → Additional information required
- REJECTED → Application rejected
Country Names
Country fields (registered_country, communication_country, bank_country) must use the full country name (e.g., "India", "United States", "United Arab Emirates").
Phone Number Format
Phone numbers must include the country code in E.164 format (e.g.,+919876543210, +14155551234).
Business Category
Multiple categories can be comma-separated. When"Other" is included, business_category_other must provide a description.Authorizations
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.
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.
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.
Body
application/json
Merchant details to create
⌘I