Jump to

• Request
• Response

Retrieves the list of Accounts with Balance and Structure Code

get

/service/accounts/accountswithbalandstrcode

This endpoint is used to retrieve the list of Accounts with Balance and Structure Code.

Request

Supported Media Types

• application/json

Query Parameters

• currency(optional): string
  Currency of the Virtual Account belonging to a Customer
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting point of records to be fetched
• realAccLinkage(optional): string
  Real Account Linkage for which facilty is provided
• realAccountNo(optional): string
  Real Account Number for which facilty is provided
• realCustomerNo: string
  Real Customer Number for which facilty is provided
• status(optional): string
  Record Status of the Virtual Accounts belonging to a Customer
• virtualAccountName(optional): string
  virtual Account Name of a Virtual Entity or Virtual Customer
• virtualAccountNo(optional): string
  virtual Account Number of a Virtual Entity or Virtual Customer
• virtualAccountProduct(optional): string
  Account Product for the Virtual Account
• virtualEntityId(optional): string
  Virtual Entity ID is a Virtual ID of which can be maintained by the customer in OBVAM system
• virtualEntityName(optional): string
  Virtual Entity Name is a Virtual ID of which can be maintained by the customer in OBVAM system

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns list of Accounts with Balance and Structure Code.

Body ()

Root Schema : AccountsWithBalAndStrCodeServiceCollection

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountWithBalAndStrCodeServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "messages":{
            "$ref":"#/definitions/VirtualAccountServiceResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AccountWithBalAndStrCodeServiceDTO

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

Nested Schema : VirtualAccountServiceResponseDto

Type: object

Show Source

• codes(optional): array codes
• status(optional): string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VirtualAccountServiceResponseCode"
            }
        }
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : AccountWithBalAndStrCodeServiceDTO

Type: object

Show Source

• availableBal(optional): number
  Available balance of a virtual account
• creationDate(optional): string
  Creation date of a virtual account
• currency(optional): string
  Currency of a virtual account
• currentBalance(optional): number
  Current balance of the Virtual Account
• realAccLinkage(optional): string
  Indicates if Real Account Linkage is at Account level or Structure level
• realAccountBrn(optional): string
  Real Account Branch for which Virtual Account is created
• realAccountNo(optional): string
  Real Account Number for which Virtual Account is created
• status(optional): string
  Status of the virtual account
• strCode(optional): string
  Structure code of the virtual account
• virtualAccountName(optional): string
  Virtual account name of a virtual account
• virtualAccountNo(optional): string
  Virtual account no, is a unique virtual no, which can be created for a entity
• virtualAccountProduct(optional): string
  Account Product with which the Virtual Account is created
• virtualEntityId(optional): string
  Virtual entity id is a unique no of virtual customer
• virtualEntityName(optional): string
  Virtual entity or customer name of entity id

{
    "type":"object",
    "properties":{
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual account no, is a unique virtual no, which can be created for a entity"
        },
        "virtualAccountName":{
            "type":"string",
            "description":"Virtual account name of a virtual account"
        },
        "currency":{
            "type":"string",
            "description":"Currency of a virtual account"
        },
        "availableBal":{
            "type":"number",
            "description":"Available balance of a virtual account"
        },
        "currentBalance":{
            "type":"number",
            "description":"Current balance of the Virtual Account"
        },
        "creationDate":{
            "type":"string",
            "description":"Creation date of a virtual account"
        },
        "strCode":{
            "type":"string",
            "description":"Structure code of the virtual account"
        },
        "status":{
            "type":"string",
            "description":"Status of the virtual account"
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real Account Number for which Virtual Account is created"
        },
        "realAccountBrn":{
            "type":"string",
            "description":"Real Account Branch for which Virtual Account is created"
        },
        "realAccLinkage":{
            "type":"string",
            "description":"Indicates if Real Account Linkage is at Account level or Structure level"
        },
        "virtualEntityName":{
            "type":"string",
            "description":"Virtual entity or customer name of entity id"
        },
        "virtualEntityId":{
            "type":"string",
            "description":"Virtual entity id is a unique no of virtual customer"
        },
        "virtualAccountProduct":{
            "type":"string",
            "description":"Account Product with which the Virtual Account is created"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object VirtualAccountServiceResponseCode

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

Nested Schema : VirtualAccountServiceResponseCode

Type: object

Show Source

• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

204 Response

NO CONTENT. No records found

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.

500 Response

Internal server error.

Back to Top