Body
Update Customer API
The API can be used to update the customer details like phone number, email, first name etc.
Note
Please keep a note of the following constraints while updating customer’s email address, First Name and Last Name-
email address - You are allowed to use alphanumeric characters and the following special characters:
!#$%&'*+-/=?^_.{|}~`@_and.cannot appear at the beginning or end of the local part of the email address (before and after the@symbol).First Name/Last Name - You are allowed to use alphanumeric characters and the following special characters:
().-_
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/customers/{customer_id}
Production Link
POST
https://api.juspay.in/customers/{customer_id}
Authorization Header
Basic Auth
*
Base64 Encoded username:password
required
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
*
string
required
Merchant ID provided by Juspay
Example:-
merchant-id
Content-Type
String
application/x-www-form-urlencoded
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Path Params
customer_id
*
String
Mandatory
This is same as the object_reference_id using which customer was created in Juspay system or the id which you got in the create customer API response.
Example:- cst_om2l6ctlptxwxuzj
Request Schema: application/json
Section1
email_address
String
The customer’s email address. If the backend gateway requires it, then you must send this value.
Warning
You are allowed to use alphanumeric characters and the following special characters:
!#$%&'*+-/=?^_.{|}~`@_and.cannot appear at the beginning or end of the local part of the email address (before and after the@symbol).
Example:- customer@gmail.com
first_name
String
It is the First Name of customer. This value will be used for customer identification.
Warning
You are allowed to use alphanumeric characters and the following special characters:
().-_We will throw Bad Request error when the following special characters are used in Firstname. +!<>?;:@%`&*$^{}/\,=
Example:-Juspay
last_name
String
It is the Last Name of customer. This value will be used for customer identification.
Warning
You are allowed to use alphanumeric characters and the following special characters:
().-_We will throw Bad Request error when the following special characters are used in Lastname. +!<>?;:@%`&*$^{}/\,=
Example:-User
mobile_country_code
String
The customer's mobile country code. Pass the country code without + prefix.
Warning
When you pass alphanumeric value for country code will throw Bad Request error. Example - ‘abcd’
Example: 91
mobile_number
String
It is the customer’s mobile number.
you should pass only the 10 digit number without appending "+" or mobile country code.
Warning
We accept ‘+‘ only at prefix of the mobile number when country code passed, if it is passed in between or suffix we will throw bad request error.
when special characters(‘?‘, ’/’, ’`’, ’~’, ’@’, ’#’, ’%’, ‘^‘, ‘,‘, ‘&‘, ‘*‘, ‘(‘, ‘)‘, ‘_‘, ‘-‘, ‘=‘, ‘\‘, ‘{‘, ‘}‘) are passed in the mobile number value will throw the Bad Request error.
Example: +919912346789 or 97675789476
200 : Success
Response Body
id
string
It is the unique identifier of the customer object in Juspay system. It is the ID with which merchant refers to a customer object and passed in the path params to update the customer details
Example :- cst_om2l6ctlptxwxuzj
object
JSON
Value: customer
object_reference_id
string
Unique ID that you use to represent the customer in your database. The typical value for this field would be email address or mobile number or auto increment ID that you have in your DB.
Example :- customer1732614823
mobile_country_code
string
Cusomter's mobile country code
Example :- 91
mobile_number
string
Customers mobile number
Example:- Eaxmple :- 9988776644
email_address
string
Customer's e-mail address
Example :- customer@gmail.com
last_name
string
Customer's last name
Example :- Snow
first_name
string
Customer's first name
Example :- Jon
date_created
string
UTC timestamp when the customer object was created in Juspay system
Example :- 2016-08-02T08:07:52+0000
last_updated
string
UTC timestamp when the customer object was last updated at
Example :- 2016-08-02T08:07:52+0000
400 : Invalid Input data
Response Body
status
String
Status of the API call.
Example :- Bad Request
error_code
String
Details of error occurred
Example:- Invalid Request
error_message
String
Further Details of keys missing in the request.
Example :- Wrong value in mobile_country_code
404 : Not Found
Response Body
status
string
invalid_request_error
error_code
string
object_not_found
error_message
string
Cannot find what you are looking for