curl --request POST \
--url https://api-sandbox.cashfree.com/partners/merchants \
--header 'Content-Type: application/json' \
--header 'x-partner-apikey: <x-partner-apikey>' \
--data @- <<EOF
{
"merchant_id": "test_merchantid_1",
"merchant_email": "[email protected]",
"merchant_name": "John Doe Business",
"poc_phone": "9999999999",
"merchant_site_url": "cashfree.com",
"business_details": {
"business_legal_name": "John Doe Company",
"business_type": "Private Limited",
"business_model": "Both",
"business_category": "Ecommerce",
"business_subcategory": "Books",
"business_pan": "ABCCD8000T",
"business_address": "Flat-101, Apartment Name, Street Name",
"business_city": "Bengaluru",
"business_state": "Karnataka",
"business_postalcode": "560076",
"business_country": "India",
"business_gstin": "29AAICP2912R1ZR",
"business_cin": "L65190MH2003PLC143249"
},
"website_details": {
"website_contact_us": "https://www.cashfree.com/",
"website_privacy_policy": "https://www.cashfree.com/privacypolicy/",
"website_refund_policy": "https://www.cashfree.com/policies/refund-policy",
"website_shop_delivery": "https://www.cashfree.com/policies/shipping-policy",
"website_checkout_page": "https://www.cashfree.com/",
"website_about_us": "https://www.cashfree.com/about-us/",
"website_pricing_policy": "https://www.cashfree.com/payment-gateway-charges/",
"website_product_service": "https://www.cashfree.com/payment-gateway-india/",
"website_address": "https://www.cashfree.com/grievance-redressal-policy",
"website_tnc": "https://www.cashfree.com/tnc/"
},
"bank_account_details": {
"bank_account_number": "026291800001191",
"bank_ifsc": "YESB0000262"
},
"signatory_details": {
"signatory_name": "John Doe",
"signatory_pan": "ABCPV1234D"
},
"additional_details": {
"payment_gateway_use_case": "Payment Gateway required for collecting money from customers for purchasing books",
"payment_gateway_mcc": "5942",
"exporter_type": "Service Exporter",
"gcl_purpose_code": "P0101",
"import_export_code": 123456789,
"gcl_transaction_value": "1 - 5 Lac",
"gcl_transaction_volume": "1 - 5",
"gcl_use_case": "Description of the merchant's international payment use case and business requirements"
}
}
EOF{
"merchant_id": "test_merchantid_1",
"merchant_email": "[email protected]",
"merchant_name": "John Doe Business",
"created_at": "2023-07-24T04:45:20.000Z",
"onboarding_status": "Email Verified",
"product_status": [
{
"product_name": "PG",
"product_min_kyc_status": "MIN_KYC_PENDING"
}
]
}Create Merchant
Use this API to create a sub-merchant account. You can provide basic merchant details during creation. KYC documents are required to activate the account.
curl --request POST \
--url https://api-sandbox.cashfree.com/partners/merchants \
--header 'Content-Type: application/json' \
--header 'x-partner-apikey: <x-partner-apikey>' \
--data @- <<EOF
{
"merchant_id": "test_merchantid_1",
"merchant_email": "[email protected]",
"merchant_name": "John Doe Business",
"poc_phone": "9999999999",
"merchant_site_url": "cashfree.com",
"business_details": {
"business_legal_name": "John Doe Company",
"business_type": "Private Limited",
"business_model": "Both",
"business_category": "Ecommerce",
"business_subcategory": "Books",
"business_pan": "ABCCD8000T",
"business_address": "Flat-101, Apartment Name, Street Name",
"business_city": "Bengaluru",
"business_state": "Karnataka",
"business_postalcode": "560076",
"business_country": "India",
"business_gstin": "29AAICP2912R1ZR",
"business_cin": "L65190MH2003PLC143249"
},
"website_details": {
"website_contact_us": "https://www.cashfree.com/",
"website_privacy_policy": "https://www.cashfree.com/privacypolicy/",
"website_refund_policy": "https://www.cashfree.com/policies/refund-policy",
"website_shop_delivery": "https://www.cashfree.com/policies/shipping-policy",
"website_checkout_page": "https://www.cashfree.com/",
"website_about_us": "https://www.cashfree.com/about-us/",
"website_pricing_policy": "https://www.cashfree.com/payment-gateway-charges/",
"website_product_service": "https://www.cashfree.com/payment-gateway-india/",
"website_address": "https://www.cashfree.com/grievance-redressal-policy",
"website_tnc": "https://www.cashfree.com/tnc/"
},
"bank_account_details": {
"bank_account_number": "026291800001191",
"bank_ifsc": "YESB0000262"
},
"signatory_details": {
"signatory_name": "John Doe",
"signatory_pan": "ABCPV1234D"
},
"additional_details": {
"payment_gateway_use_case": "Payment Gateway required for collecting money from customers for purchasing books",
"payment_gateway_mcc": "5942",
"exporter_type": "Service Exporter",
"gcl_purpose_code": "P0101",
"import_export_code": 123456789,
"gcl_transaction_value": "1 - 5 Lac",
"gcl_transaction_volume": "1 - 5",
"gcl_use_case": "Description of the merchant's international payment use case and business requirements"
}
}
EOF{
"merchant_id": "test_merchantid_1",
"merchant_email": "[email protected]",
"merchant_name": "John Doe Business",
"created_at": "2023-07-24T04:45:20.000Z",
"onboarding_status": "Email Verified",
"product_status": [
{
"product_name": "PG",
"product_min_kyc_status": "MIN_KYC_PENDING"
}
]
}Headers
Your partner API key for authentication
API version to be used for the request
Body
Unique identifier for the merchant. Max 40 characters, Alphanumeric, Hypeh, Underscore allowed.
Registered email address
Business brand name
Owner phone number
Business website
Show child attributes
Show child attributes
Registered name of business
Entity Type. One of ["Individual","Proprietorship","LLP","Partnership","Private Limited","Public Limited","Trust","Society","NGO","Hindu Undivided Family (HUF)","Association of Persons (AOP)","Body of Individuals (BOI)","Local Authority","Artificial Juridical Person","Government"]
Business Model. One of ["B2C","B2B","Both"]
Business Category. One from master sheet - https://bit.ly/ObCategory
Business Subcategory. One from master sheet - https://bit.ly/ObSubcategory
Business PAN. If Individual, provide Personal PAN
Business Address
Business CIty
Business State
Business Pincode
Business Country
Business GSTIN. Skip for unregistered businesses
For unregistered or GST exempt businesses. Value can be either "My business category is exempted from GST" or "My annual turnover is less than GST prescribed limit"
Business CIN. Provide for Private and Public Limited entities
Business LLPIN. Provide for LLP and Partnership entities
Show child attributes
Show child attributes
Website url where Email, Contact number, or Contact Us form is available
Website url where Terms & Conditions are available
Website url where Privacy, Data Storage & Security Policy is available
Website url where Refund (with request timeline) & Cancellation Policy is available
If applicable, Website url where Shipping and Delivery policy with charges and timeline is available
Website url where product, cart and checkout flow is available
Website url where company legal name and description of business is available
Website url where product pricing in INR, Rs., etc. is available
Website url mentioning Products or Services, with their pricing and images
Website url where registered address of the business is mentioned
Pass additional details required by specific products
Show child attributes
Show child attributes
Purpose of collecting payments. Min 50 characters and Max 200 characters
Merchant Category Code (MCC)
Entity Type. One of ["Service Exporter", "Goods Exporter"]
Pass 'Purpose Code' value, refer to this https://docs.cashfree.com/v3/reference/purpose-codes
Send 10 digit value of Import-Export Code, only applicable for Goods
Entity Type. One of ['Less than 1 Lac', '1 - 5 Lac', '5 - 10 Lac', '10 - 15 Lac', '15 - 25 Lac', '25 Lac & above']
Entity Type. One of ['1 - 50', '50 - 100', '100 - 1000', '1000 - 3000', '3000 & above']
Elaborate on how you will you global collection. Please also include customer type
Response
OK
Unique identifier for the merchant. Max 40 characters, Alphanumeric, Hypeh, Underscore allowed.
Registered email address
Business brand name
Timestamp when merchant account was created
Merchant account onboarding status. Possible values: "Created" (email not verified), "Email Verified" (email verified)
List of product KYC status objects containing product name and minimum KYC status required
Was this page helpful?