Skip to main content
POST
/
ppi
/
user
Create PPI User
curl --request POST \
  --url https://api.cashfree.com/ppi/user \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "user_id": "1234567890123456789",
  "phone": "9876543210",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com"
}'
{
  "user_id": "7234567890123456789",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "9876543210",
  "email": "john.doe@example.com",
  "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.

Body

application/json
​
user_id
string
required

It is the unique ID you create to identify the user. The maximum character limit is 50. Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Example:

"1234567890123456789"

​
phone
string
required

Phone number of the user without country code.

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:

"john.doe@example.com"

Response

User created successfully.

​
user_id
string

It is the unique ID you create to identify the user.

Example:

"1234567890123456789"

​
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:

"john.doe@example.com"

​
status
enum<string>

Current status of the user.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED,
BLOCKED
​
cf_user_id
string

Unique identifier of the user generated by Cashfree.

Example:

"859473832123456789"