Jump to

• Request
• Response

Service API that Get all valid value dated balances for the specified virtual account

get

/service/getVDBalance

This endpoint is used to get all valid value dated balances for a valudate or specific virtual account.

Request

Supported Media Types

• application/json

Query Parameters

• valueDate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Value date for which records are to be fetched
• virtualAccountNumber(optional): string
  Virtual account number for which balances has to be fetched

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 : VDBalanceServiceWrapperDTO

Type: object

Show Source

• data(optional): object VDBalanceDTO
• messages(optional): object VDBalanceServiceResponseDto
• paging(optional): object PagingDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/VDBalanceServiceResponseDto"
        },
        "data":{
            "$ref":"#/definitions/VDBalanceDTO"
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : VDBalanceDTO

Type: object

Show Source

• valueDatedBalanceDetails(optional): array valueDatedBalanceDetails

{
    "type":"object",
    "properties":{
        "valueDatedBalanceDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VDBalanceDetailsDTO"
            }
        }
    }
}

Nested Schema : VDBalanceServiceResponseDto

Type: object

Show Source

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

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : valueDatedBalanceDetails

Type: array

Show Source

• Array of: object VDBalanceDetailsDTO

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

Nested Schema : VDBalanceDetailsDTO

Type: object

Show Source

• valuedate(optional): string
  Pattern: [0-9]{4}[-][0-9]{2}[-][0-9]{2}

  Value date for which value dated balance is being fetched
• valueDatedBalance(optional): number
  Value dated balance for the date speficied
• virtualAccountCcy(optional): string
  Maximum Length: 3

  Currency of the virtual account number
• virtualAccountNumber(optional): string
  Virtual account number for which balance has to be fetched

{
    "type":"object",
    "properties":{
        "virtualAccountNumber":{
            "type":"string",
            "description":"Virtual account number for which balance has to be fetched"
        },
        "virtualAccountCcy":{
            "type":"string",
            "maxLength":3,
            "description":"Currency of the virtual account number"
        },
        "valuedate":{
            "type":"string",
            "pattern":"[0-9]{4}[-][0-9]{2}[-][0-9]{2}",
            "description":"Value date for which value dated balance is being fetched"
        },
        "valueDatedBalance":{
            "type":"number",
            "description":"Value dated balance for the date speficied"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object VDBalanceServiceResponseCode

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

Nested Schema : VDBalanceServiceResponseCode

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.

405 Response

Request denied, invalid input.

500 Response

Internal server error.

Back to Top