Body
Virtual Account Creation API
This API will create virtual accounts to be used for making transactions by customers.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/customers/:customer_id/virtual-accounts
Production Link
POST
https://api.juspay.in/customers/:customer_id/virtual-accounts
Authorization Header
Basic Auth
*
required
Base64 Encoded username:password
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
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 provided by Juspay or object reference Id given by merchant while customer creation.
Request Schema: application/json
Basic Parameters
virtual_account_reference
*
String
Mandatory
Unique ID that merchants can use to represent the virtual account. [AlphaNumeric Values Only]
type
*
String
Mandatory
The type of virtual account merchant wants to create. Currently the default is ACCOUNT_IFSC (Virtual Bank Account)
parent_reference_id
*
String
Mandatory
The reference against which the merchant wants to create the virtual account against.
metadata
String
A custom key-value set can be passed here. Stringified JSON. No PII allowed.
200 : Success
Response Body
status
String
virtual_account
String
virtual_account_reference
String
customer_id
String
ifsc
String
type
String
date_created
String
last_updated
String
metadata
String
400 : Invalid Input data
Response Body
status
String
error_code
String
error_message
String