Create User

Creates a new user in the PPI system with the provided personal information. This endpoint enables merchants to onboard new users who can then be associated with wallets or cards.

POST /ppi/user

Create User

cURL

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": "[e-mail]"
}
'

import requests

url = "https://api.cashfree.com/ppi/user"

payload = {
    "user_id": "USER827364",
    "phone": "9876543210",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[e-mail]"
}
headers = {
    "x-api-version": "<x-api-version>",
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-version': '<x-api-version>',
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_id: 'USER827364',
    phone: '9876543210',
    first_name: 'John',
    last_name: 'Doe',
    email: '[e-mail]'
  })
};

fetch('https://api.cashfree.com/ppi/user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cashfree.com/ppi/user",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => 'USER827364',
    'phone' => '9876543210',
    'first_name' => 'John',
    'last_name' => 'Doe',
    'email' => '[e-mail]'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-version: <x-api-version>",
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cashfree.com/ppi/user"

	payload := strings.NewReader("{\n  \"user_id\": \"USER827364\",\n  \"phone\": \"9876543210\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"email\": \"[e-mail]\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-version", "<x-api-version>")
	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cashfree.com/ppi/user")
  .header("x-api-version", "<x-api-version>")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"USER827364\",\n  \"phone\": \"9876543210\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"email\": \"[e-mail]\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cashfree.com/ppi/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"USER827364\",\n  \"phone\": \"9876543210\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\",\n  \"email\": \"[e-mail]\"\n}"

response = http.request(request)
puts response.read_body

200

SUCCESS

{
  "user_id": "USER827364",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "9876543210",
  "email": "[e-mail]",
  "status": "ACTIVE",
  "cf_user_id": "859473832123456789"
}

Authorizations

x-client-id · string · header · required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret · string · header · required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

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

Request parameters to create a new user.

user_id · string · required

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

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:

"[e-mail]"

Response

200

application/json

Success response for creating a user.

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:

"[e-mail]"

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"