Skip to main content
POST
/
ppi
/
user
Create User
curl --request POST \
  --url https://api.cashfree.com/ppi/user \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "user_id": "USER827364",
  "phone": "9876543210",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]"
}
'
{
  "user_id": "USER827364",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "9876543210",
  "email": "[email protected]",
  "status": "ACTIVE",
  "cf_user_id": "859473832123456789"
}

Authorizations

​
x-client-id
string
header
required

Your unique client identifier issued by Cashfree.

​
x-client-secret
string
header
required

The secret key associated with your client ID.

Headers

​
x-api-version
string
default:2025-11-01
required

API version to be used. Format is in YYYY-MM-DD.

Example:

"2025-11-01"

Body

application/json
​
user_id
string
required

Unique identifier that you create to identify the user in your system. Maximum 50 characters. Only alphanumeric characters, periods (.), hyphens (-), and underscores (_) are allowed.

Example:

"USER827364"

​
phone
string
required

Phone number of the user, without country code. Must be exactly 10 digits. Only numeric characters are allowed.

Example:

"9876543210"

​
first_name
string

First name of the user.

Example:

"John"

​
last_name
string

Last name of the user.

Example:

"Doe"

​
email
string

Email address of the user.

Example:

"[email protected]"

Response

User created successfully.

​
user_id
string

Unique identifier for the user, as provided by you during PPI user creation.

Example:

"USER827364"

​
first_name
string

First name of the user.

Example:

"John"

​
last_name
string

Last name of the user.

Example:

"Doe"

​
phone
string

Phone number of the user without country code.

Example:

"9876543210"

​
email
string

Email address of the user.

Example:

"[email protected]"

​
status
string

Current status of the user account. Possible values:

  • ACTIVE
  • BLOCKED
Example:

"ACTIVE"

​
cf_user_id
string

Unique identifier of the user generated by Cashfree.

Example:

"859473832123456789"