Jump to

• Request
• Response

Get all valid accounts

get

/service/accounts

This endpoint is used to get all virtual accounts.

Request

Supported Media Types

• application/json

Query Parameters

• authStat(optional): string
• branchCode(optional): string
• checkerId(optional): string
• defaultAccCcy(optional): string
• ibanAccNo(optional): string
• includeTotalCount(optional): boolean
  Default Value: true
• includecloseandunauth(optional): boolean
  includecloseandunauth must be set to fetch summary record. By default, the value is false
• limit(optional): integer
  Fetches the maximum number of limit
• makerId(optional): string
• odEndDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• odStartDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}
• offset(optional): integer
  Fetches the starting number of the offset record
• q(optional): string
  Default Value: LIKE
• realAccLinkage(optional): string
• realAccountBrn(optional): string
• realAccountNo(optional): string
• realCustomerNo(optional): string
• recordStat(optional): string
• virtualAccProduct(optional): string
• virtualAccountName(optional): string
• virtualAccountNo(optional): string
• virtualEntityId(optional): string

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : VirtualAccountServiceCollection

Type: object

Collection of account.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of account.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VirtualAccountServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VirtualAccountServiceDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/VirtualAccountServiceDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : VirtualAccountServiceDTO

Type: object

Match All

Show Source

