Jump to

• Request
• Response

Get available balance for the specified query parameters

get

/balanceFetch/availableBalance

This endpoint is used to get all the available balances for the specified account and date combinations.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountNumber: string
  Account Number
• branchCode: string
  Branch Code
• valueDate: string
  Branch Code

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of success or failure

Body ()

Root Schema : LmxTmAccountVdBalDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmxTmAccountVdBalDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "accountNumber":{
                    "type":"string",
                    "description":"",
                    "maxLength":30
                },
                "branchCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":4
                },
                "currencyCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":3
                },
                "availableBalance":{
                    "type":"number",
                    "description":""
                },
                "vdBalance":{
                    "type":"number",
                    "description":""
                },
                "icBalance":{
                    "type":"number",
                    "description":""
                },
                "bookDatedBalance":{
                    "type":"number",
                    "description":""
                },
                "valueDate":{
                    "type":"string",
                    "description":""
                },
                "lastBalanceUpdate":{
                    "type":"string",
                    "description":"",
                    "format":"date"
                },
                "source":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "balanceType":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "lastAvailableBalance":{
                    "type":"string",
                    "description":""
                },
                "sourceReference":{
                    "type":"string",
                    "description":"",
                    "maxLength":50
                },
                "isSystemAccount":{
                    "type":"string",
                    "description":""
                },
                "isSimulation":{
                    "type":"string",
                    "description":""
                },
                "simulationAccount":{
                    "type":"string",
                    "description":""
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmxTmAccountVdBalDTO-allOf[1]

Type: object

Show Source

• accountNumber(optional): string
  Maximum Length: 30
• availableBalance(optional): number
• balanceType(optional): string
  Maximum Length: 50
• bookDatedBalance(optional): number
• branchCode(optional): string
  Maximum Length: 4
• currencyCode(optional): string
  Maximum Length: 3
• icBalance(optional): number
• isSimulation(optional): string
• isSystemAccount(optional): string
• lastAvailableBalance(optional): string
• lastBalanceUpdate(optional): string(date)
• simulationAccount(optional): string
• source(optional): string
  Maximum Length: 50
• sourceReference(optional): string
  Maximum Length: 50
• valueDate(optional): string
• vdBalance(optional): number

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":"",
            "maxLength":30
        },
        "branchCode":{
            "type":"string",
            "description":"",
            "maxLength":4
        },
        "currencyCode":{
            "type":"string",
            "description":"",
            "maxLength":3
        },
        "availableBalance":{
            "type":"number",
            "description":""
        },
        "vdBalance":{
            "type":"number",
            "description":""
        },
        "icBalance":{
            "type":"number",
            "description":""
        },
        "bookDatedBalance":{
            "type":"number",
            "description":""
        },
        "valueDate":{
            "type":"string",
            "description":""
        },
        "lastBalanceUpdate":{
            "type":"string",
            "description":"",
            "format":"date"
        },
        "source":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "balanceType":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "lastAvailableBalance":{
            "type":"string",
            "description":""
        },
        "sourceReference":{
            "type":"string",
            "description":"",
            "maxLength":50
        },
        "isSystemAccount":{
            "type":"string",
            "description":""
        },
        "isSimulation":{
            "type":"string",
            "description":""
        },
        "simulationAccount":{
            "type":"string",
            "description":""
        }
    }
}

204 Response

There is no result for the query params

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