curl --request POST \
--url https://api-staging.eximpe.com/partners/merchants/ \
--header 'Content-Type: application/json' \
--header 'X-Client-ID: <api-key>' \
--header 'X-Client-Secret: <api-key>' \
--data '
{
"settlement_details": {
"bank_account_number": "1234567890",
"bank_account_name": "Example Company Ltd",
"bank_swift_code": "ABCDUS33",
"bank_name": "Example Bank",
"bank_branch_name": "Main Branch",
"bank_address": "456 Bank St",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10002",
"routing_number": "021000021"
},
"company_details": {
"legal_name": "shrine",
"brand_name": "TechSubshrine",
"registration_number": "REG123456",
"international_org_type": "PRIVATE_LIMITED",
"tax_id": "TAX789012",
"website": "https://techsub.example.com",
"monthly_avg_transaction_value": "50000.00",
"monthly_avg_transaction_volume": "100",
"communication_address": "123 Tech Street",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94105",
"same_as_registered_address": true,
"registered_address": "123 Tech Street",
"registered_city": "San Francisco",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94105",
"business_category": "TECHNOLOGY",
"business_mode": "B2B",
"commodity": "Software Services",
"payment_terms": "NET_30",
"hs_codes": [
"84713010",
"85423100"
],
"category": "E-commerce",
"description_of_products_and_services": "We provide comprehensive IT solutions including software development, cloud migration, data analytics, and digital transformation services for enterprises. Our solutions help businesses streamline operations, improve efficiency, and accelerate digital adoption.",
"agreement_details": "global_company aggrement",
"purpose_code": "P0101"
}
}
'{
"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",
"updated_at": "2025-01-15T10:30:00.000000Z",
"invoice_file": null,
"company_details": {
"legal_name": "GlobalTech Solutions Inc.",
"brand_name": "GlobalTech",
"registration_number": "US-CORP-99887766",
"international_org_type": "PRIVATE_LIMITED",
"tax_id": "94-1234567",
"website": "https://www.globaltech.io",
"monthly_avg_transaction_value": "150000.00",
"monthly_avg_transaction_volume": "300",
"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": "TECHNOLOGY",
"business_mode": "B2B",
"commodity": "Enterprise Software Solutions",
"payment_terms": "NET_30",
"hs_codes": [
"85234910",
"84715000"
],
"category": "Enterprise SaaS",
"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",
"purpose_code": "P0101"
}
}
}Create a new merchant with settlement and company details.
curl --request POST \
--url https://api-staging.eximpe.com/partners/merchants/ \
--header 'Content-Type: application/json' \
--header 'X-Client-ID: <api-key>' \
--header 'X-Client-Secret: <api-key>' \
--data '
{
"settlement_details": {
"bank_account_number": "1234567890",
"bank_account_name": "Example Company Ltd",
"bank_swift_code": "ABCDUS33",
"bank_name": "Example Bank",
"bank_branch_name": "Main Branch",
"bank_address": "456 Bank St",
"bank_city": "New York",
"bank_state": "NY",
"bank_country": "United States",
"bank_pincode": "10002",
"routing_number": "021000021"
},
"company_details": {
"legal_name": "shrine",
"brand_name": "TechSubshrine",
"registration_number": "REG123456",
"international_org_type": "PRIVATE_LIMITED",
"tax_id": "TAX789012",
"website": "https://techsub.example.com",
"monthly_avg_transaction_value": "50000.00",
"monthly_avg_transaction_volume": "100",
"communication_address": "123 Tech Street",
"communication_city": "San Francisco",
"communication_state": "CA",
"communication_country": "United States",
"communication_pincode": "94105",
"same_as_registered_address": true,
"registered_address": "123 Tech Street",
"registered_city": "San Francisco",
"registered_state": "CA",
"registered_country": "United States",
"registered_pincode": "94105",
"business_category": "TECHNOLOGY",
"business_mode": "B2B",
"commodity": "Software Services",
"payment_terms": "NET_30",
"hs_codes": [
"84713010",
"85423100"
],
"category": "E-commerce",
"description_of_products_and_services": "We provide comprehensive IT solutions including software development, cloud migration, data analytics, and digital transformation services for enterprises. Our solutions help businesses streamline operations, improve efficiency, and accelerate digital adoption.",
"agreement_details": "global_company aggrement",
"purpose_code": "P0101"
}
}
'{
"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",
"updated_at": "2025-01-15T10:30:00.000000Z",
"invoice_file": null,
"company_details": {
"legal_name": "GlobalTech Solutions Inc.",
"brand_name": "GlobalTech",
"registration_number": "US-CORP-99887766",
"international_org_type": "PRIVATE_LIMITED",
"tax_id": "94-1234567",
"website": "https://www.globaltech.io",
"monthly_avg_transaction_value": "150000.00",
"monthly_avg_transaction_volume": "300",
"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": "TECHNOLOGY",
"business_mode": "B2B",
"commodity": "Enterprise Software Solutions",
"payment_terms": "NET_30",
"hs_codes": [
"85234910",
"84715000"
],
"category": "Enterprise SaaS",
"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",
"purpose_code": "P0101"
}
}
}Client app ID. You can find your app id in the merchant dashboard.
Client secret key. You can find your secret in the merchant dashboard.
Merchant details to create
Show child attributes
Bank account number
Name on the bank account
Bank SWIFT/BIC code
Name of the bank
Bank branch name
Bank address
Bank city
Bank state
Bank country
Bank pincode/postal code
Bank routing number
Show child attributes
Legal name of the company
Brand/trading name of the company
Company registration number
Type of international organization
PRIVATE_LIMITED, PUBLIC_LIMITED, PARTNERSHIP, SOLE_PROPRIETORSHIP, LLC, CORPORATION Tax identification number
Company website URL
Average monthly transaction value
Average monthly transaction volume
Communication address
Communication city
Communication state
Communication country
Communication pincode/postal code
Whether communication address is same as registered address
Registered address
Registered city
Registered state
Registered country
Registered pincode/postal code
Business category
TECHNOLOGY, HEALTHCARE, FINANCE, RETAIL, MANUFACTURING, EDUCATION, ENTERTAINMENT, OTHER Business mode
B2B, B2C, B2B2C Primary commodity or service
Payment terms
NET_30, NET_60, NET_90, IMMEDIATE Harmonized System codes for products/services
Business category description
Detailed description of products and services
Agreement details
Purpose code for international transactions
Merchant created successfully.
Indicates if the request was successful
Response message
Show child attributes
Unique merchant identifier
Show child attributes
Bank account number
Name on the bank account
Bank SWIFT/BIC code
Name of the bank
Bank branch name
Bank address
Bank city
Bank state
Bank country
Bank pincode/postal code
Bank routing number
Merchant creation timestamp
Merchant update timestamp
Invoice file URL
Show child attributes
Legal name of the company
Brand/trading name of the company
Company registration number
Type of international organization
PRIVATE_LIMITED, PUBLIC_LIMITED, PARTNERSHIP, SOLE_PROPRIETORSHIP, LLC, CORPORATION Tax identification number
Company website URL
Average monthly transaction value
Average monthly transaction volume
Communication address
Communication city
Communication state
Communication country
Communication pincode/postal code
Whether communication address is same as registered address
Registered address
Registered city
Registered state
Registered country
Registered pincode/postal code
Business category
TECHNOLOGY, HEALTHCARE, FINANCE, RETAIL, MANUFACTURING, EDUCATION, ENTERTAINMENT, OTHER Business mode
B2B, B2C, B2B2C Primary commodity or service
Payment terms
NET_30, NET_60, NET_90, IMMEDIATE Harmonized System codes for products/services
Business category description
Detailed description of products and services
Agreement details
Purpose code for international transactions