Skip to main content
GET
/
merchants
/
{merchant_id}
Get Merchant Status
curl --request GET \
  --url https://api-sandbox.cashfree.com/partners/merchants/{merchant_id} \
  --header 'x-partner-apikey: <x-partner-apikey>'
{
  "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

Path Parameters

​
merchant_id
string
required

Unique identifier for the merchant

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.