Jump to

• Request
• Response

Retrieves the List of Existing Customer Balance

get

/service/lmd/topcustomersbalance

This endpoint is used to get the list of existing customer balance.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : LmdTbTopCustomerBalanceServiceCollection

Type: object

Collection of CustomerBalance

Show Source

• data: array data
• paging: object PagingDto

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

Nested Schema : data

Type: array

Show Source

• Array of: object LmdTbTopCustomerBalanceDTO
  CustomerBalance DTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

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

Nested Schema : LmdTbTopCustomerBalanceDTO

Type: object

CustomerBalance DTO

Match All

Show Source

• allOf GenericDto
• object LmdTbTopCustomerBalanceDTO-allOf[1]

{
    "description":"CustomerBalance DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "availableBalance":{
                    "description":"Balance in Customer Balance",
                    "type":"integer"
                },
                "currency":{
                    "description":"Currency in Customer Balance",
                    "type":"string"
                },
                "customerId":{
                    "description":"Customer Id for Customer Balance",
                    "type":"string",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "userId":{
                    "description":"User Id  of the Customer Balance",
                    "type":"string",
                    "maxLength":12
                }
            },
            "required":[
                "id",
                "userId"
            ]
        }
    ]
}

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

Type: object

Show Source

• availableBalance: integer
  Balance in Customer Balance
• currency: string
  Currency in Customer Balance
• customerId: string
  Pattern: [a-zA-Z0-9]{1,20}

  Customer Id for Customer Balance
• userId(required): string
  Maximum Length: 12

  User Id of the Customer Balance

{
    "type":"object",
    "properties":{
        "availableBalance":{
            "description":"Balance in Customer Balance",
            "type":"integer"
        },
        "currency":{
            "description":"Currency in Customer Balance",
            "type":"string"
        },
        "customerId":{
            "description":"Customer Id for Customer Balance",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "userId":{
            "description":"User Id  of the Customer Balance",
            "type":"string",
            "maxLength":12
        }
    },
    "required":[
        "id",
        "userId"
    ]
}

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