Skip to main content
POST
/
customers
Create Customer at Cashfree
curl --request POST \
  --url https://sandbox.cashfree.com/pg/customers \
  --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 '
{
  "customer_phone": "9999999999",
  "customer_email": "prasun@example.com",
  "customer_name": "Prasun"
}
'
{
  "$ref": "#/components/examples/customer_entity_example"
}

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

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

API version to be used.

​
x-request-id
string

Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

​
x-idempotency-key
string<UUID>

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Body

application/json

Request parameters to register a customer in Cashfree's system before initiating payments, subscriptions, tokenisation, or other customer-linked actions.

​
customer_phone
string
required

Customer Phone Number.

Required string length: 10
Example:

"9999999999"

​
customer_email
string

Customer Email.

Example:

"example@test.com"

​
customer_name
string

Customer Name.

Example:

"YourCustomer"

Response

Success response for registering a customer in Cashfree's system before initiating payments, subscriptions, tokenisation, or other customer-linked actions.

The complete customer entity.

​
customer_uid
string

unique id generated by cashfree for your customer.

​
customer_phone
string

Customer Phone Number.

​
customer_email
string

Customer Email.

​
customer_name
string

Customer Name.