Body
Get or Create Customer API
Get or Create a new customer object. You may invoke this method whenever someone registers in your website or App. You can use customer ID sent by you or JusPay will respond with an ID that you can persist in your Database. Pass this ID at the time of order creation to ensure proper linking of orders/payments belonging to a customer.
Request
Response
API Endpoints
Production Link
POST
https://api.juspay.in/v2/customers
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
Mandatory
application/x-www-form-urlencoded
Request Schema: application/json
Basic Parameters
object_reference_id
*
string
required
Unique ID that you use to represent the customer in your database. This must be atleast 8 characters and must be unique. 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
required
Customers mobile number. We recommend passing only the 10 digit number without appending "+" or mobile country code.
email_address
string
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
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
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
Mobile country code. No need to prefix +.
options.get_client_auth_token
Boolean
This is required to obtain the client_auth_token which is used for SDK integration
Value: true | false
200 : Success
Response Body
WITHOUT CLIENT_AUTH_TOKEN
JSON
id
string
customer_id
string
It is the ID with which merchant refers to a customer object. This id is used to access the stored payment methods, allow EMI transactions and setup subscriptions.
object
string
mobile_number
string
Customers mobile number
mobile_country_code
string
Cusomter's mobile country code
last_updated
string
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
WITH CLIENT_AUTH_TOKEN
JSON
id
string
customer_id
string
It is the ID with which merchant refers to a customer object. This id is used to access the stored payment methods, allow EMI transactions and setup subscriptions.
object
string
mobile_number
string
Customers mobile number
mobile_country_code
string
Cusomter's mobile country code
last_updated
string
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
juspay
JSON
client_auth_token_expiry
string
client_auth_token
string
400 : Invalid Input data
Response Body
status
string
Bad Request
error_code
string
Details of keys missing
Example:-
Mandatory fields are missing
error_message
string
Further Details of keys missing
Have questions?
- Need help? Contact support
- LLM? Read llms.txt