Body
Delete Customer account
This is a Server-to-Server API that takes customer account ID as an input and delete the customer account ID in the Juspay system against the provided customer ID.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/customers/{customer_id}/customer-accounts/{customer_account_id}
Production Link
POST
https://api.juspay.in/customers/{customer_id}/customer-accounts/{customer_account_id}
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
command
*
string
Mandatory
Value should be “delete”
This will delete the entity from the Juspay system.
200 : Success
Response Body
customer_account_status
String
status of customer account ID
Example:- DELETED
customer_account_id
String
customer account ID
Example:- banh_4sEpEU31yNz9NnSX
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