Body
Create Customer API
This API is responsible for creating a new customer object in Juspay systems. You can invoke this API whenever a new user registers in your App/Website and is triggering the payment process.
Note
Ensure the object_reference_id is unique to the customer.
Customer_id received in response is Juspay’s unique reference to your customer. It is recommended to store this mapping.
This API is required to save the custom payment details to re-use it in the future.
Request
Response
API Endpoints
Sandbox Link
POST
https://api.sandbox.juspay.io/customers
Production Link
POST
https://api.juspay.io/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
Max Length :255
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
Example:-
cust_123489
mobile_number
*
string
required
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
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
Required
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_reference_id
*
string
Required
object
*
string
Required
mobile_number
*
string
Required
Customers mobile number
mobile_country_code
*
string
Required
Cusomter's mobile country code
last_updated
*
string
Required
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
Required
WITH CLIENT_AUTH_TOKEN
JSON
id
*
string
Required
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
Required
mobile_number
*
string
Required
Customers mobile number
mobile_country_code
*
string
Required
Cusomter's mobile country code
last_updated
*
string
Required
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
Required
juspay
JSON
client_auth_token_expiry
string
client_auth_token
string
object_reference_id
*
String
Required
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