Jump to

• Request
• Response

Get all valid accounts for closure

get

/service/accounts/virtualaccountsforclosure

This endpoint is used to get all valid accounts allowed for closure.

Request

Supported Media Types

• application/json

Query Parameters

• branchCode(optional): string
  Branch code of the virtual account
• currency(optional): string
  Currency of the virtual account
• ibanAccNo(optional): string
  International Bank Account Number
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• realCustomerNo(optional): string
  Real customer number for which virtual accounts applicable for closure needs to be fetched
• virtualAccountName(optional): string
  Virtual account name
• virtualAccountNo(optional): string
  Virtual account number
• virtualEntityId(optional): string
  Virtual entity ID for which virtual accounts applicable for closure needs to be fetched

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : VirtualAccountsForClosureCollection

Type: object

Collection of virtual account allowed for closure

Show Source

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

{
    "description":"Collection of virtual account allowed for closure",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/VAClosureResponseDTO"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VirtualAccountForClosureDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VirtualAccountForClosureDTO

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

Nested Schema : VAClosureResponseDTO

Type: object

Show Source

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

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : VirtualAccountForClosureDTO

Type: object

Show Source

• 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
• currentBalance(optional): number
  Current balance of virtual account
• defaultAccCcy(optional): string
  Currency of Virtual Account
• ibanAccNo(optional): string
  IBan Account Number
• interestCalcReq(optional): string
  Flag to indicate if Interest Calculation is required
• keyId(optional): string
  KeyId of the Virtual Account
• realCustomerNo(optional): string
  Real Customer Number for whom Virtual Account is created
• virtualAccountName(optional): string
  Name of the Virtual Account
• virtualAccountNo(optional): string
  Virtual Account Number
• virtualEntityId(optional): string
  Virtual Entity for which Virtual Account is created
• virtualEntityName(optional): string
  Virtual Entity Name for which Virtual Account is created

{
    "type":"object",
    "properties":{
        "keyId":{
            "type":"string",
            "description":"KeyId of the Virtual Account"
        },
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number for whom Virtual Account is created"
        },
        "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"
        },
        "virtualAccountNo":{
            "type":"string",
            "description":"Virtual Account Number"
        },
        "virtualAccountName":{
            "type":"string",
            "description":"Name of the Virtual Account"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch code of the Virtual Account"
        },
        "defaultAccCcy":{
            "type":"string",
            "description":"Currency of Virtual Account"
        },
        "currentBalance":{
            "type":"number",
            "description":"Current balance of virtual account"
        },
        "interestCalcReq":{
            "type":"string",
            "description":"Flag to indicate if Interest Calculation is required"
        },
        "ibanAccNo":{
            "type":"string",
            "description":"IBan Account Number"
        },
        "branchName":{
            "type":"string",
            "description":"Name of the Branch for Virtual Account",
            "minimum":0,
            "maximum":105
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object VAClosureResponseCode

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

Nested Schema : VAClosureResponseCode

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"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top