API ReferenceIntegrationsKnowledge Base

Customers

You can create customers with basic details such as name and contact details and use them for various Razorpay solution offerings.

Postman Collection#

We have a Postman collection to make the integration quicker and easier. Click the Download Postman Collection button below to get started.

Instructions to use the Postman Collection#

  • All Razorpay APIs are authorized using Basic Authorization.
    • Generate API Keys from the Dashboard .
    • Add your API Keys in Postman. Selected the required API → Auth → Type = Basic Auth → Username = <Your_Key_ID>; Password = <Your_Key_secret>
  • Some APIs in the collection require data specific to your account such as cust_id (Customer ID) as a path parameter.
    • For example, the Fetch Customer by ID API requires you to add the cust_id as a path parameter.
    • Such parameters are enclosed in {} in the collection. For example, {cust_id}.
    • The API throws an error if these are incorrect or do not exist in your system.

Customer Entity#

id
string Unique identifier of the customer. For example, cust_1Aa00000000004.
name
string. Customer's name. Alphanumeric, with period (.), apostrophe (') and parentheses allowed. Name must be between 3-50 characters in length. For example, Gaurav Kumar.
contact
string. Customer's contact number. For example, 9876543210.
email
string. Customer's email address. For example, gaurav.kumar@example.com.
gstin
string. GST number linked to the customer. For example, 29XAbbA4369J1PA.
notes
This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.
created_at
integer. Timestamp, in Unix, when the customer was created. For example, 1234567890.

You can create and manage customer via APIs or from the Dashboard.

Create a Customer#

Use the below endpoint to create a customer.

/customers

Request Parameters#

name mandatory
string Customer's name. Alphanumeric, with period (.), apostrophe (') and parentheses allowed. Name must be between 3-50 characters in length. For example, Gaurav Kumar.
contact mandatory
string The customer's phone number. For example, 9876543210.
email optional
string The customer's email address. For example, gaurav.kumar@example.com.
fail_existing optional
string Possible values:
  • 0 - If a customer with the same details already exists, fetch details of existing customer.
  • 1 (default) - If a customer with the same details already exists, throws an error.
gstin optional
string Customer's GST number, if available. For example, 29XAbbA4369J1PA.
notes optional
object. This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Edit Customer Details#

Use the below endpoint to edit customer details.

/customers/:id

Note:
When editing a customer's details, ensure that the combination of the values in the email and contact attributes is unique to a customer.

Path Parameter#

id mandatory
string The unique identifier linked to the customer.

Fetch all Customers#

You can use the below endpoint to fetch all customers in your system.

/customers

Fetch Customer by ID#

Use the below endpoint to fetch details of a customer by ID.

/customers/:id

Path Parameter#

id mandatory
string The unique identifier linked to the customer.
×