Body
Validate Customer account
This is a Server-to-Server API that validates the bank account/UPI details and validate whether the provided account details are correct.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/customers/{customer_id}/customer-accounts/{bank_account_id}/validate
Production Link
POST
https://api.juspay.in/customers/{customer_id}/customer-accounts/{bank_account_id}/validate
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_weoridsfdkl
customer_account_id
*
String
Mandatory
Customer Account Id
Example:- bank_woeriusdfk
Parameters
preferred_ifsc_validation_gateway
String
Optional
Preferred gateway to validate the bank account/VPA details
validation_amount
String
Optional
Predefined amount to verify the bank account details.
Default amount: 1 INR (Rupee)
200 : Success
Response Body
object
String
Example:- customer_account
customer_account_id
String
Example:- banh_kGvx5TGUmkRVC2dH
customer_id
String
Example:- cst_zqqmw0v4exbhvv2l
date_created
String
Example:- 2023-06-06T13:29:49Z
account_details
Object
vpa
String
Example:- 4225246777@yesg
validation_amount
String
Example:- 1
currency
String
Example:- INR
validation_status
String
Status of the validation.
Possible values:ACTIVE - validation is successful at gateway with provided customer bank details
PENDING - Awaiting transaction status on the penny drop transaction
FAILURE - Provided account validation is failure
Example:- ACTIVE
last_validated
String
Example:- 2023-06-06T13:29:53Z
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
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