Create Escrow

API to create Digital Escrow ID (Virtual Account)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Bank Account Number (Escrow/Current) which is opened in the bank. Mandatory in case client has multiple bank accounts with a bank.

string
required

The name field is required for creating a Digital Escrow (Virtual Account). This should represent the name associated with the escrow or virtual account being created.

string
required

The purpose field specifies the reason for creating the Digital Escrow (Virtual Account). It helps define the intended use or transaction type for the escrow.

date-time
required

A start date is the date from which the escrow will be activated. The date should be provided in epoch format.

string
required

The validity field represents the number of days the Digital Escrow (Virtual Account) will be active or required. This defines the duration for which the escrow will be active.

string

The "email" field is optional but supports multiple email addresses for receiving notifications about incoming and outgoing funds from the Digital Escrow ID.

int32

The expectedVolume field is an optional parameter that represents the anticipated transaction volume for the Digital Escrow (Virtual Account).

string

This parameter is mandatory only when the bank account is held with RBL Bank. Pass the full name of the Digital Escrow Holder as registered with the bank. The value provided in escrowholderName will be validated against the name linked to the account number provided in escrowholderAccountNumber to ensure consistency and compliance with RBL Bank’s validation process.

string

Applicable only if the bank account is with RBL Bank. Provide the RBL Bank account number of the Digital Escrow Holder. This account number will be used for validation and must match the name provided in the escrowholderName field as per Bank records.

string

Applicable only if the bank account is with RBL Bank. Provide the IFSC code of the Digital Escrow Holder’s Bank account. This IFSC code will be used for validation and must correspond to the escrowholderAccountNumber and the name provided in the escrowholderName field, as per Bank records.

string

Applicable only if the bank account is with RBL Bank. Provide the PAN number of the Digital Escrow Holder. The name associated with this PAN will be validated against the escrowholderName

Headers
string
Defaults to */*
string
Defaults to {{X-Client-Key}}

API key generated from Castler dashboard

string
Defaults to {{x-api-key}}

xAPI key shared separately by Castler

Responses

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