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

Get Customer API

This is a Server-to-Server API which retrieves the customer entity for a given identifier, allowing verification of the customer's existence in the Juspay system. This API retrieves all customer-related information, including first name, last name, mobile number, email address (as provided during the Create Customer API call), along with the customer creation date and the last updated date of the customer details.

Request

Response

API Endpoints

Sandbox Link

GET

https://sandbox.juspay.in/customers/{customer_id}

Production Link

GET

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

Response Body

                      object_reference_id
                      
                      

string

ID maintained at ermchant end fro each customer

                      mobile_number
                      
                      

string

Customers mobile number

                      mobile_country_code
                      
                      

string

Cusomter'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

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 details 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 details 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
Checking for random customer_id value	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"}}
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