Rest API for Oracle Banking Liquidity Management

Retrieves the CurrencyBalance by ID.

get

/api/1.0/service/lmd/currencybalance

This endpoint is used to get the CurrencyBalance by ID.

Request

Supported Media Types

application/json
application/xml

Query Parameters

customerId: string

Pattern: [a-zA-Z0-9]{1,20}

Customer Id(s) for which data needs to be fetched
limit: integer

limit is maximum no of records to be fetched
offset: integer

offset is starting no of records to be fetched
structureId: string

Pattern: [A-Z0-9]{1,30}

Structure Id(s) for which data needs to be fetched

Header Parameters

sourceCode(required): string

Source from which request is initiated

Response

Supported Media Types

application/json
application/xml

200 Response

Returns the currency balances based on given id.

Root Schema : LmdTbCurrencyBalanceServiceCollection

Type: object

Collection of Currency Balances

Show Source

data: array data
paging: object PagingDto

{
    "description":"Collection of Currency Balances",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmdTbCurrencyBalanceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object LmdTbCurrencyBalanceDTO

CurrencyBalance DTO

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

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

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

Nested Schema : LmdTbCurrencyBalanceDTO

Type: object

CurrencyBalance DTO

Match All

Show Source

allOf GenericDto
object LmdTbCurrencyBalanceDTO-allOf[1]

{
    "description":"CurrencyBalance DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "structureId":{
                    "description":"structure id in Currency Balance",
                    "type":"string",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "valueDate":{
                    "description":"value date in Currency Balance",
                    "type":"string",
                    "format":"date"
                },
                "accountNumber":{
                    "description":"account number in Currency Balance",
                    "type":"string"
                },
                "branchCode":{
                    "description":"branch Code in Currency Balance",
                    "type":"string"
                },
                "availableBalance":{
                    "description":"Available Balance in Currency Balance",
                    "type":"integer"
                },
                "currencyCode":{
                    "description":"Currency code in Customer Balance",
                    "type":"string"
                },
                "customerId":{
                    "description":"Customer Id for Currency Balance",
                    "type":"string",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "userId":{
                    "description":"User Id  of the Currency Balance",
                    "type":"string"
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

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 : LmdTbCurrencyBalanceDTO-allOf[1]

Type: object

Show Source

accountNumber: string

account number in Currency Balance
availableBalance: integer

Available Balance in Currency Balance
branchCode: string

branch Code in Currency Balance
currencyCode: string

Currency code in Customer Balance
customerId: string

Pattern: [a-zA-Z0-9]{1,20}

Customer Id for Currency Balance
structureId: string

Pattern: [A-Z0-9]{1,30}

structure id in Currency Balance
userId: string

User Id of the Currency Balance
valueDate: string(date)

value date in Currency Balance

{
    "type":"object",
    "properties":{
        "structureId":{
            "description":"structure id in Currency Balance",
            "type":"string",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "valueDate":{
            "description":"value date in Currency Balance",
            "type":"string",
            "format":"date"
        },
        "accountNumber":{
            "description":"account number in Currency Balance",
            "type":"string"
        },
        "branchCode":{
            "description":"branch Code in Currency Balance",
            "type":"string"
        },
        "availableBalance":{
            "description":"Available Balance in Currency Balance",
            "type":"integer"
        },
        "currencyCode":{
            "description":"Currency code in Customer Balance",
            "type":"string"
        },
        "customerId":{
            "description":"Customer Id for Currency Balance",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "userId":{
            "description":"User Id  of the Currency Balance",
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error