Adds a new accounts
post
/service/accounts
This endpoint is used to add new virtual accounts.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
fileRefId(optional): string
For H2H ,send fileRefId
-
recordRefId(optional): string
For H2H ,send RecordId
Header Parameters
-
sourceCode: string
Source from which request is initiated
Request body contains data required to create a new account.
Nested Schema : VirtualAccountSaveRequestDTO-allOf[0]
Type:
Show Source
object-
accLiqdAllowed(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Liquidity Management is allowed for a virtual account -
accountFrozen(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Account is frozen -
accountPurpose(optional):
string
Minimum Length:
0Maximum Length:105Purpose of Virtual Account -
addressLine1(optional):
string
Minimum Length:
0Maximum Length:35Address Line 1 -
addressLine2(optional):
string
Minimum Length:
0Maximum Length:35Address Line 2 -
addressLine3(optional):
string
Minimum Length:
0Maximum Length:35Address Line 3 -
addressLine4(optional):
string
Minimum Length:
0Maximum Length:35Address Line 4 -
balAvailabilityOptions(optional):
string
Default Value:
OPattern:[O,P,B]If Balance check is required then balance availability option needs to be selected -
balChkForDebits(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Balance check is required for Debit Transactions -
branchCode:
string
Branch code of the Virtual Account
-
countryCode(optional):
string
Country Code
-
creditTxnsAllowed(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Credit Transaction is allowed -
debitTxnsAllowed(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Debit Transaction is allowed -
defaultAccCcy:
string
Currency of Virtual Account
-
fixedAmount(optional):
number
Pattern:
([0-9]+)?Amount should be given if overdraft is allowed -
fixedAmtFromPool(optional):
number
Pattern:
([0-9]+)?Amount should be given if balance availability option is selected as Own Balance + Fixed Amount From Pool -
ibanAccNo(optional):
string
IBAN Account Number
-
ibanRequired(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if IBAN is required -
interestCalcReq(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Interest Calculation is required -
odEndDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}Date till when OD amount can be included in calculating balance -
odStartDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}Date from when OD amount can be included in calculating balance -
operationType(optional):
string
operation type
-
overdraftAllowed(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Overdraft is allowed -
pincode(optional):
string
Pattern:
([a-zA-Z0-9]+)?Pincode -
realAccLinkage(optional):
string
Default Value:
APattern:[A,S]Indicates if Real Account Linkage is at Account level or Structure level -
realAccountBrn(optional):
string
Branch in which Real Account exists
-
realAccountCcy(optional):
string
Currency of the Real Account Number
-
realAccountNo(optional):
string
Real Account Number for which Virtual Account is created
-
realCustomerNo:
string
Virtual Entity Name for which Virtual Account is created
-
resourceId(optional):
string
resource id
-
resourceName(optional):
string
resource name
-
structureCode(optional):
string
Code to identify Virtual Account Structure
-
StructuredAddressServiceDTO(optional):
object StructuredAddressServiceDTO
-
virtualAccountName:
string
Minimum Length:
1Maximum Length:105Name of the Virtual Account -
virtualAccountNo(optional):
string
Minimum Length:
0Maximum Length:20Virtual Account Number -
virtualAccProduct:
string
Corporate Specific Virtual Account Product
-
virtualEntityId:
string
Virtual Entity for which Virtual Account is created
-
virtualParentAcc(optional):
string
Parent Account for the virtual account
Nested Schema : StructuredAddressServiceDTO
Type:
Show Source
object-
buildingName(optional):
string
Maximum Length:
35building Name -
buildingNumber(optional):
string
Maximum Length:
16Building Number -
countrySubDivision(optional):
string
Maximum Length:
35Country Sub Division -
department(optional):
string
Maximum Length:
70Department -
districtName(optional):
string
Maximum Length:
35District name -
floor(optional):
string
Maximum Length:
70Floor -
operationType(optional):
string
operation type
-
postbox(optional):
string
Maximum Length:
16postbox -
postcode:
string
Maximum Length:
16postcode -
resourceId(optional):
string
resource id
-
resourceName(optional):
string
resource name
-
room(optional):
string
Maximum Length:
70Room -
streetName(optional):
string
Maximum Length:
70Street Name -
strrCountry:
string
Maximum Length:
2country -
subDepartment(optional):
string
Maximum Length:
70Sub Department -
townLocationName(optional):
string
Maximum Length:
35Town Location Name -
townName:
string
Maximum Length:
35Town Name -
virtualEntityId:
string
Specify Virtual Entity Identification Number here
Response
Supported Media Types
- application/json
- text/csv
- application/xml
201 Response
Returns message of succes or failure
Headers
-
Location: string
URL of newly created accounts
Nested Schema : VirtualAccountServiceDTO-allOf[0]
Type:
Show Source
object-
accClosureDate(optional):
string
Date in which Virtual Account is closed
-
accLiqdAllowed(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Liquidity Management is allowed for a virtual account -
accOpenDate(optional):
string
Date in which Virtual Account is opened
-
accountFrozen(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Account is frozen -
accountPurpose(optional):
string
Minimum Length:
0Maximum Length:105Purpose of Virtual Account -
addressLine1(optional):
string
Minimum Length:
0Maximum Length:35Address Line 1 -
addressLine2(optional):
string
Minimum Length:
0Maximum Length:35Address Line 2 -
addressLine3(optional):
string
Minimum Length:
0Maximum Length:35Address Line 3 -
addressLine4(optional):
string
Minimum Length:
0Maximum Length:35Address Line 4 -
approverRemarks(optional):
string
Remarks made by Approver
-
authStatus(optional):
string
Authorization Status of Virtual Account
-
balAvailabilityOptions(optional):
string
Default Value:
OPattern:[O,P,B]If Balance check is required then balance availability option needs to be selected -
balChkForDebits(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Balance check is required for Debit Transactions -
branchCode(optional):
string
Branch code of the Virtual Account
-
branchName(optional):
string
Minimum Value:
0Maximum Value:105Name of the Branch for Virtual Account -
checkerDateStamp(optional):
string
Date and Time when some action on Virtual Account is authorized
-
checkerId(optional):
string
Checker ID of Virtual Account
-
countryCode(optional):
string
Country Code
-
creditTxnsAllowed(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Credit Transaction is allowed -
debitTxnsAllowed(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Debit Transaction is allowed -
defaultAccCcy(optional):
string
Currency of Virtual Account
-
doerRemarks(optional):
string
Remarks made by Maker
-
fixedAmount(optional):
number
Pattern:
([0-9]+)?Amount should be given if overdraft is allowed -
fixedAmtFromPool(optional):
number
Pattern:
([0-9]+)?Amount should be given if balance availability option is selected as Own Balance + Fixed Amount From Pool -
ibanAccNo(optional):
string
IBAN Account Number
-
ibanRequired(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if IBAN is required -
interestCalcReq(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Interest Calculation is required -
lastActivityDate(optional):
string
Last Activity Date
-
makerDateStamp(optional):
string
Date and Time when Virtual Account is created or modified or closed or reopened
-
makerId(optional):
string
Maker ID of Virtual Account
-
modNo(optional):
integer
Version number of Virtual Account
-
odEndDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}Date till when OD amount can be included in calculating balance -
odStartDate(optional):
string
Pattern:
[0-9]{4}[-][0-9]{2}[-][0-9]{2}Date from when OD amount can be included in calculating balance -
onceAuth(optional):
string
Flag that indicated if Virtual Account is authorized once or not
-
overdraftAllowed(optional):
string
Default Value:
NPattern:[Y,N]Flag to indicate if Overdraft is allowed -
pincode(optional):
string
Pattern:
([a-zA-Z0-9]+)?Pincode -
realAccLinkage(optional):
string
Default Value:
APattern:[A,S]Indicates if Real Account Linkage is at Account level or Structure level -
realAccountBrn(optional):
string
Branch in which Real Account exists
-
realAccountCcy(optional):
string
Currency of the Real Account Number
-
realAccountNo(optional):
string
Real Account Number for which Virtual Account is created
-
realCustomerNo(optional):
string
Real Customer Number for whom Virtual Account is created
-
recordStatus(optional):
string
Record Status of Virtual Account
-
resourceId(optional):
string
resource id of Virtual Account
-
sanctionChkStatus(optional):
string
Sanction check status
-
status(optional):
string
Pattern:
[A,I]Status of the Virtual Account -
structureCode(optional):
string
Code to identify Virtual Account Structure
-
StructuredAddressServiceDTO(optional):
object StructuredAddressServiceDTO
-
unauthModNos(optional):
array unauthModNos
-
virtualAccountName(optional):
string
Minimum Length:
1Maximum Length:105Name of the Virtual Account -
virtualAccountNo(optional):
string
Minimum Length:
0Maximum Length:20Virtual Account Number -
virtualAccProduct(optional):
string
Corporate Specific Virtual Account Product
-
virtualEntityId(optional):
string
Virtual Entity for which Virtual Account is created
-
virtualEntityName(optional):
string
Virtual Entity Name for which Virtual Account is created
-
virtualParentAcc(optional):
string
Parent Account for the virtual account
Nested Schema : StructuredAddressServiceDTO
Type:
Show Source
object-
buildingName(optional):
string
Maximum Length:
35building Name -
buildingNumber(optional):
string
Maximum Length:
16Building Number -
countrySubDivision(optional):
string
Maximum Length:
35Country Sub Division -
department(optional):
string
Maximum Length:
70Department -
districtName(optional):
string
Maximum Length:
35District name -
floor(optional):
string
Maximum Length:
70Floor -
operationType(optional):
string
operation type
-
postbox(optional):
string
Maximum Length:
16postbox -
postcode:
string
Maximum Length:
16postcode -
resourceId(optional):
string
resource id
-
resourceName(optional):
string
resource name
-
room(optional):
string
Maximum Length:
70Room -
streetName(optional):
string
Maximum Length:
70Street Name -
strrCountry:
string
Maximum Length:
2country -
subDepartment(optional):
string
Maximum Length:
70Sub Department -
townLocationName(optional):
string
Maximum Length:
35Town Location Name -
townName:
string
Maximum Length:
35Town Name -
virtualEntityId:
string
Specify Virtual Entity Identification Number here
Nested Schema : unauthModNos
Type:
Show Source
array-
Array of:
integer
Lists all unauthorized modNos if any in case of modify operation
400 Response
Bad request error, the server is unable to process the request
401 Response
Unauthorized request error, invalid credentials
403 Response
Request denied, no permission to access the request.
405 Response
Request denied, invalid input.
500 Response
Internal server error.