Body
Create Customer account
This is a Server-to-Server API that takes bank account details/UPI parameters as an input and creates an customer account ID in the Juspay system against the provided customer ID.
Note
Merchants can create multiple customer accounts (both Bank Account and UPI) simultaneously. An array of UPI and bank accounts can be provided as input, and individual customer account IDs will be created for each account details.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/customers/{customer_id}/accounts
Production Link
POST
https://api.juspay.in/customers/{customer_id}/accounts
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
Content-Type
String
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.
Warning
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
Path Params
customer_id
*
String
Mandatory
Customer Id
Example:- cst_wexxxxsfdkl
Parameters
bank_code
*
string
Required
Juspay bank code ID defining the bank.
account_details
*
string
Mandatory
Bank account details
bank_account
Array
Bank account details
ifsc
String
IFSC code for a bank branch.
Example:- AABF0008032
account
String
Bank account number
Example:- 026291800001191
name
String
Name of the customer in a given bank account.
Example:- test
upi
String
UPI details
vpa
String
Customer VPA details
Example:- 9164326296@upi
gateway_id
string
Gateway id of the underlying provider to be used for bank account validation.
gateway_reference_id
string
Optional
Reference Id to a specific gateway which is used for validation
200 : Success
Response Body
object
String
Example:- customer_account
customer_account_id
String
ID created at Juspay’s end for the Customer’s bank account details
Example:- banh_kGvx5TGUmkRVC2dH
customer_id
String
Customer ID
Example:- cst_zqqmw0v4exbhvv2l
date_created
String
Creation date of the custmer account ID
Example:- 2023-06-06T13:28:20Z
account_details
Object
Account details with which customer account ID created
account
String
Bank account number
Example:- 026291800001191
name
String
Beneficiary name
Example:- test
ifsc
String
IFSC Code
Example:- AABF0008032
juspay_bank_code
String
Bank code
Example:- 12
bank_name
String
Beneficiary account bank name
Example:- SBI
validation_amount
String
Penny drop amount
Example:- 1
currency
String
Currency of the Validation amount
Example:- INR
validation_status
String
Status of the validation.
Possible values:CREATED - Customer account has been created, validation has not yet been completed
Example:- CREATED
last_validated
String
Recent modified date of the customer account ID
Example:- 2023-06-06T13:28:20Z
401 : Authentication Failed
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
Provides 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
Have questions?
- Need help? Contact support
- LLM? Read llms.txt