Rest API for Oracle Banking Liquidity Management

Retrieves the balance by ID

get

/balanceFetch/getBySourceRef/{sourceRef}

This endpoint is used to get the balance by ID.

Request

Supported Media Types

application/json
application/xml

Path Parameters

sourceRef: string

Id of the user that needs to be fetched

Response

Supported Media Types

application/json
application/xml

200 Response

Returns the balance based on given id.

Root Schema : LmxTmAccountVdBalCollection

Type: object

Collection of balances.

Show Source

data(optional): array data

{
    "description":"Collection of balances.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmAccountVdBalDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object LmxTmAccountVdBalDTO

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

Nested 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":""
                },
                "branchCode":{
                    "type":"string",
                    "description":""
                },
                "currencyCode":{
                    "type":"string",
                    "description":""
                },
                "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":""
                },
                "balanceType":{
                    "type":"string",
                    "description":""
                },
                "sourceReference":{
                    "type":"string",
                    "description":""
                },
                "lastAvailableBalance":{
                    "type":"string",
                    "description":""
                },
                "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
availableBalance(optional): number
balanceType(optional): string
bookDatedBalance(optional): number
branchCode(optional): string
currencyCode(optional): string
icBalance(optional): number
isSimulation(optional): string
isSystemAccount(optional): string
lastAvailableBalance(optional): string
lastBalanceUpdate(optional): string(date)
simulationAccount(optional): string
source(optional): string
sourceReference(optional): string
valueDate(optional): string
vdBalance(optional): number

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "currencyCode":{
            "type":"string",
            "description":""
        },
        "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":""
        },
        "balanceType":{
            "type":"string",
            "description":""
        },
        "sourceReference":{
            "type":"string",
            "description":""
        },
        "lastAvailableBalance":{
            "type":"string",
            "description":""
        },
        "isSystemAccount":{
            "type":"string",
            "description":""
        },
        "isSimulation":{
            "type":"string",
            "description":""
        },
        "simulationAccount":{
            "type":"string",
            "description":""
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error