• object VirtualAccountServiceDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "branchCode":{
                    "type":"string",
                    "description":"Branch code of the Virtual Account"
                },
                "virtualEntityId":{
                    "type":"string",
                    "description":"Virtual Entity for which Virtual Account is created"
                },
                "virtualEntityName":{
                    "type":"string",
                    "description":"Virtual Entity Name for which Virtual Account is created"
                },
                "realCustomerNo":{
                    "type":"string",
                    "description":"Real Customer Number for whom Virtual Account is created"
                },
                "defaultAccCcy":{
                    "type":"string",
                    "description":"Currency of Virtual Account"
                },
                "virtualAccProduct":{
                    "type":"string",
                    "description":"Corporate Specific Virtual Account Product"
                },
                "virtualAccountNo":{
                    "type":"string",
                    "description":"Virtual Account Number",
                    "minLength":0,
                    "maxLength":20
                },
                "ibanRequired":{
                    "type":"string",
                    "description":"Flag to indicate if IBAN is required",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "ibanAccNo":{
                    "type":"string",
                    "description":"IBAN Account Number"
                },
                "realAccountNo":{
                    "type":"string",
                    "description":"Real Account Number for which Virtual Account is created"
                },
                "virtualAccountName":{
                    "type":"string",
                    "description":"Name of the Virtual Account",
                    "minLength":1,
                    "maxLength":105,
                    "pattern":"([a-zA-Z0-9\\s]+)?"
                },
                "addressLine1":{
                    "type":"string",
                    "description":"Address Line 1",
                    "minLength":0,
                    "maxLength":35
                },
                "addressLine2":{
                    "type":"string",
                    "description":"Address Line 2",
                    "minLength":0,
                    "maxLength":35
                },
                "addressLine3":{
                    "type":"string",
                    "description":"Address Line 3",
                    "minLength":0,
                    "maxLength":35
                },
                "addressLine4":{
                    "type":"string",
                    "description":"Address Line 4",
                    "minLength":0,
                    "maxLength":35
                },
                "pincode":{
                    "type":"string",
                    "description":"Pincode",
                    "pattern":"([a-zA-Z0-9]+)?"
                },
                "countryCode":{
                    "type":"string",
                    "description":"Country Code"
                },
                "accountPurpose":{
                    "type":"string",
                    "description":"Purpose of Virtual Account",
                    "minLength":0,
                    "maxLength":105
                },
                "interestCalcReq":{
                    "type":"string",
                    "description":"Flag to indicate if Interest Calculation is required",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "accountFrozen":{
                    "type":"string",
                    "description":"Flag to indicate if Account is frozen",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "balChkForDebits":{
                    "type":"string",
                    "description":"Flag to indicate if Balance check is required for Debit Transactions",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "balAvailabilityOptions":{
                    "type":"string",
                    "description":"If Balance check is required then balance availability option needs to be selected",
                    "pattern":"[O,P,B]",
                    "default":"O"
                },
                "fixedAmtFromPool":{
                    "type":"number",
                    "description":"Amount should be given if balance availability option is selected as Own Balance + Fixed Amount From Pool",
                    "pattern":"([0-9]+)?"
                },
                "overdraftAllowed":{
                    "type":"string",
                    "description":"Flag to indicate if Overdraft is allowed",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "fixedAmount":{
                    "type":"number",
                    "description":"Amount should be given if overdraft is allowed",
                    "pattern":"([0-9]+)?"
                },
                "creditTxnsAllowed":{
                    "type":"string",
                    "description":"Flag to indicate if Credit Transaction is allowed",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "debitTxnsAllowed":{
                    "type":"string",
                    "description":"Flag to indicate if Debit Transaction is allowed",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "status":{
                    "type":"string",
                    "description":"Status of the Virtual Account",
                    "pattern":"[A,I]"
                },
                "realAccLinkage":{
                    "type":"string",
                    "description":"Indicates if Real Account Linkage is at Account level or Structure level",
                    "pattern":"[A,S]",
                    "default":"A"
                },
                "realAccountCcy":{
                    "type":"string",
                    "description":"Currency of the Real Account Number"
                },
                "realAccountBrn":{
                    "type":"string",
                    "description":"Branch in which Real Account exists"
                },
                "accOpenDate":{
                    "type":"string",
                    "description":"Date in which Virtual Account is opened"
                },
                "accClosureDate":{
                    "type":"string",
                    "description":"Date in which Virtual Account is closed"
                },
                "lastActivityDate":{
                    "type":"string",
                    "description":"Last Activity Date"
                },
                "makerId":{
                    "type":"string",
                    "description":"Maker ID of Virtual Account"
                },
                "makerDateStamp":{
                    "type":"string",
                    "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
                },
                "checkerId":{
                    "type":"string",
                    "description":"Checker ID of Virtual Account"
                },
                "checkerDateStamp":{
                    "type":"string",
                    "description":"Date and Time when some action on Virtual Account is authorized"
                },
                "modNo":{
                    "type":"integer",
                    "description":"Version number of Virtual Account"
                },
                "recordStatus":{
                    "type":"string",
                    "description":"Record Status of Virtual Account"
                },
                "authStatus":{
                    "type":"string",
                    "description":"Authorization Status of Virtual Account"
                },
                "onceAuth":{
                    "type":"string",
                    "description":"Flag that indicated if Virtual Account is authorized once or not"
                },
                "doerRemarks":{
                    "type":"string",
                    "description":"Remarks made by Maker"
                },
                "approverRemarks":{
                    "type":"string",
                    "description":"Remarks made by Approver"
                },
                "odStartDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date from when OD amount can be included in calculating balance"
                },
                "odEndDate":{
                    "type":"string",
                    "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
                    "description":"Date till when OD amount can be included in calculating balance"
                },
                "branchName":{
                    "type":"string",
                    "description":"Name of the Branch for Virtual Account",
                    "minimum":0,
                    "maximum":105
                },
                "structureCode":{
                    "type":"string",
                    "description":"Code to identify Virtual Account Structure"
                },
                "virtualParentAcc":{
                    "type":"string",
                    "description":"Parent Account for the virtual account"
                },
                "sanctionChkStatus":{
                    "type":"string",
                    "description":"Sanction check status"
                },
                "accLiqdAllowed":{
                    "type":"string",
                    "description":"Flag to indicate if Liquidity Management is allowed for a virtual account",
                    "pattern":"[Y,N]",
                    "default":"N"
                },
                "StructuredAddressServiceDTO":{
                    "$ref":"#/definitions/StructuredAddressServiceDTO"
                }
            }
        }
    ]
}

Nested Schema : VirtualAccountServiceDTO-allOf[0]

Type: object

Show Source

• accClosureDate(optional): string
  Date in which Virtual Account is closed
• accLiqdAllowed(optional): string
  Default Value: N

  Pattern: [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: N

  Pattern: [Y,N]

  Flag to indicate if Account is frozen
• accountPurpose(optional): string
  Minimum Length: 0

  Maximum Length: 105

  Purpose of Virtual Account
• addressLine1(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Address Line 1
• addressLine2(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Address Line 2
• addressLine3(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Address Line 3
• addressLine4(optional): string
  Minimum Length: 0

  Maximum Length: 35

  Address Line 4
• approverRemarks(optional): string
  Remarks made by Approver
• authStatus(optional): string
  Authorization Status of Virtual Account
• balAvailabilityOptions(optional): string
  Default Value: O

  Pattern: [O,P,B]

  If Balance check is required then balance availability option needs to be selected
• balChkForDebits(optional): string
  Default Value: N

  Pattern: [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: 0

  Maximum Value: 105

  Name 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: N

  Pattern: [Y,N]

  Flag to indicate if Credit Transaction is allowed
• debitTxnsAllowed(optional): string
  Default Value: N

  Pattern: [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: N

  Pattern: [Y,N]

  Flag to indicate if IBAN is required
• interestCalcReq(optional): string
  Default Value: N

  Pattern: [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: N

  Pattern: [Y,N]

  Flag to indicate if Overdraft is allowed
• pincode(optional): string
  Pattern: ([a-zA-Z0-9]+)?

  Pincode
• realAccLinkage(optional): string
  Default Value: A

  Pattern: [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
• 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
• virtualAccountName(optional): string
  Minimum Length: 1

  Maximum Length: 105

  Pattern: ([a-zA-Z0-9\s]+)?

  Name of the Virtual Account
• virtualAccountNo(optional): string
  Minimum Length: 0

  Maximum Length: 20

  Virtual 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

{
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Branch code of the Virtual Account"
        },
        "virtualEntityId":{
            "type":"string",
            "description":"Virtual Entity for which Virtual Account is created"
        },
        "virtualEntityName":{
            "type":"string",
            "description":"Virtual Entity Name for which Virtual Account is created"
        },
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number for whom Virtual Account is created"
        },
        "defaultAccCcy":{
            "type":"string",
            "description":"Currency of Virtual Account"
        },
        "virtualAccProduct":{
            "type":"string",
            "description":"Corporate Specific Virtual Account Product"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account Number",
            "minLength":0,
            "maxLength":20
        },
        "ibanRequired":{
            "type":"string",
            "description":"Flag to indicate if IBAN is required",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "ibanAccNo":{
            "type":"string",
            "description":"IBAN Account Number"
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real Account Number for which Virtual Account is created"
        },
        "virtualAccountName":{
            "type":"string",
            "description":"Name of the Virtual Account",
            "minLength":1,
            "maxLength":105,
            "pattern":"([a-zA-Z0-9\\s]+)?"
        },
        "addressLine1":{
            "type":"string",
            "description":"Address Line 1",
            "minLength":0,
            "maxLength":35
        },
        "addressLine2":{
            "type":"string",
            "description":"Address Line 2",
            "minLength":0,
            "maxLength":35
        },
        "addressLine3":{
            "type":"string",
            "description":"Address Line 3",
            "minLength":0,
            "maxLength":35
        },
        "addressLine4":{
            "type":"string",
            "description":"Address Line 4",
            "minLength":0,
            "maxLength":35
        },
        "pincode":{
            "type":"string",
            "description":"Pincode",
            "pattern":"([a-zA-Z0-9]+)?"
        },
        "countryCode":{
            "type":"string",
            "description":"Country Code"
        },
        "accountPurpose":{
            "type":"string",
            "description":"Purpose of Virtual Account",
            "minLength":0,
            "maxLength":105
        },
        "interestCalcReq":{
            "type":"string",
            "description":"Flag to indicate if Interest Calculation is required",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "accountFrozen":{
            "type":"string",
            "description":"Flag to indicate if Account is frozen",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "balChkForDebits":{
            "type":"string",
            "description":"Flag to indicate if Balance check is required for Debit Transactions",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "balAvailabilityOptions":{
            "type":"string",
            "description":"If Balance check is required then balance availability option needs to be selected",
            "pattern":"[O,P,B]",
            "default":"O"
        },
        "fixedAmtFromPool":{
            "type":"number",
            "description":"Amount should be given if balance availability option is selected as Own Balance + Fixed Amount From Pool",
            "pattern":"([0-9]+)?"
        },
        "overdraftAllowed":{
            "type":"string",
            "description":"Flag to indicate if Overdraft is allowed",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "fixedAmount":{
            "type":"number",
            "description":"Amount should be given if overdraft is allowed",
            "pattern":"([0-9]+)?"
        },
        "creditTxnsAllowed":{
            "type":"string",
            "description":"Flag to indicate if Credit Transaction is allowed",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "debitTxnsAllowed":{
            "type":"string",
            "description":"Flag to indicate if Debit Transaction is allowed",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "status":{
            "type":"string",
            "description":"Status of the Virtual Account",
            "pattern":"[A,I]"
        },
        "realAccLinkage":{
            "type":"string",
            "description":"Indicates if Real Account Linkage is at Account level or Structure level",
            "pattern":"[A,S]",
            "default":"A"
        },
        "realAccountCcy":{
            "type":"string",
            "description":"Currency of the Real Account Number"
        },
        "realAccountBrn":{
            "type":"string",
            "description":"Branch in which Real Account exists"
        },
        "accOpenDate":{
            "type":"string",
            "description":"Date in which Virtual Account is opened"
        },
        "accClosureDate":{
            "type":"string",
            "description":"Date in which Virtual Account is closed"
        },
        "lastActivityDate":{
            "type":"string",
            "description":"Last Activity Date"
        },
        "makerId":{
            "type":"string",
            "description":"Maker ID of Virtual Account"
        },
        "makerDateStamp":{
            "type":"string",
            "description":"Date and Time when Virtual Account is created or modified or closed or reopened"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID of Virtual Account"
        },
        "checkerDateStamp":{
            "type":"string",
            "description":"Date and Time when some action on Virtual Account is authorized"
        },
        "modNo":{
            "type":"integer",
            "description":"Version number of Virtual Account"
        },
        "recordStatus":{
            "type":"string",
            "description":"Record Status of Virtual Account"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status of Virtual Account"
        },
        "onceAuth":{
            "type":"string",
            "description":"Flag that indicated if Virtual Account is authorized once or not"
        },
        "doerRemarks":{
            "type":"string",
            "description":"Remarks made by Maker"
        },
        "approverRemarks":{
            "type":"string",
            "description":"Remarks made by Approver"
        },
        "odStartDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date from when OD amount can be included in calculating balance"
        },
        "odEndDate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Date till when OD amount can be included in calculating balance"
        },
        "branchName":{
            "type":"string",
            "description":"Name of the Branch for Virtual Account",
            "minimum":0,
            "maximum":105
        },
        "structureCode":{
            "type":"string",
            "description":"Code to identify Virtual Account Structure"
        },
        "virtualParentAcc":{
            "type":"string",
            "description":"Parent Account for the virtual account"
        },
        "sanctionChkStatus":{
            "type":"string",
            "description":"Sanction check status"
        },
        "accLiqdAllowed":{
            "type":"string",
            "description":"Flag to indicate if Liquidity Management is allowed for a virtual account",
            "pattern":"[Y,N]",
            "default":"N"
        },
        "StructuredAddressServiceDTO":{
            "$ref":"#/definitions/StructuredAddressServiceDTO"
        }
    }
}

Nested Schema : StructuredAddressServiceDTO

Type: object

Show Source

• buildingName(optional): string
  Maximum Length: 35

  building Name
• buildingNumber(optional): string
  Maximum Length: 16

  Building Number
• countrySubDivision(optional): string
  Maximum Length: 35

  Country Sub Division
• department(optional): string
  Maximum Length: 70

  Department
• districtName(optional): string
  Maximum Length: 35

  District name
• floor(optional): string
  Maximum Length: 70

  Floor
• operationType(optional): string
  operation type
• postbox(optional): string
  Maximum Length: 16

  postbox
• postcode: string
  Maximum Length: 16

  postcode
• resourceId(optional): string
  resource id
• resourceName(optional): string
  resource name
• room(optional): string
  Maximum Length: 70

  Room
• streetName(optional): string
  Maximum Length: 70

  Street Name
• strrCountry: string
  Maximum Length: 2

  country
• subDepartment(optional): string
  Maximum Length: 70

  Sub Department
• townLocationName(optional): string
  Maximum Length: 35

  Town Location Name
• townName: string
  Maximum Length: 35

  Town Name
• virtualEntityId: string
  Specify Virtual Entity Identification Number here

{
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "operationType":{
            "description":"operation type",
            "type":"string"
        },
        "department":{
            "type":"string",
            "description":"Department",
            "maxLength":70
        },
        "subDepartment":{
            "type":"string",
            "description":"Sub Department",
            "maxLength":70
        },
        "streetName":{
            "type":"string",
            "description":"Street Name",
            "maxLength":70
        },
        "buildingNumber":{
            "type":"string",
            "description":"Building Number",
            "maxLength":16
        },
        "buildingName":{
            "type":"string",
            "description":"building Name",
            "maxLength":35
        },
        "floor":{
            "type":"string",
            "description":"Floor",
            "maxLength":70
        },
        "postbox":{
            "type":"string",
            "description":"postbox",
            "maxLength":16
        },
        "room":{
            "type":"string",
            "description":"Room",
            "maxLength":70
        },
        "postcode":{
            "type":"string",
            "description":"postcode",
            "maxLength":16
        },
        "townName":{
            "type":"string",
            "description":"Town Name",
            "maxLength":35
        },
        "townLocationName":{
            "type":"string",
            "description":"Town Location Name",
            "maxLength":35
        },
        "districtName":{
            "type":"string",
            "description":"District name",
            "maxLength":35
        },
        "countrySubDivision":{
            "type":"string",
            "description":"Country Sub Division",
            "maxLength":35
        },
        "strrCountry":{
            "type":"string",
            "description":"country",
            "maxLength":2
        },
        "virtualEntityId":{
            "type":"string",
            "description":"Specify Virtual Entity Identification Number here"
        }
    },
    "required":[
        "virtualEntityId",
        "townName",
        "strrCountry",
        "postcode"
    ]
}

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.

Back to Top