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

Create Customer API

This API creates a new customer object in Juspay system. You should call this API whenever a new user registers in your App/Website and is triggering the payment process

List of gateways which requires email address or phone number of the customer

Scroll inside to view more

Gateway	Mandatory Fields
RAZORPAY	Mobile number, Email address
EASEBUZZ	Mobile number, Email address
PAYU	Mobile number, Email address
BILLDESK	Mobile number
CASHFREE	Mobile number, Email address
TPSL	Mobile number, Email address
OLAAPP	Mobile number, Email address
PAYTM	Mobile number, Email address
SIMPL	Mobile number, Email address
PAYPAL	Email address
HSBC UPI	Mobile number
LAZYPAY	Mobile number
LOANTAP	Mobile number
PAYFORT	Email address
CYBERSOURCE	Email address, Mobile number
FREECHARGEWALLET	Email address
MORPHEUS	Email address, Mobile number
ZAAKPAY	Email address, Mobile number
AUTHORIZEDOTNET	Email address
BHARATX	Mobile number
GOKWIK	Mobile number
GPAYIMF	Email address
HYPERPAY	Email address
HYPERPG	Mobile number
IFG	Email address
LYRA	Email address, Mobile number
M2P	Email address, Mobile number
ONEPAY	Email address, Mobile number
PAYMOB	Email address, Mobile number
SHOPSE	Mobile number
TAPPAY	Email address, Mobile number

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/customers

Production Link

POST

https://api.juspay.in/customers

                      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

required

Merchant ID provided by Juspay

Example:-
merchant_id

                      Content-Type
                      *
                      

String

Required

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.

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

Body

Request Schema: application/json

                      object_reference_id
                      *
                      

string

required

It is the Unique ID which represents a customer in your database. It should 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

                      email_address
                      
                      

string

The customer’s email address. 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).

Example:- customer@gmail.com

                      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: ().-_

We will throw Bad Request error when the following special characters are used in Firstname. +!<>?;:@%`&*$^{}/\,=

Example:- Lorem

                      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: ().-_

We will throw Bad Request error when the following special characters are used in Lastname. +!<>?;:@%`&*$^{}/\,=

Example:- Ipsum

                      options.get_client_auth_token
                      
                      

Boolean

false : if doing Express Checkout API Integration
true : if doing Express Checkout SDK Integration

It is used to fetch the client auth token which is required for authentication in Express Checkout SDK integration
Token expiry time is 15 minutes

                      mobile_country_code
                      
                      

String

The customer's mobile country code. Pass the country code without + prefix.

When you pass alphanumeric value for country code will throw Bad Request error. Example - ‘abcd’

Example: 91

                      mobile_number
                      *
                      

String

Required

It is the customer’s mobile number.

you should pass only the 10 digit number without appending "+" or mobile country code.

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

Response Body

id

string

It is the unique identifier of the customer object in Juspay system

                      object
                      
                      

string

Value: customer

                      object_reference_id
                      
                      

String

It is the Unique ID which represents a customer in your database.

                      mobile_number
                      
                      

string

The customer’s mobile number without the country code.

Example:- 9988998899

                      mobile_country_code
                      
                      

string

The customer's mobile country code

Example:- 91

                      last_updated
                      
                      

string

UTC timestamp when the customer object was last updated at

Example:- 2020-03-17T14:29:17Z

                      last_name
                      
                      

string

The customer's last name

                      first_name
                      
                      

string

The customer's first name

                      email_address
                      
                      

string

The customer's e-mail address

Example:- customer@gmail.com

                      date_created
                      
                      

string

UTC timestamp when the customer object was created in Juspay system

Example:- 2020-03-17T14:29:17Z

                      juspay
                      
                      

JSON

Conditional

This object will be returned only if options.get_client_auth_token was true in the request

                      client_auth_token
                      
                      

String

The Client Auth Token is used to authenticate requests in Express Checkout SDK Integration

Example:- tkn_8649cd66d30c47728b8dd2fb6279a4cc

                      client_auth_token_expiry
                      
                      

String

UTC timestamp when the client auth token will expire at. The default expiry is 15 minutes

Example:- 2020-03-17T14:45:26Z

Response Body

                      status
                      
                      

string

Status of the API call.

Example:-
Bad Request

                      error_code
                      
                      

string

Details of error occurred

Example:-
Mandatory fields are missing

                      error_message
                      
                      

string

Further Details of keys missing in the request.

Example:-
mobile_number is mandatory field.