Skip to main content
POST
/
merchants
Create Merchant
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": "john@cashfree.com",
  "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": "john@cashfree.com",
  "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"
    }
  ]
}

Documentation Index

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

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

Headers

​
x-partner-apikey
string
required

Your partner API key for authentication

​
x-api-version
string
default:2023-01-01

API version to be used for the request

Body

application/json
​
merchant_id
string
required

Unique identifier for the merchant. Max 40 characters, alphanumeric, hyphen, underscore allowed.

​
merchant_email
string
required

Registered email address.

​
merchant_name
string
required

Business brand name.

​
poc_phone
string
required

Owner phone number.

​
merchant_site_url
string
required

Business website.

​
business_details
object
​
website_details
object
​
bank_account_details
object

Bank account to receive settlements.

​
signatory_details
object

Beneficial owner of the business.

​
additional_details
object

Pass additional details required by specific products.

Response

OK

​
merchant_id
string

Unique identifier for the merchant. Max 40 characters, alphanumeric, hyphen, underscore are allowed.

​
merchant_email
string

Registered email address.

​
merchant_name
string

Business brand name.

​
created_at
string

Timestamp when merchant account was created.

​
onboarding_status
string

Merchant account onboarding status. Possible values are "Created" (email not verified) and "Email Verified" (email verified).

​
product_status
object[]

List of product KYC status objects containing product name and minimum KYC status required.