Jump to

• Request
• Response

Retrieves the Balance by ID.

get

/service/lmx/balanceFetch/getBySourceRef/{sourceRef}

This endpoint is used to get the balance by ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• sourceRef(required): string
  Id of the user that needs to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the balance based on given id.

Body ()

Root Schema : LmxTmAccountVdBalCollection

Type: object

Collection of balances.

Show Source

• data: array data
• paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmxTmAccountVdBalDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

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":""
                },
                "bookDatedBalance":{
                    "type":"number",
                    "description":""
                },
                "valueDate":{
                    "type":"string",
                    "description":""
                },
                "lastBalanceUpdate":{
                    "type":"string",
                    "description":"",
                    "format":"date"
                },
                "source":{
                    "type":"string",
                    "description":""
                },
                "balanceType":{
                    "type":"string",
                    "description":""
                },
                "lastAvailableBalance":{
                    "type":"string",
                    "description":""
                },
                "sourceReference":{
                    "type":"string",
                    "description":""
                },
                "availBalCreditDebit":{
                    "type":"number",
                    "description":""
                },
                "bookBalCreditDebit":{
                    "type":"number",
                    "description":""
                },
                "sumOfCreditEntries":{
                    "type":"number",
                    "description":""
                },
                "sumOfDebitEntries":{
                    "type":"number",
                    "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: string
• availableBalance: number
• availBalCreditDebit: number
• balanceType: string
• bookBalCreditDebit: number
• bookDatedBalance: number
• branchCode: string
• currencyCode: string
• lastAvailableBalance: string
• lastBalanceUpdate: string(date)
• source: string
• sourceReference: string
• sumOfCreditEntries: number
• sumOfDebitEntries: number
• valueDate: string

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "type":"string",
            "description":""
        },
        "branchCode":{
            "type":"string",
            "description":""
        },
        "currencyCode":{
            "type":"string",
            "description":""
        },
        "availableBalance":{
            "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":""
        },
        "lastAvailableBalance":{
            "type":"string",
            "description":""
        },
        "sourceReference":{
            "type":"string",
            "description":""
        },
        "availBalCreditDebit":{
            "type":"number",
            "description":""
        },
        "bookBalCreditDebit":{
            "type":"number",
            "description":""
        },
        "sumOfCreditEntries":{
            "type":"number",
            "description":""
        },
        "sumOfDebitEntries":{
            "type":"number",
            "description":""
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top