JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Update Customer API

The API can be used to update the customer details like phone number, email, first name etc.

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}

                      Basic Auth
                      *
                      

Base64 Encoded username:password

required

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      
                      

string

Recommended

Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.

Passing this value will help us route efficiently at network level.

Example:- x-merchantid: testaccount

                      Content-Type
                      
                      

String

application/x-www-form-urlencoded

                      customer_id
                      *
                      

string

required

Max Length :300

It is the ID with which merchant refers to a customer object. Merchants can use either customer_id or object_reference_id. This ID is essential for accessing stored payment methods, enabling EMI transactions, and setting up subscriptions.

Object_reference_id: An ID maintained at merchant’s end for each customer.
Customer_id: An ID(idfield of Create customer API response) created by Juspay for each Object_reference_id during the Create Customer API call.

Example:-
customer-id-007

Body

Request Schema: application/json

                      mobile_number
                      
                      

string

Optional

Max Length : 300

Customers mobile number. We recommend passing number without appending "+" or mobile country code.

Example:-
99889988

                      email_address
                      
                      

string

Max Length : 300

Email address of the customer. If the backend gateway requires it, then you must send this value.

Constraints : 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
                      
                      

string

Max Length :255

First Name of customer. This value will be used for customer identification.

Constraints : You are allowed to use alphanumeric characters and the following special characters: ().-_

                      last_name
                      
                      

string

Max Length :255

Last Name of customer. This value will be used for customer identification.

Constraints : You are allowed to use alphanumeric characters and the following special characters: ().-_

                      mobile_country_code
                      
                      

string

Max Length :64

Mobile country code. No need to prefix +.

Example:-
65

Response Body

                      object
                      
                      

JSON

id

string

ID / customer_id created at Juspay end for the specifiedobject_reference_id

                      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

                      mobile_number
                      
                      

string

Customers mobile number

                      mobile_country_code
                      
                      

string

Customer's mobile country code

                      last_updated
                      
                      

string

Last updated information of the customer details

                      last_name
                      
                      

string

Customer's last name

                      first_name
                      
                      

string

Customer's first name

                      email_address
                      
                      

string

Customer's e-mail address

                      date_created
                      
                      

string

Denotes Customer created date

Response Body

                      status
                      
                      

String

Status of the get customer api response

Example:- Response: error

                      error_code
                      
                      

String

error code information

Example:- Sample response: access_denied

                      error_info
                      
                      

JSON

Detailed information of the error

                      user_message
                      
                      

String

User error message

Example:- Response: Unauthorized.

                      developer_message
                      
                      

String

Provide accurate detailed information on the error message

Example:- Sample Response: Invalid API Key. Please pass a valid and active api key.

                      category
                      
                      

String

Denotes the category of the error

Example:- Sample Response: USER_ERROR

Response Body

                      error_message
                      
                      

String

Response Error message

Example:- sample Response: Cannot find what you are looking for

                      status
                      
                      

String

Status of the api response

Example:- Response: invalid_request_error

                      error_code
                      
                      

String

error code information

Example:- Response: object_not_found

                      error_info
                      
                      

JSON

Detailed information of the error

                      user_message
                      
                      

String

User error message

Example:- Response: Cannot process your request as customer account not found.

                      developer_message
                      
                      

String

Provide accurate detailed information on the error message

Example:- Response: Customer account not found.

                      category
                      
                      

String

Denotes the category of the error

Example:- sample response: USER_ERROR

Error Codes:

Scroll inside to view more

Scenario	Error Codes	Description	Sample Error Message
Trying to update for wrong/random customer_id	404	Not Found	{"error_message": "Cannot find what you are looking for","status": "invalid_request_error","error_code": "object_not_found","error_info": {"user_message": "Cannot process your request as customer account not found.","developer_message": "Customer account not found.","code": "RESOURCE_NOT_FOUND","category": "USER_ERROR"}}
Updating mobile_number with empty or negative value	400	Bad Request	{"error_message":"Wrong value in mobile_number","status":"Invalid Request","error_code":"Invalid Request","error_info": {"user_message":"Invalid request params. Please verify your input.","fields": [{"field_name":"mobile_number","reason":"Invalid value."}],"developer_message":"Invalid request params","code":"INVALID_INPUT","category":"USER_ERROR"}}
Whitelisting of IP in dashboard	403	IP Verification Failed	{"error":true,"error_message":"Internal Server error.","user_message":"Bad Origin.","error_info":{"code":"BAD_ORIGIN","category":"USER_ERROR","user_message":"Bad Origin.","developer_message":"IP Verification Failed"}}
Wrong API Key	401	Unauthorized	{"status":"error","error_code":"access_denied","error_info": {"user_message":"Unauthorized.","developer_message":"Invalid API Key. Please pass a valid and active api key.","code":"UNAUTHORIZED","category":"USER_ERROR"}}
Wrong API endpoint	404	Not Found

Have questions?
Need help? Contact support
LLM? Read llms.txt