Create VA Alias (Single)

Creates a VA Alias under the assigned VA Code. A VA Code must already exist before creating an alias.

STATIC VA Alias: Permanent alias (allows multiple credits to the same virtual account).
DYNAMIC VA Alias: Auto-expiring alias, the virtual account is tied to an order id and gets deactivated after a certain interval of time (default 10 minutes).

Failure conditions (all return statusCode: 900 with the description below):

ConditionStatus Description
Invalid or missing va_codeva_code is mandatory and must be 5 characters long
VA Code does not existVA Code does not exist
Invalid or missing va_nameva_name is mandatory and cannot exceed 100 characters
Invalid va_email formatva_email must be a valid email address
Invalid mobile numberva_mobile must be a valid 10-digit mobile number
Invalid VA Aliasva_alias must be alphanumeric and up to 7 characters long
Range start/end missingBoth va_range_start and va_range_end are required if range is provided
Invalid range valuesva_range_start and va_range_end must be numeric values
Invalid range orderva_range_end must be greater than or equal to va_range_start
Missing va_typeva_type is required
Invalid VA TypeInvalid VA Type
Invalid remitter formatva_allowed_remitter must be a JSON array
Invalid remitter account numberEach remitter must have a valid account_number (5–24 digits)
Invalid remitter IFSCEach remitter must have a valid IFSC code
Invalid numeric limits<limit_field> must be a valid numeric value
Min limit > Max limitva_min_amount_limit cannot be greater than va_max_amount_limit
Invalid activation datetimeVA Activation Date is mandatory and must be a valid datetime
Invalid deactivation datetimeVA Deactivation Date must be a valid datetime if provided
Activation date in pastVA Activation Date cannot be in the past
Activation ≥ Deactivationva_activation_dt must be before va_deactivation_dt
Alias already existsVA Alias already exists
Internal server errorInternal Server Error
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Parent VA Code (5 chars).

string

Account holder name.

string

Email of account holder or end customer to whom the Virtual account is being assigned.

string

Mobile of account holder or end customer to whom the Virtual account is being assigned (10 digits).

string

Alias string (alphanumeric, up to 7 chars).

string
enum
required

STATIC (permanent, allows multiple credits) or DYNAMIC (auto-expiring, tied to an order id, default 10-minute deactivation).

Allowed:
va_allowed_remitter
array of objects

Array of allowed remitters. To be passed if credit is needed from only certain bank accounts.

va_allowed_remitter
string

Activation datetime. Cannot be in the past.

string

Deactivation datetime. Must be after va_activation_dt.

string

Start of a range of virtual accounts to create (numeric only). Either a single va_alias or a range must be provided, not both.

string

End of the range. Required if va_range_start is passed.

number

Minimum amount to be credited to the Virtual account.

number

Maximum amount that can be credited to the virtual account.

number

Amount limit for IMPS payment mode.

number

Amount limit for NEFT payment mode.

number

Amount limit for RTGS payment mode.

number

Amount limit for IFT payment mode.

string

Merchant-defined custom field 1.

string

Merchant-defined custom field 2.

string

Merchant-defined custom field 3.

string

Merchant-defined custom field 4.

string

Merchant-defined custom field 5.

string

Merchant-defined custom field 6.

string

Merchant-defined custom field 7.

string

Merchant-defined custom field 8.

string

Merchant-defined custom field 9.

string

Merchant-defined custom field 10.

string

Merchant-defined custom field 11.

string

Merchant-defined custom field 12.

string

Merchant-defined custom field 13.

string

Merchant-defined custom field 14.

string

Merchant-defined custom field 15.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json