POST
/
customers
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"
}'
{
  "description": "CustomerEntityExample",
  "summary": "CustomerEntityExample",
  "value": [
    {
      "customer_uid": "cfcustom_78364873648723",
      "customer_phone": "9999999999",
      "customer_email": "prasun@example.com",
      "customer_name": "Prasun"
    }
  ]
}

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 in the Merchant Dashboard.

Headers

x-api-version
string
default:2023-08-01
required

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

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

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 to create a new customer at Cashfree

Request body to create a customer at cashfree

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

200
application/json
OK

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